Update version | Documentation

Version Update version

PUT

/control-plane/api/v1/v1/documentation/{organization_id}/{documentation_id}/version/{version_id}

Authentication

API Key (BearerAuth)

Header: Authorization

Path Parameters

organization_idstringrequired

Organization ID

documentation_idstringrequired

Documentation ID

version_idstringrequired

Version ID

Request Body

Version update input

Required

is_defaultboolean

is_deprecatedboolean

is_latestboolean

namestring

released_atstring

slugstring

Example:

{
  "is_default": true,
  "is_deprecated": true,
  "is_latest": true,
  "name": "string",
  "released_at": "string",
  "slug": "string"
}

Responses

200

Response Fields:

created_at (string)
documentation_id (string)
id (string)
is_default (boolean)
is_deprecated (boolean)
is_latest (boolean)
name (string)
released_at (string)
slug (string)
updated_at (string)

Example:

{
  "created_at": "string",
  "documentation_id": "string",
  "id": "string",
  "is_default": true,
  "is_deprecated": true,
  "is_latest": true,
  "name": "string",
  "released_at": "string",
  "slug": "string",
  "updated_at": "string"
}

400

Bad Request

Example:

{
  "key": "value"
}

500

Internal Server Error

Example:

{
  "key": "value"
}