Struct Documentation 

#[non_exhaustive]
pub struct Documentation {
    pub summary: String,
    pub pages: Vec<Page>,
    pub rules: Vec<DocumentationRule>,
    pub documentation_root_url: String,
    pub service_root_url: String,
    pub overview: String,
    /* private fields */
}

Documentation provides the information for describing a service.

Example:

Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded.

Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided.

A number of constructs specific to the API platform are supported in documentation text.

In order to reference a proto element, the following notation can be used:

To override the display text used for the link, this can be used:

Text can be excluded from doc using the following notation:

A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The include directive includes a markdown file from an external source:

The resource_for directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection:

The directive suppress_warning does not directly affect documentation and is documented together with service config validation.

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.

summary: String

A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field description.

pages: Vec<Page>

The top level pages for the documentation set.

rules: Vec<DocumentationRule>

A list of documentation rules that apply to individual API elements.

NOTE: All service configuration rules follow “last one wins” order.

documentation_root_url: String

The URL to the root of documentation.

service_root_url: String

Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.

overview: String

Declares a single overview page. For example:

This is a shortcut for the following declaration (using pages style):

Note: you cannot specify both overview field and pages field.

Implementations

impl Documentation

pub fn new() -> Self

pub fn set_summary<T: Into<String>>(self, v: T) -> Self

Sets the value of summary.

pub fn set_pages<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Page>,

Sets the value of pages.

pub fn set_rules<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<DocumentationRule>,

Sets the value of rules.

pub fn set_documentation_root_url<T: Into<String>>(self, v: T) -> Self

Sets the value of documentation_root_url.

pub fn set_service_root_url<T: Into<String>>(self, v: T) -> Self

Sets the value of service_root_url.

pub fn set_overview<T: Into<String>>(self, v: T) -> Self

Sets the value of overview.

Trait Implementations

impl Clone for Documentation

fn clone(&self) -> Documentation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Documentation

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

Formats the value using the given formatter.

impl Default for Documentation

fn default() -> Documentation

Returns the “default value” for a type.

impl Message for Documentation

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Documentation

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

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

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 Documentation