Struct rusoto_apigateway::DocumentationPart
source · [−]pub struct DocumentationPart {
pub id: Option<String>,
pub location: Option<DocumentationPartLocation>,
pub properties: Option<String>,
}
Expand 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
, 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 OpenAPI-compliant documentation fields will be injected into the associated API entity definition in the exported OpenAPI definition file.
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 OpenAPI-compliant documentation-related fields from the x-amazon-apigateway-documentation
.
Trait Implementations
sourceimpl Clone for DocumentationPart
impl Clone for DocumentationPart
sourcefn clone(&self) -> DocumentationPart
fn clone(&self) -> DocumentationPart
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for DocumentationPart
impl Debug for DocumentationPart
sourceimpl Default for DocumentationPart
impl Default for DocumentationPart
sourcefn default() -> DocumentationPart
fn default() -> DocumentationPart
Returns the “default value” for a type. Read more
sourceimpl<'de> Deserialize<'de> for DocumentationPart
impl<'de> Deserialize<'de> for DocumentationPart
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<DocumentationPart> for DocumentationPart
impl PartialEq<DocumentationPart> for DocumentationPart
sourcefn eq(&self, other: &DocumentationPart) -> bool
fn eq(&self, other: &DocumentationPart) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &DocumentationPart) -> bool
fn ne(&self, other: &DocumentationPart) -> bool
This method tests for !=
.
impl StructuralPartialEq for DocumentationPart
Auto Trait Implementations
impl RefUnwindSafe for DocumentationPart
impl Send for DocumentationPart
impl Sync for DocumentationPart
impl Unpin for DocumentationPart
impl UnwindSafe for DocumentationPart
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more