Documentation provides the information for describing a service.
Example: <pre><code>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: > ... </code></pre> 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: <pre><code>[fully.qualified.proto.name][]</code></pre> To override the display text used for the link, this can be used: <pre><code>[display text][fully.qualified.proto.name]</code></pre> Text can be excluded from doc using the following notation: <pre><code>(-- internal comment --)</code></pre>
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: <pre><code>(== include path/to/file ==)</code></pre> 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: <pre><code>(== resource_for v1.shelves.books ==)</code></pre> The directive suppress_warning does not directly affect documentation and is documented together with service config validation.
Value parameters
- documentationRootUrl
-
The URL to the root of documentation.
- overview
-
Declares a single overview page. For example: <pre><code>documentation: summary: ... overview: (== include overview.md ==) </code></pre> This is a shortcut for the following declaration (using pages style): <pre><code>documentation: summary: ... pages:
name: Overview content: (== include overview.md ==) </code></pre> Note: you cannot specify both
overviewfield andpagesfield.
- pages
-
The top level pages for the documentation set.
- rules
-
A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.
- serviceRootUrl
-
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.
- summary
-
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.
Attributes
- Companion
- object
- Source
- Documentation.scala
- Graph
-
- Supertypes
-
trait Updatable[Documentation]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any