Skip to content

Commit

Permalink
feat(serviceconsumermanagement): update the API
Browse files Browse the repository at this point in the history
#### serviceconsumermanagement:v1beta1

The following keys were added:
- schemas.CommonLanguageSettings.properties.selectiveGapicGeneration.$ref
- schemas.CommonLanguageSettings.properties.selectiveGapicGeneration.description
- schemas.ExperimentalFeatures.description
- schemas.ExperimentalFeatures.id
- schemas.ExperimentalFeatures.properties.restAsyncIoEnabled.description
- schemas.ExperimentalFeatures.properties.restAsyncIoEnabled.type
- schemas.ExperimentalFeatures.type
- schemas.MetricDescriptorMetadata.properties.timeSeriesResourceHierarchyLevel.description
- schemas.MetricDescriptorMetadata.properties.timeSeriesResourceHierarchyLevel.items.enum
- schemas.MetricDescriptorMetadata.properties.timeSeriesResourceHierarchyLevel.items.enumDescriptions
- schemas.MetricDescriptorMetadata.properties.timeSeriesResourceHierarchyLevel.items.type
- schemas.MetricDescriptorMetadata.properties.timeSeriesResourceHierarchyLevel.type
- schemas.PythonSettings.properties.experimentalFeatures.$ref
- schemas.PythonSettings.properties.experimentalFeatures.description
- schemas.SelectiveGapicGeneration.description
- schemas.SelectiveGapicGeneration.id
- schemas.SelectiveGapicGeneration.properties.methods.description
- schemas.SelectiveGapicGeneration.properties.methods.items.type
- schemas.SelectiveGapicGeneration.properties.methods.type
- schemas.SelectiveGapicGeneration.type

The following keys were changed:
- schemas.Mixin.description
- schemas.V1beta1DefaultIdentity.properties.email.description

#### serviceconsumermanagement:v1

The following keys were added:
- schemas.CommonLanguageSettings.properties.selectiveGapicGeneration.$ref
- schemas.CommonLanguageSettings.properties.selectiveGapicGeneration.description
- schemas.ExperimentalFeatures.description
- schemas.ExperimentalFeatures.id
- schemas.ExperimentalFeatures.properties.restAsyncIoEnabled.description
- schemas.ExperimentalFeatures.properties.restAsyncIoEnabled.type
- schemas.ExperimentalFeatures.type
- schemas.MetricDescriptorMetadata.properties.timeSeriesResourceHierarchyLevel.description
- schemas.MetricDescriptorMetadata.properties.timeSeriesResourceHierarchyLevel.items.enum
- schemas.MetricDescriptorMetadata.properties.timeSeriesResourceHierarchyLevel.items.enumDescriptions
- schemas.MetricDescriptorMetadata.properties.timeSeriesResourceHierarchyLevel.items.type
- schemas.MetricDescriptorMetadata.properties.timeSeriesResourceHierarchyLevel.type
- schemas.PythonSettings.properties.experimentalFeatures.$ref
- schemas.PythonSettings.properties.experimentalFeatures.description
- schemas.SelectiveGapicGeneration.description
- schemas.SelectiveGapicGeneration.id
- schemas.SelectiveGapicGeneration.properties.methods.description
- schemas.SelectiveGapicGeneration.properties.methods.items.type
- schemas.SelectiveGapicGeneration.properties.methods.type
- schemas.SelectiveGapicGeneration.type

The following keys were changed:
- schemas.Mixin.description
- schemas.V1DefaultIdentity.properties.email.description
  • Loading branch information
yoshi-automation authored and sofisl committed Oct 10, 2024
1 parent 9a161ab commit 70bd2b3
Show file tree
Hide file tree
Showing 4 changed files with 174 additions and 10 deletions.
58 changes: 55 additions & 3 deletions discovery/serviceconsumermanagement-v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -542,7 +542,7 @@
}
}
},
"revision": "20240712",
"revision": "20240929",
"rootUrl": "https://serviceconsumermanagement.googleapis.com/",
"schemas": {
"AddTenantProjectRequest": {
Expand Down Expand Up @@ -966,6 +966,10 @@
"deprecated": true,
"description": "Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest",
"type": "string"
},
"selectiveGapicGeneration": {
"$ref": "SelectiveGapicGeneration",
"description": "Configuration for which RPCs should be generated in the GAPIC client."
}
},
"type": "object"
Expand Down Expand Up @@ -1340,6 +1344,17 @@
},
"type": "object"
},
"ExperimentalFeatures": {
"description": "Experimental features to be included during client library generation. These fields will be deprecated once the feature graduates and is enabled by default.",
"id": "ExperimentalFeatures",
"properties": {
"restAsyncIoEnabled": {
"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.",
"type": "boolean"
}
},
"type": "object"
},
"Field": {
"description": "A single field of a message type.",
"id": "Field",
Expand Down Expand Up @@ -1979,6 +1994,25 @@
"description": "The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.",
"format": "google-duration",
"type": "string"
},
"timeSeriesResourceHierarchyLevel": {
"description": "The scope of the timeseries data of the metric.",
"items": {
"enum": [
"TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED",
"PROJECT",
"ORGANIZATION",
"FOLDER"
],
"enumDescriptions": [
"Do not use this default value.",
"Scopes a metric to a project.",
"Scopes a metric to an organization.",
"Scopes a metric to a folder."
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
Expand All @@ -2003,7 +2037,7 @@
"type": "object"
},
"Mixin": {
"description": "Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v1/{resource=**}:getAcl\"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = \"/v2/{resource=**}\"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/{resource=**}:getAcl\"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\"; } ... }",
"description": "Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v1/{resource=**}:getAcl\"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = \"/v2/{resource=**}\"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inheriting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/{resource=**}:getAcl\"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\"; } ... }",
"id": "Mixin",
"properties": {
"name": {
Expand Down Expand Up @@ -2324,6 +2358,10 @@
"common": {
"$ref": "CommonLanguageSettings",
"description": "Some settings."
},
"experimentalFeatures": {
"$ref": "ExperimentalFeatures",
"description": "Experimental features to be included during client library generation."
}
},
"type": "object"
Expand Down Expand Up @@ -2443,6 +2481,20 @@
},
"type": "object"
},
"SelectiveGapicGeneration": {
"description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.",
"id": "SelectiveGapicGeneration",
"properties": {
"methods": {
"description": "An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Service": {
"description": "`Service` is the root object of Google API service configuration (service config). It describes the basic information about a logical service, such as the service name and the user-facing title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. For more information, see each proto message definition. Example: type: google.api.Service name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar visibility: rules: - selector: \"google.calendar.v3.*\" restriction: PREVIEW backend: rules: - selector: \"google.calendar.v3.*\" address: calendar.example.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: \"*\" requirements: provider_id: google_calendar_auth",
"id": "Service",
Expand Down Expand Up @@ -3125,7 +3177,7 @@
"id": "V1DefaultIdentity",
"properties": {
"email": {
"description": "The email address of the default identity.",
"description": "The email address of the default identity. Calling GenerateDefaultIdentity with a deleted or purged default identity should expect does_not_exist@invalid-project.iam.gserviceaccount.com placeholder email.",
"type": "string"
},
"name": {
Expand Down
58 changes: 55 additions & 3 deletions discovery/serviceconsumermanagement-v1beta1.json
Original file line number Diff line number Diff line change
Expand Up @@ -715,7 +715,7 @@
}
}
},
"revision": "20240712",
"revision": "20240929",
"rootUrl": "https://serviceconsumermanagement.googleapis.com/",
"schemas": {
"Api": {
Expand Down Expand Up @@ -1073,6 +1073,10 @@
"deprecated": true,
"description": "Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest",
"type": "string"
},
"selectiveGapicGeneration": {
"$ref": "SelectiveGapicGeneration",
"description": "Configuration for which RPCs should be generated in the GAPIC client."
}
},
"type": "object"
Expand Down Expand Up @@ -1425,6 +1429,17 @@
},
"type": "object"
},
"ExperimentalFeatures": {
"description": "Experimental features to be included during client library generation. These fields will be deprecated once the feature graduates and is enabled by default.",
"id": "ExperimentalFeatures",
"properties": {
"restAsyncIoEnabled": {
"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.",
"type": "boolean"
}
},
"type": "object"
},
"Field": {
"description": "A single field of a message type.",
"id": "Field",
Expand Down Expand Up @@ -2028,6 +2043,25 @@
"description": "The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.",
"format": "google-duration",
"type": "string"
},
"timeSeriesResourceHierarchyLevel": {
"description": "The scope of the timeseries data of the metric.",
"items": {
"enum": [
"TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED",
"PROJECT",
"ORGANIZATION",
"FOLDER"
],
"enumDescriptions": [
"Do not use this default value.",
"Scopes a metric to a project.",
"Scopes a metric to an organization.",
"Scopes a metric to a folder."
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
Expand All @@ -2052,7 +2086,7 @@
"type": "object"
},
"Mixin": {
"description": "Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v1/{resource=**}:getAcl\"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = \"/v2/{resource=**}\"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/{resource=**}:getAcl\"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\"; } ... }",
"description": "Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v1/{resource=**}:getAcl\"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = \"/v2/{resource=**}\"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inheriting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/{resource=**}:getAcl\"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\"; } ... }",
"id": "Mixin",
"properties": {
"name": {
Expand Down Expand Up @@ -2355,6 +2389,10 @@
"common": {
"$ref": "CommonLanguageSettings",
"description": "Some settings."
},
"experimentalFeatures": {
"$ref": "ExperimentalFeatures",
"description": "Experimental features to be included during client library generation."
}
},
"type": "object"
Expand Down Expand Up @@ -2445,6 +2483,20 @@
},
"type": "object"
},
"SelectiveGapicGeneration": {
"description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.",
"id": "SelectiveGapicGeneration",
"properties": {
"methods": {
"description": "An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Service": {
"description": "`Service` is the root object of Google API service configuration (service config). It describes the basic information about a logical service, such as the service name and the user-facing title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. For more information, see each proto message definition. Example: type: google.api.Service name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar visibility: rules: - selector: \"google.calendar.v3.*\" restriction: PREVIEW backend: rules: - selector: \"google.calendar.v3.*\" address: calendar.example.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: \"*\" requirements: provider_id: google_calendar_auth",
"id": "Service",
Expand Down Expand Up @@ -3247,7 +3299,7 @@
"id": "V1beta1DefaultIdentity",
"properties": {
"email": {
"description": "The email address of the default identity.",
"description": "The email address of the default identity. Calling GenerateDefaultIdentity with a deleted or purged default identity should expect does_not_exist@invalid-project.iam.gserviceaccount.com placeholder email.",
"type": "string"
},
"name": {
Expand Down
Loading

0 comments on commit 70bd2b3

Please sign in to comment.