Struct CreateDocumentationPartInput

#[non_exhaustive]
pub struct CreateDocumentationPartInput {
    pub rest_api_id: Option<String>,
    pub location: Option<DocumentationPartLocation>,
    pub properties: Option<String>,
}

Creates a new documentation part of a given API.

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.

rest_api_id: Option<String>

The string identifier of the associated RestApi.

location: Option<DocumentationPartLocation>

The location of the targeted API entity of the to-be-created documentation part.

properties: Option<String>

The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

Implementations

impl CreateDocumentationPartInput

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

The string identifier of the associated RestApi.

pub fn location(&self) -> Option<&DocumentationPartLocation>

The location of the targeted API entity of the to-be-created documentation part.

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

The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

impl CreateDocumentationPartInput

pub fn builder() -> CreateDocumentationPartInputBuilder

Creates a new builder-style object to manufacture CreateDocumentationPartInput.

Trait Implementations

impl Clone for CreateDocumentationPartInput

fn clone(&self) -> CreateDocumentationPartInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateDocumentationPartInput

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

Formats the value using the given formatter.

impl PartialEq for CreateDocumentationPartInput

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

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

const 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 StructuralPartialEq for CreateDocumentationPartInput