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 deleted:
- schemas.ExplainOptions (Total Keys: 3)
- schemas.RunAggregationQueryRequest.properties.explainOptions.$ref (Total Keys: 1)
- schemas.RunQueryRequest.properties.explainOptions.$ref (Total Keys: 1)

#### firestore:v1beta1

The following keys were deleted:
- schemas.ExplainOptions (Total Keys: 3)
- schemas.RunAggregationQueryRequest.properties.explainOptions.$ref (Total Keys: 1)
- schemas.RunQueryRequest.properties.explainOptions.$ref (Total Keys: 1)
  • Loading branch information
yoshi-automation committed Feb 27, 2024
1 parent 07cec5e commit 57904b3
Show file tree
Hide file tree
Showing 5 changed files with 3 additions and 53 deletions.
6 changes: 0 additions & 6 deletions docs/dyn/firestore_v1.projects.databases.documents.html
Expand Up @@ -1750,9 +1750,6 @@ <h3>Method Details</h3>
The object takes the form of:

{ # The request for Firestore.RunAggregationQuery.
&quot;explainOptions&quot;: { # Explain options for the query. # Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.
&quot;analyze&quot;: True or False, # Optional. Whether to execute this query. When false (the default), the query will be planned, returning only metrics from the planning stages. When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics.
},
&quot;newTransaction&quot;: { # Options for creating a new transaction. # Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream.
&quot;readOnly&quot;: { # Options for a transaction that can only be used to read documents. # The transaction can only be used for read operations.
&quot;readTime&quot;: &quot;A String&quot;, # Reads documents at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
Expand Down Expand Up @@ -1964,9 +1961,6 @@ <h3>Method Details</h3>
The object takes the form of:

{ # The request for Firestore.RunQuery.
&quot;explainOptions&quot;: { # Explain options for the query. # Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.
&quot;analyze&quot;: True or False, # Optional. Whether to execute this query. When false (the default), the query will be planned, returning only metrics from the planning stages. When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics.
},
&quot;newTransaction&quot;: { # Options for creating a new transaction. # Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.
&quot;readOnly&quot;: { # Options for a transaction that can only be used to read documents. # The transaction can only be used for read operations.
&quot;readTime&quot;: &quot;A String&quot;, # Reads documents at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
Expand Down
6 changes: 0 additions & 6 deletions docs/dyn/firestore_v1beta1.projects.databases.documents.html
Expand Up @@ -1750,9 +1750,6 @@ <h3>Method Details</h3>
The object takes the form of:

{ # The request for Firestore.RunAggregationQuery.
&quot;explainOptions&quot;: { # Explain options for the query. # Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.
&quot;analyze&quot;: True or False, # Optional. Whether to execute this query. When false (the default), the query will be planned, returning only metrics from the planning stages. When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics.
},
&quot;newTransaction&quot;: { # Options for creating a new transaction. # Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream.
&quot;readOnly&quot;: { # Options for a transaction that can only be used to read documents. # The transaction can only be used for read operations.
&quot;readTime&quot;: &quot;A String&quot;, # Reads documents at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
Expand Down Expand Up @@ -1964,9 +1961,6 @@ <h3>Method Details</h3>
The object takes the form of:

{ # The request for Firestore.RunQuery.
&quot;explainOptions&quot;: { # Explain options for the query. # Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.
&quot;analyze&quot;: True or False, # Optional. Whether to execute this query. When false (the default), the query will be planned, returning only metrics from the planning stages. When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics.
},
&quot;newTransaction&quot;: { # Options for creating a new transaction. # Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.
&quot;readOnly&quot;: { # Options for a transaction that can only be used to read documents. # The transaction can only be used for read operations.
&quot;readTime&quot;: &quot;A String&quot;, # Reads documents at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
Expand Down
21 changes: 1 addition & 20 deletions googleapiclient/discovery_cache/documents/firestore.v1.json
Expand Up @@ -1672,7 +1672,7 @@
}
}
},
"revision": "20240208",
"revision": "20240215",
"rootUrl": "https://firestore.googleapis.com/",
"schemas": {
"Aggregation": {
Expand Down Expand Up @@ -2179,17 +2179,6 @@
},
"type": "object"
},
"ExplainOptions": {
"description": "Explain options for the query.",
"id": "ExplainOptions",
"properties": {
"analyze": {
"description": "Optional. Whether to execute this query. When false (the default), the query will be planned, returning only metrics from the planning stages. When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics.",
"type": "boolean"
}
},
"type": "object"
},
"FieldFilter": {
"description": "A filter on a specific field.",
"id": "FieldFilter",
Expand Down Expand Up @@ -3801,10 +3790,6 @@
"description": "The request for Firestore.RunAggregationQuery.",
"id": "RunAggregationQueryRequest",
"properties": {
"explainOptions": {
"$ref": "ExplainOptions",
"description": "Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned."
},
"newTransaction": {
"$ref": "TransactionOptions",
"description": "Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream."
Expand Down Expand Up @@ -3851,10 +3836,6 @@
"description": "The request for Firestore.RunQuery.",
"id": "RunQueryRequest",
"properties": {
"explainOptions": {
"$ref": "ExplainOptions",
"description": "Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned."
},
"newTransaction": {
"$ref": "TransactionOptions",
"description": "Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream."
Expand Down
21 changes: 1 addition & 20 deletions googleapiclient/discovery_cache/documents/firestore.v1beta1.json
Expand Up @@ -950,7 +950,7 @@
}
}
},
"revision": "20240208",
"revision": "20240215",
"rootUrl": "https://firestore.googleapis.com/",
"schemas": {
"Aggregation": {
Expand Down Expand Up @@ -1457,17 +1457,6 @@
},
"type": "object"
},
"ExplainOptions": {
"description": "Explain options for the query.",
"id": "ExplainOptions",
"properties": {
"analyze": {
"description": "Optional. Whether to execute this query. When false (the default), the query will be planned, returning only metrics from the planning stages. When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics.",
"type": "boolean"
}
},
"type": "object"
},
"FieldFilter": {
"description": "A filter on a specific field.",
"id": "FieldFilter",
Expand Down Expand Up @@ -2319,10 +2308,6 @@
"description": "The request for Firestore.RunAggregationQuery.",
"id": "RunAggregationQueryRequest",
"properties": {
"explainOptions": {
"$ref": "ExplainOptions",
"description": "Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned."
},
"newTransaction": {
"$ref": "TransactionOptions",
"description": "Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream."
Expand Down Expand Up @@ -2369,10 +2354,6 @@
"description": "The request for Firestore.RunQuery.",
"id": "RunQueryRequest",
"properties": {
"explainOptions": {
"$ref": "ExplainOptions",
"description": "Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned."
},
"newTransaction": {
"$ref": "TransactionOptions",
"description": "Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream."
Expand Down
Expand Up @@ -415,7 +415,7 @@
}
}
},
"revision": "20240208",
"revision": "20240215",
"rootUrl": "https://firestore.googleapis.com/",
"schemas": {
"Empty": {
Expand Down

0 comments on commit 57904b3

Please sign in to comment.