New: AI Insights are here.
See what your users are asking.
Ctrlk
Pricing Log in Sign up
For the complete documentation index, see llms.txt. This page is also available as Markdown.

OpenAPI spec versions

Track changes to your OpenAPI documents by versioning them.

Keep a history of your OpenAPI specs, enabling you to compare different versions, revert, or maintain multiple concurrent versions for testing or documentation.

The OpenAPISpecVersion object

Attributes
objectstring · enumRequired

The object type, which is always "openapi-spec-version"

Possible values:
idstringRequired

Unique identifier

createdAtstring · date-timeOptional

Date of creation

urlstring · uri · max: 2048Required

URL where the specification is accessible.

The OpenAPISpecVersion object

Available in MCP

List all OpenAPI spec versions

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
specSlugstringRequired

Slug of the OpenAPI specification

Query parameters
pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses
200

OK

application/json
countnumberOptional

Total count of objects in the list

get/orgs/{organizationId}/openapi/{specSlug}/versions
Available in MCP

Get the latest OpenAPI spec version

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
specSlugstringRequired

Slug of the OpenAPI specification

Responses
200

OK

application/json
objectstring · enumRequired

The object type, which is always "openapi-spec-version"

Possible values:
idstringRequired

Unique identifier

createdAtstring · date-timeOptional

Date of creation

urlstring · uri · max: 2048Required

URL where the specification is accessible.

get/orgs/{organizationId}/openapi/{specSlug}/versions/latest
Available in MCP

Get the latest OpenAPI spec version content

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
specSlugstringRequired

Slug of the OpenAPI specification

Responses
200

OK

application/json

Content of the specification available through filesystem or public URL.

filesystemobjectRequired

Filesystem containing all specifications.

get/orgs/{organizationId}/openapi/{specSlug}/versions/latest/content
Available in MCP

Get an OpenAPI spec version by its ID

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
specSlugstringRequired

Slug of the OpenAPI specification

versionIdstringRequired

The unique ID of the OpenAPI specification version

Responses
200

OK

application/json
objectstring · enumRequired

The object type, which is always "openapi-spec-version"

Possible values:
idstringRequired

Unique identifier

createdAtstring · date-timeOptional

Date of creation

urlstring · uri · max: 2048Required

URL where the specification is accessible.

get/orgs/{organizationId}/openapi/{specSlug}/versions/{versionId}
Available in MCP

Get an OpenAPI spec version content by its ID

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
specSlugstringRequired

Slug of the OpenAPI specification

versionIdstringRequired

The unique ID of the OpenAPI specification version

Responses
200

OK

application/json

Content of the specification available through filesystem or public URL.

filesystemobjectRequired

Filesystem containing all specifications.

get/orgs/{organizationId}/openapi/{specSlug}/versions/{versionId}/content

Last updated

Was this helpful?

AltStyle によって変換されたページ (->オリジナル) /