@devvit/protos 0.11.17-next-2025-05-28-417d95f5a.0 → 0.11.17-next-2025-05-29-91b3cf49f.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (30) hide show
  1. package/package.json +4 -4
  2. package/schema/.snootobuf/deps/google/api/annotations.proto +1 -1
  3. package/schema/.snootobuf/deps/google/api/auth.proto +19 -75
  4. package/schema/.snootobuf/deps/google/api/backend.proto +8 -142
  5. package/schema/.snootobuf/deps/google/api/billing.proto +13 -23
  6. package/schema/.snootobuf/deps/google/api/client.proto +1 -333
  7. package/schema/.snootobuf/deps/google/api/config_change.proto +3 -2
  8. package/schema/.snootobuf/deps/google/api/consumer.proto +2 -1
  9. package/schema/.snootobuf/deps/google/api/context.proto +5 -34
  10. package/schema/.snootobuf/deps/google/api/control.proto +7 -15
  11. package/schema/.snootobuf/deps/google/api/distribution.proto +5 -5
  12. package/schema/.snootobuf/deps/google/api/documentation.proto +16 -27
  13. package/schema/.snootobuf/deps/google/api/endpoint.proto +25 -23
  14. package/schema/.snootobuf/deps/google/api/field_behavior.proto +3 -23
  15. package/schema/.snootobuf/deps/google/api/http.proto +120 -173
  16. package/schema/.snootobuf/deps/google/api/httpbody.proto +6 -11
  17. package/schema/.snootobuf/deps/google/api/label.proto +2 -1
  18. package/schema/.snootobuf/deps/google/api/launch_stage.proto +5 -10
  19. package/schema/.snootobuf/deps/google/api/log.proto +2 -1
  20. package/schema/.snootobuf/deps/google/api/logging.proto +8 -6
  21. package/schema/.snootobuf/deps/google/api/metric.proto +40 -116
  22. package/schema/.snootobuf/deps/google/api/monitored_resource.proto +24 -38
  23. package/schema/.snootobuf/deps/google/api/monitoring.proto +25 -43
  24. package/schema/.snootobuf/deps/google/api/quota.proto +95 -20
  25. package/schema/.snootobuf/deps/google/api/resource.proto +74 -18
  26. package/schema/.snootobuf/deps/google/api/routing.proto +1 -1
  27. package/schema/.snootobuf/deps/google/api/service.proto +38 -54
  28. package/schema/.snootobuf/deps/google/api/source_info.proto +2 -1
  29. package/schema/.snootobuf/deps/google/api/system_parameter.proto +3 -3
  30. package/schema/.snootobuf/deps/google/api/usage.proto +5 -9
@@ -1,4 +1,4 @@
1
- // Copyright 2024 Google LLC
1
+ // Copyright 2020 Google LLC
2
2
  //
3
3
  // Licensed under the Apache License, Version 2.0 (the "License");
4
4
  // you may not use this file except in compliance with the License.
@@ -16,9 +16,7 @@ syntax = "proto3";
16
16
 
17
17
  package google.api;
18
18
 
19
- import "google/api/launch_stage.proto";
20
19
  import "google/protobuf/descriptor.proto";
21
- import "google/protobuf/duration.proto";
22
20
 
23
21
  option go_package = "google.golang.org/genproto/googleapis/api/annotations;annotations";
24
22
  option java_multiple_files = true;
@@ -98,334 +96,4 @@ extend google.protobuf.ServiceOptions {
98
96
  // ...
99
97
  // }
100
98
  string oauth_scopes = 1050;
101
-
102
- // The API version of this service, which should be sent by version-aware
103
- // clients to the service. This allows services to abide by the schema and
104
- // behavior of the service at the time this API version was deployed.
105
- // The format of the API version must be treated as opaque by clients.
106
- // Services may use a format with an apparent structure, but clients must
107
- // not rely on this to determine components within an API version, or attempt
108
- // to construct other valid API versions. Note that this is for upcoming
109
- // functionality and may not be implemented for all services.
110
- //
111
- // Example:
112
- //
113
- // service Foo {
114
- // option (google.api.api_version) = "v1_20230821_preview";
115
- // }
116
- string api_version = 525000001;
117
- }
118
-
119
- // Required information for every language.
120
- message CommonLanguageSettings {
121
- // Link to automatically generated reference documentation. Example:
122
- // https://cloud.google.com/nodejs/docs/reference/asset/latest
123
- string reference_docs_uri = 1 [deprecated = true];
124
-
125
- // The destination where API teams want this client library to be published.
126
- repeated ClientLibraryDestination destinations = 2;
127
- }
128
-
129
- // Details about how and where to publish client libraries.
130
- message ClientLibrarySettings {
131
- // Version of the API to apply these settings to. This is the full protobuf
132
- // package for the API, ending in the version element.
133
- // Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
134
- string version = 1;
135
-
136
- // Launch stage of this version of the API.
137
- LaunchStage launch_stage = 2;
138
-
139
- // When using transport=rest, the client request will encode enums as
140
- // numbers rather than strings.
141
- bool rest_numeric_enums = 3;
142
-
143
- // Settings for legacy Java features, supported in the Service YAML.
144
- JavaSettings java_settings = 21;
145
-
146
- // Settings for C++ client libraries.
147
- CppSettings cpp_settings = 22;
148
-
149
- // Settings for PHP client libraries.
150
- PhpSettings php_settings = 23;
151
-
152
- // Settings for Python client libraries.
153
- PythonSettings python_settings = 24;
154
-
155
- // Settings for Node client libraries.
156
- NodeSettings node_settings = 25;
157
-
158
- // Settings for .NET client libraries.
159
- DotnetSettings dotnet_settings = 26;
160
-
161
- // Settings for Ruby client libraries.
162
- RubySettings ruby_settings = 27;
163
-
164
- // Settings for Go client libraries.
165
- GoSettings go_settings = 28;
166
- }
167
-
168
- // This message configures the settings for publishing [Google Cloud Client
169
- // libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
170
- // generated from the service config.
171
- message Publishing {
172
- // A list of API method settings, e.g. the behavior for methods that use the
173
- // long-running operation pattern.
174
- repeated MethodSettings method_settings = 2;
175
-
176
- // Link to a *public* URI where users can report issues. Example:
177
- // https://issuetracker.google.com/issues/new?component=190865&template=1161103
178
- string new_issue_uri = 101;
179
-
180
- // Link to product home page. Example:
181
- // https://cloud.google.com/asset-inventory/docs/overview
182
- string documentation_uri = 102;
183
-
184
- // Used as a tracking tag when collecting data about the APIs developer
185
- // relations artifacts like docs, packages delivered to package managers,
186
- // etc. Example: "speech".
187
- string api_short_name = 103;
188
-
189
- // GitHub label to apply to issues and pull requests opened for this API.
190
- string github_label = 104;
191
-
192
- // GitHub teams to be added to CODEOWNERS in the directory in GitHub
193
- // containing source code for the client libraries for this API.
194
- repeated string codeowner_github_teams = 105;
195
-
196
- // A prefix used in sample code when demarking regions to be included in
197
- // documentation.
198
- string doc_tag_prefix = 106;
199
-
200
- // For whom the client library is being published.
201
- ClientLibraryOrganization organization = 107;
202
-
203
- // Client library settings. If the same version string appears multiple
204
- // times in this list, then the last one wins. Settings from earlier
205
- // settings with the same version string are discarded.
206
- repeated ClientLibrarySettings library_settings = 109;
207
-
208
- // Optional link to proto reference documentation. Example:
209
- // https://cloud.google.com/pubsub/lite/docs/reference/rpc
210
- string proto_reference_documentation_uri = 110;
211
-
212
- // Optional link to REST reference documentation. Example:
213
- // https://cloud.google.com/pubsub/lite/docs/reference/rest
214
- string rest_reference_documentation_uri = 111;
215
- }
216
-
217
- // Settings for Java client libraries.
218
- message JavaSettings {
219
- // The package name to use in Java. Clobbers the java_package option
220
- // set in the protobuf. This should be used **only** by APIs
221
- // who have already set the language_settings.java.package_name" field
222
- // in gapic.yaml. API teams should use the protobuf java_package option
223
- // where possible.
224
- //
225
- // Example of a YAML configuration::
226
- //
227
- // publishing:
228
- // java_settings:
229
- // library_package: com.google.cloud.pubsub.v1
230
- string library_package = 1;
231
-
232
- // Configure the Java class name to use instead of the service's for its
233
- // corresponding generated GAPIC client. Keys are fully-qualified
234
- // service names as they appear in the protobuf (including the full
235
- // the language_settings.java.interface_names" field in gapic.yaml. API
236
- // teams should otherwise use the service name as it appears in the
237
- // protobuf.
238
- //
239
- // Example of a YAML configuration::
240
- //
241
- // publishing:
242
- // java_settings:
243
- // service_class_names:
244
- // - google.pubsub.v1.Publisher: TopicAdmin
245
- // - google.pubsub.v1.Subscriber: SubscriptionAdmin
246
- map<string, string> service_class_names = 2;
247
-
248
- // Some settings.
249
- CommonLanguageSettings common = 3;
250
- }
251
-
252
- // Settings for C++ client libraries.
253
- message CppSettings {
254
- // Some settings.
255
- CommonLanguageSettings common = 1;
256
- }
257
-
258
- // Settings for Php client libraries.
259
- message PhpSettings {
260
- // Some settings.
261
- CommonLanguageSettings common = 1;
262
- }
263
-
264
- // Settings for Python client libraries.
265
- message PythonSettings {
266
- // Some settings.
267
- CommonLanguageSettings common = 1;
268
- }
269
-
270
- // Settings for Node client libraries.
271
- message NodeSettings {
272
- // Some settings.
273
- CommonLanguageSettings common = 1;
274
- }
275
-
276
- // Settings for Dotnet client libraries.
277
- message DotnetSettings {
278
- // Some settings.
279
- CommonLanguageSettings common = 1;
280
-
281
- // Map from original service names to renamed versions.
282
- // This is used when the default generated types
283
- // would cause a naming conflict. (Neither name is
284
- // fully-qualified.)
285
- // Example: Subscriber to SubscriberServiceApi.
286
- map<string, string> renamed_services = 2;
287
-
288
- // Map from full resource types to the effective short name
289
- // for the resource. This is used when otherwise resource
290
- // named from different services would cause naming collisions.
291
- // Example entry:
292
- // "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
293
- map<string, string> renamed_resources = 3;
294
-
295
- // List of full resource types to ignore during generation.
296
- // This is typically used for API-specific Location resources,
297
- // which should be handled by the generator as if they were actually
298
- // the common Location resources.
299
- // Example entry: "documentai.googleapis.com/Location"
300
- repeated string ignored_resources = 4;
301
-
302
- // Namespaces which must be aliased in snippets due to
303
- // a known (but non-generator-predictable) naming collision
304
- repeated string forced_namespace_aliases = 5;
305
-
306
- // Method signatures (in the form "service.method(signature)")
307
- // which are provided separately, so shouldn't be generated.
308
- // Snippets *calling* these methods are still generated, however.
309
- repeated string handwritten_signatures = 6;
310
- }
311
-
312
- // Settings for Ruby client libraries.
313
- message RubySettings {
314
- // Some settings.
315
- CommonLanguageSettings common = 1;
316
- }
317
-
318
- // Settings for Go client libraries.
319
- message GoSettings {
320
- // Some settings.
321
- CommonLanguageSettings common = 1;
322
- }
323
-
324
- // Describes the generator configuration for a method.
325
- message MethodSettings {
326
- // Describes settings to use when generating API methods that use the
327
- // long-running operation pattern.
328
- // All default values below are from those used in the client library
329
- // generators (e.g.
330
- // [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
331
- message LongRunning {
332
- // Initial delay after which the first poll request will be made.
333
- // Default value: 5 seconds.
334
- google.protobuf.Duration initial_poll_delay = 1;
335
-
336
- // Multiplier to gradually increase delay between subsequent polls until it
337
- // reaches max_poll_delay.
338
- // Default value: 1.5.
339
- float poll_delay_multiplier = 2;
340
-
341
- // Maximum time between two subsequent poll requests.
342
- // Default value: 45 seconds.
343
- google.protobuf.Duration max_poll_delay = 3;
344
-
345
- // Total polling timeout.
346
- // Default value: 5 minutes.
347
- google.protobuf.Duration total_poll_timeout = 4;
348
- }
349
-
350
- // The fully qualified name of the method, for which the options below apply.
351
- // This is used to find the method to apply the options.
352
- //
353
- // Example:
354
- //
355
- // publishing:
356
- // method_settings:
357
- // - selector: google.storage.control.v2.StorageControl.CreateFolder
358
- // # method settings for CreateFolder...
359
- string selector = 1;
360
-
361
- // Describes settings to use for long-running operations when generating
362
- // API methods for RPCs. Complements RPCs that use the annotations in
363
- // google/longrunning/operations.proto.
364
- //
365
- // Example of a YAML configuration::
366
- //
367
- // publishing:
368
- // method_settings:
369
- // - selector: google.cloud.speech.v2.Speech.BatchRecognize
370
- // long_running:
371
- // initial_poll_delay: 60s # 1 minute
372
- // poll_delay_multiplier: 1.5
373
- // max_poll_delay: 360s # 6 minutes
374
- // total_poll_timeout: 54000s # 90 minutes
375
- LongRunning long_running = 2;
376
-
377
- // List of top-level fields of the request message, that should be
378
- // automatically populated by the client libraries based on their
379
- // (google.api.field_info).format. Currently supported format: UUID4.
380
- //
381
- // Example of a YAML configuration:
382
- //
383
- // publishing:
384
- // method_settings:
385
- // - selector: google.example.v1.ExampleService.CreateExample
386
- // auto_populated_fields:
387
- // - request_id
388
- repeated string auto_populated_fields = 3;
389
- }
390
-
391
- // The organization for which the client libraries are being published.
392
- // Affects the url where generated docs are published, etc.
393
- enum ClientLibraryOrganization {
394
- // Not useful.
395
- CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0;
396
-
397
- // Google Cloud Platform Org.
398
- CLOUD = 1;
399
-
400
- // Ads (Advertising) Org.
401
- ADS = 2;
402
-
403
- // Photos Org.
404
- PHOTOS = 3;
405
-
406
- // Street View Org.
407
- STREET_VIEW = 4;
408
-
409
- // Shopping Org.
410
- SHOPPING = 5;
411
-
412
- // Geo Org.
413
- GEO = 6;
414
-
415
- // Generative AI - https://developers.generativeai.google
416
- GENERATIVE_AI = 7;
417
- }
418
-
419
- // To where should client libraries be published?
420
- enum ClientLibraryDestination {
421
- // Client libraries will neither be generated nor published to package
422
- // managers.
423
- CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0;
424
-
425
- // Generate the client library in a repo under github.com/googleapis,
426
- // but don't publish it to package managers.
427
- GITHUB = 10;
428
-
429
- // Publish the library to package managers like nuget.org and npmjs.com.
430
- PACKAGE_MANAGER = 20;
431
99
  }
@@ -1,4 +1,4 @@
1
- // Copyright 2024 Google LLC
1
+ // Copyright 2018 Google LLC.
2
2
  //
3
3
  // Licensed under the Apache License, Version 2.0 (the "License");
4
4
  // you may not use this file except in compliance with the License.
@@ -22,6 +22,7 @@ option java_outer_classname = "ConfigChangeProto";
22
22
  option java_package = "com.google.api";
23
23
  option objc_class_prefix = "GAPI";
24
24
 
25
+
25
26
  // Output generated from semantically comparing two versions of a service
26
27
  // configuration.
27
28
  //
@@ -35,7 +36,7 @@ message ConfigChange {
35
36
  // 'key' is used. If the field has no unique identifier, the numeric index
36
37
  // is used.
37
38
  // Examples:
38
- // - visibility.rules[selector=="google.LibraryService.ListBooks"].restriction
39
+ // - visibility.rules[selector=="google.LibraryService.CreateBook"].restriction
39
40
  // - quota.metric_rules[selector=="google"].metric_costs[key=="reads"].value
40
41
  // - logging.producer_destinations[0]
41
42
  string element = 1;
@@ -1,4 +1,4 @@
1
- // Copyright 2024 Google LLC
1
+ // Copyright 2016 Google Inc.
2
2
  //
3
3
  // Licensed under the Apache License, Version 2.0 (the "License");
4
4
  // you may not use this file except in compliance with the License.
@@ -21,6 +21,7 @@ option java_multiple_files = true;
21
21
  option java_outer_classname = "ConsumerProto";
22
22
  option java_package = "com.google.api";
23
23
 
24
+
24
25
  // A descriptor for defining project properties for a service. One service may
25
26
  // have many consumer projects, and the service may want to behave differently
26
27
  // depending on some properties on the project. For example, a project may be
@@ -1,4 +1,4 @@
1
- // Copyright 2024 Google LLC
1
+ // Copyright 2017 Google Inc.
2
2
  //
3
3
  // Licensed under the Apache License, Version 2.0 (the "License");
4
4
  // you may not use this file except in compliance with the License.
@@ -22,6 +22,7 @@ option java_outer_classname = "ContextProto";
22
22
  option java_package = "com.google.api";
23
23
  option objc_class_prefix = "GAPI";
24
24
 
25
+
25
26
  // `Context` defines which contexts an API requests.
26
27
  //
27
28
  // Example:
@@ -39,25 +40,6 @@ option objc_class_prefix = "GAPI";
39
40
  //
40
41
  // Available context types are defined in package
41
42
  // `google.rpc.context`.
42
- //
43
- // This also provides mechanism to allowlist any protobuf message extension that
44
- // can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and
45
- // “x-goog-ext-<extension_id>-jspb” format. For example, list any service
46
- // specific protobuf types that can appear in grpc metadata as follows in your
47
- // yaml file:
48
- //
49
- // Example:
50
- //
51
- // context:
52
- // rules:
53
- // - selector: "google.example.library.v1.LibraryService.CreateBook"
54
- // allowed_request_extensions:
55
- // - google.foo.v1.NewExtension
56
- // allowed_response_extensions:
57
- // - google.foo.v1.NewExtension
58
- //
59
- // You can also specify extension ID instead of fully qualified extension name
60
- // here.
61
43
  message Context {
62
44
  // A list of RPC context rules that apply to individual API methods.
63
45
  //
@@ -70,23 +52,12 @@ message Context {
70
52
  message ContextRule {
71
53
  // Selects the methods to which this rule applies.
72
54
  //
73
- // Refer to [selector][google.api.DocumentationRule.selector] for syntax
74
- // details.
55
+ // Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
75
56
  string selector = 1;
76
57
 
77
- // A list of full type names of requested contexts, only the requested context
78
- // will be made available to the backend.
58
+ // A list of full type names of requested contexts.
79
59
  repeated string requested = 2;
80
60
 
81
- // A list of full type names of provided contexts. It is used to support
82
- // propagating HTTP headers and ETags from the response extension.
61
+ // A list of full type names of provided contexts.
83
62
  repeated string provided = 3;
84
-
85
- // A list of full type names or extension IDs of extensions allowed in grpc
86
- // side channel from client to backend.
87
- repeated string allowed_request_extensions = 4;
88
-
89
- // A list of full type names or extension IDs of extensions allowed in grpc
90
- // side channel from backend to client.
91
- repeated string allowed_response_extensions = 5;
92
63
  }
@@ -1,4 +1,4 @@
1
- // Copyright 2024 Google LLC
1
+ // Copyright 2018 Google LLC.
2
2
  //
3
3
  // Licensed under the Apache License, Version 2.0 (the "License");
4
4
  // you may not use this file except in compliance with the License.
@@ -16,26 +16,18 @@ syntax = "proto3";
16
16
 
17
17
  package google.api;
18
18
 
19
- import "google/api/policy.proto";
20
-
21
19
  option go_package = "google.golang.org/genproto/googleapis/api/serviceconfig;serviceconfig";
22
20
  option java_multiple_files = true;
23
21
  option java_outer_classname = "ControlProto";
24
22
  option java_package = "com.google.api";
25
23
  option objc_class_prefix = "GAPI";
26
24
 
27
- // Selects and configures the service controller used by the service.
28
- //
29
- // Example:
30
- //
31
- // control:
32
- // environment: servicecontrol.googleapis.com
25
+
26
+ // Selects and configures the service controller used by the service. The
27
+ // service controller handles features like abuse, quota, billing, logging,
28
+ // monitoring, etc.
33
29
  message Control {
34
- // The service controller environment to use. If empty, no control plane
35
- // feature (like quota and billing) will be enabled. The recommended value for
36
- // most services is servicecontrol.googleapis.com
30
+ // The service control environment to use. If empty, no control plane
31
+ // feature (like quota and billing) will be enabled.
37
32
  string environment = 1;
38
-
39
- // Defines policies applying to the API methods of the service.
40
- repeated MethodPolicy method_policies = 4;
41
33
  }
@@ -1,4 +1,4 @@
1
- // Copyright 2024 Google LLC
1
+ // Copyright 2019 Google LLC.
2
2
  //
3
3
  // Licensed under the Apache License, Version 2.0 (the "License");
4
4
  // you may not use this file except in compliance with the License.
@@ -11,6 +11,7 @@
11
11
  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
12
  // See the License for the specific language governing permissions and
13
13
  // limitations under the License.
14
+ //
14
15
 
15
16
  syntax = "proto3";
16
17
 
@@ -25,6 +26,7 @@ option java_outer_classname = "DistributionProto";
25
26
  option java_package = "com.google.api";
26
27
  option objc_class_prefix = "GAPI";
27
28
 
29
+
28
30
  // `Distribution` contains summary statistics for a population of values. It
29
31
  // optionally contains a histogram representing the distribution of those values
30
32
  // across a set of buckets.
@@ -73,7 +75,6 @@ message Distribution {
73
75
  // following boundaries:
74
76
  //
75
77
  // Upper bound (0 <= i < N-1): offset + (width * i).
76
- //
77
78
  // Lower bound (1 <= i < N): offset + (width * (i - 1)).
78
79
  message Linear {
79
80
  // Must be greater than 0.
@@ -94,7 +95,6 @@ message Distribution {
94
95
  // following boundaries:
95
96
  //
96
97
  // Upper bound (0 <= i < N-1): scale * (growth_factor ^ i).
97
- //
98
98
  // Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)).
99
99
  message Exponential {
100
100
  // Must be greater than 0.
@@ -151,7 +151,7 @@ message Distribution {
151
151
 
152
152
  // Contextual information about the example value. Examples are:
153
153
  //
154
- // Trace: type.googleapis.com/google.monitoring.v3.SpanContext
154
+ // Trace ID: type.googleapis.com/google.devtools.cloudtrace.v1.Trace
155
155
  //
156
156
  // Literal string: type.googleapis.com/google.protobuf.StringValue
157
157
  //
@@ -177,7 +177,7 @@ message Distribution {
177
177
  //
178
178
  // Sum[i=1..n]((x_i - mean)^2)
179
179
  //
180
- // Knuth, "The Art of Computer Programming", Vol. 2, page 232, 3rd edition
180
+ // Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition
181
181
  // describes Welford's method for accumulating this sum in one pass.
182
182
  //
183
183
  // If `count` is zero then this field must be zero.
@@ -1,4 +1,4 @@
1
- // Copyright 2024 Google LLC
1
+ // Copyright 2018 Google LLC.
2
2
  //
3
3
  // Licensed under the Apache License, Version 2.0 (the "License");
4
4
  // you may not use this file except in compliance with the License.
@@ -22,6 +22,7 @@ option java_outer_classname = "DocumentationProto";
22
22
  option java_package = "com.google.api";
23
23
  option objc_class_prefix = "GAPI";
24
24
 
25
+
25
26
  // `Documentation` provides the information for describing a service.
26
27
  //
27
28
  // Example:
@@ -34,7 +35,7 @@ option objc_class_prefix = "GAPI";
34
35
  // content: &#40;== include google/foo/overview.md ==&#41;
35
36
  // - name: Tutorial
36
37
  // content: &#40;== include google/foo/tutorial.md ==&#41;
37
- // subpages:
38
+ // subpages;
38
39
  // - name: Java
39
40
  // content: &#40;== include google/foo/tutorial_java.md ==&#41;
40
41
  // rules:
@@ -78,10 +79,8 @@ option objc_class_prefix = "GAPI";
78
79
  // The directive `suppress_warning` does not directly affect documentation
79
80
  // and is documented together with service config validation.
80
81
  message Documentation {
81
- // A short description of what the service does. The summary must be plain
82
- // text. It becomes the overview of the service displayed in Google Cloud
83
- // Console.
84
- // NOTE: This field is equivalent to the standard field `description`.
82
+ // A short summary of what the service does. Can only be provided by
83
+ // plain text.
85
84
  string summary = 1;
86
85
 
87
86
  // The top level pages for the documentation set.
@@ -95,12 +94,6 @@ message Documentation {
95
94
  // The URL to the root of documentation.
96
95
  string documentation_root_url = 4;
97
96
 
98
- // Specifies the service root url if the default one (the service name
99
- // from the yaml file) is not suitable. This can be seen in any fully
100
- // specified service urls as well as sections that show a base that other
101
- // urls are relative to.
102
- string service_root_url = 6;
103
-
104
97
  // Declares a single overview page. For example:
105
98
  // <pre><code>documentation:
106
99
  // summary: ...
@@ -119,22 +112,19 @@ message Documentation {
119
112
 
120
113
  // A documentation rule provides information about individual API elements.
121
114
  message DocumentationRule {
122
- // The selector is a comma-separated list of patterns for any element such as
123
- // a method, a field, an enum value. Each pattern is a qualified name of the
124
- // element which may end in "*", indicating a wildcard. Wildcards are only
125
- // allowed at the end and for a whole component of the qualified name,
126
- // i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match
127
- // one or more components. To specify a default for all applicable elements,
128
- // the whole pattern "*" is used.
115
+ // The selector is a comma-separated list of patterns. Each pattern is a
116
+ // qualified name of the element which may end in "*", indicating a wildcard.
117
+ // Wildcards are only allowed at the end and for a whole component of the
118
+ // qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". To
119
+ // specify a default for all applicable elements, the whole pattern "*"
120
+ // is used.
129
121
  string selector = 1;
130
122
 
131
- // Description of the selected proto element (e.g. a message, a method, a
132
- // 'service' definition, or a field). Defaults to leading & trailing comments
133
- // taken from the proto source definition of the proto element.
123
+ // Description of the selected API(s).
134
124
  string description = 2;
135
125
 
136
- // Deprecation description of the selected element(s). It can be provided if
137
- // an element is marked as `deprecated`.
126
+ // Deprecation description of the selected element(s). It can be provided if an
127
+ // element is marked as `deprecated`.
138
128
  string deprecation_description = 3;
139
129
  }
140
130
 
@@ -157,9 +147,8 @@ message Page {
157
147
  // `[Java][Tutorial.Java]`.
158
148
  string name = 1;
159
149
 
160
- // The Markdown content of the page. You can use <code>&#40;== include {path}
161
- // ==&#41;</code> to include content from a Markdown file. The content can be
162
- // used to produce the documentation page such as HTML format page.
150
+ // The Markdown content of the page. You can use <code>&#40;== include {path} ==&#41;</code>
151
+ // to include content from a Markdown file.
163
152
  string content = 2;
164
153
 
165
154
  // Subpages of this page. The order of subpages specified here will be