Skip to content

Commit 63c47c4

Browse files
yoshi-automationsofisl
authored andcommitted
feat(servicecontrol)!: update the API
BREAKING CHANGE: This release has breaking changes. #### servicecontrol:v1 The following keys were deleted: - schemas.Auth.properties.credentialId.description - schemas.Auth.properties.credentialId.type The following keys were changed: - schemas.Attributes.properties.attributeMap.description - schemas.CheckError.properties.code.enumDescriptions - schemas.HttpRequest.properties.referer.description - schemas.V1HttpRequest.properties.referer.description #### servicecontrol:v2 The following keys were deleted: - schemas.Auth.properties.credentialId.description - schemas.Auth.properties.credentialId.type The following keys were added: - schemas.CheckResponse.properties.dynamicMetadata.additionalProperties.description - schemas.CheckResponse.properties.dynamicMetadata.additionalProperties.type - schemas.CheckResponse.properties.dynamicMetadata.description - schemas.CheckResponse.properties.dynamicMetadata.type The following keys were changed: - schemas.V2HttpRequest.properties.referer.description
1 parent 001b43a commit 63c47c4

File tree

4 files changed

+23
-27
lines changed

4 files changed

+23
-27
lines changed

‎discovery/servicecontrol-v1.json

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@
197197
}
198198
}
199199
},
200-
"revision": "20240802",
200+
"revision": "20250117",
201201
"rootUrl": "https://servicecontrol.googleapis.com/",
202202
"schemas": {
203203
"AllocateInfo": {
@@ -289,7 +289,7 @@
289289
"additionalProperties": {
290290
"$ref": "AttributeValue"
291291
},
292-
"description": "The set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the Boolean values `true` and `false`. For example: \"/instance_id\": \"my-instance\" \"/http/user_agent\": \"\" \"/http/request_bytes\": 300 \"abc.com/myattribute\": true",
292+
"description": "The set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the Boolean values `true` and `false`. For example: \"/instance_id\": \"my-instance\" \"/http/user_agent\": \"\" \"/http/request_bytes\": 300 \"example.com/myattribute\": true",
293293
"type": "object"
294294
},
295295
"droppedAttributesCount": {
@@ -418,10 +418,6 @@
418418
"description": "Structured claims presented with the credential. JWTs include `{key: value}` pairs for standard and private claims. The following is a subset of the standard required and optional claims that would typically be presented for a Google-based JWT: {'iss': 'accounts.google.com', 'sub': '113289723416554971153', 'aud': ['123456789012', 'pubsub.googleapis.com'], 'azp': '123456789012.apps.googleusercontent.com', 'email': 'jsmith@example.com', 'iat': 1353601026, 'exp': 1353604926} SAML assertions are similarly specified, but with an identity provider dependent structure.",
419419
"type": "object"
420420
},
421-
"credentialId": {
422-
"description": "Identifies the client credential id used for authentication. credential_id is in the format of AUTH_METHOD:IDENTIFIER, e.g. \"serviceaccount:XXXXX, apikey:XXXXX\" where the format of the IDENTIFIER can vary for different AUTH_METHODs.",
423-
"type": "string"
424-
},
425421
"presenter": {
426422
"description": "The authorized presenter of the credential. Reflects the optional Authorized Presenter (`azp`) claim within a JWT or the OAuth client id. For example, a Google Cloud Platform client id looks as follows: \"123456789012.apps.googleusercontent.com\".",
427423
"type": "string"
@@ -596,7 +592,7 @@
596592
"The backend server for checking quota limits is unavailable.",
597593
"The Spanner for looking up LOAS project is unavailable.",
598594
"Cloud Resource Manager backend server is unavailable.",
599-
"NOTE: for customers in the scope of Beta/GA of https://cloud.google.com/vpc-service-controls, this error is no longer returned. If the security backend is unavailable, rpc UNAVAILABLE status will be returned instead. It should be ignored and should not be used to reject client requests.",
595+
"NOTE: for customers in the scope of Beta/GA of https://cloud.google.com/vpc-service-controls, this error is no longer returned. If the security backend is unavailable: For Fail open requests, error is ignored and request is allowed. For Fail close requests, rpc UNAVAILABLE status will be returned instead. It should be ignored and should not be used to reject client requests.",
600596
"Backend server for evaluating location policy is unavailable.",
601597
"Part of the project of fault injection: go/chemist-slo-validation. To distinguish between artificially injected errors and organic ones, this value will be exported for the per_service_check_error_count streamz. http://google3/apiserving/servicecontrol/server/controller_service.cc;l=196 Rpcinjectz2 works by injecting errors early in the rpc life cycle, before any of the chemist business logic runs."
602598
],
@@ -905,7 +901,7 @@
905901
"type": "string"
906902
},
907903
"referer": {
908-
"description": "The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).",
904+
"description": "The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).",
909905
"type": "string"
910906
},
911907
"remoteIp": {
@@ -1994,7 +1990,7 @@
19941990
"type": "string"
19951991
},
19961992
"referer": {
1997-
"description": "The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).",
1993+
"description": "The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).",
19981994
"type": "string"
19991995
},
20001996
"remoteIp": {

‎discovery/servicecontrol-v2.json

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@
169169
}
170170
}
171171
},
172-
"revision": "20240802",
172+
"revision": "20250103",
173173
"rootUrl": "https://servicecontrol.googleapis.com/",
174174
"schemas": {
175175
"Api": {
@@ -359,10 +359,6 @@
359359
"description": "Structured claims presented with the credential. JWTs include `{key: value}` pairs for standard and private claims. The following is a subset of the standard required and optional claims that would typically be presented for a Google-based JWT: {'iss': 'accounts.google.com', 'sub': '113289723416554971153', 'aud': ['123456789012', 'pubsub.googleapis.com'], 'azp': '123456789012.apps.googleusercontent.com', 'email': 'jsmith@example.com', 'iat': 1353601026, 'exp': 1353604926} SAML assertions are similarly specified, but with an identity provider dependent structure.",
360360
"type": "object"
361361
},
362-
"credentialId": {
363-
"description": "Identifies the client credential id used for authentication. credential_id is in the format of AUTH_METHOD:IDENTIFIER, e.g. \"serviceaccount:XXXXX, apikey:XXXXX\" where the format of the IDENTIFIER can vary for different AUTH_METHODs.",
364-
"type": "string"
365-
},
366362
"presenter": {
367363
"description": "The authorized presenter of the credential. Reflects the optional Authorized Presenter (`azp`) claim within a JWT or the OAuth client id. For example, a Google Cloud Platform client id looks as follows: \"123456789012.apps.googleusercontent.com\".",
368364
"type": "string"
@@ -487,6 +483,14 @@
487483
"description": "Response message for the Check method.",
488484
"id": "CheckResponse",
489485
"properties": {
486+
"dynamicMetadata": {
487+
"additionalProperties": {
488+
"description": "Properties of the object.",
489+
"type": "any"
490+
},
491+
"description": "Optional response metadata that will be emitted as dynamic metadata to be consumed by the caller of ServiceController. For compatibility with the ext_authz interface.",
492+
"type": "object"
493+
},
490494
"headers": {
491495
"additionalProperties": {
492496
"type": "string"
@@ -1007,7 +1011,7 @@
10071011
"type": "string"
10081012
},
10091013
"referer": {
1010-
"description": "The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).",
1014+
"description": "The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).",
10111015
"type": "string"
10121016
},
10131017
"remoteIp": {

‎src/apis/servicecontrol/v1.ts

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ export namespace servicecontrol_v1 {
173173
*/
174174
export interface Schema$Attributes {
175175
/**
176-
* The set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the Boolean values `true` and `false`. For example: "/instance_id": "my-instance" "/http/user_agent": "" "/http/request_bytes": 300 "abc.com/myattribute": true
176+
* The set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the Boolean values `true` and `false`. For example: "/instance_id": "my-instance" "/http/user_agent": "" "/http/request_bytes": 300 "example.com/myattribute": true
177177
*/
178178
attributeMap?: {[key: string]: Schema$AttributeValue} | null;
179179
/**
@@ -279,10 +279,6 @@ export namespace servicecontrol_v1 {
279279
* Structured claims presented with the credential. JWTs include `{key: value\}` pairs for standard and private claims. The following is a subset of the standard required and optional claims that would typically be presented for a Google-based JWT: {'iss': 'accounts.google.com', 'sub': '113289723416554971153', 'aud': ['123456789012', 'pubsub.googleapis.com'], 'azp': '123456789012.apps.googleusercontent.com', 'email': 'jsmith@example.com', 'iat': 1353601026, 'exp': 1353604926\} SAML assertions are similarly specified, but with an identity provider dependent structure.
280280
*/
281281
claims?: {[key: string]: any} | null;
282-
/**
283-
* Identifies the client credential id used for authentication. credential_id is in the format of AUTH_METHOD:IDENTIFIER, e.g. "serviceaccount:XXXXX, apikey:XXXXX" where the format of the IDENTIFIER can vary for different AUTH_METHODs.
284-
*/
285-
credentialId?: string | null;
286282
/**
287283
* The authorized presenter of the credential. Reflects the optional Authorized Presenter (`azp`) claim within a JWT or the OAuth client id. For example, a Google Cloud Platform client id looks as follows: "123456789012.apps.googleusercontent.com".
288284
*/
@@ -585,7 +581,7 @@ export namespace servicecontrol_v1 {
585581
*/
586582
protocol?: string | null;
587583
/**
588-
* The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
584+
* The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
589585
*/
590586
referer?: string | null;
591587
/**
@@ -1369,7 +1365,7 @@ export namespace servicecontrol_v1 {
13691365
*/
13701366
protocol?: string | null;
13711367
/**
1372-
* The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
1368+
* The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
13731369
*/
13741370
referer?: string | null;
13751371
/**

‎src/apis/servicecontrol/v2.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -263,10 +263,6 @@ export namespace servicecontrol_v2 {
263263
* Structured claims presented with the credential. JWTs include `{key: value\}` pairs for standard and private claims. The following is a subset of the standard required and optional claims that would typically be presented for a Google-based JWT: {'iss': 'accounts.google.com', 'sub': '113289723416554971153', 'aud': ['123456789012', 'pubsub.googleapis.com'], 'azp': '123456789012.apps.googleusercontent.com', 'email': 'jsmith@example.com', 'iat': 1353601026, 'exp': 1353604926\} SAML assertions are similarly specified, but with an identity provider dependent structure.
264264
*/
265265
claims?: {[key: string]: any} | null;
266-
/**
267-
* Identifies the client credential id used for authentication. credential_id is in the format of AUTH_METHOD:IDENTIFIER, e.g. "serviceaccount:XXXXX, apikey:XXXXX" where the format of the IDENTIFIER can vary for different AUTH_METHODs.
268-
*/
269-
credentialId?: string | null;
270266
/**
271267
* The authorized presenter of the credential. Reflects the optional Authorized Presenter (`azp`) claim within a JWT or the OAuth client id. For example, a Google Cloud Platform client id looks as follows: "123456789012.apps.googleusercontent.com".
272268
*/
@@ -359,6 +355,10 @@ export namespace servicecontrol_v2 {
359355
* Response message for the Check method.
360356
*/
361357
export interface Schema$CheckResponse {
358+
/**
359+
* Optional response metadata that will be emitted as dynamic metadata to be consumed by the caller of ServiceController. For compatibility with the ext_authz interface.
360+
*/
361+
dynamicMetadata?: {[key: string]: any} | null;
362362
/**
363363
* Returns a set of request contexts generated from the `CheckRequest`.
364364
*/
@@ -763,7 +763,7 @@ export namespace servicecontrol_v2 {
763763
*/
764764
protocol?: string | null;
765765
/**
766-
* The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
766+
* The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
767767
*/
768768
referer?: string | null;
769769
/**

0 commit comments

Comments
 (0)