@devvit/protos 0.11.4-next-2024-12-07-be2205f63.0 → 0.11.4
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/devvit/dev_portal/app/app.proto +0 -3
- package/schema/devvit/dev_portal/app/info/app_info.proto +1 -13
- package/schema/devvit/ui/block_kit/v1beta/ui.proto +1 -1
- package/schema/devvit/ui/effects/web_view/v1alpha/fullscreen.proto +1 -7
- package/schema/snootobuf.devenv.lock +292 -459
- package/schema/snootobuf.lock +292 -459
- package/schema/snootobuf.redditapi.lock +292 -459
- package/schema/snootobuf.ts.lock +293 -459
- package/types/devvit/dev_portal/app/app.d.ts +0 -2
- package/types/devvit/dev_portal/app/app.d.ts.map +1 -1
- package/types/devvit/dev_portal/app/app.js +0 -17
- package/types/devvit/dev_portal/app/info/app_info.d.ts +0 -13
- package/types/devvit/dev_portal/app/info/app_info.d.ts.map +1 -1
- package/types/devvit/dev_portal/app/info/app_info.js +0 -17
- package/types/devvit/dev_portal/dev_portal.d.ts +0 -42
- package/types/devvit/dev_portal/dev_portal.d.ts.map +1 -1
- package/types/devvit/reddit/custom_post/v1alpha/custom_post.d.ts +0 -4
- package/types/devvit/reddit/custom_post/v1alpha/custom_post.d.ts.map +1 -1
- package/types/devvit/ui/effects/web_view/v1alpha/fullscreen.d.ts +1 -8
- package/types/devvit/ui/effects/web_view/v1alpha/fullscreen.d.ts.map +1 -1
- package/types/devvit/ui/effects/web_view/v1alpha/fullscreen.js +1 -15
- package/meta.min.json +0 -7814
- package/protos.min.js +0 -2
- package/protos.min.js.map +0 -7
- package/schema/.snootobuf/deps/buf/validate/expression.proto +0 -92
- package/schema/.snootobuf/deps/buf/validate/priv/private.proto +0 -41
- package/schema/.snootobuf/deps/buf/validate/validate.proto +0 -4130
- package/schema/.snootobuf/deps/devvit/data/api/admin/v1alpha/audit.proto +0 -72
- package/schema/.snootobuf/deps/devvit/data/api/admin/v1alpha/auth.proto +0 -49
- package/schema/.snootobuf/deps/devvit/data/api/admin/v1alpha/organization.proto +0 -54
- package/schema/.snootobuf/deps/devvit/data/api/admin/v1alpha/service.proto +0 -46
- package/schema/.snootobuf/deps/devvit/data/api/admin/v1alpha/subscription.proto +0 -72
- package/schema/.snootobuf/deps/devvit/data/api/admin/v1alpha/ui.proto +0 -20
- package/schema/.snootobuf/deps/devvit/data/api/admin/v1alpha/user.proto +0 -45
- package/schema/.snootobuf/deps/devvit/data/api/v1alpha/admin.proto +0 -54
- package/schema/.snootobuf/deps/devvit/data/api/v1alpha/delivery.proto +0 -773
- package/schema/.snootobuf/deps/devvit/data/api/v1alpha/filter.proto +0 -66
- package/schema/.snootobuf/deps/devvit/data/api/v1alpha/firehose.proto +0 -100
- package/schema/.snootobuf/deps/devvit/data/api/v1alpha/intake.proto +0 -19
- package/schema/.snootobuf/deps/devvit/events/v1alpha/events.proto +0 -446
- package/schema/.snootobuf/deps/devvit/gateway/v1alpha/payments.proto +0 -24
- package/schema/.snootobuf/deps/devvit/options/options.proto +0 -98
- package/schema/.snootobuf/deps/devvit/reddit/v2alpha/commentv2.proto +0 -29
- package/schema/.snootobuf/deps/devvit/reddit/v2alpha/flair.proto +0 -25
- package/schema/.snootobuf/deps/devvit/reddit/v2alpha/modaction.proto +0 -53
- package/schema/.snootobuf/deps/devvit/reddit/v2alpha/modmail.proto +0 -56
- package/schema/.snootobuf/deps/devvit/reddit/v2alpha/postv2.proto +0 -107
- package/schema/.snootobuf/deps/devvit/reddit/v2alpha/subredditv2.proto +0 -41
- package/schema/.snootobuf/deps/devvit/reddit/v2alpha/userv2.proto +0 -23
- package/schema/.snootobuf/deps/devvit/triggers/v1alpha/triggers.proto +0 -162
- package/schema/.snootobuf/deps/enum/account_gender_category.proto +0 -14
- package/schema/.snootobuf/deps/enum/approval_status.proto +0 -15
- package/schema/.snootobuf/deps/enum/automated_reporting_level.proto +0 -12
- package/schema/.snootobuf/deps/enum/ban_evasion_threshold.proto +0 -13
- package/schema/.snootobuf/deps/enum/ban_info_action.proto +0 -12
- package/schema/.snootobuf/deps/enum/block_relation_type.proto +0 -11
- package/schema/.snootobuf/deps/enum/comment_sort.proto +0 -18
- package/schema/.snootobuf/deps/enum/comment_type.proto +0 -11
- package/schema/.snootobuf/deps/enum/crowd_control_level.proto +0 -12
- package/schema/.snootobuf/deps/enum/discussion_type.proto +0 -10
- package/schema/.snootobuf/deps/enum/distinguish_type.proto +0 -14
- package/schema/.snootobuf/deps/enum/flair_position.proto +0 -11
- package/schema/.snootobuf/deps/enum/hateful_content_threshold.proto +0 -12
- package/schema/.snootobuf/deps/enum/link_content_type.proto +0 -11
- package/schema/.snootobuf/deps/enum/link_type.proto +0 -11
- package/schema/.snootobuf/deps/enum/link_visibility.proto +0 -11
- package/schema/.snootobuf/deps/enum/prediction_leaderboard_entry_type.proto +0 -11
- package/schema/.snootobuf/deps/enum/promo_layout.proto +0 -11
- package/schema/.snootobuf/deps/enum/removed_by_type.proto +0 -18
- package/schema/.snootobuf/deps/enum/spam_level.proto +0 -11
- package/schema/.snootobuf/deps/enum/subreddit_type.proto +0 -16
- package/schema/.snootobuf/deps/enum/verdict.proto +0 -14
- package/schema/.snootobuf/deps/enum/vote.proto +0 -12
- package/schema/.snootobuf/deps/enum/whitelist_status.proto +0 -17
- package/schema/.snootobuf/deps/enum/wiki_edit_mode.proto +0 -12
- package/schema/.snootobuf/deps/evaluator/evaluator.proto +0 -203
- package/schema/.snootobuf/deps/google/api/annotations.proto +0 -31
- package/schema/.snootobuf/deps/google/api/apikeys/v2/apikeys.proto +0 -288
- package/schema/.snootobuf/deps/google/api/apikeys/v2/resources.proto +0 -175
- package/schema/.snootobuf/deps/google/api/auth.proto +0 -237
- package/schema/.snootobuf/deps/google/api/backend.proto +0 -185
- package/schema/.snootobuf/deps/google/api/billing.proto +0 -77
- package/schema/.snootobuf/deps/google/api/client.proto +0 -431
- package/schema/.snootobuf/deps/google/api/cloudquotas/v1/cloudquotas.proto +0 -322
- package/schema/.snootobuf/deps/google/api/cloudquotas/v1/resources.proto +0 -315
- package/schema/.snootobuf/deps/google/api/config_change.proto +0 -84
- package/schema/.snootobuf/deps/google/api/consumer.proto +0 -82
- package/schema/.snootobuf/deps/google/api/context.proto +0 -92
- package/schema/.snootobuf/deps/google/api/control.proto +0 -41
- package/schema/.snootobuf/deps/google/api/distribution.proto +0 -213
- package/schema/.snootobuf/deps/google/api/documentation.proto +0 -168
- package/schema/.snootobuf/deps/google/api/endpoint.proto +0 -69
- package/schema/.snootobuf/deps/google/api/error_reason.proto +0 -589
- package/schema/.snootobuf/deps/google/api/expr/conformance/v1alpha1/conformance_service.proto +0 -183
- package/schema/.snootobuf/deps/google/api/expr/v1alpha1/checked.proto +0 -343
- package/schema/.snootobuf/deps/google/api/expr/v1alpha1/eval.proto +0 -118
- package/schema/.snootobuf/deps/google/api/expr/v1alpha1/explain.proto +0 -53
- package/schema/.snootobuf/deps/google/api/expr/v1alpha1/syntax.proto +0 -438
- package/schema/.snootobuf/deps/google/api/expr/v1alpha1/value.proto +0 -115
- package/schema/.snootobuf/deps/google/api/expr/v1beta1/decl.proto +0 -84
- package/schema/.snootobuf/deps/google/api/expr/v1beta1/eval.proto +0 -125
- package/schema/.snootobuf/deps/google/api/expr/v1beta1/expr.proto +0 -265
- package/schema/.snootobuf/deps/google/api/expr/v1beta1/source.proto +0 -62
- package/schema/.snootobuf/deps/google/api/expr/v1beta1/value.proto +0 -114
- package/schema/.snootobuf/deps/google/api/field_behavior.proto +0 -104
- package/schema/.snootobuf/deps/google/api/field_info.proto +0 -106
- package/schema/.snootobuf/deps/google/api/http.proto +0 -371
- package/schema/.snootobuf/deps/google/api/httpbody.proto +0 -81
- package/schema/.snootobuf/deps/google/api/label.proto +0 -48
- package/schema/.snootobuf/deps/google/api/launch_stage.proto +0 -72
- package/schema/.snootobuf/deps/google/api/log.proto +0 -54
- package/schema/.snootobuf/deps/google/api/logging.proto +0 -81
- package/schema/.snootobuf/deps/google/api/metric.proto +0 -268
- package/schema/.snootobuf/deps/google/api/monitored_resource.proto +0 -130
- package/schema/.snootobuf/deps/google/api/monitoring.proto +0 -107
- package/schema/.snootobuf/deps/google/api/policy.proto +0 -85
- package/schema/.snootobuf/deps/google/api/quota.proto +0 -184
- package/schema/.snootobuf/deps/google/api/resource.proto +0 -243
- package/schema/.snootobuf/deps/google/api/routing.proto +0 -461
- package/schema/.snootobuf/deps/google/api/service.proto +0 -191
- package/schema/.snootobuf/deps/google/api/servicecontrol/v1/check_error.proto +0 -124
- package/schema/.snootobuf/deps/google/api/servicecontrol/v1/distribution.proto +0 -166
- package/schema/.snootobuf/deps/google/api/servicecontrol/v1/http_request.proto +0 -93
- package/schema/.snootobuf/deps/google/api/servicecontrol/v1/log_entry.proto +0 -126
- package/schema/.snootobuf/deps/google/api/servicecontrol/v1/metric_value.proto +0 -81
- package/schema/.snootobuf/deps/google/api/servicecontrol/v1/operation.proto +0 -123
- package/schema/.snootobuf/deps/google/api/servicecontrol/v1/quota_controller.proto +0 -245
- package/schema/.snootobuf/deps/google/api/servicecontrol/v1/service_controller.proto +0 -260
- package/schema/.snootobuf/deps/google/api/servicecontrol/v2/service_controller.proto +0 -196
- package/schema/.snootobuf/deps/google/api/servicemanagement/v1/resources.proto +0 -295
- package/schema/.snootobuf/deps/google/api/servicemanagement/v1/servicemanager.proto +0 -508
- package/schema/.snootobuf/deps/google/api/serviceusage/v1/resources.proto +0 -130
- package/schema/.snootobuf/deps/google/api/serviceusage/v1/serviceusage.proto +0 -305
- package/schema/.snootobuf/deps/google/api/serviceusage/v1beta1/resources.proto +0 -458
- package/schema/.snootobuf/deps/google/api/serviceusage/v1beta1/serviceusage.proto +0 -793
- package/schema/.snootobuf/deps/google/api/source_info.proto +0 -31
- package/schema/.snootobuf/deps/google/api/system_parameter.proto +0 -96
- package/schema/.snootobuf/deps/google/api/usage.proto +0 -96
- package/schema/.snootobuf/deps/google/api/visibility.proto +0 -113
- package/schema/.snootobuf/deps/google/cloud/extended_operations.proto +0 -150
- package/schema/.snootobuf/deps/google/iam/admin/v1/iam.proto +0 -1087
- package/schema/.snootobuf/deps/google/iam/v1/iam_policy.proto +0 -145
- package/schema/.snootobuf/deps/google/iam/v1/logging/audit_data.proto +0 -34
- package/schema/.snootobuf/deps/google/iam/v1/options.proto +0 -41
- package/schema/.snootobuf/deps/google/iam/v1/policy.proto +0 -240
- package/schema/.snootobuf/deps/google/logging/type/http_request.proto +0 -92
- package/schema/.snootobuf/deps/google/logging/type/log_severity.proto +0 -72
- package/schema/.snootobuf/deps/google/longrunning/operations.proto +0 -247
- package/schema/.snootobuf/deps/google/protobuf/any.proto +0 -158
- package/schema/.snootobuf/deps/google/protobuf/api.proto +0 -208
- package/schema/.snootobuf/deps/google/protobuf/compiler/plugin.proto +0 -183
- package/schema/.snootobuf/deps/google/protobuf/descriptor.proto +0 -921
- package/schema/.snootobuf/deps/google/protobuf/duration.proto +0 -116
- package/schema/.snootobuf/deps/google/protobuf/empty.proto +0 -51
- package/schema/.snootobuf/deps/google/protobuf/field_mask.proto +0 -245
- package/schema/.snootobuf/deps/google/protobuf/source_context.proto +0 -48
- package/schema/.snootobuf/deps/google/protobuf/struct.proto +0 -95
- package/schema/.snootobuf/deps/google/protobuf/timestamp.proto +0 -147
- package/schema/.snootobuf/deps/google/protobuf/type.proto +0 -187
- package/schema/.snootobuf/deps/google/protobuf/wrappers.proto +0 -123
- package/schema/.snootobuf/deps/google/rpc/code.proto +0 -186
- package/schema/.snootobuf/deps/google/rpc/context/attribute_context.proto +0 -287
- package/schema/.snootobuf/deps/google/rpc/error_details.proto +0 -246
- package/schema/.snootobuf/deps/google/rpc/status.proto +0 -47
- package/schema/.snootobuf/deps/google/type/calendar_period.proto +0 -57
- package/schema/.snootobuf/deps/google/type/color.proto +0 -170
- package/schema/.snootobuf/deps/google/type/date.proto +0 -50
- package/schema/.snootobuf/deps/google/type/datetime.proto +0 -97
- package/schema/.snootobuf/deps/google/type/dayofweek.proto +0 -51
- package/schema/.snootobuf/deps/google/type/expr.proto +0 -51
- package/schema/.snootobuf/deps/google/type/fraction.proto +0 -34
- package/schema/.snootobuf/deps/google/type/latlng.proto +0 -37
- package/schema/.snootobuf/deps/google/type/money.proto +0 -43
- package/schema/.snootobuf/deps/google/type/month.proto +0 -66
- package/schema/.snootobuf/deps/google/type/postal_address.proto +0 -135
- package/schema/.snootobuf/deps/google/type/quaternion.proto +0 -95
- package/schema/.snootobuf/deps/google/type/timeofday.proto +0 -44
- package/schema/.snootobuf/deps/openapi/helper.proto +0 -20
- package/schema/.snootobuf/deps/products-api/protos/reddit/xpaymentsplatform/payproducts/v1/currencies.proto +0 -189
- package/schema/.snootobuf/deps/products-api/protos/reddit/xpaymentsplatform/payproducts/v1/payproducts.proto +0 -118
- package/schema/.snootobuf/deps/reddit/api/metadata/v1/metadata.proto +0 -55
- package/schema/.snootobuf/deps/reddit/coreplatform/account/v1/account.proto +0 -579
- package/schema/.snootobuf/deps/reddit/coreplatform/account/v1/account_relations.proto +0 -43
- package/schema/.snootobuf/deps/reddit/coreplatform/api/metadata/v1/metadata.proto +0 -82
- package/schema/.snootobuf/deps/reddit/coreplatform/blocking/v1/user_blocking_service.proto +0 -221
- package/schema/.snootobuf/deps/reddit/coreplatform/comments/v1/comment_tree.proto +0 -78
- package/schema/.snootobuf/deps/reddit/coreplatform/comments/v1/comment_tree_service.proto +0 -189
- package/schema/.snootobuf/deps/reddit/coreplatform/comments/v1/comment_tree_structure.proto +0 -29
- package/schema/.snootobuf/deps/reddit/coreplatform/comments/v1/comments.proto +0 -417
- package/schema/.snootobuf/deps/reddit/coreplatform/comments/v1/comments_service.proto +0 -72
- package/schema/.snootobuf/deps/reddit/coreplatform/common/v1/auth.proto +0 -25
- package/schema/.snootobuf/deps/reddit/coreplatform/common/v1/features.proto +0 -52
- package/schema/.snootobuf/deps/reddit/coreplatform/common/v1/lang.proto +0 -16
- package/schema/.snootobuf/deps/reddit/coreplatform/common/v1/legal.proto +0 -20
- package/schema/.snootobuf/deps/reddit/coreplatform/common/v1/media.proto +0 -149
- package/schema/.snootobuf/deps/reddit/coreplatform/common/v1/moderation.proto +0 -197
- package/schema/.snootobuf/deps/reddit/coreplatform/common/v1/safety.proto +0 -116
- package/schema/.snootobuf/deps/reddit/coreplatform/common/v1/time.proto +0 -25
- package/schema/.snootobuf/deps/reddit/coreplatform/domains/v1/domains_metadata_service.proto +0 -101
- package/schema/.snootobuf/deps/reddit/coreplatform/grpc_thrift/v1/grpc_thrift_options.proto +0 -34
- package/schema/.snootobuf/deps/reddit/coreplatform/links/v1/links.proto +0 -798
- package/schema/.snootobuf/deps/reddit/coreplatform/links/v1/links_service.proto +0 -186
- package/schema/.snootobuf/deps/reddit/coreplatform/messages/v1/messages.proto +0 -110
- package/schema/.snootobuf/deps/reddit/coreplatform/sensitive/v1/wrappers.proto +0 -51
- package/schema/.snootobuf/deps/reddit/coreplatform/subreddit/v1/subreddit.proto +0 -1202
- package/schema/.snootobuf/deps/reddit/coreplatform/subreddit/v1/subreddit_member_relations.proto +0 -85
- package/schema/.snootobuf/deps/reddit/coreplatform/subreddit/v1/subreddit_moderator_service.proto +0 -363
- package/schema/.snootobuf/deps/reddit/coreplatform/subreddit/v1/subreddit_service.proto +0 -301
- package/schema/.snootobuf/deps/reddit/coreplatform/thing/v0/thing.proto +0 -2869
- package/schema/.snootobuf/deps/reddit/devvit/custom_post/v1/custom_post.proto +0 -15
- package/schema/.snootobuf/deps/reddit/devvit/custom_post/v1/service.proto +0 -11
- package/schema/.snootobuf/deps/reddit/devvit/subreddit/v1/context_action.proto +0 -48
- package/schema/.snootobuf/deps/reddit/devvit/subreddit/v1/manifest.proto +0 -70
- package/schema/.snootobuf/deps/reddit/devvit/subreddit/v1/service.proto +0 -11
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/acknowledge_order_delivery.proto +0 -17
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/checkout.proto +0 -89
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/common.proto +0 -322
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/delete_products.proto +0 -17
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/events.proto +0 -14
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_batch_products.proto +0 -15
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_gold_balances.proto +0 -48
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_order.proto +0 -31
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_orders.proto +0 -26
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_orders_by_user.proto +0 -15
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_payout_info_batch.proto +0 -52
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_products.proto +0 -23
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/get_user_profiles.proto +0 -28
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/refund_order.proto +0 -17
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/service.proto +0 -49
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/service_data_compliance.proto +0 -20
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payapi/v1/upsert_products.proto +0 -17
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/paygatewaypsps/v1/paygatewaypsps.proto +0 -158
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payorders/v1/payments_data_compliance.proto +0 -18
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payorders/v1/payorders.proto +0 -195
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/paypayments/v1/admin.proto +0 -44
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/paypayments/v1/ledger.proto +0 -200
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/paypayments/v1/payments_data_compliance.proto +0 -18
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/paypayments/v1/paypayments.proto +0 -210
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payproducts/v1/currencies.proto +0 -189
- package/schema/.snootobuf/deps/reddit/xpaymentsplatform/payproducts/v1/payproducts.proto +0 -135
- package/schema/.snootobuf/deps/snooron_sources/text_classification/text_classification.proto +0 -29
- package/schema/.snootobuf/deps/snooron_sources/v2_event/v2_event.proto +0 -3292
- package/schema/.snootobuf/deps/validate/validate.proto +0 -862
@@ -1,84 +0,0 @@
|
|
1
|
-
// Copyright 2024 Google LLC
|
2
|
-
//
|
3
|
-
// Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
-
// you may not use this file except in compliance with the License.
|
5
|
-
// You may obtain a copy of the License at
|
6
|
-
//
|
7
|
-
// http://www.apache.org/licenses/LICENSE-2.0
|
8
|
-
//
|
9
|
-
// Unless required by applicable law or agreed to in writing, software
|
10
|
-
// distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
-
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
-
// See the License for the specific language governing permissions and
|
13
|
-
// limitations under the License.
|
14
|
-
|
15
|
-
syntax = "proto3";
|
16
|
-
|
17
|
-
package google.api;
|
18
|
-
|
19
|
-
option go_package = "google.golang.org/genproto/googleapis/api/configchange;configchange";
|
20
|
-
option java_multiple_files = true;
|
21
|
-
option java_outer_classname = "ConfigChangeProto";
|
22
|
-
option java_package = "com.google.api";
|
23
|
-
option objc_class_prefix = "GAPI";
|
24
|
-
|
25
|
-
// Output generated from semantically comparing two versions of a service
|
26
|
-
// configuration.
|
27
|
-
//
|
28
|
-
// Includes detailed information about a field that have changed with
|
29
|
-
// applicable advice about potential consequences for the change, such as
|
30
|
-
// backwards-incompatibility.
|
31
|
-
message ConfigChange {
|
32
|
-
// Object hierarchy path to the change, with levels separated by a '.'
|
33
|
-
// character. For repeated fields, an applicable unique identifier field is
|
34
|
-
// used for the index (usually selector, name, or id). For maps, the term
|
35
|
-
// 'key' is used. If the field has no unique identifier, the numeric index
|
36
|
-
// is used.
|
37
|
-
// Examples:
|
38
|
-
// - visibility.rules[selector=="google.LibraryService.ListBooks"].restriction
|
39
|
-
// - quota.metric_rules[selector=="google"].metric_costs[key=="reads"].value
|
40
|
-
// - logging.producer_destinations[0]
|
41
|
-
string element = 1;
|
42
|
-
|
43
|
-
// Value of the changed object in the old Service configuration,
|
44
|
-
// in JSON format. This field will not be populated if ChangeType == ADDED.
|
45
|
-
string old_value = 2;
|
46
|
-
|
47
|
-
// Value of the changed object in the new Service configuration,
|
48
|
-
// in JSON format. This field will not be populated if ChangeType == REMOVED.
|
49
|
-
string new_value = 3;
|
50
|
-
|
51
|
-
// The type for this change, either ADDED, REMOVED, or MODIFIED.
|
52
|
-
ChangeType change_type = 4;
|
53
|
-
|
54
|
-
// Collection of advice provided for this change, useful for determining the
|
55
|
-
// possible impact of this change.
|
56
|
-
repeated Advice advices = 5;
|
57
|
-
}
|
58
|
-
|
59
|
-
// Generated advice about this change, used for providing more
|
60
|
-
// information about how a change will affect the existing service.
|
61
|
-
message Advice {
|
62
|
-
// Useful description for why this advice was applied and what actions should
|
63
|
-
// be taken to mitigate any implied risks.
|
64
|
-
string description = 2;
|
65
|
-
}
|
66
|
-
|
67
|
-
// Classifies set of possible modifications to an object in the service
|
68
|
-
// configuration.
|
69
|
-
enum ChangeType {
|
70
|
-
// No value was provided.
|
71
|
-
CHANGE_TYPE_UNSPECIFIED = 0;
|
72
|
-
|
73
|
-
// The changed object exists in the 'new' service configuration, but not
|
74
|
-
// in the 'old' service configuration.
|
75
|
-
ADDED = 1;
|
76
|
-
|
77
|
-
// The changed object exists in the 'old' service configuration, but not
|
78
|
-
// in the 'new' service configuration.
|
79
|
-
REMOVED = 2;
|
80
|
-
|
81
|
-
// The changed object exists in both service configurations, but its value
|
82
|
-
// is different.
|
83
|
-
MODIFIED = 3;
|
84
|
-
}
|
@@ -1,82 +0,0 @@
|
|
1
|
-
// Copyright 2024 Google LLC
|
2
|
-
//
|
3
|
-
// Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
-
// you may not use this file except in compliance with the License.
|
5
|
-
// You may obtain a copy of the License at
|
6
|
-
//
|
7
|
-
// http://www.apache.org/licenses/LICENSE-2.0
|
8
|
-
//
|
9
|
-
// Unless required by applicable law or agreed to in writing, software
|
10
|
-
// distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
-
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
-
// See the License for the specific language governing permissions and
|
13
|
-
// limitations under the License.
|
14
|
-
|
15
|
-
syntax = "proto3";
|
16
|
-
|
17
|
-
package google.api;
|
18
|
-
|
19
|
-
option go_package = "google.golang.org/genproto/googleapis/api/serviceconfig;serviceconfig";
|
20
|
-
option java_multiple_files = true;
|
21
|
-
option java_outer_classname = "ConsumerProto";
|
22
|
-
option java_package = "com.google.api";
|
23
|
-
|
24
|
-
// A descriptor for defining project properties for a service. One service may
|
25
|
-
// have many consumer projects, and the service may want to behave differently
|
26
|
-
// depending on some properties on the project. For example, a project may be
|
27
|
-
// associated with a school, or a business, or a government agency, a business
|
28
|
-
// type property on the project may affect how a service responds to the client.
|
29
|
-
// This descriptor defines which properties are allowed to be set on a project.
|
30
|
-
//
|
31
|
-
// Example:
|
32
|
-
//
|
33
|
-
// project_properties:
|
34
|
-
// properties:
|
35
|
-
// - name: NO_WATERMARK
|
36
|
-
// type: BOOL
|
37
|
-
// description: Allows usage of the API without watermarks.
|
38
|
-
// - name: EXTENDED_TILE_CACHE_PERIOD
|
39
|
-
// type: INT64
|
40
|
-
message ProjectProperties {
|
41
|
-
// List of per consumer project-specific properties.
|
42
|
-
repeated Property properties = 1;
|
43
|
-
}
|
44
|
-
|
45
|
-
// Defines project properties.
|
46
|
-
//
|
47
|
-
// API services can define properties that can be assigned to consumer projects
|
48
|
-
// so that backends can perform response customization without having to make
|
49
|
-
// additional calls or maintain additional storage. For example, Maps API
|
50
|
-
// defines properties that controls map tile cache period, or whether to embed a
|
51
|
-
// watermark in a result.
|
52
|
-
//
|
53
|
-
// These values can be set via API producer console. Only API providers can
|
54
|
-
// define and set these properties.
|
55
|
-
message Property {
|
56
|
-
// Supported data type of the property values
|
57
|
-
enum PropertyType {
|
58
|
-
// The type is unspecified, and will result in an error.
|
59
|
-
UNSPECIFIED = 0;
|
60
|
-
|
61
|
-
// The type is `int64`.
|
62
|
-
INT64 = 1;
|
63
|
-
|
64
|
-
// The type is `bool`.
|
65
|
-
BOOL = 2;
|
66
|
-
|
67
|
-
// The type is `string`.
|
68
|
-
STRING = 3;
|
69
|
-
|
70
|
-
// The type is 'double'.
|
71
|
-
DOUBLE = 4;
|
72
|
-
}
|
73
|
-
|
74
|
-
// The name of the property (a.k.a key).
|
75
|
-
string name = 1;
|
76
|
-
|
77
|
-
// The type of this property.
|
78
|
-
PropertyType type = 2;
|
79
|
-
|
80
|
-
// The description of the property
|
81
|
-
string description = 3;
|
82
|
-
}
|
@@ -1,92 +0,0 @@
|
|
1
|
-
// Copyright 2024 Google LLC
|
2
|
-
//
|
3
|
-
// Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
-
// you may not use this file except in compliance with the License.
|
5
|
-
// You may obtain a copy of the License at
|
6
|
-
//
|
7
|
-
// http://www.apache.org/licenses/LICENSE-2.0
|
8
|
-
//
|
9
|
-
// Unless required by applicable law or agreed to in writing, software
|
10
|
-
// distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
-
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
-
// See the License for the specific language governing permissions and
|
13
|
-
// limitations under the License.
|
14
|
-
|
15
|
-
syntax = "proto3";
|
16
|
-
|
17
|
-
package google.api;
|
18
|
-
|
19
|
-
option go_package = "google.golang.org/genproto/googleapis/api/serviceconfig;serviceconfig";
|
20
|
-
option java_multiple_files = true;
|
21
|
-
option java_outer_classname = "ContextProto";
|
22
|
-
option java_package = "com.google.api";
|
23
|
-
option objc_class_prefix = "GAPI";
|
24
|
-
|
25
|
-
// `Context` defines which contexts an API requests.
|
26
|
-
//
|
27
|
-
// Example:
|
28
|
-
//
|
29
|
-
// context:
|
30
|
-
// rules:
|
31
|
-
// - selector: "*"
|
32
|
-
// requested:
|
33
|
-
// - google.rpc.context.ProjectContext
|
34
|
-
// - google.rpc.context.OriginContext
|
35
|
-
//
|
36
|
-
// The above specifies that all methods in the API request
|
37
|
-
// `google.rpc.context.ProjectContext` and
|
38
|
-
// `google.rpc.context.OriginContext`.
|
39
|
-
//
|
40
|
-
// Available context types are defined in package
|
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.
|
61
|
-
message Context {
|
62
|
-
// A list of RPC context rules that apply to individual API methods.
|
63
|
-
//
|
64
|
-
// **NOTE:** All service configuration rules follow "last one wins" order.
|
65
|
-
repeated ContextRule rules = 1;
|
66
|
-
}
|
67
|
-
|
68
|
-
// A context rule provides information about the context for an individual API
|
69
|
-
// element.
|
70
|
-
message ContextRule {
|
71
|
-
// Selects the methods to which this rule applies.
|
72
|
-
//
|
73
|
-
// Refer to [selector][google.api.DocumentationRule.selector] for syntax
|
74
|
-
// details.
|
75
|
-
string selector = 1;
|
76
|
-
|
77
|
-
// A list of full type names of requested contexts, only the requested context
|
78
|
-
// will be made available to the backend.
|
79
|
-
repeated string requested = 2;
|
80
|
-
|
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.
|
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;
|
92
|
-
}
|
@@ -1,41 +0,0 @@
|
|
1
|
-
// Copyright 2024 Google LLC
|
2
|
-
//
|
3
|
-
// Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
-
// you may not use this file except in compliance with the License.
|
5
|
-
// You may obtain a copy of the License at
|
6
|
-
//
|
7
|
-
// http://www.apache.org/licenses/LICENSE-2.0
|
8
|
-
//
|
9
|
-
// Unless required by applicable law or agreed to in writing, software
|
10
|
-
// distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
-
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
-
// See the License for the specific language governing permissions and
|
13
|
-
// limitations under the License.
|
14
|
-
|
15
|
-
syntax = "proto3";
|
16
|
-
|
17
|
-
package google.api;
|
18
|
-
|
19
|
-
import "google/api/policy.proto";
|
20
|
-
|
21
|
-
option go_package = "google.golang.org/genproto/googleapis/api/serviceconfig;serviceconfig";
|
22
|
-
option java_multiple_files = true;
|
23
|
-
option java_outer_classname = "ControlProto";
|
24
|
-
option java_package = "com.google.api";
|
25
|
-
option objc_class_prefix = "GAPI";
|
26
|
-
|
27
|
-
// Selects and configures the service controller used by the service.
|
28
|
-
//
|
29
|
-
// Example:
|
30
|
-
//
|
31
|
-
// control:
|
32
|
-
// environment: servicecontrol.googleapis.com
|
33
|
-
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
|
37
|
-
string environment = 1;
|
38
|
-
|
39
|
-
// Defines policies applying to the API methods of the service.
|
40
|
-
repeated MethodPolicy method_policies = 4;
|
41
|
-
}
|
@@ -1,213 +0,0 @@
|
|
1
|
-
// Copyright 2024 Google LLC
|
2
|
-
//
|
3
|
-
// Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
-
// you may not use this file except in compliance with the License.
|
5
|
-
// You may obtain a copy of the License at
|
6
|
-
//
|
7
|
-
// http://www.apache.org/licenses/LICENSE-2.0
|
8
|
-
//
|
9
|
-
// Unless required by applicable law or agreed to in writing, software
|
10
|
-
// distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
-
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
-
// See the License for the specific language governing permissions and
|
13
|
-
// limitations under the License.
|
14
|
-
|
15
|
-
syntax = "proto3";
|
16
|
-
|
17
|
-
package google.api;
|
18
|
-
|
19
|
-
import "google/protobuf/any.proto";
|
20
|
-
import "google/protobuf/timestamp.proto";
|
21
|
-
|
22
|
-
option go_package = "google.golang.org/genproto/googleapis/api/distribution;distribution";
|
23
|
-
option java_multiple_files = true;
|
24
|
-
option java_outer_classname = "DistributionProto";
|
25
|
-
option java_package = "com.google.api";
|
26
|
-
option objc_class_prefix = "GAPI";
|
27
|
-
|
28
|
-
// `Distribution` contains summary statistics for a population of values. It
|
29
|
-
// optionally contains a histogram representing the distribution of those values
|
30
|
-
// across a set of buckets.
|
31
|
-
//
|
32
|
-
// The summary statistics are the count, mean, sum of the squared deviation from
|
33
|
-
// the mean, the minimum, and the maximum of the set of population of values.
|
34
|
-
// The histogram is based on a sequence of buckets and gives a count of values
|
35
|
-
// that fall into each bucket. The boundaries of the buckets are given either
|
36
|
-
// explicitly or by formulas for buckets of fixed or exponentially increasing
|
37
|
-
// widths.
|
38
|
-
//
|
39
|
-
// Although it is not forbidden, it is generally a bad idea to include
|
40
|
-
// non-finite values (infinities or NaNs) in the population of values, as this
|
41
|
-
// will render the `mean` and `sum_of_squared_deviation` fields meaningless.
|
42
|
-
message Distribution {
|
43
|
-
// The range of the population values.
|
44
|
-
message Range {
|
45
|
-
// The minimum of the population values.
|
46
|
-
double min = 1;
|
47
|
-
|
48
|
-
// The maximum of the population values.
|
49
|
-
double max = 2;
|
50
|
-
}
|
51
|
-
|
52
|
-
// `BucketOptions` describes the bucket boundaries used to create a histogram
|
53
|
-
// for the distribution. The buckets can be in a linear sequence, an
|
54
|
-
// exponential sequence, or each bucket can be specified explicitly.
|
55
|
-
// `BucketOptions` does not include the number of values in each bucket.
|
56
|
-
//
|
57
|
-
// A bucket has an inclusive lower bound and exclusive upper bound for the
|
58
|
-
// values that are counted for that bucket. The upper bound of a bucket must
|
59
|
-
// be strictly greater than the lower bound. The sequence of N buckets for a
|
60
|
-
// distribution consists of an underflow bucket (number 0), zero or more
|
61
|
-
// finite buckets (number 1 through N - 2) and an overflow bucket (number N -
|
62
|
-
// 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the
|
63
|
-
// same as the upper bound of bucket i - 1. The buckets span the whole range
|
64
|
-
// of finite values: lower bound of the underflow bucket is -infinity and the
|
65
|
-
// upper bound of the overflow bucket is +infinity. The finite buckets are
|
66
|
-
// so-called because both bounds are finite.
|
67
|
-
message BucketOptions {
|
68
|
-
// Specifies a linear sequence of buckets that all have the same width
|
69
|
-
// (except overflow and underflow). Each bucket represents a constant
|
70
|
-
// absolute uncertainty on the specific value in the bucket.
|
71
|
-
//
|
72
|
-
// There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the
|
73
|
-
// following boundaries:
|
74
|
-
//
|
75
|
-
// Upper bound (0 <= i < N-1): offset + (width * i).
|
76
|
-
//
|
77
|
-
// Lower bound (1 <= i < N): offset + (width * (i - 1)).
|
78
|
-
message Linear {
|
79
|
-
// Must be greater than 0.
|
80
|
-
int32 num_finite_buckets = 1;
|
81
|
-
|
82
|
-
// Must be greater than 0.
|
83
|
-
double width = 2;
|
84
|
-
|
85
|
-
// Lower bound of the first bucket.
|
86
|
-
double offset = 3;
|
87
|
-
}
|
88
|
-
|
89
|
-
// Specifies an exponential sequence of buckets that have a width that is
|
90
|
-
// proportional to the value of the lower bound. Each bucket represents a
|
91
|
-
// constant relative uncertainty on a specific value in the bucket.
|
92
|
-
//
|
93
|
-
// There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the
|
94
|
-
// following boundaries:
|
95
|
-
//
|
96
|
-
// Upper bound (0 <= i < N-1): scale * (growth_factor ^ i).
|
97
|
-
//
|
98
|
-
// Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)).
|
99
|
-
message Exponential {
|
100
|
-
// Must be greater than 0.
|
101
|
-
int32 num_finite_buckets = 1;
|
102
|
-
|
103
|
-
// Must be greater than 1.
|
104
|
-
double growth_factor = 2;
|
105
|
-
|
106
|
-
// Must be greater than 0.
|
107
|
-
double scale = 3;
|
108
|
-
}
|
109
|
-
|
110
|
-
// Specifies a set of buckets with arbitrary widths.
|
111
|
-
//
|
112
|
-
// There are `size(bounds) + 1` (= N) buckets. Bucket `i` has the following
|
113
|
-
// boundaries:
|
114
|
-
//
|
115
|
-
// Upper bound (0 <= i < N-1): bounds[i]
|
116
|
-
// Lower bound (1 <= i < N); bounds[i - 1]
|
117
|
-
//
|
118
|
-
// The `bounds` field must contain at least one element. If `bounds` has
|
119
|
-
// only one element, then there are no finite buckets, and that single
|
120
|
-
// element is the common boundary of the overflow and underflow buckets.
|
121
|
-
message Explicit {
|
122
|
-
// The values must be monotonically increasing.
|
123
|
-
repeated double bounds = 1;
|
124
|
-
}
|
125
|
-
|
126
|
-
// Exactly one of these three fields must be set.
|
127
|
-
oneof options {
|
128
|
-
// The linear bucket.
|
129
|
-
Linear linear_buckets = 1;
|
130
|
-
|
131
|
-
// The exponential buckets.
|
132
|
-
Exponential exponential_buckets = 2;
|
133
|
-
|
134
|
-
// The explicit buckets.
|
135
|
-
Explicit explicit_buckets = 3;
|
136
|
-
}
|
137
|
-
}
|
138
|
-
|
139
|
-
// Exemplars are example points that may be used to annotate aggregated
|
140
|
-
// distribution values. They are metadata that gives information about a
|
141
|
-
// particular value added to a Distribution bucket, such as a trace ID that
|
142
|
-
// was active when a value was added. They may contain further information,
|
143
|
-
// such as a example values and timestamps, origin, etc.
|
144
|
-
message Exemplar {
|
145
|
-
// Value of the exemplar point. This value determines to which bucket the
|
146
|
-
// exemplar belongs.
|
147
|
-
double value = 1;
|
148
|
-
|
149
|
-
// The observation (sampling) time of the above value.
|
150
|
-
google.protobuf.Timestamp timestamp = 2;
|
151
|
-
|
152
|
-
// Contextual information about the example value. Examples are:
|
153
|
-
//
|
154
|
-
// Trace: type.googleapis.com/google.monitoring.v3.SpanContext
|
155
|
-
//
|
156
|
-
// Literal string: type.googleapis.com/google.protobuf.StringValue
|
157
|
-
//
|
158
|
-
// Labels dropped during aggregation:
|
159
|
-
// type.googleapis.com/google.monitoring.v3.DroppedLabels
|
160
|
-
//
|
161
|
-
// There may be only a single attachment of any given message type in a
|
162
|
-
// single exemplar, and this is enforced by the system.
|
163
|
-
repeated google.protobuf.Any attachments = 3;
|
164
|
-
}
|
165
|
-
|
166
|
-
// The number of values in the population. Must be non-negative. This value
|
167
|
-
// must equal the sum of the values in `bucket_counts` if a histogram is
|
168
|
-
// provided.
|
169
|
-
int64 count = 1;
|
170
|
-
|
171
|
-
// The arithmetic mean of the values in the population. If `count` is zero
|
172
|
-
// then this field must be zero.
|
173
|
-
double mean = 2;
|
174
|
-
|
175
|
-
// The sum of squared deviations from the mean of the values in the
|
176
|
-
// population. For values x_i this is:
|
177
|
-
//
|
178
|
-
// Sum[i=1..n]((x_i - mean)^2)
|
179
|
-
//
|
180
|
-
// Knuth, "The Art of Computer Programming", Vol. 2, page 232, 3rd edition
|
181
|
-
// describes Welford's method for accumulating this sum in one pass.
|
182
|
-
//
|
183
|
-
// If `count` is zero then this field must be zero.
|
184
|
-
double sum_of_squared_deviation = 3;
|
185
|
-
|
186
|
-
// If specified, contains the range of the population values. The field
|
187
|
-
// must not be present if the `count` is zero.
|
188
|
-
Range range = 4;
|
189
|
-
|
190
|
-
// Defines the histogram bucket boundaries. If the distribution does not
|
191
|
-
// contain a histogram, then omit this field.
|
192
|
-
BucketOptions bucket_options = 6;
|
193
|
-
|
194
|
-
// The number of values in each bucket of the histogram, as described in
|
195
|
-
// `bucket_options`. If the distribution does not have a histogram, then omit
|
196
|
-
// this field. If there is a histogram, then the sum of the values in
|
197
|
-
// `bucket_counts` must equal the value in the `count` field of the
|
198
|
-
// distribution.
|
199
|
-
//
|
200
|
-
// If present, `bucket_counts` should contain N values, where N is the number
|
201
|
-
// of buckets specified in `bucket_options`. If you supply fewer than N
|
202
|
-
// values, the remaining values are assumed to be 0.
|
203
|
-
//
|
204
|
-
// The order of the values in `bucket_counts` follows the bucket numbering
|
205
|
-
// schemes described for the three bucket types. The first value must be the
|
206
|
-
// count for the underflow bucket (number 0). The next N-2 values are the
|
207
|
-
// counts for the finite buckets (number 1 through N-2). The N'th value in
|
208
|
-
// `bucket_counts` is the count for the overflow bucket (number N-1).
|
209
|
-
repeated int64 bucket_counts = 7;
|
210
|
-
|
211
|
-
// Must be in increasing order of `value` field.
|
212
|
-
repeated Exemplar exemplars = 10;
|
213
|
-
}
|
@@ -1,168 +0,0 @@
|
|
1
|
-
// Copyright 2024 Google LLC
|
2
|
-
//
|
3
|
-
// Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
-
// you may not use this file except in compliance with the License.
|
5
|
-
// You may obtain a copy of the License at
|
6
|
-
//
|
7
|
-
// http://www.apache.org/licenses/LICENSE-2.0
|
8
|
-
//
|
9
|
-
// Unless required by applicable law or agreed to in writing, software
|
10
|
-
// distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
-
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
-
// See the License for the specific language governing permissions and
|
13
|
-
// limitations under the License.
|
14
|
-
|
15
|
-
syntax = "proto3";
|
16
|
-
|
17
|
-
package google.api;
|
18
|
-
|
19
|
-
option go_package = "google.golang.org/genproto/googleapis/api/serviceconfig;serviceconfig";
|
20
|
-
option java_multiple_files = true;
|
21
|
-
option java_outer_classname = "DocumentationProto";
|
22
|
-
option java_package = "com.google.api";
|
23
|
-
option objc_class_prefix = "GAPI";
|
24
|
-
|
25
|
-
// `Documentation` provides the information for describing a service.
|
26
|
-
//
|
27
|
-
// Example:
|
28
|
-
// <pre><code>documentation:
|
29
|
-
// summary: >
|
30
|
-
// The Google Calendar API gives access
|
31
|
-
// to most calendar features.
|
32
|
-
// pages:
|
33
|
-
// - name: Overview
|
34
|
-
// content: (== include google/foo/overview.md ==)
|
35
|
-
// - name: Tutorial
|
36
|
-
// content: (== include google/foo/tutorial.md ==)
|
37
|
-
// subpages:
|
38
|
-
// - name: Java
|
39
|
-
// content: (== include google/foo/tutorial_java.md ==)
|
40
|
-
// rules:
|
41
|
-
// - selector: google.calendar.Calendar.Get
|
42
|
-
// description: >
|
43
|
-
// ...
|
44
|
-
// - selector: google.calendar.Calendar.Put
|
45
|
-
// description: >
|
46
|
-
// ...
|
47
|
-
// </code></pre>
|
48
|
-
// Documentation is provided in markdown syntax. In addition to
|
49
|
-
// standard markdown features, definition lists, tables and fenced
|
50
|
-
// code blocks are supported. Section headers can be provided and are
|
51
|
-
// interpreted relative to the section nesting of the context where
|
52
|
-
// a documentation fragment is embedded.
|
53
|
-
//
|
54
|
-
// Documentation from the IDL is merged with documentation defined
|
55
|
-
// via the config at normalization time, where documentation provided
|
56
|
-
// by config rules overrides IDL provided.
|
57
|
-
//
|
58
|
-
// A number of constructs specific to the API platform are supported
|
59
|
-
// in documentation text.
|
60
|
-
//
|
61
|
-
// In order to reference a proto element, the following
|
62
|
-
// notation can be used:
|
63
|
-
// <pre><code>[fully.qualified.proto.name][]</code></pre>
|
64
|
-
// To override the display text used for the link, this can be used:
|
65
|
-
// <pre><code>[display text][fully.qualified.proto.name]</code></pre>
|
66
|
-
// Text can be excluded from doc using the following notation:
|
67
|
-
// <pre><code>(-- internal comment --)</code></pre>
|
68
|
-
//
|
69
|
-
// A few directives are available in documentation. Note that
|
70
|
-
// directives must appear on a single line to be properly
|
71
|
-
// identified. The `include` directive includes a markdown file from
|
72
|
-
// an external source:
|
73
|
-
// <pre><code>(== include path/to/file ==)</code></pre>
|
74
|
-
// The `resource_for` directive marks a message to be the resource of
|
75
|
-
// a collection in REST view. If it is not specified, tools attempt
|
76
|
-
// to infer the resource from the operations in a collection:
|
77
|
-
// <pre><code>(== resource_for v1.shelves.books ==)</code></pre>
|
78
|
-
// The directive `suppress_warning` does not directly affect documentation
|
79
|
-
// and is documented together with service config validation.
|
80
|
-
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`.
|
85
|
-
string summary = 1;
|
86
|
-
|
87
|
-
// The top level pages for the documentation set.
|
88
|
-
repeated Page pages = 5;
|
89
|
-
|
90
|
-
// A list of documentation rules that apply to individual API elements.
|
91
|
-
//
|
92
|
-
// **NOTE:** All service configuration rules follow "last one wins" order.
|
93
|
-
repeated DocumentationRule rules = 3;
|
94
|
-
|
95
|
-
// The URL to the root of documentation.
|
96
|
-
string documentation_root_url = 4;
|
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
|
-
|
104
|
-
// Declares a single overview page. For example:
|
105
|
-
// <pre><code>documentation:
|
106
|
-
// summary: ...
|
107
|
-
// overview: (== include overview.md ==)
|
108
|
-
// </code></pre>
|
109
|
-
// This is a shortcut for the following declaration (using pages style):
|
110
|
-
// <pre><code>documentation:
|
111
|
-
// summary: ...
|
112
|
-
// pages:
|
113
|
-
// - name: Overview
|
114
|
-
// content: (== include overview.md ==)
|
115
|
-
// </code></pre>
|
116
|
-
// Note: you cannot specify both `overview` field and `pages` field.
|
117
|
-
string overview = 2;
|
118
|
-
}
|
119
|
-
|
120
|
-
// A documentation rule provides information about individual API elements.
|
121
|
-
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.
|
129
|
-
string selector = 1;
|
130
|
-
|
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.
|
134
|
-
string description = 2;
|
135
|
-
|
136
|
-
// Deprecation description of the selected element(s). It can be provided if
|
137
|
-
// an element is marked as `deprecated`.
|
138
|
-
string deprecation_description = 3;
|
139
|
-
}
|
140
|
-
|
141
|
-
// Represents a documentation page. A page can contain subpages to represent
|
142
|
-
// nested documentation set structure.
|
143
|
-
message Page {
|
144
|
-
// The name of the page. It will be used as an identity of the page to
|
145
|
-
// generate URI of the page, text of the link to this page in navigation,
|
146
|
-
// etc. The full page name (start from the root page name to this page
|
147
|
-
// concatenated with `.`) can be used as reference to the page in your
|
148
|
-
// documentation. For example:
|
149
|
-
// <pre><code>pages:
|
150
|
-
// - name: Tutorial
|
151
|
-
// content: (== include tutorial.md ==)
|
152
|
-
// subpages:
|
153
|
-
// - name: Java
|
154
|
-
// content: (== include tutorial_java.md ==)
|
155
|
-
// </code></pre>
|
156
|
-
// You can reference `Java` page using Markdown reference link syntax:
|
157
|
-
// `[Java][Tutorial.Java]`.
|
158
|
-
string name = 1;
|
159
|
-
|
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.
|
163
|
-
string content = 2;
|
164
|
-
|
165
|
-
// Subpages of this page. The order of subpages specified here will be
|
166
|
-
// honored in the generated docset.
|
167
|
-
repeated Page subpages = 3;
|
168
|
-
}
|