[−][src]Struct rusoto_apigateway::DocumentationPart
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
impl Clone for DocumentationPart
[src]
fn clone(&self) -> DocumentationPart
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for DocumentationPart
[src]
impl Default for DocumentationPart
[src]
fn default() -> DocumentationPart
[src]
impl<'de> Deserialize<'de> for DocumentationPart
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl PartialEq<DocumentationPart> for DocumentationPart
[src]
fn eq(&self, other: &DocumentationPart) -> bool
[src]
fn ne(&self, other: &DocumentationPart) -> bool
[src]
impl StructuralPartialEq for DocumentationPart
[src]
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
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> Sealed<T> for T where
T: ?Sized,
T: ?Sized,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,