api-docs-icon

Update an API Specification and/or metadata

PATCH
/ api/ {api_name}/ spec/ {api_version}

api_name
string
required

Unique project name or the uuid

Example:
my-project
api_version
union
required

Can be either the semantic version or a released type (like latest)

Variant 1
enum
Allowed Values:
latest
OR
Variant 2
string

Semantic version following conventions from https://semver.org/

Example:
0.1.0

object
allow_lint_errors
boolean

Allow API spec to be updated with a new OpenAPI spec even if it has linting errors

mock_server_enabled
boolean

Enable a public mock server requests for this API Specification

notes
string (html)

Text field to add any notes (comments, changelog, etc.) relevant to the version in html format

Example:
<p>This version includes a number of excellent improvements</p>
openapi
binary

An OpenAPI specification in YAML or JSON

Example:
uploads/openapi.yaml
version
string

Semantic Version of the API

Responses

Details of an API Specification version

application/json
object
api
object
required

created_at
string (date-time)
required
id
string (uuid)
required
mock_server
object
required

notes
string (html)
required

Text field to add any notes (comments, changelog, etc.) relevant to the version in html format

Example:
<p>This version includes a number of excellent improvements</p>
version
string
required

Code Examples

Response