google_api_service_consumer_management v0.18.0 GoogleApi.ServiceConsumerManagement.V1.Model.Documentation View Source
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.
## Attributes
* `documentationRootUrl` (*type:* `String.t`, *default:* `nil`) - The URL to the root of documentation.
* `overview` (*type:* `String.t`, *default:* `nil`) - 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.
* `pages` (*type:* `list(GoogleApi.ServiceConsumerManagement.V1.Model.Page.t)`, *default:* `nil`) - The top level pages for the documentation set.
* `rules` (*type:* `list(GoogleApi.ServiceConsumerManagement.V1.Model.DocumentationRule.t)`, *default:* `nil`) - A list of documentation rules that apply to individual API elements.
**NOTE:** All service configuration rules follow "last one wins" order.
* `serviceRootUrl` (*type:* `String.t`, *default:* `nil`) - 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` (*type:* `String.t`, *default:* `nil`) - A short summary of what the service does. Can only be provided by
plain text. Link to this section Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Link to this section Types
Link to this type
t()
View Sourcet() :: %GoogleApi.ServiceConsumerManagement.V1.Model.Documentation{ documentationRootUrl: String.t(), overview: String.t(), pages: [GoogleApi.ServiceConsumerManagement.V1.Model.Page.t()], rules: [GoogleApi.ServiceConsumerManagement.V1.Model.DocumentationRule.t()], serviceRootUrl: String.t(), summary: String.t() }
Link to this section Functions
Unwrap a decoded JSON object into its complex fields.