logo
pub struct GetDocumentationPartsRequest {
    pub limit: Option<i64>,
    pub location_status: Option<String>,
    pub name_query: Option<String>,
    pub path: Option<String>,
    pub position: Option<String>,
    pub rest_api_id: String,
    pub type_: Option<String>,
}
Expand description

Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).

Fields

limit: Option<i64>

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

location_status: Option<String>

The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.

name_query: Option<String>

The name of API entities of the to-be-retrieved documentation parts.

path: Option<String>

The path of API entities of the to-be-retrieved documentation parts.

position: Option<String>

The current pagination position in the paged result set.

rest_api_id: String

[Required] The string identifier of the associated RestApi.

type_: Option<String>

The type of API entities of the to-be-retrieved documentation parts.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

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

This method tests for !=.

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more