Skip to content

API Gateway  >  Operations  >  create_documentation_version

create_documentation_version

Operation

create_documentation_version async 

create_documentation_version(input: CreateDocumentationVersionInput, plugins: list[Plugin] | None = None) -> CreateDocumentationVersionOutput

Creates a documentation version

Parameters:

Name Type Description Default
input CreateDocumentationVersionInput

An instance of CreateDocumentationVersionInput.

 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
CreateDocumentationVersionOutput

An instance of CreateDocumentationVersionOutput.

Input

CreateDocumentationVersionInput dataclass

Creates a new documentation version of a given API.

Attributes

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

A description about the new documentation snapshot.

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

The version identifier of the new snapshot.

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

The string identifier of the associated RestApi.

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

The stage name to be associated with the new documentation snapshot.

Output

CreateDocumentationVersionOutput dataclass

A snapshot of the documentation of an API.

Attributes

created_date class-attribute instance-attribute 
created_date: datetime | None = None

The date when the API documentation snapshot is created.

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

The description of the API documentation snapshot.

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

The version identifier of the API documentation snapshot.