Get OpenAPI

GET
/ api/ {api_name}/ spec/ {api_version}/ openapi



Response












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)

Responses

OpenAPI Specification as JSON and OAS metadata

extension
enum
required
Allowed Values:
json
yaml
is_config_valid
deprecated
boolean
required

Deprecated with July 1st sunset date. Are the various the Sideko configuration (x-fields) valid

is_valid
boolean
required

Is the OpenAPI spec a valid 3.x spec

openapi
string
required

OpenAPI content as a string in JSON format

validations
deprecated
array<object>
required

Deprecated with July 1st sunset date. Validations are now returned via the linting routes

object