Sign in
latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-07-21130282381.6 KB

aef12fc964d5

API Documentation

Update API documentation page

Update API documentation page

Update API documentation. The result will be the updated documentation. Only MARKDOWN and FOLDER types are supported.

Low-value for routine assistant workflows; prefer higher-level API inspection tools first.

put/environments/{envId}/apis/{apiId}/pages/{pageId}

Request body

type'FOLDER' | 'MARKDOWN' | 'SWAGGER' | 'ASYNCAPI' | 'ASCIIDOC' required

The type of documentation to update.

namestring required

Page's name.

orderinteger

Page's order.

visibility'PUBLIC' | 'PRIVATE'

The visibility of the resource regarding the portal.

excludedAccessControlsboolean

Flag to restrict access to user matching the restrictions.

configurationobject

Configuration of a page

Example request

{
  "name": "My Page",
  "order": 1,
  "visibility": "PUBLIC",
  "accessControls": [
    {
      "referenceId": "00f8c9e7-78fc-4907-b8c9-e778fc790750"
    }
  ]
}

Response

API Documentation Updated

idstring

Page's uuid.

crossIdstring

Page's cross uuid.

namestring

Page's name.

type'ASCIIDOC' | 'ASYNCAPI' | 'MARKDOWN' | 'MARKDOWN_TEMPLATE' | 'SWAGGER' | 'FOLDER' | 'LINK' | 'ROOT' | 'SYSTEM_FOLDER' | 'TRANSLATION'

The type of the page.

contentstring

Page's content.

orderinteger

Page's order.

lastContributorstring

Page's last contributor. Id of a user.

publishedboolean

Page's published status.

visibility'PUBLIC' | 'PRIVATE'

The visibility of the resource regarding the portal.

updatedAtstring date-time

Page's last update date.

contentTypestring

Page's content type.

configurationobject

Page's configuration.

homepageboolean

Page's homepage status.

parentIdstring

Page's parent id.

parentPathstring

Page's parent path.

excludedAccessControlsboolean

Flag to restrict access to user matching the restrictions.

metadataobject

Page's metadata.

hiddenboolean

If folder is published but not shown in Portal.

generalConditionsboolean

If page is used as General Conditions of an active plan.

Example response

{
  "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
  "crossId": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
  "name": "My Page",
  "type": "MARKDOWN",
  "content": "My Page content",
  "order": 1,
  "lastContributor": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
  "published": true,
  "visibility": "PUBLIC",
  "updatedAt": "2018-01-01 00:00:00+00:00",
  "contentType": "application/json",
  "homepage": true,
  "parentId": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
  "parentPath": "/parent",
  "accessControls": [
    {
      "referenceId": "00f8c9e7-78fc-4907-b8c9-e778fc790750"
    }
  ],
  "attachedMedia": [
    {
      "name": "My Media",
      "hash": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
      "attachedAt": "2018-01-01 00:00:00+00:00"
    }
  ],
  "contentRevision": {
    "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
    "revision": 1
  }
}