1. class
  2. Google
  3. \
  4. Api
  5. \
  6. Documentation

Documentation

class Documentation extends Message

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

Comments can be made conditional using a visibility label. The below text will be only rendered if the BETA label is available:

(--BETA: comment for BETA users --)

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.

Protobuf type Google\Api\Documentation

Methods

__construct()

No description

string
getSummary()

A short summary of what the service does. Can only be provided by plain text.

setSummary(string $var)

A short summary of what the service does. Can only be provided by plain text.

RepeatedField
getPages()

The top level pages for the documentation set.

setPages(array|RepeatedField $var)

The top level pages for the documentation set.

RepeatedField
getRules()

A list of documentation rules that apply to individual API elements.

setRules(array|RepeatedField $var)

A list of documentation rules that apply to individual API elements.

string
getDocumentationRootUrl()

The URL to the root of documentation.

setDocumentationRootUrl(string $var)

The URL to the root of documentation.

string
getOverview()

Declares a single overview page. For example:

<

pre>documentation: summary: .

setOverview(string $var)

Declares a single overview page. For example:

<

pre>documentation: summary: .

Details

at line 115
__construct()

at line 127
string getSummary()

A short summary of what the service does. Can only be provided by plain text.

Generated from protobuf field string summary = 1;

Return Value

string

at line 139
setSummary(string $var)

A short summary of what the service does. Can only be provided by plain text.

Generated from protobuf field string summary = 1;

Parameters

string $var

at line 151
RepeatedField getPages()

The top level pages for the documentation set.

Generated from protobuf field repeated .google.api.Page pages = 5;

Return Value

RepeatedField

at line 162
setPages(array|RepeatedField $var)

The top level pages for the documentation set.

Generated from protobuf field repeated .google.api.Page pages = 5;

Parameters

array|RepeatedField $var

at line 175
RepeatedField getRules()

A list of documentation rules that apply to individual API elements.

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

Generated from protobuf field repeated .google.api.DocumentationRule rules = 3;

Return Value

RepeatedField

at line 187
setRules(array|RepeatedField $var)

A list of documentation rules that apply to individual API elements.

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

Generated from protobuf field repeated .google.api.DocumentationRule rules = 3;

Parameters

array|RepeatedField $var

at line 199
string getDocumentationRootUrl()

The URL to the root of documentation.

Generated from protobuf field string documentation_root_url = 4;

Return Value

string

at line 210
setDocumentationRootUrl(string $var)

The URL to the root of documentation.

Generated from protobuf field string documentation_root_url = 4;

Parameters

string $var

at line 234
string getOverview()

Declares a single overview page. For example:

<

pre>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.

Generated from protobuf field string overview = 2;

Return Value

string

at line 257
setOverview(string $var)

Declares a single overview page. For example:

<

pre>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.

Generated from protobuf field string overview = 2;

Parameters

string $var