api-docs-icon

Update API Link

PATCH
/ doc_project/ {doc_name}/ version/ {doc_version}/ api_link/ {link_id}

object
required
api_version
union

Can be either the semantic version or a released type (like latest)

ask_ai
boolean
build_request_enabled
boolean
include_mock_server
boolean
label
string
policy
enum
Allowed Values:
latest
pinned
slug
string

Responses

Updated API link successfully

application/json
object
api_version
object
required

ask_ai
boolean
required
build_request_enabled
boolean
required
created_at
string (date-time)
required
doc_version
object
required

id
string (uuid)
required
include_mock_server
boolean
required
label
string
required
policy
enum
required
Allowed Values:
latest
pinned
slug
string
required
type
enum
required

Constant denoting sidebar component as an API link

Allowed Values:
api_link

Code Examples










Response