/api/v1/workspaces/{workspaceId}/knowledge/sites/{siteId}/pages/{pageId}/api-code-samples

Scope knowledge:write

Set per-language code samples on an API documentation page. An empty sample clears that language back to the generated snippet.

Pfad

siteIdPflicht

string (uuid)

Knowledge site identifier.

pageIdPflicht

string (uuid)

Page identifier.

workspaceIdPflicht

string

Workspace that owns the resource.

codeSamples

object

200KnowledgeApiRefDtoThe request succeeded. The JSON body contains url, data, and meta. The linked schema is data.

Knowledge API ref.

kind

key

string

Key.

codeSamples

object

400ApiProblemThe request is invalid.

401ApiProblemThe private app token is missing or invalid.

403ApiProblemThe token is missing the required scope, or this action is not allowed.

404ApiProblemThe workspace or resource was not found.

defaultApiProblemError response.