Skip to content

ImportDocumentationPartsRequest

Source code in docs_src/capo_api_gateway/types/import_documentation_parts_request.py 
16
17
18
19
20
21
22
23
24
class ImportDocumentationPartsRequest(TypedDict, closed=True):
    rest_api_id: "capo_api_gateway.types.string.String"
    """<p>The string identifier of the associated RestApi.</p>"""
    mode: NotRequired["capo_api_gateway.types.put_mode.PutMode"]
    """<p>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>.</p>"""
    fail_on_warnings: "capo_api_gateway.types.boolean.Boolean"
    """<p>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>.</p>"""
    body: "capo_api_gateway.types.blob.Blob"
    """<p>Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.</p>"""

body instance-attribute 

body: Blob

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

fail_on_warnings instance-attribute 

fail_on_warnings: Boolean

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

mode instance-attribute 

mode: NotRequired[PutMode]

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

rest_api_id instance-attribute 

rest_api_id: String

The string identifier of the associated RestApi.