Struct Documentation

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,
}

Documentation provides the information for describing a service.

Example:

documentation:
   summary: >
     The Google Calendar API gives access
     to most calendar features.
   pages:
   - name: Overview
     content: (== include google/foo/overview.md ==)
   - name: Tutorial
     content: (== include google/foo/tutorial.md ==)
     subpages:
     - name: Java
       content: (== include google/foo/tutorial_java.md ==)
   rules:
   - selector: google.calendar.Calendar.Get
     description: >
       ...
   - selector: google.calendar.Calendar.Put
     description: >
       ...

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:

[fully.qualified.proto.name][]

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

[display text][fully.qualified.proto.name]

Text can be excluded from doc using the following notation:

(-- internal comment --)

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:

(== include path/to/file ==)

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:

(== resource_for v1.shelves.books ==)

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

Fields

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:

documentation:
   summary: ...
   overview: (== include overview.md ==)

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

documentation:
   summary: ...
   pages:
   - name: Overview
     content: (== include overview.md ==)

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

Trait Implementations

impl Clone for Documentation

fn clone(&self) -> Documentation

Returns a copy 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<(), Error>

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 encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

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