« blib/lib/Paws/ApiGateway/Deployments.pm
↑ Summary
blib/lib/Paws/ApiGateway/DocumentationPartIds.pm »
| 1 | |||
| 2 | package Paws::ApiGateway::DocumentationPart; | ||
| 3 | use Moose; | ||
| 4 | has Id => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'id'); | ||
| 5 | has Location => (is => 'ro', isa => 'Paws::ApiGateway::DocumentationPartLocation', traits => ['NameInRequest'], request_name => 'location'); | ||
| 6 | has Properties => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'properties'); | ||
| 7 | |||
| 8 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::ApiGateway::DocumentationPart | ||
| 16 | |||
| 17 | =head1 ATTRIBUTES | ||
| 18 | |||
| 19 | |||
| 20 | =head2 Id => Str | ||
| 21 | |||
| 22 | The DocumentationPart identifier, generated by API Gateway when the | ||
| 23 | C<DocumentationPart> is created. | ||
| 24 | |||
| 25 | |||
| 26 | =head2 Location => L<Paws::ApiGateway::DocumentationPartLocation> | ||
| 27 | |||
| 28 | The location of the API entity to which the documentation applies. | ||
| 29 | Valid fields depend on the targeted API entity type. All the valid | ||
| 30 | location fields are not required. If not explicitly specified, a valid | ||
| 31 | location field is treated as a wildcard and associated documentation | ||
| 32 | content may be inherited by matching entities, unless overridden. | ||
| 33 | |||
| 34 | |||
| 35 | =head2 Properties => Str | ||
| 36 | |||
| 37 | A content map of API-specific key-value pairs describing the targeted | ||
| 38 | API entity. The map must be encoded as a JSON string, e.g., C<"{ | ||
| 39 | \"description\": \"The API does ...\" }">. Only OpenAPI-compliant | ||
| 40 | documentation-related fields from the properties map are exported and, | ||
| 41 | hence, published as part of the API entity definitions, while the | ||
| 42 | original documentation parts are exported in a OpenAPI extension of | ||
| 43 | C<x-amazon-apigateway-documentation>. | ||
| 44 | |||
| 45 | |||
| 46 | =head2 _request_id => Str | ||
| 47 | |||
| 48 | |||
| 49 | =cut | ||
| 50 |