id
string (uuid)
required
object
api_version
object
the api version can only be patched on api links with a pinned policy
build_request_enabled
boolean
include_mock_server
boolean
automatically add the sideko mock server as one of the server options when building a request in the api reference (requires mock server to be enabled on the linked Api Version)
nav_label
string
policy
enum
defines how the link should be automatically updated as new API version are added
Allowed Values:
latest
pinned
slug
string
Responses
Link updated
application/json
object
api_version
object
required
Summary object of the api version included in the api link
build_request_enabled
boolean
required
created_at
string (date-time)
required
doc_version
object
required
Summary object of the doc version included in the api link
group_id
string (uuid)
required
id
string (uuid)
required
include_mock_server
boolean
required
automatically add the sideko mock server as one of the server options when building a request in the api reference (requires mock server to be enabled on the linked Api Version)
nav_label
string
required
Example:
Generation API
order
integer
required
Example:
0
policy
enum
required
defines how the link should be automatically updated as new API version are added
Allowed Values:
latest
pinned
slug
string
required
Example:
generation-api
Code Examples
Response