OpenAPI
Update OpenAPI document for mock API
Mock APIs
Teams
Organisations
Data sources
Database connections
Usage
Access control
Stub Mappings
- GETGet all stub mappings
- POSTCreate a new stub mapping
- DELDelete all stub mappings
- POSTReset stub mappings
- POSTPersist stub mappings
- POSTImport stub mappings
- GETGet stub mapping by ID
- PUTUpdate a stub mapping
- DELDelete a stub mapping
- POSTFind stub mappings matching metadata
- POSTDelete stub mappings matching metadata
Requests
OpenAPI
Update OpenAPI document for mock API
PUT
/
v1
/
mock-apis
/
{mockApiId}
/
open-api
Authorization
object
*
Authorization
Required
object
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
username
string
username
string
password
string
password
string
mockApiId
string
*
mockApiId
Required
string
The ID of the Mock API
Add Example Value
object
*
openApi
object
*
openApi
Required
object
doc
string
*
doc
Required
string
Add Example Value
Authorizations
Authorization
string
headerrequiredBasic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Path Parameters
mockApiId
string
requiredThe ID of the Mock API
Body
application/json
openApi
object
required