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.

Generated from protobuf message google.api.Documentation

CloneableInstantiable
ExtendsGoogle\Protobuf\Internal\Message
Methods
public __construct( $data = NULL)
 

Constructor.

    public Google\Protobuf\Internal\Message::byteSize()
     
    • ignore
    public Google\Protobuf\Internal\Message::clear()
     

    Clear all containing fields.

    • return
    public Google\Protobuf\Internal\Message::discardUnknownFields()
     

    Clear all unknown fields previously parsed.

    • return
    public getDocumentationRootUrl()
     

    The URL to the root of documentation.

    Generated from protobuf field string documentation_root_url = 4;

    • return string
    public getOverview()
     

    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.

    Generated from protobuf field string overview = 2;

    • return string
    public getPages()
     

    The top level pages for the documentation set.

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

    public 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;

    public getSummary()
     

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

    Generated from protobuf field string summary = 1;

    • return string
    public Google\Protobuf\Internal\Message::jsonByteSize()
     
    • ignore
    public Google\Protobuf\Internal\Message::mergeFrom( $msg)
     

    Merges the contents of the specified message into current message.

    This method merges the contents of the specified message into the
    current message. Singular fields that are set in the specified message
    overwrite the corresponding fields in the current message. Repeated
    fields are appended. Map fields key-value pairs are overwritten.
    Singular/Oneof sub-messages are recursively merged. All overwritten
    sub-messages are deep-copied.

    • return
    public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)
     

    Parses a json string to protobuf message.

    This function takes a string in the json wire format, matching the
    encoding output by serializeToJsonString().
    See mergeFrom() for merging behavior, if the field is already set in the
    specified message.

    • return
    • throws Exception Invalid data.
    public Google\Protobuf\Internal\Message::mergeFromString( $data)
     

    Parses a protocol buffer contained in a string.

    This function takes a string in the (non-human-readable) binary wire
    format, matching the encoding output by serializeToString().
    See mergeFrom() for merging behavior, if the field is already set in the
    specified message.

    • return
    • throws Exception Invalid data.
    public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)
     
    • ignore
    public Google\Protobuf\Internal\Message::parseFromStream( $input)
     
    • ignore
    public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)
     
    • ignore
    public Google\Protobuf\Internal\Message::serializeToJsonString()
     

    Serialize the message to json string.

    • return string Serialized json protobuf data.
    public Google\Protobuf\Internal\Message::serializeToStream( $output)
     
    • ignore
    public Google\Protobuf\Internal\Message::serializeToString()
     

    Serialize the message to string.

    • return string Serialized binary protobuf data.
    public setDocumentationRootUrl( $var)
     

    The URL to the root of documentation.

    Generated from protobuf field string documentation_root_url = 4;

    • return $this
    public setOverview( $var)
     

    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.

    Generated from protobuf field string overview = 2;

    • return $this
    public setPages( $var)
     

    The top level pages for the documentation set.

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

    • return $this
    public setRules( $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;

    • return $this
    public setSummary( $var)
     

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

    Generated from protobuf field string summary = 1;

    • return $this
    Methods
    protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)
     

    Populates the message from a user-supplied PHP array. Array keys
    correspond to Message properties and nested message properties.

    Example:

    $message->mergeFromArray([
        'name' => 'This is a message name',
        'interval' => [
             'startTime' => time() - 60,
             'endTime' => time(),
        ]
    ]);
    

    This method will trigger an error if it is passed data that cannot
    be converted to the correct type. For example, a StringValue field
    must receive data that is either a string or a StringValue object.

    • return
    protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)
    protected Google\Protobuf\Internal\Message::readOneof( $number)
    protected Google\Protobuf\Internal\Message::readWrapperValue( $member)
    protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)
    protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)
    protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)
    Properties
    private $documentation_root_url
     

    The URL to the root of documentation.

    Generated from protobuf field string documentation_root_url = 4;

    private $overview
     

    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.

    Generated from protobuf field string overview = 2;

    private $pages
     

    The top level pages for the documentation set.

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

    private $rules
     

    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;

    private $summary
     

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

    Generated from protobuf field string summary = 1;

    Methods
    private Google\Protobuf\Internal\Message::appendHelper( $field, $append_value)
    private Google\Protobuf\Internal\Message::convertJsonValueToProtoValue( $value, $field, $ignore_unknown, $is_map_key = false)
    private Google\Protobuf\Internal\Message::defaultValue( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::existField( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldByteSize( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyByteSize( $field, $value)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyJsonByteSize( $field, $value)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldJsonByteSize( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::initWithDescriptor(Google\Protobuf\Internal\Descriptor $desc)
     
    • ignore
    private Google\Protobuf\Internal\Message::initWithGeneratedPool()
     
    • ignore
    private Google\Protobuf\Internal\Message::kvUpdateHelper( $field, $update_key, $update_value)
    private Google\Protobuf\Internal\Message::mergeFromArrayJsonImpl( $array, $ignore_unknown)
    private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
     

    Tries to normalize the elements in $value into a provided protobuf
    wrapper type $class. If $value is any type other than array, we do
    not do any conversion, and instead rely on the existing protobuf
    type checking. If $value is an array, we process each element and
    try to convert it to an instance of $class.

      private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
       

      Tries to normalize $value into a provided protobuf wrapper type $class.

      If $value is any type other than an object, we attempt to construct an
      instance of $class and assign $value to it using the setValue method
      shared by all wrapper types.

      This method will raise an error if it receives a type that cannot be
      assigned to the wrapper type via setValue.

        private Google\Protobuf\Internal\Message::parseFieldFromStream( $tag, $input, $field)
         
        • ignore
        private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
         
        • ignore
        private Google\Protobuf\Internal\Message::repeatedFieldDataOnlyByteSize( $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToJsonStream( $output, $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToStream( $output, $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeMapFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeRepeatedFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeSingularFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::skipField( $input, $tag)
         
        • ignore
        Methods
        private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
         

        Tries to normalize the elements in $value into a provided protobuf
        wrapper type $class. If $value is any type other than array, we do
        not do any conversion, and instead rely on the existing protobuf
        type checking. If $value is an array, we process each element and
        try to convert it to an instance of $class.

          private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
           

          Tries to normalize $value into a provided protobuf wrapper type $class.

          If $value is any type other than an object, we attempt to construct an
          instance of $class and assign $value to it using the setValue method
          shared by all wrapper types.

          This method will raise an error if it receives a type that cannot be
          assigned to the wrapper type via setValue.

            private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
             
            • ignore
            © 2020 Bruce Wells
            Search Namespaces \ Classes
            ConfigurationNumbers (0-9.) only