vendor/google.golang.org/genproto/googleapis/api/serviceconfig/documentation.pb.go

   1 // Code generated by protoc-gen-go. DO NOT EDIT.
   2 // source: google/api/documentation.proto
   3
   4 package serviceconfig
   5
   6 import proto "github.com/golang/protobuf/proto"
   7 import fmt "fmt"
   8 import math "math"
   9
  10 // Reference imports to suppress errors if they are not otherwise used.
  11 var _ = proto.Marshal
  12 var _ = fmt.Errorf
  13 var _ = math.Inf
  14
  15 // `Documentation` provides the information for describing a service.
  16 //
  17 // Example:
  18 // <pre><code>documentation:
  19 //   summary: >
  20 //     The Google Calendar API gives access
  21 //     to most calendar features.
  22 //   pages:
  23 //   - name: Overview
  24 //     content: &#40;== include google/foo/overview.md ==&#41;
  25 //   - name: Tutorial
  26 //     content: &#40;== include google/foo/tutorial.md ==&#41;
  27 //     subpages;
  28 //     - name: Java
  29 //       content: &#40;== include google/foo/tutorial_java.md ==&#41;
  30 //   rules:
  31 //   - selector: google.calendar.Calendar.Get
  32 //     description: >
  33 //       ...
  34 //   - selector: google.calendar.Calendar.Put
  35 //     description: >
  36 //       ...
  37 // </code></pre>
  38 // Documentation is provided in markdown syntax. In addition to
  39 // standard markdown features, definition lists, tables and fenced
  40 // code blocks are supported. Section headers can be provided and are
  41 // interpreted relative to the section nesting of the context where
  42 // a documentation fragment is embedded.
  43 //
  44 // Documentation from the IDL is merged with documentation defined
  45 // via the config at normalization time, where documentation provided
  46 // by config rules overrides IDL provided.
  47 //
  48 // A number of constructs specific to the API platform are supported
  49 // in documentation text.
  50 //
  51 // In order to reference a proto element, the following
  52 // notation can be used:
  53 // <pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre>
  54 // To override the display text used for the link, this can be used:
  55 // <pre><code>&#91;display text]&#91;fully.qualified.proto.name]</code></pre>
  56 // Text can be excluded from doc using the following notation:
  57 // <pre><code>&#40;-- internal comment --&#41;</code></pre>
  58 // Comments can be made conditional using a visibility label. The below
  59 // text will be only rendered if the `BETA` label is available:
  60 // <pre><code>&#40;--BETA: comment for BETA users --&#41;</code></pre>
  61 // A few directives are available in documentation. Note that
  62 // directives must appear on a single line to be properly
  63 // identified. The `include` directive includes a markdown file from
  64 // an external source:
  65 // <pre><code>&#40;== include path/to/file ==&#41;</code></pre>
  66 // The `resource_for` directive marks a message to be the resource of
  67 // a collection in REST view. If it is not specified, tools attempt
  68 // to infer the resource from the operations in a collection:
  69 // <pre><code>&#40;== resource_for v1.shelves.books ==&#41;</code></pre>
  70 // The directive `suppress_warning` does not directly affect documentation
  71 // and is documented together with service config validation.
  72 type Documentation struct {
  73         // A short summary of what the service does. Can only be provided by
  74         // plain text.
  75         Summary string `protobuf:"bytes,1,opt,name=summary" json:"summary,omitempty"`
  76         // The top level pages for the documentation set.
  77         Pages []*Page `protobuf:"bytes,5,rep,name=pages" json:"pages,omitempty"`
  78         // A list of documentation rules that apply to individual API elements.
  79         //
  80         // **NOTE:** All service configuration rules follow "last one wins" order.
  81         Rules []*DocumentationRule `protobuf:"bytes,3,rep,name=rules" json:"rules,omitempty"`
  82         // The URL to the root of documentation.
  83         DocumentationRootUrl string `protobuf:"bytes,4,opt,name=documentation_root_url,json=documentationRootUrl" json:"documentation_root_url,omitempty"`
  84         // Declares a single overview page. For example:
  85         // <pre><code>documentation:
  86         //   summary: ...
  87         //   overview: &#40;== include overview.md ==&#41;
  88         // </code></pre>
  89         // This is a shortcut for the following declaration (using pages style):
  90         // <pre><code>documentation:
  91         //   summary: ...
  92         //   pages:
  93         //   - name: Overview
  94         //     content: &#40;== include overview.md ==&#41;
  95         // </code></pre>
  96         // Note: you cannot specify both `overview` field and `pages` field.
  97         Overview string `protobuf:"bytes,2,opt,name=overview" json:"overview,omitempty"`
  98 }
  99
 100 func (m *Documentation) Reset()                    { *m = Documentation{} }
 101 func (m *Documentation) String() string            { return proto.CompactTextString(m) }
 102 func (*Documentation) ProtoMessage()               {}
 103 func (*Documentation) Descriptor() ([]byte, []int) { return fileDescriptor6, []int{0} }
 104
 105 func (m *Documentation) GetSummary() string {
 106         if m != nil {
 107                 return m.Summary
 108         }
 109         return ""
 110 }
 111
 112 func (m *Documentation) GetPages() []*Page {
 113         if m != nil {
 114                 return m.Pages
 115         }
 116         return nil
 117 }
 118
 119 func (m *Documentation) GetRules() []*DocumentationRule {
 120         if m != nil {
 121                 return m.Rules
 122         }
 123         return nil
 124 }
 125
 126 func (m *Documentation) GetDocumentationRootUrl() string {
 127         if m != nil {
 128                 return m.DocumentationRootUrl
 129         }
 130         return ""
 131 }
 132
 133 func (m *Documentation) GetOverview() string {
 134         if m != nil {
 135                 return m.Overview
 136         }
 137         return ""
 138 }
 139
 140 // A documentation rule provides information about individual API elements.
 141 type DocumentationRule struct {
 142         // The selector is a comma-separated list of patterns. Each pattern is a
 143         // qualified name of the element which may end in "*", indicating a wildcard.
 144         // Wildcards are only allowed at the end and for a whole component of the
 145         // qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". To
 146         // specify a default for all applicable elements, the whole pattern "*"
 147         // is used.
 148         Selector string `protobuf:"bytes,1,opt,name=selector" json:"selector,omitempty"`
 149         // Description of the selected API(s).
 150         Description string `protobuf:"bytes,2,opt,name=description" json:"description,omitempty"`
 151         // Deprecation description of the selected element(s). It can be provided if an
 152         // element is marked as `deprecated`.
 153         DeprecationDescription string `protobuf:"bytes,3,opt,name=deprecation_description,json=deprecationDescription" json:"deprecation_description,omitempty"`
 154 }
 155
 156 func (m *DocumentationRule) Reset()                    { *m = DocumentationRule{} }
 157 func (m *DocumentationRule) String() string            { return proto.CompactTextString(m) }
 158 func (*DocumentationRule) ProtoMessage()               {}
 159 func (*DocumentationRule) Descriptor() ([]byte, []int) { return fileDescriptor6, []int{1} }
 160
 161 func (m *DocumentationRule) GetSelector() string {
 162         if m != nil {
 163                 return m.Selector
 164         }
 165         return ""
 166 }
 167
 168 func (m *DocumentationRule) GetDescription() string {
 169         if m != nil {
 170                 return m.Description
 171         }
 172         return ""
 173 }
 174
 175 func (m *DocumentationRule) GetDeprecationDescription() string {
 176         if m != nil {
 177                 return m.DeprecationDescription
 178         }
 179         return ""
 180 }
 181
 182 // Represents a documentation page. A page can contain subpages to represent
 183 // nested documentation set structure.
 184 type Page struct {
 185         // The name of the page. It will be used as an identity of the page to
 186         // generate URI of the page, text of the link to this page in navigation,
 187         // etc. The full page name (start from the root page name to this page
 188         // concatenated with `.`) can be used as reference to the page in your
 189         // documentation. For example:
 190         // <pre><code>pages:
 191         // - name: Tutorial
 192         //   content: &#40;== include tutorial.md ==&#41;
 193         //   subpages:
 194         //   - name: Java
 195         //     content: &#40;== include tutorial_java.md ==&#41;
 196         // </code></pre>
 197         // You can reference `Java` page using Markdown reference link syntax:
 198         // `[Java][Tutorial.Java]`.
 199         Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
 200         // The Markdown content of the page. You can use <code>&#40;== include {path} ==&#41;</code>
 201         // to include content from a Markdown file.
 202         Content string `protobuf:"bytes,2,opt,name=content" json:"content,omitempty"`
 203         // Subpages of this page. The order of subpages specified here will be
 204         // honored in the generated docset.
 205         Subpages []*Page `protobuf:"bytes,3,rep,name=subpages" json:"subpages,omitempty"`
 206 }
 207
 208 func (m *Page) Reset()                    { *m = Page{} }
 209 func (m *Page) String() string            { return proto.CompactTextString(m) }
 210 func (*Page) ProtoMessage()               {}
 211 func (*Page) Descriptor() ([]byte, []int) { return fileDescriptor6, []int{2} }
 212
 213 func (m *Page) GetName() string {
 214         if m != nil {
 215                 return m.Name
 216         }
 217         return ""
 218 }
 219
 220 func (m *Page) GetContent() string {
 221         if m != nil {
 222                 return m.Content
 223         }
 224         return ""
 225 }
 226
 227 func (m *Page) GetSubpages() []*Page {
 228         if m != nil {
 229                 return m.Subpages
 230         }
 231         return nil
 232 }
 233
 234 func init() {
 235         proto.RegisterType((*Documentation)(nil), "google.api.Documentation")
 236         proto.RegisterType((*DocumentationRule)(nil), "google.api.DocumentationRule")
 237         proto.RegisterType((*Page)(nil), "google.api.Page")
 238 }
 239
 240 func init() { proto.RegisterFile("google/api/documentation.proto", fileDescriptor6) }
 241
 242 var fileDescriptor6 = []byte{
 243         // 356 bytes of a gzipped FileDescriptorProto
 244         0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0x74, 0x92, 0xc1, 0x6a, 0xe3, 0x30,
 245         0x14, 0x45, 0x71, 0xec, 0xcc, 0x64, 0x5e, 0x98, 0x61, 0x46, 0x0c, 0x19, 0x33, 0xd0, 0x12, 0xb2,
 246         0x28, 0x59, 0x14, 0x1b, 0x9a, 0x42, 0x17, 0x5d, 0x35, 0xa4, 0x94, 0xee, 0x8c, 0xa1, 0x9b, 0x6e,
 247         0x82, 0xa2, 0xbc, 0x0a, 0x83, 0xad, 0x67, 0x24, 0x39, 0xa5, 0xbf, 0xd0, 0xcf, 0xe8, 0x57, 0xf5,
 248         0x73, 0x8a, 0x65, 0x27, 0xb1, 0x29, 0xdd, 0xf9, 0xfa, 0x1e, 0xe9, 0x3e, 0x5d, 0x09, 0x4e, 0x25,
 249         0x91, 0xcc, 0x31, 0xe6, 0x65, 0x16, 0x6f, 0x49, 0x54, 0x05, 0x2a, 0xcb, 0x6d, 0x46, 0x2a, 0x2a,
 250         0x35, 0x59, 0x62, 0xd0, 0xf8, 0x11, 0x2f, 0xb3, 0xd9, 0xbb, 0x07, 0x3f, 0x57, 0x5d, 0x86, 0x85,
 251         0xf0, 0xdd, 0x54, 0x45, 0xc1, 0xf5, 0x4b, 0xe8, 0x4d, 0xbd, 0xf9, 0x8f, 0x74, 0x2f, 0xd9, 0x19,
 252         0x0c, 0x4b, 0x2e, 0xd1, 0x84, 0xc3, 0xa9, 0x3f, 0x1f, 0x5f, 0xfc, 0x8e, 0x8e, 0xfb, 0x44, 0x09,
 253         0x97, 0x98, 0x36, 0x36, 0x5b, 0xc0, 0x50, 0x57, 0x39, 0x9a, 0xd0, 0x77, 0xdc, 0x49, 0x97, 0xeb,
 254         0x65, 0xa5, 0x55, 0x8e, 0x69, 0xc3, 0xb2, 0x4b, 0x98, 0xf4, 0x66, 0x5d, 0x6b, 0x22, 0xbb, 0xae,
 255         0x74, 0x1e, 0x06, 0x6e, 0x8a, 0xbf, 0x3d, 0x37, 0x25, 0xb2, 0x0f, 0x3a, 0x67, 0xff, 0x61, 0x44,
 256         0x3b, 0xd4, 0xbb, 0x0c, 0x9f, 0xc3, 0x81, 0xe3, 0x0e, 0x7a, 0xf6, 0xea, 0xc1, 0x9f, 0x4f, 0x71,
 257         0xf5, 0x0a, 0x83, 0x39, 0x0a, 0x4b, 0xba, 0x3d, 0xdf, 0x41, 0xb3, 0x29, 0x8c, 0xb7, 0x68, 0x84,
 258         0xce, 0xca, 0x1a, 0x6f, 0x37, 0xec, 0xfe, 0x62, 0x57, 0xf0, 0x6f, 0x8b, 0xa5, 0x46, 0xd1, 0xcc,
 259         0xd8, 0xa5, 0x7d, 0x47, 0x4f, 0x3a, 0xf6, 0xea, 0xe8, 0xce, 0x36, 0x10, 0xd4, 0x15, 0x31, 0x06,
 260         0x81, 0xe2, 0x05, 0xb6, 0xd1, 0xee, 0xbb, 0x6e, 0x5c, 0x90, 0xb2, 0xa8, 0x6c, 0x1b, 0xb9, 0x97,
 261         0xec, 0x1c, 0x46, 0xa6, 0xda, 0x34, 0xa5, 0xfb, 0x5f, 0x94, 0x7e, 0x20, 0x96, 0x16, 0x7e, 0x09,
 262         0x2a, 0x3a, 0xc0, 0x92, 0xf5, 0xce, 0x9f, 0xd4, 0xb7, 0x9f, 0x78, 0x8f, 0xb7, 0x2d, 0x21, 0x29,
 263         0xe7, 0x4a, 0x46, 0xa4, 0x65, 0x2c, 0x51, 0xb9, 0xb7, 0x11, 0x37, 0x16, 0x2f, 0x33, 0xe3, 0x9e,
 264         0x8f, 0xa9, 0xbb, 0x14, 0x28, 0x48, 0x3d, 0x65, 0xf2, 0xba, 0xa7, 0xde, 0x06, 0xc1, 0xdd, 0x4d,
 265         0x72, 0xbf, 0xf9, 0xe6, 0x16, 0x2e, 0x3e, 0x02, 0x00, 0x00, 0xff, 0xff, 0x3e, 0x04, 0x32, 0xbf,
 266         0x76, 0x02, 0x00, 0x00,
 267 }