Class: Google::Apis::ServiceusageV1beta1::Documentation
- Inherits:
-
Object
- Object
- Google::Apis::ServiceusageV1beta1::Documentation
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/serviceusage_v1beta1/classes.rb,
generated/google/apis/serviceusage_v1beta1/representations.rb,
generated/google/apis/serviceusage_v1beta1/representations.rb
Overview
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.
Instance Attribute Summary collapse
-
#documentation_root_url ⇒ String
The URL to the root of documentation.
-
#overview ⇒ String
Declares a single overview page.
-
#pages ⇒ Array<Google::Apis::ServiceusageV1beta1::Page>
The top level pages for the documentation set.
-
#rules ⇒ Array<Google::Apis::ServiceusageV1beta1::DocumentationRule>
A list of documentation rules that apply to individual API elements.
-
#service_root_url ⇒ String
Specifies the service root url if the default one (the service name from the yaml file) is not suitable.
-
#summary ⇒ String
A short summary of what the service does.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Documentation
constructor
A new instance of Documentation.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Documentation
Returns a new instance of Documentation.
943 944 945 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 943 def initialize(**args) update!(**args) end |
Instance Attribute Details
#documentation_root_url ⇒ String
The URL to the root of documentation.
Corresponds to the JSON property documentationRootUrl
899 900 901 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 899 def documentation_root_url @documentation_root_url end |
#overview ⇒ 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.
Corresponds to the JSON property overview
916 917 918 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 916 def overview @overview end |
#pages ⇒ Array<Google::Apis::ServiceusageV1beta1::Page>
The top level pages for the documentation set.
Corresponds to the JSON property pages
921 922 923 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 921 def pages @pages end |
#rules ⇒ Array<Google::Apis::ServiceusageV1beta1::DocumentationRule>
A list of documentation rules that apply to individual API elements.
NOTE: All service configuration rules follow "last one wins" order.
Corresponds to the JSON property rules
927 928 929 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 927 def rules @rules end |
#service_root_url ⇒ 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.
Corresponds to the JSON property serviceRootUrl
935 936 937 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 935 def service_root_url @service_root_url end |
#summary ⇒ String
A short summary of what the service does. Can only be provided by
plain text.
Corresponds to the JSON property summary
941 942 943 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 941 def summary @summary end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
948 949 950 951 952 953 954 955 |
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 948 def update!(**args) @documentation_root_url = args[:documentation_root_url] if args.key?(:documentation_root_url) @overview = args[:overview] if args.key?(:overview) @pages = args[:pages] if args.key?(:pages) @rules = args[:rules] if args.key?(:rules) @service_root_url = args[:service_root_url] if args.key?(:service_root_url) @summary = args[:summary] if args.key?(:summary) end |