Skip to content

Api Gateway  >  Operations  >  create_documentation_part

create_documentation_part

Operation

create_documentation_part async 

create_documentation_part(input: CreateDocumentationPartInput, plugins: list[Plugin] | None = None) -> CreateDocumentationPartOutput

Creates a documentation part.

Parameters:

Name Type Description Default
input CreateDocumentationPartInput

An instance of CreateDocumentationPartInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
CreateDocumentationPartOutput

An instance of CreateDocumentationPartOutput.

Input

CreateDocumentationPartInput dataclass

Creates a new documentation part of a given API.

Attributes

location class-attribute instance-attribute 
location: DocumentationPartLocation | None = None

The location of the targeted API entity of the to-be-created documentation part.

properties class-attribute instance-attribute 
properties: str | None = None

The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

rest_api_id class-attribute instance-attribute 
rest_api_id: str | None = None

The string identifier of the associated RestApi.

Output

CreateDocumentationPartOutput dataclass

A documentation part for a targeted API entity.

Attributes

id class-attribute instance-attribute 
id: str | None = None

The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

location class-attribute instance-attribute 
location: DocumentationPartLocation | None = None

The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.

properties class-attribute instance-attribute 
properties: str | None = None

A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ "description": "The API does ..." }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.