api-docs-icon

Get OpenAPI specification

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

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

Responses

OpenAPI Specification as JSON and OAS metadata

application/json
object
extension
enum
required
Allowed Values:
json
yaml
is_config_valid
boolean
required

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
array[object]
required
object

Code Examples

Response