# Service Management V1 API - Class Google::Api::Documentation (v1.8.0)

1.8.0 (latest) 1.7.1 1.6.0 1.5.1 1.4.0 1.3.0 1.2.1 1.1.0 1.0.2 0.11.0 0.10.2 0.9.0 0.8.0 0.7.0 0.6.1 0.5.0 0.4.1 0.3.10 Reference documentation and code samples for the Service Management V1 API class Google::Api::Documentation.

`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 ==)

<br />

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

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #documentation_root_url

    def documentation_root_url() -> ::String

**Returns**

- (::String) --- The URL to the root of documentation.

### #documentation_root_url=

    def documentation_root_url=(value) -> ::String

**Parameter**

- **value** (::String) --- The URL to the root of documentation.
**Returns**

- (::String) --- The URL to the root of documentation.

### #overview

    def overview() -> ::String

**Returns**

- (::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.

### #overview=

    def overview=(value) -> ::String

**Parameter**

- **value** (::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.
**Returns**

- (::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.

### #pages

    def pages() -> ::Array<::Google::Api::Page>

**Returns**

- (::Array\<[::Google::Api::Page](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-service_management-v1/latest/Google-Api-Page)\>) --- The top level pages for the documentation set.

### #pages=

    def pages=(value) -> ::Array<::Google::Api::Page>

**Parameter**

- **value** (::Array\<[::Google::Api::Page](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-service_management-v1/latest/Google-Api-Page)\>) --- The top level pages for the documentation set.
**Returns**

- (::Array\<[::Google::Api::Page](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-service_management-v1/latest/Google-Api-Page)\>) --- The top level pages for the documentation set.

### #rules

    def rules() -> ::Array<::Google::Api::DocumentationRule>

**Returns**

- (::Array\<[::Google::Api::DocumentationRule](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-service_management-v1/latest/Google-Api-DocumentationRule)\>) --- A list of documentation rules that apply to individual API elements.


  **NOTE:** All service configuration rules follow "last one wins" order.

### #rules=

    def rules=(value) -> ::Array<::Google::Api::DocumentationRule>

**Parameter**

- **value** (::Array\<[::Google::Api::DocumentationRule](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-service_management-v1/latest/Google-Api-DocumentationRule)\>) --- A list of documentation rules that apply to individual API elements.


  **NOTE:** All service configuration rules follow "last one wins" order.
**Returns**

- (::Array\<[::Google::Api::DocumentationRule](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-service_management-v1/latest/Google-Api-DocumentationRule)\>) --- A list of documentation rules that apply to individual API elements.


  **NOTE:** All service configuration rules follow "last one wins" order.

### #service_root_url

    def service_root_url() -> ::String

**Returns**

- (::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.

### #service_root_url=

    def service_root_url=(value) -> ::String

**Parameter**

- **value** (::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.
**Returns**

- (::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.

### #summary

    def summary() -> ::String

**Returns**

- (::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`.

### #summary=

    def summary=(value) -> ::String

**Parameter**

- **value** (::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`.
**Returns**

- (::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`.