Skip to content

Commit 48814ae

Browse files
feat(servicemanagement): update the API
#### servicemanagement:v1 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.SelectiveGapicGeneration.properties.generateOmittedAsInternal.description - schemas.SelectiveGapicGeneration.properties.generateOmittedAsInternal.type - schemas.Service.properties.aspects.description - schemas.Service.properties.aspects.items.$ref - schemas.Service.properties.aspects.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 cd71b24 commit 48814ae

File tree

2 files changed

+78
-11
lines changed

2 files changed

+78
-11
lines changed

discovery/servicemanagement-v1.json

Lines changed: 44 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -830,7 +830,7 @@
830830
}
831831
}
832832
},
833-
"revision": "20241202",
833+
"revision": "20250228",
834834
"rootUrl": "https://servicemanagement.googleapis.com/",
835835
"schemas": {
836836
"Advice": {
@@ -898,6 +898,25 @@
898898
},
899899
"type": "object"
900900
},
901+
"Aspect": {
902+
"description": "Aspect represents Generic aspect. It is used to configure an aspect without making direct changes to service.proto",
903+
"id": "Aspect",
904+
"properties": {
905+
"kind": {
906+
"description": "The type of this aspect configuration.",
907+
"type": "string"
908+
},
909+
"spec": {
910+
"additionalProperties": {
911+
"description": "Properties of the object.",
912+
"type": "any"
913+
},
914+
"description": "Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`.",
915+
"type": "object"
916+
}
917+
},
918+
"type": "object"
919+
},
901920
"AuditConfig": {
902921
"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:[email protected]\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:[email protected]\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `[email protected]` from DATA_READ logging, and `[email protected]` from DATA_WRITE logging.",
903922
"id": "AuditConfig",
@@ -1077,6 +1096,10 @@
10771096
"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.",
10781097
"type": "string"
10791098
},
1099+
"loadBalancingPolicy": {
1100+
"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\".",
1101+
"type": "string"
1102+
},
10801103
"minDeadline": {
10811104
"deprecated": true,
10821105
"description": "Deprecated, do not use.",
@@ -1595,7 +1618,7 @@
15951618
"type": "array"
15961619
},
15971620
"sectionOverrides": {
1598-
"description": "Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries",
1621+
"description": "Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries",
15991622
"items": {
16001623
"$ref": "Page"
16011624
},
@@ -1625,7 +1648,7 @@
16251648
"type": "string"
16261649
},
16271650
"disableReplacementWords": {
1628-
"description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.",
1651+
"description": "String of comma or space separated case-sensitive words for which method/field name replacement will be disabled.",
16291652
"type": "string"
16301653
},
16311654
"selector": {
@@ -1794,6 +1817,10 @@
17941817
"restAsyncIoEnabled": {
17951818
"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.",
17961819
"type": "boolean"
1820+
},
1821+
"unversionedPackageDisabled": {
1822+
"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`.",
1823+
"type": "boolean"
17971824
}
17981825
},
17991826
"type": "object"
@@ -2885,7 +2912,7 @@
28852912
"id": "Page",
28862913
"properties": {
28872914
"content": {
2888-
"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.",
2915+
"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.",
28892916
"type": "string"
28902917
},
28912918
"name": {
@@ -3198,6 +3225,10 @@
31983225
"description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.",
31993226
"id": "SelectiveGapicGeneration",
32003227
"properties": {
3228+
"generateOmittedAsInternal": {
3229+
"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.",
3230+
"type": "boolean"
3231+
},
32013232
"methods": {
32023233
"description": "An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.",
32033234
"items": {
@@ -3219,6 +3250,13 @@
32193250
},
32203251
"type": "array"
32213252
},
3253+
"aspects": {
3254+
"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.",
3255+
"items": {
3256+
"$ref": "Aspect"
3257+
},
3258+
"type": "array"
3259+
},
32223260
"authentication": {
32233261
"$ref": "Authentication",
32243262
"description": "Auth configuration."
@@ -3666,11 +3704,11 @@
36663704
"type": "object"
36673705
},
36683706
"UsageRule": {
3669-
"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",
3707+
"description": "Usage configuration rules for the service.",
36703708
"id": "UsageRule",
36713709
"properties": {
36723710
"allowUnregisteredCalls": {
3673-
"description": "If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.",
3711+
"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.",
36743712
"type": "boolean"
36753713
},
36763714
"selector": {

src/apis/servicemanagement/v1.ts

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,19 @@ export namespace servicemanagement_v1 {
168168
*/
169169
version?: string | null;
170170
}
171+
/**
172+
* Aspect represents Generic aspect. It is used to configure an aspect without making direct changes to service.proto
173+
*/
174+
export interface Schema$Aspect {
175+
/**
176+
* The type of this aspect configuration.
177+
*/
178+
kind?: string | null;
179+
/**
180+
* Content of the configuration. The underlying schema should be defined by Aspect owners as protobuf message under `apiserving/configaspects/proto`.
181+
*/
182+
spec?: {[key: string]: any} | null;
183+
}
171184
/**
172185
* Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \}, { "log_type": "ADMIN_READ" \} ] \}, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" \}, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] \} ] \} ] \} For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `[email protected]` from DATA_READ logging, and `[email protected]` from DATA_WRITE logging.
173186
*/
@@ -299,6 +312,10 @@ export namespace servicemanagement_v1 {
299312
* 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.
300313
*/
301314
jwtAudience?: string | null;
315+
/**
316+
* 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".
317+
*/
318+
loadBalancingPolicy?: string | null;
302319
/**
303320
* Deprecated, do not use.
304321
*/
@@ -640,7 +657,7 @@ export namespace servicemanagement_v1 {
640657
*/
641658
rules?: Schema$DocumentationRule[];
642659
/**
643-
* Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
660+
* Specifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries
644661
*/
645662
sectionOverrides?: Schema$Page[];
646663
/**
@@ -665,7 +682,7 @@ export namespace servicemanagement_v1 {
665682
*/
666683
description?: string | null;
667684
/**
668-
* String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
685+
* String of comma or space separated case-sensitive words for which method/field name replacement will be disabled.
669686
*/
670687
disableReplacementWords?: string | null;
671688
/**
@@ -785,6 +802,10 @@ export namespace servicemanagement_v1 {
785802
* 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.
786803
*/
787804
restAsyncIoEnabled?: boolean | null;
805+
/**
806+
* 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`.
807+
*/
808+
unversionedPackageDisabled?: boolean | null;
788809
}
789810
/**
790811
* Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
@@ -1502,7 +1523,7 @@ export namespace servicemanagement_v1 {
15021523
*/
15031524
export interface Schema$Page {
15041525
/**
1505-
* 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.
1526+
* 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.
15061527
*/
15071528
content?: string | null;
15081529
/**
@@ -1723,6 +1744,10 @@ export namespace servicemanagement_v1 {
17231744
* This message is used to configure the generation of a subset of the RPCs in a service for client libraries.
17241745
*/
17251746
export interface Schema$SelectiveGapicGeneration {
1747+
/**
1748+
* 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.
1749+
*/
1750+
generateOmittedAsInternal?: boolean | null;
17261751
/**
17271752
* An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.
17281753
*/
@@ -1736,6 +1761,10 @@ export namespace servicemanagement_v1 {
17361761
* A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files.
17371762
*/
17381763
apis?: Schema$Api[];
1764+
/**
1765+
* 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.
1766+
*/
1767+
aspects?: Schema$Aspect[];
17391768
/**
17401769
* Auth configuration.
17411770
*/
@@ -2054,11 +2083,11 @@ export namespace servicemanagement_v1 {
20542083
rules?: Schema$UsageRule[];
20552084
}
20562085
/**
2057-
* 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
2086+
* Usage configuration rules for the service.
20582087
*/
20592088
export interface Schema$UsageRule {
20602089
/**
2061-
* If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
2090+
* 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.
20622091
*/
20632092
allowUnregisteredCalls?: boolean | null;
20642093
/**

0 commit comments

Comments
 (0)