Struct rusoto_apigateway::DocumentationPart

pub struct DocumentationPart {
    pub id: Option<String>,
    pub location: Option<DocumentationPartLocation>,
    pub properties: Option<String>,
}

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, PATHPARAMETER, QUERYPARAMETER, REQUESTHEADER, REQUESTBODY, RESPONSE, RESPONSEHEADER, and RESPONSEBODY. 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 Swagger-compliant documentation fields will be injected into the associated API entity definition in the exported Swagger definition file.

Documenting an API, DocumentationParts

Fields

id: Option<String>

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

location: Option<DocumentationPartLocation>

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: Option<String>

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 Swagger-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 Swagger extension of x-amazon-apigateway-documentation.

Trait Implementations

impl Default for DocumentationPart

fn default() -> DocumentationPart

Returns the "default value" for a type.

impl PartialEq<DocumentationPart> for DocumentationPart

fn eq(&self, other: &DocumentationPart) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &DocumentationPart) -> bool

This method tests for !=.

impl Clone for DocumentationPart

fn clone(&self) -> DocumentationPart

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DocumentationPart

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocumentationPart

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where     __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.