@devvit/protos 0.11.17-next-2025-05-29-91b3cf49f.0 → 0.11.17-next-2025-05-29-de9726085.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.
- package/package.json +4 -4
- package/schema/.snootobuf/deps/google/api/annotations.proto +1 -1
- package/schema/.snootobuf/deps/google/api/auth.proto +75 -19
- package/schema/.snootobuf/deps/google/api/backend.proto +142 -8
- package/schema/.snootobuf/deps/google/api/billing.proto +23 -13
- package/schema/.snootobuf/deps/google/api/client.proto +333 -1
- package/schema/.snootobuf/deps/google/api/config_change.proto +2 -3
- package/schema/.snootobuf/deps/google/api/consumer.proto +1 -2
- package/schema/.snootobuf/deps/google/api/context.proto +34 -5
- package/schema/.snootobuf/deps/google/api/control.proto +15 -7
- package/schema/.snootobuf/deps/google/api/distribution.proto +5 -5
- package/schema/.snootobuf/deps/google/api/documentation.proto +27 -16
- package/schema/.snootobuf/deps/google/api/endpoint.proto +23 -25
- package/schema/.snootobuf/deps/google/api/field_behavior.proto +23 -3
- package/schema/.snootobuf/deps/google/api/http.proto +173 -120
- package/schema/.snootobuf/deps/google/api/httpbody.proto +11 -6
- package/schema/.snootobuf/deps/google/api/label.proto +1 -2
- package/schema/.snootobuf/deps/google/api/launch_stage.proto +10 -5
- package/schema/.snootobuf/deps/google/api/log.proto +1 -2
- package/schema/.snootobuf/deps/google/api/logging.proto +6 -8
- package/schema/.snootobuf/deps/google/api/metric.proto +116 -40
- package/schema/.snootobuf/deps/google/api/monitored_resource.proto +38 -24
- package/schema/.snootobuf/deps/google/api/monitoring.proto +43 -25
- package/schema/.snootobuf/deps/google/api/quota.proto +20 -95
- package/schema/.snootobuf/deps/google/api/resource.proto +18 -74
- package/schema/.snootobuf/deps/google/api/routing.proto +1 -1
- package/schema/.snootobuf/deps/google/api/service.proto +54 -38
- package/schema/.snootobuf/deps/google/api/source_info.proto +1 -2
- package/schema/.snootobuf/deps/google/api/system_parameter.proto +3 -3
- package/schema/.snootobuf/deps/google/api/usage.proto +9 -5
@@ -1,4 +1,4 @@
|
|
1
|
-
// Copyright
|
1
|
+
// Copyright 2024 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,7 +16,9 @@ syntax = "proto3";
|
|
16
16
|
|
17
17
|
package google.api;
|
18
18
|
|
19
|
+
import "google/api/launch_stage.proto";
|
19
20
|
import "google/protobuf/descriptor.proto";
|
21
|
+
import "google/protobuf/duration.proto";
|
20
22
|
|
21
23
|
option go_package = "google.golang.org/genproto/googleapis/api/annotations;annotations";
|
22
24
|
option java_multiple_files = true;
|
@@ -96,4 +98,334 @@ extend google.protobuf.ServiceOptions {
|
|
96
98
|
// ...
|
97
99
|
// }
|
98
100
|
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;
|
99
431
|
}
|
@@ -1,4 +1,4 @@
|
|
1
|
-
// Copyright
|
1
|
+
// Copyright 2024 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,7 +22,6 @@ option java_outer_classname = "ConfigChangeProto";
|
|
22
22
|
option java_package = "com.google.api";
|
23
23
|
option objc_class_prefix = "GAPI";
|
24
24
|
|
25
|
-
|
26
25
|
// Output generated from semantically comparing two versions of a service
|
27
26
|
// configuration.
|
28
27
|
//
|
@@ -36,7 +35,7 @@ message ConfigChange {
|
|
36
35
|
// 'key' is used. If the field has no unique identifier, the numeric index
|
37
36
|
// is used.
|
38
37
|
// Examples:
|
39
|
-
// - visibility.rules[selector=="google.LibraryService.
|
38
|
+
// - visibility.rules[selector=="google.LibraryService.ListBooks"].restriction
|
40
39
|
// - quota.metric_rules[selector=="google"].metric_costs[key=="reads"].value
|
41
40
|
// - logging.producer_destinations[0]
|
42
41
|
string element = 1;
|
@@ -1,4 +1,4 @@
|
|
1
|
-
// Copyright
|
1
|
+
// Copyright 2024 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.
|
@@ -21,7 +21,6 @@ option java_multiple_files = true;
|
|
21
21
|
option java_outer_classname = "ConsumerProto";
|
22
22
|
option java_package = "com.google.api";
|
23
23
|
|
24
|
-
|
25
24
|
// A descriptor for defining project properties for a service. One service may
|
26
25
|
// have many consumer projects, and the service may want to behave differently
|
27
26
|
// depending on some properties on the project. For example, a project may be
|
@@ -1,4 +1,4 @@
|
|
1
|
-
// Copyright
|
1
|
+
// Copyright 2024 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,7 +22,6 @@ option java_outer_classname = "ContextProto";
|
|
22
22
|
option java_package = "com.google.api";
|
23
23
|
option objc_class_prefix = "GAPI";
|
24
24
|
|
25
|
-
|
26
25
|
// `Context` defines which contexts an API requests.
|
27
26
|
//
|
28
27
|
// Example:
|
@@ -40,6 +39,25 @@ option objc_class_prefix = "GAPI";
|
|
40
39
|
//
|
41
40
|
// Available context types are defined in package
|
42
41
|
// `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.
|
43
61
|
message Context {
|
44
62
|
// A list of RPC context rules that apply to individual API methods.
|
45
63
|
//
|
@@ -52,12 +70,23 @@ message Context {
|
|
52
70
|
message ContextRule {
|
53
71
|
// Selects the methods to which this rule applies.
|
54
72
|
//
|
55
|
-
// Refer to [selector][google.api.DocumentationRule.selector] for syntax
|
73
|
+
// Refer to [selector][google.api.DocumentationRule.selector] for syntax
|
74
|
+
// details.
|
56
75
|
string selector = 1;
|
57
76
|
|
58
|
-
// A list of full type names of requested contexts
|
77
|
+
// A list of full type names of requested contexts, only the requested context
|
78
|
+
// will be made available to the backend.
|
59
79
|
repeated string requested = 2;
|
60
80
|
|
61
|
-
// A list of full type names of provided contexts.
|
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.
|
62
83
|
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;
|
63
92
|
}
|
@@ -1,4 +1,4 @@
|
|
1
|
-
// Copyright
|
1
|
+
// Copyright 2024 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,18 +16,26 @@ syntax = "proto3";
|
|
16
16
|
|
17
17
|
package google.api;
|
18
18
|
|
19
|
+
import "google/api/policy.proto";
|
20
|
+
|
19
21
|
option go_package = "google.golang.org/genproto/googleapis/api/serviceconfig;serviceconfig";
|
20
22
|
option java_multiple_files = true;
|
21
23
|
option java_outer_classname = "ControlProto";
|
22
24
|
option java_package = "com.google.api";
|
23
25
|
option objc_class_prefix = "GAPI";
|
24
26
|
|
25
|
-
|
26
|
-
//
|
27
|
-
//
|
28
|
-
//
|
27
|
+
// Selects and configures the service controller used by the service.
|
28
|
+
//
|
29
|
+
// Example:
|
30
|
+
//
|
31
|
+
// control:
|
32
|
+
// environment: servicecontrol.googleapis.com
|
29
33
|
message Control {
|
30
|
-
// The service
|
31
|
-
// feature (like quota and billing) will be enabled.
|
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
|
32
37
|
string environment = 1;
|
38
|
+
|
39
|
+
// Defines policies applying to the API methods of the service.
|
40
|
+
repeated MethodPolicy method_policies = 4;
|
33
41
|
}
|
@@ -1,4 +1,4 @@
|
|
1
|
-
// Copyright
|
1
|
+
// Copyright 2024 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,7 +11,6 @@
|
|
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
|
-
//
|
15
14
|
|
16
15
|
syntax = "proto3";
|
17
16
|
|
@@ -26,7 +25,6 @@ option java_outer_classname = "DistributionProto";
|
|
26
25
|
option java_package = "com.google.api";
|
27
26
|
option objc_class_prefix = "GAPI";
|
28
27
|
|
29
|
-
|
30
28
|
// `Distribution` contains summary statistics for a population of values. It
|
31
29
|
// optionally contains a histogram representing the distribution of those values
|
32
30
|
// across a set of buckets.
|
@@ -75,6 +73,7 @@ message Distribution {
|
|
75
73
|
// following boundaries:
|
76
74
|
//
|
77
75
|
// Upper bound (0 <= i < N-1): offset + (width * i).
|
76
|
+
//
|
78
77
|
// Lower bound (1 <= i < N): offset + (width * (i - 1)).
|
79
78
|
message Linear {
|
80
79
|
// Must be greater than 0.
|
@@ -95,6 +94,7 @@ message Distribution {
|
|
95
94
|
// following boundaries:
|
96
95
|
//
|
97
96
|
// 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
|
154
|
+
// Trace: type.googleapis.com/google.monitoring.v3.SpanContext
|
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
|
180
|
+
// Knuth, "The Art of Computer Programming", Vol. 2, page 232, 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
|
1
|
+
// Copyright 2024 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,7 +22,6 @@ option java_outer_classname = "DocumentationProto";
|
|
22
22
|
option java_package = "com.google.api";
|
23
23
|
option objc_class_prefix = "GAPI";
|
24
24
|
|
25
|
-
|
26
25
|
// `Documentation` provides the information for describing a service.
|
27
26
|
//
|
28
27
|
// Example:
|
@@ -35,7 +34,7 @@ option objc_class_prefix = "GAPI";
|
|
35
34
|
// content: (== include google/foo/overview.md ==)
|
36
35
|
// - name: Tutorial
|
37
36
|
// content: (== include google/foo/tutorial.md ==)
|
38
|
-
// subpages
|
37
|
+
// subpages:
|
39
38
|
// - name: Java
|
40
39
|
// content: (== include google/foo/tutorial_java.md ==)
|
41
40
|
// rules:
|
@@ -79,8 +78,10 @@ option objc_class_prefix = "GAPI";
|
|
79
78
|
// The directive `suppress_warning` does not directly affect documentation
|
80
79
|
// and is documented together with service config validation.
|
81
80
|
message Documentation {
|
82
|
-
// A short
|
83
|
-
//
|
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`.
|
84
85
|
string summary = 1;
|
85
86
|
|
86
87
|
// The top level pages for the documentation set.
|
@@ -94,6 +95,12 @@ message Documentation {
|
|
94
95
|
// The URL to the root of documentation.
|
95
96
|
string documentation_root_url = 4;
|
96
97
|
|
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
|
+
|
97
104
|
// Declares a single overview page. For example:
|
98
105
|
// <pre><code>documentation:
|
99
106
|
// summary: ...
|
@@ -112,19 +119,22 @@ message Documentation {
|
|
112
119
|
|
113
120
|
// A documentation rule provides information about individual API elements.
|
114
121
|
message DocumentationRule {
|
115
|
-
// The selector is a comma-separated list of patterns
|
116
|
-
//
|
117
|
-
//
|
118
|
-
//
|
119
|
-
//
|
120
|
-
//
|
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.
|
121
129
|
string selector = 1;
|
122
130
|
|
123
|
-
// Description of the selected
|
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.
|
124
134
|
string description = 2;
|
125
135
|
|
126
|
-
// Deprecation description of the selected element(s). It can be provided if
|
127
|
-
// element is marked as `deprecated`.
|
136
|
+
// Deprecation description of the selected element(s). It can be provided if
|
137
|
+
// an element is marked as `deprecated`.
|
128
138
|
string deprecation_description = 3;
|
129
139
|
}
|
130
140
|
|
@@ -147,8 +157,9 @@ message Page {
|
|
147
157
|
// `[Java][Tutorial.Java]`.
|
148
158
|
string name = 1;
|
149
159
|
|
150
|
-
// The Markdown content of the page. You can use <code>(== include {path}
|
151
|
-
// to include content from a Markdown file.
|
160
|
+
// The Markdown content of the page. You can use <code>(== include {path}
|
161
|
+
// ==)</code> to include content from a Markdown file. The content can be
|
162
|
+
// used to produce the documentation page such as HTML format page.
|
152
163
|
string content = 2;
|
153
164
|
|
154
165
|
// Subpages of this page. The order of subpages specified here will be
|