Skip to content

Commit

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

The following keys were added:
- schemas.PostgreSql.properties.schemaMigration.description
- schemas.PostgreSql.properties.schemaMigration.enum
- schemas.PostgreSql.properties.schemaMigration.enumDescriptions
- schemas.PostgreSql.properties.schemaMigration.type

The following keys were changed:
- description
- resources.projects.resources.locations.resources.operations.methods.cancel.description
- schemas.ListConnectorsResponse.description
- schemas.ListSchemasResponse.description
- schemas.PostgreSql.properties.schemaValidation.description
  • Loading branch information
yoshi-automation authored and sofisl committed Jan 29, 2025
1 parent bbb3321 commit 7f2b97d
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 11 deletions.
24 changes: 18 additions & 6 deletions discovery/firebasedataconnect-v1beta.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"baseUrl": "https://firebasedataconnect.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Firebase Data Connect",
"description": "",
"description": "Firebase Data Connect is a relational database service for mobile and web apps that lets you build and scale using a fully-managed PostgreSQL database powered by Cloud SQL. The REST API lets developers manage the connections to their database, change the schema of their database, and query the database.",
"discoveryVersion": "v1",
"documentationLink": "https://firebase.google.com/docs/data-connect",
"fullyEncodeReservedExpansion": true,
Expand Down Expand Up @@ -180,7 +180,7 @@
"operations": {
"methods": {
"cancel": {
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "firebasedataconnect.projects.locations.operations.cancel",
Expand Down Expand Up @@ -1070,7 +1070,7 @@
}
}
},
"revision": "20240924",
"revision": "20250105",
"rootUrl": "https://firebasedataconnect.googleapis.com/",
"schemas": {
"CancelOperationRequest": {
Expand Down Expand Up @@ -1384,7 +1384,7 @@
"type": "object"
},
"ListConnectorsResponse": {
"description": "Message for response to listing Connectors.",
"description": "Message for response to listing Connectors. By default, `connectors.source` will not be included in the response. To specify the fields included in the response, the response field mask can be provided by using the query parameter `$fields` or the header `X-Goog-FieldMask`.",
"id": "ListConnectorsResponse",
"properties": {
"connectors": {
Expand Down Expand Up @@ -1445,7 +1445,7 @@
"type": "object"
},
"ListSchemasResponse": {
"description": "Message for response to listing Schemas.",
"description": "Message for response to listing Schemas. By default, `schemas.source` will not be included in the response. To specify the fields included in the response, the response field mask can be provided by using the query parameter `$fields` or the header `X-Goog-FieldMask`.",
"id": "ListSchemasResponse",
"properties": {
"nextPageToken": {
Expand Down Expand Up @@ -1619,8 +1619,20 @@
"description": "Required. Name of the PostgreSQL database.",
"type": "string"
},
"schemaMigration": {
"description": "Optional. Configure how to perform Postgresql schema migration.",
"enum": [
"SQL_SCHEMA_MIGRATION_UNSPECIFIED",
"MIGRATE_COMPATIBLE"
],
"enumDescriptions": [
"Unspecified SQL schema migration.",
"Connect to the SQL database and identify any missing SQL resources used in the given Firebase Data Connect Schema. Automatically create necessary SQL resources (SQL table, column, etc) before deploying the schema. During migration steps, the SQL Schema must comply with the previous before_deploy setting in case the migration is interrupted. Therefore, the previous before_deploy setting must not be `schema_validation=STRICT`."
],
"type": "string"
},
"schemaValidation": {
"description": "Optional. Configure how much Postgresql schema validation to perform. Default to `STRICT` if not specified.",
"description": "Optional. Configure how much Postgresql schema validation to perform.",
"enum": [
"SQL_SCHEMA_VALIDATION_UNSPECIFIED",
"NONE",
Expand Down
14 changes: 9 additions & 5 deletions src/apis/firebasedataconnect/v1beta.ts
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ export namespace firebasedataconnect_v1beta {
/**
* Firebase Data Connect API
*
*
* Firebase Data Connect is a relational database service for mobile and web apps that lets you build and scale using a fully-managed PostgreSQL database powered by Cloud SQL. The REST API lets developers manage the connections to their database, change the schema of their database, and query the database.
*
* @example
* ```js
Expand Down Expand Up @@ -347,7 +347,7 @@ export namespace firebasedataconnect_v1beta {
unauthenticated?: boolean | null;
}
/**
* Message for response to listing Connectors.
* Message for response to listing Connectors. By default, `connectors.source` will not be included in the response. To specify the fields included in the response, the response field mask can be provided by using the query parameter `$fields` or the header `X-Goog-FieldMask`.
*/
export interface Schema$ListConnectorsResponse {
/**
Expand Down Expand Up @@ -390,7 +390,7 @@ export namespace firebasedataconnect_v1beta {
operations?: Schema$Operation[];
}
/**
* Message for response to listing Schemas.
* Message for response to listing Schemas. By default, `schemas.source` will not be included in the response. To specify the fields included in the response, the response field mask can be provided by using the query parameter `$fields` or the header `X-Goog-FieldMask`.
*/
export interface Schema$ListSchemasResponse {
/**
Expand Down Expand Up @@ -519,7 +519,11 @@ export namespace firebasedataconnect_v1beta {
*/
database?: string | null;
/**
* Optional. Configure how much Postgresql schema validation to perform. Default to `STRICT` if not specified.
* Optional. Configure how to perform Postgresql schema migration.
*/
schemaMigration?: string | null;
/**
* Optional. Configure how much Postgresql schema validation to perform.
*/
schemaValidation?: string | null;
/**
Expand Down Expand Up @@ -893,7 +897,7 @@ export namespace firebasedataconnect_v1beta {
}

/**
* Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
* Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
Expand Down

0 comments on commit 7f2b97d

Please sign in to comment.