AWS SDK for C++  1.9.124
AWS SDK for C++
Public Member Functions | List of all members
Aws::APIGateway::Model::DocumentationPart Class Reference

#include <DocumentationPart.h>

Public Member Functions

 DocumentationPart ()
 
 DocumentationPart (Aws::Utils::Json::JsonView jsonValue)
 
DocumentationPartoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
DocumentationPartWithId (const Aws::String &value)
 
DocumentationPartWithId (Aws::String &&value)
 
DocumentationPartWithId (const char *value)
 
const DocumentationPartLocationGetLocation () const
 
bool LocationHasBeenSet () const
 
void SetLocation (const DocumentationPartLocation &value)
 
void SetLocation (DocumentationPartLocation &&value)
 
DocumentationPartWithLocation (const DocumentationPartLocation &value)
 
DocumentationPartWithLocation (DocumentationPartLocation &&value)
 
const Aws::StringGetProperties () const
 
bool PropertiesHasBeenSet () const
 
void SetProperties (const Aws::String &value)
 
void SetProperties (Aws::String &&value)
 
void SetProperties (const char *value)
 
DocumentationPartWithProperties (const Aws::String &value)
 
DocumentationPartWithProperties (Aws::String &&value)
 
DocumentationPartWithProperties (const char *value)
 

Detailed Description

A documentation part for a targeted API entity.

A documentation part consists of a content map (properties) and a target (location). The target specifies an API entity to which the documentation content applies. The supported API entity types are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Valid location fields depend on the API entity type. All valid fields are not required.
The content map is a JSON string of API-specific key-value pairs. Although an API can use any shape for the content map, only the OpenAPI-compliant documentation fields will be injected into the associated API entity definition in the exported OpenAPI definition file.
Documenting an API, DocumentationParts

See Also:

AWS API Reference

Definition at line 47 of file DocumentationPart.h.

Constructor & Destructor Documentation

◆ DocumentationPart() [1/2]

Aws::APIGateway::Model::DocumentationPart::DocumentationPart ( )

◆ DocumentationPart() [2/2]

Aws::APIGateway::Model::DocumentationPart::DocumentationPart ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetId()

const Aws::String& Aws::APIGateway::Model::DocumentationPart::GetId ( ) const
inline

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

Definition at line 60 of file DocumentationPart.h.

◆ GetLocation()

const DocumentationPartLocation& Aws::APIGateway::Model::DocumentationPart::GetLocation ( ) const
inline

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.

Definition at line 112 of file DocumentationPart.h.

◆ GetProperties()

const Aws::String& Aws::APIGateway::Model::DocumentationPart::GetProperties ( ) const
inline

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 <literal>properties</literal> 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.

Definition at line 169 of file DocumentationPart.h.

◆ IdHasBeenSet()

bool Aws::APIGateway::Model::DocumentationPart::IdHasBeenSet ( ) const
inline

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

Definition at line 66 of file DocumentationPart.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::APIGateway::Model::DocumentationPart::Jsonize ( ) const

◆ LocationHasBeenSet()

bool Aws::APIGateway::Model::DocumentationPart::LocationHasBeenSet ( ) const
inline

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.

Definition at line 121 of file DocumentationPart.h.

◆ operator=()

DocumentationPart& Aws::APIGateway::Model::DocumentationPart::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PropertiesHasBeenSet()

bool Aws::APIGateway::Model::DocumentationPart::PropertiesHasBeenSet ( ) const
inline

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 <literal>properties</literal> 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.

Definition at line 180 of file DocumentationPart.h.

◆ SetId() [1/3]

void Aws::APIGateway::Model::DocumentationPart::SetId ( Aws::String &&  value)
inline

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

Definition at line 78 of file DocumentationPart.h.

◆ SetId() [2/3]

void Aws::APIGateway::Model::DocumentationPart::SetId ( const Aws::String value)
inline

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

Definition at line 72 of file DocumentationPart.h.

◆ SetId() [3/3]

void Aws::APIGateway::Model::DocumentationPart::SetId ( const char *  value)
inline

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

Definition at line 84 of file DocumentationPart.h.

◆ SetLocation() [1/2]

void Aws::APIGateway::Model::DocumentationPart::SetLocation ( const DocumentationPartLocation value)
inline

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.

Definition at line 130 of file DocumentationPart.h.

◆ SetLocation() [2/2]

void Aws::APIGateway::Model::DocumentationPart::SetLocation ( DocumentationPartLocation &&  value)
inline

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.

Definition at line 139 of file DocumentationPart.h.

◆ SetProperties() [1/3]

void Aws::APIGateway::Model::DocumentationPart::SetProperties ( Aws::String &&  value)
inline

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 <literal>properties</literal> 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.

Definition at line 202 of file DocumentationPart.h.

◆ SetProperties() [2/3]

void Aws::APIGateway::Model::DocumentationPart::SetProperties ( const Aws::String value)
inline

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 <literal>properties</literal> 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.

Definition at line 191 of file DocumentationPart.h.

◆ SetProperties() [3/3]

void Aws::APIGateway::Model::DocumentationPart::SetProperties ( const char *  value)
inline

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 <literal>properties</literal> 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.

Definition at line 213 of file DocumentationPart.h.

◆ WithId() [1/3]

DocumentationPart& Aws::APIGateway::Model::DocumentationPart::WithId ( Aws::String &&  value)
inline

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

Definition at line 96 of file DocumentationPart.h.

◆ WithId() [2/3]

DocumentationPart& Aws::APIGateway::Model::DocumentationPart::WithId ( const Aws::String value)
inline

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

Definition at line 90 of file DocumentationPart.h.

◆ WithId() [3/3]

DocumentationPart& Aws::APIGateway::Model::DocumentationPart::WithId ( const char *  value)
inline

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

Definition at line 102 of file DocumentationPart.h.

◆ WithLocation() [1/2]

DocumentationPart& Aws::APIGateway::Model::DocumentationPart::WithLocation ( const DocumentationPartLocation value)
inline

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.

Definition at line 148 of file DocumentationPart.h.

◆ WithLocation() [2/2]

DocumentationPart& Aws::APIGateway::Model::DocumentationPart::WithLocation ( DocumentationPartLocation &&  value)
inline

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.

Definition at line 157 of file DocumentationPart.h.

◆ WithProperties() [1/3]

DocumentationPart& Aws::APIGateway::Model::DocumentationPart::WithProperties ( Aws::String &&  value)
inline

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 <literal>properties</literal> 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.

Definition at line 235 of file DocumentationPart.h.

◆ WithProperties() [2/3]

DocumentationPart& Aws::APIGateway::Model::DocumentationPart::WithProperties ( const Aws::String value)
inline

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 <literal>properties</literal> 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.

Definition at line 224 of file DocumentationPart.h.

◆ WithProperties() [3/3]

DocumentationPart& Aws::APIGateway::Model::DocumentationPart::WithProperties ( const char *  value)
inline

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 <literal>properties</literal> 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.

Definition at line 246 of file DocumentationPart.h.


The documentation for this class was generated from the following file: