Sign in

v5

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-07-0330110112.1 KB
API Documentations

Create or update an API Documentation page

Create or update a Documentation page attached to an API

put/organizations/{orgId}/environments/{envId}/apis/{apiHrid}/documentations

Path parameters

orgIdstring required
Example:dedd0e0f-b3e9-4d2f-89cd-b2a9de7cb145

organization ID

envIdstring required
Example:a44e0d1b-9fa9-4d64-8b76-3634623a2e27

environment ID

apiHridstring required
Example:my_demo_api

Human-readable ID of api

Query parameters

dryRunboolean
Example:true

For modifying requests, this parameter allow you to test the result of an endpoint without actually persisting the state of the underlying spec.

Request body

hridstring required

A unique human readable id identifying this resource

namestring required

Display name of the documentation page

type'GRAVITEE_MARKDOWN' | 'OPENAPI' | 'ASYNCAPI' required

The type of documentation page

contentstring required

The content of the documentation page

locationstring

The path in the navigation hierarchy where this page should appear.

orderinteger

Display order relative to siblings at the same location

Example request

{
  "hrid": "demo_api",
  "name": "Getting Started",
  "location": "/projects/alpha/docs"
}

Response

State of the successfully created/updated Documentation

hridstring required

A unique human readable id identifying this resource

namestring required

Display name of the documentation page

type'GRAVITEE_MARKDOWN' | 'OPENAPI' | 'ASYNCAPI' required

The type of documentation page

contentstring required

The content of the documentation page

locationstring

The path in the navigation hierarchy where this page should appear.

orderinteger

Display order relative to siblings at the same location

idstring

Resource UUID.

environmentIdstring

The environment ID.

organizationIdstring

The organization ID.

portalHridstring

The HRID of the portal this documentation page belongs to (when attached to a portal).

apiHridstring

The HRID of the API this documentation page belongs to (when attached to an API).

Example response

{
  "hrid": "demo_api",
  "name": "Getting Started",
  "location": "/projects/alpha/docs"
}