Skip to content

Commit

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

The following keys were added:
- resources.projects.resources.databases.methods.delete.parameters.freeId.description
- resources.projects.resources.databases.methods.delete.parameters.freeId.location
- resources.projects.resources.databases.methods.delete.parameters.freeId.type
- schemas.GoogleFirestoreAdminV1ExportDocumentsMetadata.properties.namespaceIds.description
- schemas.GoogleFirestoreAdminV1ExportDocumentsMetadata.properties.namespaceIds.items.type
- schemas.GoogleFirestoreAdminV1ExportDocumentsMetadata.properties.namespaceIds.type
- schemas.GoogleFirestoreAdminV1ExportDocumentsRequest.properties.namespaceIds.description
- schemas.GoogleFirestoreAdminV1ExportDocumentsRequest.properties.namespaceIds.items.type
- schemas.GoogleFirestoreAdminV1ExportDocumentsRequest.properties.namespaceIds.type
- schemas.GoogleFirestoreAdminV1ImportDocumentsMetadata.properties.namespaceIds.description
- schemas.GoogleFirestoreAdminV1ImportDocumentsMetadata.properties.namespaceIds.items.type
- schemas.GoogleFirestoreAdminV1ImportDocumentsMetadata.properties.namespaceIds.type
- schemas.GoogleFirestoreAdminV1ImportDocumentsRequest.properties.namespaceIds.description
- schemas.GoogleFirestoreAdminV1ImportDocumentsRequest.properties.namespaceIds.items.type
- schemas.GoogleFirestoreAdminV1ImportDocumentsRequest.properties.namespaceIds.type

The following keys were changed:
- schemas.GoogleFirestoreAdminV1ExportDocumentsMetadata.properties.outputUriPrefix.description
  • Loading branch information
yoshi-automation authored and sofisl committed Feb 2, 2023
1 parent 072eac4 commit d9f11cf
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 4 deletions.
37 changes: 35 additions & 2 deletions discovery/firestore-v1.json
Expand Up @@ -165,6 +165,11 @@
"location": "query",
"type": "string"
},
"freeId": {
"description": "If set, will free the database_id associated with this database. uid will be used as the resource id to identify this deleted database.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Required. A name of the form `projects/{project_id}/databases/{database_id}`",
"location": "path",
Expand Down Expand Up @@ -1423,7 +1428,7 @@
}
}
},
"revision": "20221210",
"revision": "20230126",
"rootUrl": "https://firestore.googleapis.com/",
"schemas": {
"Aggregation": {
Expand Down Expand Up @@ -2074,6 +2079,13 @@
"format": "google-datetime",
"type": "string"
},
"namespaceIds": {
"description": "Which namespace ids are being exported.",
"items": {
"type": "string"
},
"type": "array"
},
"operationState": {
"description": "The state of the export operation.",
"enum": [
Expand All @@ -2099,7 +2111,7 @@
"type": "string"
},
"outputUriPrefix": {
"description": "Where the entities are being exported to.",
"description": "Where the documents are being exported to.",
"type": "string"
},
"progressBytes": {
Expand Down Expand Up @@ -2129,6 +2141,13 @@
},
"type": "array"
},
"namespaceIds": {
"description": "An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces. An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.",
"items": {
"type": "string"
},
"type": "array"
},
"outputUriPrefix": {
"description": "The output URI. Currently only supports Google Cloud Storage URIs of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional Google Cloud Storage namespace path. When choosing a name, be sure to consider Google Cloud Storage naming guidelines: https://cloud.google.com/storage/docs/naming. If the URI is a bucket (without a namespace path), a prefix will be generated based on the start time.",
"type": "string"
Expand Down Expand Up @@ -2250,6 +2269,13 @@
"description": "The location of the documents being imported.",
"type": "string"
},
"namespaceIds": {
"description": "Which namespace ids are being imported.",
"items": {
"type": "string"
},
"type": "array"
},
"operationState": {
"description": "The state of the import operation.",
"enum": [
Expand Down Expand Up @@ -2304,6 +2330,13 @@
"inputUriPrefix": {
"description": "Location of the exported files. This must match the output_uri_prefix of an ExportDocumentsResponse from an export that has completed successfully. See: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix.",
"type": "string"
},
"namespaceIds": {
"description": "An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces. An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
Expand Down
28 changes: 26 additions & 2 deletions src/apis/firestore/v1.ts
Expand Up @@ -560,12 +560,16 @@ export namespace firestore_v1 {
* The time this operation completed. Will be unset if operation still in progress.
*/
endTime?: string | null;
/**
* Which namespace ids are being exported.
*/
namespaceIds?: string[] | null;
/**
* The state of the export operation.
*/
operationState?: string | null;
/**
* Where the entities are being exported to.
* Where the documents are being exported to.
*/
outputUriPrefix?: string | null;
/**
Expand All @@ -589,6 +593,10 @@ export namespace firestore_v1 {
* Which collection ids to export. Unspecified means all collections.
*/
collectionIds?: string[] | null;
/**
* An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces. An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.
*/
namespaceIds?: string[] | null;
/**
* The output URI. Currently only supports Google Cloud Storage URIs of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional Google Cloud Storage namespace path. When choosing a name, be sure to consider Google Cloud Storage naming guidelines: https://cloud.google.com/storage/docs/naming. If the URI is a bucket (without a namespace path), a prefix will be generated based on the start time.
*/
Expand Down Expand Up @@ -673,6 +681,10 @@ export namespace firestore_v1 {
* The location of the documents being imported.
*/
inputUriPrefix?: string | null;
/**
* Which namespace ids are being imported.
*/
namespaceIds?: string[] | null;
/**
* The state of the import operation.
*/
Expand Down Expand Up @@ -702,6 +714,10 @@ export namespace firestore_v1 {
* Location of the exported files. This must match the output_uri_prefix of an ExportDocumentsResponse from an export that has completed successfully. See: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix.
*/
inputUriPrefix?: string | null;
/**
* An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces. An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.
*/
namespaceIds?: string[] | null;
}
/**
* Cloud Firestore indexes enable simple and complex queries against documents in a database.
Expand Down Expand Up @@ -1767,6 +1783,8 @@ export namespace firestore_v1 {
* allowMissing: 'placeholder-value',
* // The current etag of the Database. If an etag is provided and does not match the current etag of the database, deletion will be blocked and a FAILED_PRECONDITION error will be returned.
* etag: 'placeholder-value',
* // If set, will free the database_id associated with this database. uid will be used as the resource id to identify this deleted database.
* freeId: 'placeholder-value',
* // Required. A name of the form `projects/{project_id\}/databases/{database_id\}`
* name: 'projects/my-project/databases/my-database',
* // If set, validate the request and preview the response, but do not actually delete the database.
Expand Down Expand Up @@ -1917,6 +1935,7 @@ export namespace firestore_v1 {
* // request body parameters
* // {
* // "collectionIds": [],
* // "namespaceIds": [],
* // "outputUriPrefix": "my_outputUriPrefix"
* // }
* },
Expand Down Expand Up @@ -2213,7 +2232,8 @@ export namespace firestore_v1 {
* // request body parameters
* // {
* // "collectionIds": [],
* // "inputUriPrefix": "my_inputUriPrefix"
* // "inputUriPrefix": "my_inputUriPrefix",
* // "namespaceIds": []
* // }
* },
* });
Expand Down Expand Up @@ -2651,6 +2671,10 @@ export namespace firestore_v1 {
* The current etag of the Database. If an etag is provided and does not match the current etag of the database, deletion will be blocked and a FAILED_PRECONDITION error will be returned.
*/
etag?: string;
/**
* If set, will free the database_id associated with this database. uid will be used as the resource id to identify this deleted database.
*/
freeId?: boolean;
/**
* Required. A name of the form `projects/{project_id\}/databases/{database_id\}`
*/
Expand Down

0 comments on commit d9f11cf

Please sign in to comment.