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
*/
class Documentation extends \Google\Protobuf\Internal\Message
{
/**
* A short summary of what the service does. Can only be provided by
* plain text.
*
* Generated from protobuf field string summary = 1;
*/
private $summary = '';
/**
* The top level pages for the documentation set.
*
* Generated from protobuf field repeated .google.api.Page pages = 5;
*/
private $pages;
/**
* 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 $rules;
/**
* The URL to the root of documentation.
*
* Generated from protobuf field string documentation_root_url = 4;
*/
private $documentation_root_url = '';
/**
* 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 $overview = '';
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type string $summary
* A short summary of what the service does. Can only be provided by
* plain text.
* @type \Google\Api\Page[]|\Google\Protobuf\Internal\RepeatedField $pages
* The top level pages for the documentation set.
* @type \Google\Api\DocumentationRule[]|\Google\Protobuf\Internal\RepeatedField $rules
* A list of documentation rules that apply to individual API elements.
* **NOTE:** All service configuration rules follow "last one wins" order.
* @type string $documentation_root_url
* The URL to the root of documentation.
* @type string $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.
* }
*/
public function __construct($data = NULL) {
\GPBMetadata\Google\Api\Documentation::initOnce();
parent::__construct($data);
}
/**
* 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 function getSummary()
{
return $this->summary;
}
/**
* A short summary of what the service does. Can only be provided by
* plain text.
*
* Generated from protobuf field string summary = 1;
* @param string $var
* @return $this
*/
public function setSummary($var)
{
GPBUtil::checkString($var, True);
$this->summary = $var;
return $this;
}
/**
* The top level pages for the documentation set.
*
* Generated from protobuf field repeated .google.api.Page pages = 5;
* @return \Google\Protobuf\Internal\RepeatedField
*/
public function getPages()
{
return $this->pages;
}
/**
* The top level pages for the documentation set.
*
* Generated from protobuf field repeated .google.api.Page pages = 5;
* @param \Google\Api\Page[]|\Google\Protobuf\Internal\RepeatedField $var
* @return $this
*/
public function setPages($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Api\Page::class);
$this->pages = $arr;
return $this;
}
/**
* 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 \Google\Protobuf\Internal\RepeatedField
*/
public function getRules()
{
return $this->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;
* @param \Google\Api\DocumentationRule[]|\Google\Protobuf\Internal\RepeatedField $var
* @return $this
*/
public function setRules($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Api\DocumentationRule::class);
$this->rules = $arr;
return $this;
}
/**
* The URL to the root of documentation.
*
* Generated from protobuf field string documentation_root_url = 4;
* @return string
*/
public function getDocumentationRootUrl()
{
return $this->documentation_root_url;
}
/**
* The URL to the root of documentation.
*
* Generated from protobuf field string documentation_root_url = 4;
* @param string $var
* @return $this
*/
public function setDocumentationRootUrl($var)
{
GPBUtil::checkString($var, True);
$this->documentation_root_url = $var;
return $this;
}
/**
* 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 function getOverview()
{
return $this->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;
* @param string $var
* @return $this
*/
public function setOverview($var)
{
GPBUtil::checkString($var, True);
$this->overview = $var;
return $this;
}
}