| // Code generated by protoc-gen-go. |
| // source: google.golang.org/genproto/googleapis/api/serviceconfig/documentation.proto |
| // DO NOT EDIT! |
| |
| package google_api |
| |
| import proto "github.com/golang/protobuf/proto" |
| import fmt "fmt" |
| import math "math" |
| |
| // Reference imports to suppress errors if they are not otherwise used. |
| var _ = proto.Marshal |
| var _ = fmt.Errorf |
| var _ = math.Inf |
| |
| // `Documentation` provides the information for describing a service. |
| // |
| // Example: |
| // <pre><code>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: > |
| // ... |
| // </code></pre> |
| // 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: |
| // <pre><code>[fully.qualified.proto.name][]</code></pre> |
| // To override the display text used for the link, this can be used: |
| // <pre><code>[display text][fully.qualified.proto.name]</code></pre> |
| // Text can be excluded from doc using the following notation: |
| // <pre><code>(-- internal comment --)</code></pre> |
| // Comments can be made conditional using a visibility label. The below |
| // text will be only rendered if the `BETA` label is available: |
| // <pre><code>(--BETA: comment for BETA users --)</code></pre> |
| // 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: |
| // <pre><code>(== include path/to/file ==)</code></pre> |
| // 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: |
| // <pre><code>(== resource_for v1.shelves.books ==)</code></pre> |
| // The directive `suppress_warning` does not directly affect documentation |
| // and is documented together with service config validation. |
| type Documentation struct { |
| // A short summary of what the service does. Can only be provided by |
| // plain text. |
| Summary string `protobuf:"bytes,1,opt,name=summary" json:"summary,omitempty"` |
| // The top level pages for the documentation set. |
| Pages []*Page `protobuf:"bytes,5,rep,name=pages" json:"pages,omitempty"` |
| // A list of documentation rules that apply to individual API elements. |
| // |
| // **NOTE:** All service configuration rules follow "last one wins" order. |
| Rules []*DocumentationRule `protobuf:"bytes,3,rep,name=rules" json:"rules,omitempty"` |
| // The URL to the root of documentation. |
| DocumentationRootUrl string `protobuf:"bytes,4,opt,name=documentation_root_url,json=documentationRootUrl" json:"documentation_root_url,omitempty"` |
| // Declares a single overview page. For example: |
| // <pre><code>documentation: |
| // summary: ... |
| // overview: (== include overview.md ==) |
| // </code></pre> |
| // This is a shortcut for the following declaration (using pages style): |
| // <pre><code>documentation: |
| // summary: ... |
| // pages: |
| // - name: Overview |
| // content: (== include overview.md ==) |
| // </code></pre> |
| // Note: you cannot specify both `overview` field and `pages` field. |
| Overview string `protobuf:"bytes,2,opt,name=overview" json:"overview,omitempty"` |
| } |
| |
| func (m *Documentation) Reset() { *m = Documentation{} } |
| func (m *Documentation) String() string { return proto.CompactTextString(m) } |
| func (*Documentation) ProtoMessage() {} |
| func (*Documentation) Descriptor() ([]byte, []int) { return fileDescriptor7, []int{0} } |
| |
| func (m *Documentation) GetPages() []*Page { |
| if m != nil { |
| return m.Pages |
| } |
| return nil |
| } |
| |
| func (m *Documentation) GetRules() []*DocumentationRule { |
| if m != nil { |
| return m.Rules |
| } |
| return nil |
| } |
| |
| // A documentation rule provides information about individual API elements. |
| type DocumentationRule struct { |
| // The selector is a comma-separated list of patterns. Each pattern is a |
| // qualified name of the element which may end in "*", indicating a wildcard. |
| // Wildcards are only allowed at the end and for a whole component of the |
| // qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". To |
| // specify a default for all applicable elements, the whole pattern "*" |
| // is used. |
| Selector string `protobuf:"bytes,1,opt,name=selector" json:"selector,omitempty"` |
| // Description of the selected API(s). |
| Description string `protobuf:"bytes,2,opt,name=description" json:"description,omitempty"` |
| // Deprecation description of the selected element(s). It can be provided if an |
| // element is marked as `deprecated`. |
| DeprecationDescription string `protobuf:"bytes,3,opt,name=deprecation_description,json=deprecationDescription" json:"deprecation_description,omitempty"` |
| } |
| |
| func (m *DocumentationRule) Reset() { *m = DocumentationRule{} } |
| func (m *DocumentationRule) String() string { return proto.CompactTextString(m) } |
| func (*DocumentationRule) ProtoMessage() {} |
| func (*DocumentationRule) Descriptor() ([]byte, []int) { return fileDescriptor7, []int{1} } |
| |
| // Represents a documentation page. A page can contain subpages to represent |
| // nested documentation set structure. |
| type Page struct { |
| // The name of the page. It will be used as an identity of the page to |
| // generate URI of the page, text of the link to this page in navigation, |
| // etc. The full page name (start from the root page name to this page |
| // concatenated with `.`) can be used as reference to the page in your |
| // documentation. For example: |
| // <pre><code>pages: |
| // - name: Tutorial |
| // content: (== include tutorial.md ==) |
| // subpages: |
| // - name: Java |
| // content: (== include tutorial_java.md ==) |
| // </code></pre> |
| // You can reference `Java` page using Markdown reference link syntax: |
| // `[Java][Tutorial.Java]`. |
| Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` |
| // The Markdown content of the page. You can use <code>(== include {path} ==)</code> |
| // to include content from a Markdown file. |
| Content string `protobuf:"bytes,2,opt,name=content" json:"content,omitempty"` |
| // Subpages of this page. The order of subpages specified here will be |
| // honored in the generated docset. |
| Subpages []*Page `protobuf:"bytes,3,rep,name=subpages" json:"subpages,omitempty"` |
| } |
| |
| func (m *Page) Reset() { *m = Page{} } |
| func (m *Page) String() string { return proto.CompactTextString(m) } |
| func (*Page) ProtoMessage() {} |
| func (*Page) Descriptor() ([]byte, []int) { return fileDescriptor7, []int{2} } |
| |
| func (m *Page) GetSubpages() []*Page { |
| if m != nil { |
| return m.Subpages |
| } |
| return nil |
| } |
| |
| func init() { |
| proto.RegisterType((*Documentation)(nil), "google.api.Documentation") |
| proto.RegisterType((*DocumentationRule)(nil), "google.api.DocumentationRule") |
| proto.RegisterType((*Page)(nil), "google.api.Page") |
| } |
| |
| func init() { |
| proto.RegisterFile("google.golang.org/genproto/googleapis/api/serviceconfig/documentation.proto", fileDescriptor7) |
| } |
| |
| var fileDescriptor7 = []byte{ |
| // 342 bytes of a gzipped FileDescriptorProto |
| 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x09, 0x6e, 0x88, 0x02, 0xff, 0x74, 0x92, 0xcf, 0x4a, 0xc3, 0x40, |
| 0x10, 0xc6, 0x49, 0x93, 0xfa, 0x67, 0x8a, 0xa2, 0x8b, 0xd4, 0x20, 0x08, 0xa5, 0x07, 0xe9, 0x41, |
| 0x13, 0xb0, 0x82, 0x67, 0x4b, 0x41, 0xc4, 0x4b, 0x08, 0x78, 0x2e, 0xe9, 0x76, 0x5c, 0x02, 0x49, |
| 0x26, 0x6c, 0x92, 0x8a, 0xaf, 0xe0, 0x63, 0xf8, 0x54, 0x3e, 0x8e, 0x9b, 0x4d, 0x9a, 0x6e, 0x10, |
| 0x2f, 0x21, 0x93, 0xef, 0xb7, 0x33, 0xdf, 0x7c, 0x1b, 0x78, 0x15, 0x44, 0x22, 0x41, 0x4f, 0x50, |
| 0x12, 0x65, 0xc2, 0x23, 0x29, 0x7c, 0x81, 0x59, 0x2e, 0xa9, 0x24, 0xbf, 0x91, 0xa2, 0x3c, 0x2e, |
| 0x7c, 0xf5, 0xf0, 0x0b, 0x94, 0xdb, 0x98, 0x23, 0xa7, 0xec, 0x3d, 0x16, 0xfe, 0x86, 0x78, 0x95, |
| 0x62, 0x56, 0x46, 0x65, 0x4c, 0x99, 0xa7, 0x0f, 0x30, 0x68, 0x9b, 0x29, 0x7a, 0xfa, 0x63, 0xc1, |
| 0xc9, 0xd2, 0x64, 0x98, 0x0b, 0x87, 0x45, 0x95, 0xa6, 0x91, 0xfc, 0x74, 0xad, 0x89, 0x35, 0x3b, |
| 0x0e, 0x77, 0x25, 0xbb, 0x81, 0x61, 0x1e, 0x09, 0x2c, 0xdc, 0xe1, 0xc4, 0x9e, 0x8d, 0xee, 0xcf, |
| 0xbc, 0x7d, 0x1f, 0x2f, 0x50, 0x42, 0xd8, 0xc8, 0x6c, 0x0e, 0x43, 0x59, 0x25, 0x8a, 0xb3, 0x35, |
| 0x77, 0x6d, 0x72, 0xbd, 0x59, 0xa1, 0xa2, 0xc2, 0x86, 0x65, 0x0f, 0x30, 0xee, 0x79, 0x5d, 0x49, |
| 0xa2, 0x72, 0x55, 0xc9, 0xc4, 0x75, 0xb4, 0x8b, 0x8b, 0x9e, 0x1a, 0x2a, 0xf1, 0x4d, 0x26, 0xec, |
| 0x0a, 0x8e, 0x68, 0x5b, 0x2f, 0x8c, 0x1f, 0xee, 0x40, 0x73, 0x5d, 0x3d, 0xfd, 0xb2, 0xe0, 0xfc, |
| 0xcf, 0xb8, 0xfa, 0x44, 0x81, 0x09, 0xf2, 0x92, 0x64, 0xbb, 0x5f, 0x57, 0xb3, 0x09, 0x8c, 0x36, |
| 0x58, 0x70, 0x19, 0xe7, 0x35, 0xde, 0x36, 0x34, 0x3f, 0xb1, 0x47, 0xb8, 0xdc, 0x60, 0x2e, 0x91, |
| 0x37, 0x1e, 0x4d, 0xda, 0xd6, 0xf4, 0xd8, 0x90, 0x97, 0x7b, 0x75, 0xba, 0x06, 0xa7, 0x8e, 0x88, |
| 0x31, 0x70, 0xb2, 0x28, 0xc5, 0x76, 0xb4, 0x7e, 0xaf, 0x13, 0x57, 0xb7, 0x55, 0x2a, 0x9b, 0xed, |
| 0xc8, 0x5d, 0xc9, 0x6e, 0x95, 0xd9, 0x6a, 0xdd, 0x84, 0x6e, 0xff, 0x13, 0x7a, 0x47, 0x2c, 0xee, |
| 0xe0, 0x94, 0x53, 0x6a, 0x00, 0x0b, 0xd6, 0xdb, 0x3f, 0xa8, 0x6f, 0x3f, 0xb0, 0xbe, 0x07, 0xce, |
| 0xf3, 0x53, 0xf0, 0xb2, 0x3e, 0xd0, 0x7f, 0xc3, 0xfc, 0x37, 0x00, 0x00, 0xff, 0xff, 0x62, 0xd9, |
| 0x85, 0x51, 0x5c, 0x02, 0x00, 0x00, |
| } |