Skip to content

Commit c4dc7f9

Browse files
yoshi-automationyoshi-automation
committed
feat(serviceusage)!: update the API
BREAKING CHANGE: This release has breaking changes. #### serviceusage:v1beta1 The following keys were deleted: - schemas.GoogleApiServiceusageV2betaAnalysis.properties.analysis.$ref - schemas.GoogleApiServiceusageV2betaAnalysis.properties.analysis.description - schemas.GoogleApiServiceusageV2betaAnalysis.properties.analysis.readOnly The following keys were added: - schemas.Aspect.description - schemas.Aspect.id - schemas.Aspect.properties.kind.description - schemas.Aspect.properties.kind.type - schemas.Aspect.properties.spec.additionalProperties.description - schemas.Aspect.properties.spec.additionalProperties.type - schemas.Aspect.properties.spec.description - schemas.Aspect.properties.spec.type - schemas.Aspect.type - schemas.BackendRule.properties.loadBalancingPolicy.description - schemas.BackendRule.properties.loadBalancingPolicy.type - schemas.ExperimentalFeatures.properties.unversionedPackageDisabled.description - schemas.ExperimentalFeatures.properties.unversionedPackageDisabled.type - schemas.GoogleApiService.properties.aspects.description - schemas.GoogleApiService.properties.aspects.items.$ref - schemas.GoogleApiService.properties.aspects.type - schemas.GoogleApiServiceusageV2betaAnalysis.properties.analysisResult.$ref - schemas.GoogleApiServiceusageV2betaAnalysis.properties.analysisResult.description - schemas.GoogleApiServiceusageV2betaAnalysis.properties.analysisResult.readOnly - schemas.SelectiveGapicGeneration.properties.generateOmittedAsInternal.description - schemas.SelectiveGapicGeneration.properties.generateOmittedAsInternal.type The following keys were changed: - schemas.Documentation.properties.sectionOverrides.description - schemas.DocumentationRule.properties.disableReplacementWords.description - schemas.Page.properties.content.description - schemas.UsageRule.description - schemas.UsageRule.properties.allowUnregisteredCalls.description #### serviceusage:v1 The following keys were deleted: - schemas.GoogleApiServiceusageV2betaAnalysis.properties.analysis.$ref - schemas.GoogleApiServiceusageV2betaAnalysis.properties.analysis.description - schemas.GoogleApiServiceusageV2betaAnalysis.properties.analysis.readOnly The following keys were added: - schemas.Aspect.description - schemas.Aspect.id - schemas.Aspect.properties.kind.description - schemas.Aspect.properties.kind.type - schemas.Aspect.properties.spec.additionalProperties.description - schemas.Aspect.properties.spec.additionalProperties.type - schemas.Aspect.properties.spec.description - schemas.Aspect.properties.spec.type - schemas.Aspect.type - schemas.BackendRule.properties.loadBalancingPolicy.description - schemas.BackendRule.properties.loadBalancingPolicy.type - schemas.ExperimentalFeatures.properties.unversionedPackageDisabled.description - schemas.ExperimentalFeatures.properties.unversionedPackageDisabled.type - schemas.GoogleApiService.properties.aspects.description - schemas.GoogleApiService.properties.aspects.items.$ref - schemas.GoogleApiService.properties.aspects.type - schemas.GoogleApiServiceusageV2betaAnalysis.properties.analysisResult.$ref - schemas.GoogleApiServiceusageV2betaAnalysis.properties.analysisResult.description - schemas.GoogleApiServiceusageV2betaAnalysis.properties.analysisResult.readOnly - schemas.SelectiveGapicGeneration.properties.generateOmittedAsInternal.description - schemas.SelectiveGapicGeneration.properties.generateOmittedAsInternal.type The following keys were changed: - schemas.Documentation.properties.sectionOverrides.description - schemas.DocumentationRule.properties.disableReplacementWords.description - schemas.Page.properties.content.description - schemas.UsageRule.description - schemas.UsageRule.properties.allowUnregisteredCalls.description
1 parent 82325f1 commit c4dc7f9

File tree

4 files changed

+160
-26
lines changed

4 files changed

+160
-26
lines changed

‎discovery/serviceusage-v1.json‎

Lines changed: 45 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -426,7 +426,7 @@
426426
}
427427
}
428428
},
429-
"revision": "20241219",
429+
"revision": "20250227",
430430
"rootUrl": "https://serviceusage.googleapis.com/",
431431
"schemas": {
432432
"AddEnableRulesMetadata": {
@@ -621,6 +621,25 @@
621621
},
622622
"type": "object"
623623
},
624+
"Aspect": {
625+
"description": "Aspect represents Generic aspect. It is used to configure an aspect without making direct changes to service.proto",
626+
"id": "Aspect",
627+
"properties": {
628+
"kind": {
629+
"description": "The type of this aspect configuration.",
630+
"type": "string"
631+
},
632+
"spec": {
633+
"additionalProperties": {
634+
"description": "Properties of the object.",
635+
"type": "any"
636+
},
637+
"description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`.",
638+
"type": "object"
639+
}
640+
},
641+
"type": "object"
642+
},
624643
"AuthProvider": {
625644
"description": "Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
626645
"id": "AuthProvider",
@@ -752,6 +771,10 @@
752771
"description": "The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP \"authorization\" header, and sent to the backend.",
753772
"type": "string"
754773
},
774+
"loadBalancingPolicy": {
775+
"description": "The load balancing policy used for connection to the application backend. Defined as an arbitrary string to accomondate custom load balancing policies supported by the underlying channel, but suggest most users use one of the standard policies, such as the default, \"RoundRobin\".",
776+
"type": "string"
777+
},
755778
"minDeadline": {
756779
"deprecated": true,
757780
"description": "Deprecated, do not use.",
@@ -1260,7 +1283,7 @@
12601283
"type": "array"
12611284
},
12621285
"sectionOverrides": {
1263-
"description": "Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries",
1286+
"description": "Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries",
12641287
"items": {
12651288
"$ref": "Page"
12661289
},
@@ -1290,7 +1313,7 @@
12901313
"type": "string"
12911314
},
12921315
"disableReplacementWords": {
1293-
"description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.",
1316+
"description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled.",
12941317
"type": "string"
12951318
},
12961319
"selector": {
@@ -1537,6 +1560,10 @@
15371560
"restAsyncIoEnabled": {
15381561
"description": "Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages.",
15391562
"type": "boolean"
1563+
},
1564+
"unversionedPackageDisabled": {
1565+
"description": "Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`.",
1566+
"type": "boolean"
15401567
}
15411568
},
15421569
"type": "object"
@@ -1724,6 +1751,13 @@
17241751
},
17251752
"type": "array"
17261753
},
1754+
"aspects": {
1755+
"description": "Configuration aspects. This is a repeated field to allow multiple aspects to be configured. The kind field in each ConfigAspect specifies the type of aspect. The spec field contains the configuration for that aspect. The schema for the spec field is defined by the backend service owners.",
1756+
"items": {
1757+
"$ref": "Aspect"
1758+
},
1759+
"type": "array"
1760+
},
17271761
"authentication": {
17281762
"$ref": "Authentication",
17291763
"description": "Auth configuration."
@@ -2065,7 +2099,7 @@
20652099
"description": "A message to group the analysis information.",
20662100
"id": "GoogleApiServiceusageV2betaAnalysis",
20672101
"properties": {
2068-
"analysis": {
2102+
"analysisResult": {
20692103
"$ref": "GoogleApiServiceusageV2betaAnalysisResult",
20702104
"description": "Output only. Analysis result of updating a policy.",
20712105
"readOnly": true
@@ -3065,7 +3099,7 @@
30653099
"id": "Page",
30663100
"properties": {
30673101
"content": {
3068-
"description": "The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.",
3102+
"description": "The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.",
30693103
"type": "string"
30703104
},
30713105
"name": {
@@ -3338,6 +3372,10 @@
33383372
"description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.",
33393373
"id": "SelectiveGapicGeneration",
33403374
"properties": {
3375+
"generateOmittedAsInternal": {
3376+
"description": "Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns.",
3377+
"type": "boolean"
3378+
},
33413379
"methods": {
33423380
"description": "An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.",
33433381
"items": {
@@ -3562,11 +3600,11 @@
35623600
"type": "object"
35633601
},
35643602
"UsageRule": {
3565-
"description": "Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: \"*\" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: \"google.example.library.v1.LibraryService.CreateBook\" allow_unregistered_calls: true",
3603+
"description": "Usage configuration rules for the service.",
35663604
"id": "UsageRule",
35673605
"properties": {
35683606
"allowUnregisteredCalls": {
3569-
"description": "If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.",
3607+
"description": " Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.",
35703608
"type": "boolean"
35713609
},
35723610
"selector": {

‎discovery/serviceusage-v1beta1.json‎

Lines changed: 45 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -964,7 +964,7 @@
964964
}
965965
}
966966
},
967-
"revision": "20241219",
967+
"revision": "20250227",
968968
"rootUrl": "https://serviceusage.googleapis.com/",
969969
"schemas": {
970970
"AddEnableRulesMetadata": {
@@ -1159,6 +1159,25 @@
11591159
},
11601160
"type": "object"
11611161
},
1162+
"Aspect": {
1163+
"description": "Aspect represents Generic aspect. It is used to configure an aspect without making direct changes to service.proto",
1164+
"id": "Aspect",
1165+
"properties": {
1166+
"kind": {
1167+
"description": "The type of this aspect configuration.",
1168+
"type": "string"
1169+
},
1170+
"spec": {
1171+
"additionalProperties": {
1172+
"description": "Properties of the object.",
1173+
"type": "any"
1174+
},
1175+
"description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`.",
1176+
"type": "object"
1177+
}
1178+
},
1179+
"type": "object"
1180+
},
11621181
"AuthProvider": {
11631182
"description": "Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
11641183
"id": "AuthProvider",
@@ -1290,6 +1309,10 @@
12901309
"description": "The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP \"authorization\" header, and sent to the backend.",
12911310
"type": "string"
12921311
},
1312+
"loadBalancingPolicy": {
1313+
"description": "The load balancing policy used for connection to the application backend. Defined as an arbitrary string to accomondate custom load balancing policies supported by the underlying channel, but suggest most users use one of the standard policies, such as the default, \"RoundRobin\".",
1314+
"type": "string"
1315+
},
12931316
"minDeadline": {
12941317
"deprecated": true,
12951318
"description": "Deprecated, do not use.",
@@ -1837,7 +1860,7 @@
18371860
"type": "array"
18381861
},
18391862
"sectionOverrides": {
1840-
"description": "Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries",
1863+
"description": "Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries",
18411864
"items": {
18421865
"$ref": "Page"
18431866
},
@@ -1867,7 +1890,7 @@
18671890
"type": "string"
18681891
},
18691892
"disableReplacementWords": {
1870-
"description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.",
1893+
"description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled.",
18711894
"type": "string"
18721895
},
18731896
"selector": {
@@ -2114,6 +2137,10 @@
21142137
"restAsyncIoEnabled": {
21152138
"description": "Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages.",
21162139
"type": "boolean"
2140+
},
2141+
"unversionedPackageDisabled": {
2142+
"description": "Disables generation of an unversioned Python package for this client library. This means that the module names will need to be versioned in import statements. For example `import google.cloud.library_v2` instead of `import google.cloud.library`.",
2143+
"type": "boolean"
21172144
}
21182145
},
21192146
"type": "object"
@@ -2301,6 +2328,13 @@
23012328
},
23022329
"type": "array"
23032330
},
2331+
"aspects": {
2332+
"description": "Configuration aspects. This is a repeated field to allow multiple aspects to be configured. The kind field in each ConfigAspect specifies the type of aspect. The spec field contains the configuration for that aspect. The schema for the spec field is defined by the backend service owners.",
2333+
"items": {
2334+
"$ref": "Aspect"
2335+
},
2336+
"type": "array"
2337+
},
23042338
"authentication": {
23052339
"$ref": "Authentication",
23062340
"description": "Auth configuration."
@@ -2642,7 +2676,7 @@
26422676
"description": "A message to group the analysis information.",
26432677
"id": "GoogleApiServiceusageV2betaAnalysis",
26442678
"properties": {
2645-
"analysis": {
2679+
"analysisResult": {
26462680
"$ref": "GoogleApiServiceusageV2betaAnalysisResult",
26472681
"description": "Output only. Analysis result of updating a policy.",
26482682
"readOnly": true
@@ -3774,7 +3808,7 @@
37743808
"id": "Page",
37753809
"properties": {
37763810
"content": {
3777-
"description": "The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.",
3811+
"description": "The Markdown content of the page. You can use ```(== include {path} ==)``` to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.",
37783812
"type": "string"
37793813
},
37803814
"name": {
@@ -4137,6 +4171,10 @@
41374171
"description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.",
41384172
"id": "SelectiveGapicGeneration",
41394173
"properties": {
4174+
"generateOmittedAsInternal": {
4175+
"description": "Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns.",
4176+
"type": "boolean"
4177+
},
41404178
"methods": {
41414179
"description": "An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.",
41424180
"items": {
@@ -4450,11 +4488,11 @@
44504488
"type": "object"
44514489
},
44524490
"UsageRule": {
4453-
"description": "Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: \"*\" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: \"google.example.library.v1.LibraryService.CreateBook\" allow_unregistered_calls: true",
4491+
"description": "Usage configuration rules for the service.",
44544492
"id": "UsageRule",
44554493
"properties": {
44564494
"allowUnregisteredCalls": {
4457-
"description": "If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.",
4495+
"description": " Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.",
44584496
"type": "boolean"
44594497
},
44604498
"selector": {

0 commit comments

Comments
 (0)