Struct CreateDocumentationPartOutput

#[non_exhaustive]
pub struct CreateDocumentationPartOutput {
    pub id: Option<String>,
    pub location: Option<DocumentationPartLocation>,
    pub properties: Option<String>,
    /* private fields */
}

A documentation part for a targeted API entity.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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 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.

Implementations

impl CreateDocumentationPartOutput

pub fn id(&self) -> Option<&str>

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

pub fn location(&self) -> 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.

pub fn properties(&self) -> Option<&str>

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.

impl CreateDocumentationPartOutput

pub fn builder() -> CreateDocumentationPartOutputBuilder

Creates a new builder-style object to manufacture CreateDocumentationPartOutput.

Trait Implementations

impl Clone for CreateDocumentationPartOutput

fn clone(&self) -> CreateDocumentationPartOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateDocumentationPartOutput

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

Formats the value using the given formatter.

impl PartialEq for CreateDocumentationPartOutput

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for CreateDocumentationPartOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for CreateDocumentationPartOutput