pub struct RestDescription {
Show 30 fields pub protocol: Option<String>, pub methods: Option<HashMap<String, RestMethod>>, pub labels: Option<Vec<String>>, pub kind: Option<String>, pub canonical_name: Option<String>, pub documentation_link: Option<String>, pub owner_name: Option<String>, pub package_path: Option<String>, pub batch_path: Option<String>, pub id: Option<String>, pub features: Option<Vec<String>>, pub owner_domain: Option<String>, pub root_url: Option<String>, pub name: Option<String>, pub parameters: Option<HashMap<String, JsonSchema>>, pub icons: Option<RestDescriptionIcons>, pub version_module: Option<bool>, pub description: Option<String>, pub title: Option<String>, pub exponential_backoff_default: Option<bool>, pub base_url: Option<String>, pub etag: Option<String>, pub version: Option<String>, pub service_path: Option<String>, pub discovery_version: Option<String>, pub schemas: Option<HashMap<String, JsonSchema>>, pub auth: Option<RestDescriptionAuth>, pub base_path: Option<String>, pub resources: Option<HashMap<String, RestResource>>, pub revision: Option<String>,
}
Expand description

There is no detailed description.

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

Fields§

§protocol: Option<String>

The protocol described by this document.

§methods: Option<HashMap<String, RestMethod>>

API-level methods for this API.

§labels: Option<Vec<String>>

Labels for the status of this API, such as labs or deprecated.

§kind: Option<String>

The kind for this response.

§canonical_name: Option<String>

Indicates how the API name should be capitalized and split into various parts. Useful for generating pretty class names.

§documentation_link: Option<String>

A link to human readable documentation for the API.

§owner_name: Option<String>

The name of the owner of this API. See ownerDomain.

§package_path: Option<String>

The package of the owner of this API. See ownerDomain.

§batch_path: Option<String>

The path for REST batch requests.

§id: Option<String>

The ID of this API.

§features: Option<Vec<String>>

A list of supported features for this API.

§owner_domain: Option<String>

The domain of the owner of this API. Together with the ownerName and a packagePath values, this can be used to generate a library for this API which would have a unique fully qualified name.

§root_url: Option<String>

The root URL under which all API services live.

§name: Option<String>

The name of this API.

§parameters: Option<HashMap<String, JsonSchema>>

Common parameters that apply across all apis.

§icons: Option<RestDescriptionIcons>

Links to 16x16 and 32x32 icons representing the API.

§version_module: Option<bool>

no description provided

§description: Option<String>

The description of this API.

§title: Option<String>

The title of this API.

§exponential_backoff_default: Option<bool>

Enable exponential backoff for suitable methods in the generated clients.

§base_url: Option<String>

[DEPRECATED] The base URL for REST requests.

§etag: Option<String>

The ETag for this response.

§version: Option<String>

The version of this API.

§service_path: Option<String>

The base path for all REST requests.

§discovery_version: Option<String>

Indicate the version of the Discovery API used to generate this doc.

§schemas: Option<HashMap<String, JsonSchema>>

The schemas for this API.

§auth: Option<RestDescriptionAuth>

Authentication information.

§base_path: Option<String>

[DEPRECATED] The base path for REST requests.

§resources: Option<HashMap<String, RestResource>>

The resources in this API.

§revision: Option<String>

The version of this API.

Trait Implementations§

source§

impl Clone for RestDescription

source§

fn clone(&self) -> RestDescription

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for RestDescription

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for RestDescription

source§

fn default() -> RestDescription

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

impl<'de> Deserialize<'de> for RestDescription

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Serialize for RestDescription

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl ResponseResult for RestDescription

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> Typeable for Twhere T: Any,

§

fn get_type(&self) -> TypeId

Get the TypeId of this object.
source§

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,