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
sourceimpl Clone for GetDocumentationPartsRequest
impl Clone for GetDocumentationPartsRequest
sourcefn clone(&self) -> GetDocumentationPartsRequest
fn clone(&self) -> GetDocumentationPartsRequest
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 GetDocumentationPartsRequest
impl Debug for GetDocumentationPartsRequest
sourceimpl Default for GetDocumentationPartsRequest
impl Default for GetDocumentationPartsRequest
sourcefn default() -> GetDocumentationPartsRequest
fn default() -> GetDocumentationPartsRequest
Returns the “default value” for a type. Read more
sourceimpl PartialEq<GetDocumentationPartsRequest> for GetDocumentationPartsRequest
impl PartialEq<GetDocumentationPartsRequest> for GetDocumentationPartsRequest
sourcefn eq(&self, other: &GetDocumentationPartsRequest) -> bool
fn eq(&self, other: &GetDocumentationPartsRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &GetDocumentationPartsRequest) -> bool
fn ne(&self, other: &GetDocumentationPartsRequest) -> bool
This method tests for !=
.
impl StructuralPartialEq for GetDocumentationPartsRequest
Auto Trait Implementations
impl RefUnwindSafe for GetDocumentationPartsRequest
impl Send for GetDocumentationPartsRequest
impl Sync for GetDocumentationPartsRequest
impl Unpin for GetDocumentationPartsRequest
impl UnwindSafe for GetDocumentationPartsRequest
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