Skip to content

Commit b4bc88d

Browse files
yoshi-automationsofisl
authored andcommitted
feat(firestore): update the API
#### firestore:v1beta1 The following keys were changed: - schemas.FindNearest.properties.distanceThreshold.description - schemas.StructuredQuery.description #### firestore:v1 The following keys were added: - schemas.GoogleFirestoreAdminV1Index.properties.density.description - schemas.GoogleFirestoreAdminV1Index.properties.density.enum - schemas.GoogleFirestoreAdminV1Index.properties.density.enumDescriptions - schemas.GoogleFirestoreAdminV1Index.properties.density.type - schemas.GoogleFirestoreAdminV1Index.properties.multikey.description - schemas.GoogleFirestoreAdminV1Index.properties.multikey.type The following keys were changed: - resources.projects.resources.databases.resources.operations.methods.cancel.description - schemas.FindNearest.properties.distanceThreshold.description - schemas.GoogleFirestoreAdminV1Index.properties.apiScope.enum - schemas.GoogleFirestoreAdminV1Index.properties.apiScope.enumDescriptions - schemas.StructuredQuery.description
1 parent d1b06fe commit b4bc88d

File tree

4 files changed

+44
-14
lines changed

4 files changed

+44
-14
lines changed

‎discovery/firestore-v1.json

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1421,7 +1421,7 @@
14211421
"operations": {
14221422
"methods": {
14231423
"cancel": {
1424-
"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`.",
1424+
"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`.",
14251425
"flatPath": "v1/projects/{projectsId}/databases/{databasesId}/operations/{operationsId}:cancel",
14261426
"httpMethod": "POST",
14271427
"id": "firestore.projects.databases.operations.cancel",
@@ -1711,7 +1711,7 @@
17111711
}
17121712
}
17131713
},
1714-
"revision": "20240904",
1714+
"revision": "20250120",
17151715
"rootUrl": "https://firestore.googleapis.com/",
17161716
"schemas": {
17171717
"Aggregation": {
@@ -2417,7 +2417,7 @@
24172417
"type": "string"
24182418
},
24192419
"distanceThreshold": {
2420-
"description": "Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold For DOT_PRODUCT: WHERE distance >= distance_threshold",
2420+
"description": "Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance >= distance_threshold",
24212421
"format": "double",
24222422
"type": "number"
24232423
},
@@ -3150,11 +3150,29 @@
31503150
"description": "The API scope supported by this index.",
31513151
"enum": [
31523152
"ANY_API",
3153-
"DATASTORE_MODE_API"
3153+
"DATASTORE_MODE_API",
3154+
"IGNITE_API"
31543155
],
31553156
"enumDescriptions": [
31563157
"The index can only be used by the Firestore Native query API. This is the default.",
3157-
"The index can only be used by the Firestore in Datastore Mode query API."
3158+
"The index can only be used by the Firestore in Datastore Mode query API.",
3159+
"The index can only be used by Ignite."
3160+
],
3161+
"type": "string"
3162+
},
3163+
"density": {
3164+
"description": "Immutable. The density configuration of the index.",
3165+
"enum": [
3166+
"DENSITY_UNSPECIFIED",
3167+
"SPARSE_ALL",
3168+
"SPARSE_ANY",
3169+
"DENSE"
3170+
],
3171+
"enumDescriptions": [
3172+
"Unspecified. It will use database default setting. This value is input only.",
3173+
"In order for an index entry to be added, the document must contain all fields specified in the index. This is the only allowed value for indexes having ApiScope `ANY_API` and `DATASTORE_MODE_API`.",
3174+
"In order for an index entry to be added, the document must contain at least one of the fields specified in the index. Non-existent fields are treated as having a NULL value when generating index entries.",
3175+
"An index entry will be added regardless of whether the document contains any of the fields specified in the index. Non-existent fields are treated as having a NULL value when generating index entries."
31583176
],
31593177
"type": "string"
31603178
},
@@ -3165,6 +3183,10 @@
31653183
},
31663184
"type": "array"
31673185
},
3186+
"multikey": {
3187+
"description": "Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to index with IGNITE_API ApiScope.",
3188+
"type": "boolean"
3189+
},
31683190
"name": {
31693191
"description": "Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty.",
31703192
"type": "string"
@@ -4264,7 +4286,7 @@
42644286
"type": "object"
42654287
},
42664288
"StructuredQuery": {
4267-
"description": "A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit",
4289+
"description": "A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7. find_nearest",
42684290
"id": "StructuredQuery",
42694291
"properties": {
42704292
"endAt": {

‎discovery/firestore-v1beta1.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -950,7 +950,7 @@
950950
}
951951
}
952952
},
953-
"revision": "20240822",
953+
"revision": "20241018",
954954
"rootUrl": "https://firestore.googleapis.com/",
955955
"schemas": {
956956
"Aggregation": {
@@ -1656,7 +1656,7 @@
16561656
"type": "string"
16571657
},
16581658
"distanceThreshold": {
1659-
"description": "Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold For DOT_PRODUCT: WHERE distance >= distance_threshold",
1659+
"description": "Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance >= distance_threshold",
16601660
"format": "double",
16611661
"type": "number"
16621662
},
@@ -2654,7 +2654,7 @@
26542654
"type": "object"
26552655
},
26562656
"StructuredQuery": {
2657-
"description": "A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit",
2657+
"description": "A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7. find_nearest",
26582658
"id": "StructuredQuery",
26592659
"properties": {
26602660
"endAt": {

‎src/apis/firestore/v1.ts

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -618,7 +618,7 @@ export namespace firestore_v1 {
618618
*/
619619
distanceResultField?: string | null;
620620
/**
621-
* Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold For DOT_PRODUCT: WHERE distance \>= distance_threshold
621+
* Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance \>= distance_threshold
622622
*/
623623
distanceThreshold?: number | null;
624624
/**
@@ -1078,10 +1078,18 @@ export namespace firestore_v1 {
10781078
* The API scope supported by this index.
10791079
*/
10801080
apiScope?: string | null;
1081+
/**
1082+
* Immutable. The density configuration of the index.
1083+
*/
1084+
density?: string | null;
10811085
/**
10821086
* The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. The last field entry is always for the field path `__name__`. If, on creation, `__name__` was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the `__name__` will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.
10831087
*/
10841088
fields?: Schema$GoogleFirestoreAdminV1IndexField[];
1089+
/**
1090+
* Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to index with IGNITE_API ApiScope.
1091+
*/
1092+
multikey?: boolean | null;
10851093
/**
10861094
* Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id\}/databases/{database_id\}/collectionGroups/{collection_id\}/indexes/{composite_index_id\}` For single field indexes, this field will be empty.
10871095
*/
@@ -1821,7 +1829,7 @@ export namespace firestore_v1 {
18211829
structuredQuery?: Schema$StructuredQuery;
18221830
}
18231831
/**
1824-
* A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit
1832+
* A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7. find_nearest
18251833
*/
18261834
export interface Schema$StructuredQuery {
18271835
/**
@@ -6234,7 +6242,7 @@ export namespace firestore_v1 {
62346242
}
62356243

62366244
/**
6237-
* 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`.
6245+
* 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`.
62386246
*
62396247
* @param params - Parameters for request
62406248
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.

‎src/apis/firestore/v1beta1.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -618,7 +618,7 @@ export namespace firestore_v1beta1 {
618618
*/
619619
distanceResultField?: string | null;
620620
/**
621-
* Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold For DOT_PRODUCT: WHERE distance \>= distance_threshold
621+
* Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance \>= distance_threshold
622622
*/
623623
distanceThreshold?: number | null;
624624
/**
@@ -1304,7 +1304,7 @@ export namespace firestore_v1beta1 {
13041304
structuredQuery?: Schema$StructuredQuery;
13051305
}
13061306
/**
1307-
* A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit
1307+
* A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7. find_nearest
13081308
*/
13091309
export interface Schema$StructuredQuery {
13101310
/**

0 commit comments

Comments
 (0)