Portal Pages

Update portal page content OpenAPI viewer configuration

Changed on

User must have the ENVIRONMENT_DOCUMENTATION[update] permission.

patch/portal-page-contents/{portalPageContentId}/configuration

Request

  • Base URL
    /management/v2/environments/DEFAULT (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /management/v2/environments/DEFAULT/portal-page-contents/{portalPageContentId}/configuration
  • Auth
    • HTTP basic
    • or API key in cookie Auth-Graviteeio-APIM

Path parameters

portalPageContentIdstring required

The unique ID of the portal page content

Request body

OR

Response

Portal page content

idstring required

The unique ID of the portal page content

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

Type of portal page content

contentstring required

The content of the page

Changes

    • warning

      removed the request property //

    • warning

      removed the optional property /// from the response with the status

    • info

      added the new optional request property //

    • info

      added the optional property /// to the response with the status

    • breaking

      added subschema #2 to the request property allOf list

    • info

      added subschema #2 to the / response property allOf list for the response status