google_api_service_consumer_management v0.23.0 GoogleApi.ServiceConsumerManagement.V1.Model.Documentation View Source

Documentation provides the information for describing a service.

Example:

<code>documentation:  summary: >    The Google Calendar API gives access    to most calendar features.  pages:  - name: Overview    content: &#40;== include google/foo/overview.md ==&#41;  - name: Tutorial    content: &#40;== include google/foo/tutorial.md ==&#41;    subpages;    - name: Java      content: &#40;== include google/foo/tutorial_java.md ==&#41;  rules:  - selector: google.calendar.Calendar.Get    description: >      ...  - selector: google.calendar.Calendar.Put    description: >      ...</code></pre>Documentation is provided in markdown syntax. In addition tostandard markdown features, definition lists, tables and fencedcode blocks are supported. Section headers can be provided and areinterpreted relative to the section nesting of the context wherea documentation fragment is embedded.Documentation from the IDL is merged with documentation definedvia the config at normalization time, where documentation providedby config rules overrides IDL provided.A number of constructs specific to the API platform are supportedin documentation text.In order to reference a proto element, the followingnotation can be used:<pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre>To override the display text used for the link, this can be used:<pre><code>&#91;display text]&#91;fully.qualified.proto.name]</code></pre>Text can be excluded from doc using the following notation:<pre><code>&#40;-- internal comment --&#41;</code></pre>A few directives are available in documentation. Note thatdirectives must appear on a single line to be properlyidentified. The `include` directive includes a markdown file froman external source:<pre><code>&#40;== include path/to/file ==&#41;</code></pre>The `resource_for` directive marks a message to be the resource ofa collection in REST view. If it is not specified, tools attemptto infer the resource from the operations in a collection:<pre><code>&#40;== resource_for v1.shelves.books ==&#41;</code></pre>The directive `suppress_warning` does not directly affect documentationand 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:    <pre><code>documentation:      summary: ...      overview: &#40;== include overview.md ==&#41;    </code></pre>    This is a shortcut for the following declaration (using pages style):    <pre><code>documentation:      summary: ...      pages:      - name: Overview        content: &#40;== include overview.md ==&#41;    </code></pre>    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

Specs

t() :: %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

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.