v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14120262383.5 KB

Imports documentation parts

put/restapis/{restapi_id}/documentation/parts

Path parameters

restapi_idstring required

The string identifier of the associated RestApi.

Query parameters

mode'merge' | 'overwrite'

A query parameter to indicate whether to overwrite (<code>OVERWRITE</code>) any existing DocumentationParts definition or to merge (<code>MERGE</code>) the new definition into the existing one. The default value is <code>MERGE</code>.

failonwarningsboolean

A query parameter to specify whether to rollback the documentation importation (<code>true</code>) or not (<code>false</code>) when a warning is encountered. The default value is <code>false</code>.

Request body

bodystring required

Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.

Response

Success

idsString[]

A list of the returned documentation part identifiers.

warningsString[]

A list of warning messages reported during import of documentation parts.