Skip to content

Commit 0fdf1a8

Browse files
feat(connectors)!: update the API
BREAKING CHANGE: This release has breaking changes. #### connectors:v1 The following keys were deleted: - schemas.ConnectorVersion.properties.isAsyncOperationsSupported.description - schemas.ConnectorVersion.properties.isAsyncOperationsSupported.readOnly - schemas.ConnectorVersion.properties.isAsyncOperationsSupported.type The following keys were added: - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.description - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.location - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.repeated - resources.projects.resources.locations.methods.list.parameters.extraLocationTypes.type - resources.projects.resources.locations.resources.global.resources.managedZones.methods.list.parameters.returnPartialSuccess.description - resources.projects.resources.locations.resources.global.resources.managedZones.methods.list.parameters.returnPartialSuccess.location - resources.projects.resources.locations.resources.global.resources.managedZones.methods.list.parameters.returnPartialSuccess.type - schemas.ConnectorInfraConfig.properties.provisionMemstore.description - schemas.ConnectorInfraConfig.properties.provisionMemstore.type - schemas.CustomConnectorVersion.properties.asyncOperationsSupport.description - schemas.CustomConnectorVersion.properties.asyncOperationsSupport.type - schemas.CustomConnectorVersion.properties.authConfigTemplates.description - schemas.CustomConnectorVersion.properties.authConfigTemplates.items.$ref - schemas.CustomConnectorVersion.properties.authConfigTemplates.type - schemas.CustomConnectorVersion.properties.authOverrideSupport.description - schemas.CustomConnectorVersion.properties.authOverrideSupport.type - schemas.EventingConfig.properties.sslConfig.$ref - schemas.EventingConfig.properties.sslConfig.description - schemas.EventingConfigTemplate.properties.sslConfigTemplate.$ref - schemas.EventingConfigTemplate.properties.sslConfigTemplate.description - schemas.Instance.properties.consumerProjectNumber.description - schemas.Instance.properties.consumerProjectNumber.type - schemas.ListManagedZonesResponse.properties.unreachable.description - schemas.ListManagedZonesResponse.properties.unreachable.items.type - schemas.ListManagedZonesResponse.properties.unreachable.type - schemas.SupportedRuntimeFeatures.properties.asyncOperations.description - schemas.SupportedRuntimeFeatures.properties.asyncOperations.type The following keys were changed: - schemas.CustomConnector.properties.customConnectorType.enum - schemas.CustomConnector.properties.customConnectorType.enumDescriptions - schemas.CustomConnectorVersion.properties.authConfig.description - schemas.CustomConnectorVersion.properties.backendVariableTemplates.description - schemas.CustomConnectorVersion.properties.destinationConfigs.description - schemas.CustomConnectorVersion.properties.enableBackendDestinationConfig.description - schemas.CustomConnectorVersion.properties.specLocation.description - schemas.CustomConnectorVersion.properties.specServerUrls.description - schemas.EventingConfig.description - schemas.EventingConfigTemplate.description - schemas.ValidateCustomConnectorSpecRequest.properties.specType.enum - schemas.ValidateCustomConnectorSpecRequest.properties.specType.enumDescriptions #### connectors:v2 The following keys were added: - resources.projects.resources.locations.resources.connections.resources.actions.methods.get.parameters.view.description - resources.projects.resources.locations.resources.connections.resources.actions.methods.get.parameters.view.enum - resources.projects.resources.locations.resources.connections.resources.actions.methods.get.parameters.view.enumDescriptions - resources.projects.resources.locations.resources.connections.resources.actions.methods.get.parameters.view.location - resources.projects.resources.locations.resources.connections.resources.actions.methods.get.parameters.view.type - schemas.Instance.properties.consumerProjectNumber.description - schemas.Instance.properties.consumerProjectNumber.type
1 parent a14f291 commit 0fdf1a8

File tree

4 files changed

+150
-31
lines changed

4 files changed

+150
-31
lines changed

‎discovery/connectors-v1.json

Lines changed: 70 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,12 @@
193193
"name"
194194
],
195195
"parameters": {
196+
"extraLocationTypes": {
197+
"description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.",
198+
"location": "query",
199+
"repeated": true,
200+
"type": "string"
201+
},
196202
"filter": {
197203
"description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).",
198204
"location": "query",
@@ -1954,6 +1960,11 @@
19541960
"pattern": "^projects/[^/]+/locations/global$",
19551961
"required": true,
19561962
"type": "string"
1963+
},
1964+
"returnPartialSuccess": {
1965+
"description": "Optional. If true, allow partial responses for multi-regional Aggregated List requests.",
1966+
"location": "query",
1967+
"type": "boolean"
19571968
}
19581969
},
19591970
"path": "v1/{+parent}/managedZones",
@@ -2560,7 +2571,7 @@
25602571
}
25612572
}
25622573
},
2563-
"revision": "20250304",
2574+
"revision": "20250423",
25642575
"rootUrl": "https://connectors.googleapis.com/",
25652576
"schemas": {
25662577
"AuditConfig": {
@@ -3587,6 +3598,10 @@
35873598
"description": "Indicate whether cloud spanner is required for connector job.",
35883599
"type": "boolean"
35893600
},
3601+
"provisionMemstore": {
3602+
"description": "Indicate whether memstore is required for connector job.",
3603+
"type": "boolean"
3604+
},
35903605
"ratelimitThreshold": {
35913606
"description": "Max QPS supported by the connector version before throttling of requests.",
35923607
"format": "int64",
@@ -3666,11 +3681,6 @@
36663681
"description": "Output only. Eventing configuration supported by the Connector.",
36673682
"readOnly": true
36683683
},
3669-
"isAsyncOperationsSupported": {
3670-
"description": "Output only. Is async operations supported.",
3671-
"readOnly": true,
3672-
"type": "boolean"
3673-
},
36743684
"isCustomActionsSupported": {
36753685
"description": "Output only. Is custom actions supported.",
36763686
"readOnly": true,
@@ -3958,12 +3968,14 @@
39583968
"enum": [
39593969
"CUSTOM_CONNECTOR_TYPE_UNSPECIFIED",
39603970
"OPEN_API",
3961-
"PROTO"
3971+
"PROTO",
3972+
"SDK"
39623973
],
39633974
"enumDescriptions": [
39643975
"Connector type is not specified.",
39653976
"OpenAPI connector.",
3966-
"Proto connector."
3977+
"Proto connector.",
3978+
"SDK connector."
39673979
],
39683980
"type": "string"
39693981
},
@@ -4011,12 +4023,27 @@
40114023
"description": "CustomConnectorVersion indicates a specific version of a connector.",
40124024
"id": "CustomConnectorVersion",
40134025
"properties": {
4026+
"asyncOperationsSupport": {
4027+
"description": "Optional. Indicates if Async Operations/Connector Job is supported. This is only available for SDK based custom connectors.",
4028+
"type": "boolean"
4029+
},
40144030
"authConfig": {
40154031
"$ref": "AuthConfig",
4016-
"description": "Optional. Authentication config for accessing connector facade/ proxy. This is used only when enable_backend_destination_config is true."
4032+
"description": "Optional. Authentication config for accessing connector service (facade). This is used only when enable_backend_destination_config is true."
4033+
},
4034+
"authConfigTemplates": {
4035+
"description": "Optional. Auth Config Templates is only used when connector backend is enabled. This is used to specify the auth configs supported by the connector backend service to talk to the actual application backend.",
4036+
"items": {
4037+
"$ref": "AuthConfigTemplate"
4038+
},
4039+
"type": "array"
4040+
},
4041+
"authOverrideSupport": {
4042+
"description": "Optional. Auth override support.",
4043+
"type": "boolean"
40174044
},
40184045
"backendVariableTemplates": {
4019-
"description": "Optional. Backend variables config templates. This translates to additional variable templates in connection.",
4046+
"description": "Optional. Backend variable templates is only used when connector backend is enabled. This is used to specify the variables required by the connector backend service to talk to the actual application backend. This translates to additional variable templates in the connection config.",
40204047
"items": {
40214048
"$ref": "ConfigVariableTemplate"
40224049
},
@@ -4029,14 +4056,14 @@
40294056
"type": "string"
40304057
},
40314058
"destinationConfigs": {
4032-
"description": "Optional. Destination config(s) for accessing connector facade/ proxy. This is used only when enable_backend_destination_config is true.",
4059+
"description": "Optional. Destination config(s) for accessing connector service (facade). This is used only when enable_backend_destination_config is true.",
40334060
"items": {
40344061
"$ref": "DestinationConfig"
40354062
},
40364063
"type": "array"
40374064
},
40384065
"enableBackendDestinationConfig": {
4039-
"description": "Optional. When enabled, the connector will be a facade/ proxy, and connects to the destination provided during connection creation.",
4066+
"description": "Optional. Indicates if an intermediatory connectorservice is used as backend. When this is enabled, the connector destination and connector auth config are required. For SDK based connectors, this is always enabled.",
40404067
"type": "boolean"
40414068
},
40424069
"labels": {
@@ -4065,11 +4092,11 @@
40654092
"type": "string"
40664093
},
40674094
"specLocation": {
4068-
"description": "Optional. Location of the custom connector spec. The location can be either a public url like `https://public-url.com/spec` Or a Google Cloud Storage location like `gs:///`",
4095+
"description": "Optional. Location of the custom connector spec. This is only used for Open API based custom connectors. The location can be either a public url like `https://public-url.com/spec` Or a Google Cloud Storage location like `gs:///`.",
40694096
"type": "string"
40704097
},
40714098
"specServerUrls": {
4072-
"description": "Output only. Server URLs parsed from the spec.",
4099+
"description": "Output only. Server URLs parsed from the Open API spec. This is only used for Open API based custom connectors.",
40734100
"items": {
40744101
"type": "string"
40754102
},
@@ -4641,7 +4668,7 @@
46414668
"type": "object"
46424669
},
46434670
"EventingConfig": {
4644-
"description": "Eventing Configuration of a connection",
4671+
"description": "Eventing Configuration of a connection next: 18",
46454672
"id": "EventingConfig",
46464673
"properties": {
46474674
"additionalVariables": {
@@ -4686,12 +4713,16 @@
46864713
"registrationDestinationConfig": {
46874714
"$ref": "DestinationConfig",
46884715
"description": "Optional. Registration endpoint for auto registration."
4716+
},
4717+
"sslConfig": {
4718+
"$ref": "SslConfig",
4719+
"description": "Optional. Ssl config of a connection"
46894720
}
46904721
},
46914722
"type": "object"
46924723
},
46934724
"EventingConfigTemplate": {
4694-
"description": "Eventing Config details of a connector version.",
4725+
"description": "Eventing Config details of a connector version. next: 14",
46954726
"id": "EventingConfigTemplate",
46964727
"properties": {
46974728
"additionalVariables": {
@@ -4757,6 +4788,10 @@
47574788
"$ref": "DestinationConfigTemplate",
47584789
"description": "Registration host destination config template."
47594790
},
4791+
"sslConfigTemplate": {
4792+
"$ref": "SslConfigTemplate",
4793+
"description": "SSL Config template for the connector version."
4794+
},
47604795
"triggerConfigVariables": {
47614796
"description": "Trigger Config fields that needs to be rendered",
47624797
"items": {
@@ -5414,6 +5449,10 @@
54145449
"description": "consumer_defined_name is the name of the instance set by the service consumers. Generally this is different from the `name` field which reperesents the system-assigned id of the instance which the service consumers do not recognize. This is a required field for tenants onboarding to Maintenance Window notifications (go/slm-rollout-maintenance-policies#prerequisites).",
54155450
"type": "string"
54165451
},
5452+
"consumerProjectNumber": {
5453+
"description": "Optional. The consumer_project_number associated with this Apigee instance. This field is added specifically to support Apigee integration with SLM Rollout and UMM. It represents the numerical project ID of the GCP project that consumes this Apigee instance. It is used for SLM rollout notifications and UMM integration, enabling proper mapping to customer projects and log delivery for Apigee instances. This field complements consumer_project_id and may be used for specific Apigee scenarios where the numerical ID is required.",
5454+
"type": "string"
5455+
},
54175456
"createTime": {
54185457
"description": "Output only. Timestamp when the resource was created.",
54195458
"format": "google-datetime",
@@ -6056,6 +6095,13 @@
60566095
"nextPageToken": {
60576096
"description": "Next page token.",
60586097
"type": "string"
6098+
},
6099+
"unreachable": {
6100+
"description": "Locations that could not be reached.",
6101+
"items": {
6102+
"type": "string"
6103+
},
6104+
"type": "array"
60596105
}
60606106
},
60616107
"type": "object"
@@ -7971,6 +8017,10 @@
79718017
"description": "Specifies if the connector supports action apis like 'executeAction'.",
79728018
"type": "boolean"
79738019
},
8020+
"asyncOperations": {
8021+
"description": "Specifies if the connector supports async long running operations.",
8022+
"type": "boolean"
8023+
},
79748024
"entityApis": {
79758025
"description": "Specifies if the connector supports entity apis like 'createEntity'.",
79768026
"type": "boolean"
@@ -8124,12 +8174,14 @@
81248174
"enum": [
81258175
"CUSTOM_CONNECTOR_TYPE_UNSPECIFIED",
81268176
"OPEN_API",
8127-
"PROTO"
8177+
"PROTO",
8178+
"SDK"
81288179
],
81298180
"enumDescriptions": [
81308181
"Connector type is not specified.",
81318182
"OpenAPI connector.",
8132-
"Proto connector."
8183+
"Proto connector.",
8184+
"SDK connector."
81338185
],
81348186
"type": "string"
81358187
}

‎discovery/connectors-v2.json

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -288,6 +288,21 @@
288288
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/actions/[^/]+$",
289289
"required": true,
290290
"type": "string"
291+
},
292+
"view": {
293+
"description": "Specified view of the action schema.",
294+
"enum": [
295+
"ACTION_SCHEMA_VIEW_UNSPECIFIED",
296+
"ACTION_SCHEMA_VIEW_BASIC",
297+
"ACTION_SCHEMA_VIEW_ENRICHED"
298+
],
299+
"enumDescriptions": [
300+
"VIEW_UNSPECIFIED. The unset value. Defaults to BASIC View.",
301+
"Return basic action schema.",
302+
"Return enriched action schema."
303+
],
304+
"location": "query",
305+
"type": "string"
291306
}
292307
},
293308
"path": "v2/{+name}",
@@ -675,7 +690,7 @@
675690
}
676691
}
677692
},
678-
"revision": "20250304",
693+
"revision": "20250423",
679694
"rootUrl": "https://connectors.googleapis.com/",
680695
"schemas": {
681696
"AccessCredentials": {
@@ -1380,6 +1395,10 @@
13801395
"description": "consumer_defined_name is the name of the instance set by the service consumers. Generally this is different from the `name` field which reperesents the system-assigned id of the instance which the service consumers do not recognize. This is a required field for tenants onboarding to Maintenance Window notifications (go/slm-rollout-maintenance-policies#prerequisites).",
13811396
"type": "string"
13821397
},
1398+
"consumerProjectNumber": {
1399+
"description": "Optional. The consumer_project_number associated with this Apigee instance. This field is added specifically to support Apigee integration with SLM Rollout and UMM. It represents the numerical project ID of the GCP project that consumes this Apigee instance. It is used for SLM rollout notifications and UMM integration, enabling proper mapping to customer projects and log delivery for Apigee instances. This field complements consumer_project_id and may be used for specific Apigee scenarios where the numerical ID is required.",
1400+
"type": "string"
1401+
},
13831402
"createTime": {
13841403
"description": "Output only. Timestamp when the resource was created.",
13851404
"format": "google-datetime",

0 commit comments

Comments
 (0)