object
name
string
required
Example:
my-api-spec
openapi
binary
required
An OpenAPI specification in YAML or JSON
Example:
uploads/openapi.yaml
version
union
required
Semantic version (0.1.0) or a release type (major, minor, patch, rc)
Example:
patch
allow_lint_errors
boolean
default: false
Allow API spec to be created even if it has linting errors
mock_server_enabled
boolean
default: true
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>
Responses
API created
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