Skip to content

Commit 270fcf6

Browse files
feat(firebasedataconnect): update the api
#### firebasedataconnect:v1 The following keys were added: - schemas.GraphqlErrorExtensions.properties.code.type (Total Keys: 1) - schemas.GraphqlErrorExtensions.properties.debugDetails.type (Total Keys: 1) - schemas.GraphqlErrorExtensions.properties.resource.type (Total Keys: 1) #### firebasedataconnect:v1beta The following keys were added: - schemas.GraphqlErrorExtensions.properties.code.type (Total Keys: 1) - schemas.GraphqlErrorExtensions.properties.debugDetails.type (Total Keys: 1) - schemas.GraphqlErrorExtensions.properties.resource.type (Total Keys: 1)
1 parent d51ac7b commit 270fcf6

6 files changed

+126
-2
lines changed

docs/dyn/firebasedataconnect_v1.projects.locations.services.connectors.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,10 @@ <h3>Method Details</h3>
243243
&quot;errors&quot;: [ # Errors of this response.
244244
{ # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body.
245245
&quot;extensions&quot;: { # GraphqlErrorExtensions contains additional information of `GraphqlError`. # Additional error information.
246+
&quot;code&quot;: &quot;A String&quot;, # Maps to canonical gRPC codes. If not specified, it represents `Code.INTERNAL`.
247+
&quot;debugDetails&quot;: &quot;A String&quot;, # More detailed error message to assist debugging. In the backend, only include it in admin authenticated API like ExecuteGraphql. In the emulator, always include it to assist debugging.
246248
&quot;file&quot;: &quot;A String&quot;, # The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`.
249+
&quot;resource&quot;: &quot;A String&quot;, # Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`).
247250
},
248251
&quot;locations&quot;: [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn&#x27;t have access access the underlying GQL source.
249252
{ # SourceLocation references a location in a GraphQL source.
@@ -291,7 +294,10 @@ <h3>Method Details</h3>
291294
&quot;errors&quot;: [ # Errors of this response.
292295
{ # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body.
293296
&quot;extensions&quot;: { # GraphqlErrorExtensions contains additional information of `GraphqlError`. # Additional error information.
297+
&quot;code&quot;: &quot;A String&quot;, # Maps to canonical gRPC codes. If not specified, it represents `Code.INTERNAL`.
298+
&quot;debugDetails&quot;: &quot;A String&quot;, # More detailed error message to assist debugging. In the backend, only include it in admin authenticated API like ExecuteGraphql. In the emulator, always include it to assist debugging.
294299
&quot;file&quot;: &quot;A String&quot;, # The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`.
300+
&quot;resource&quot;: &quot;A String&quot;, # Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`).
295301
},
296302
&quot;locations&quot;: [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn&#x27;t have access access the underlying GQL source.
297303
{ # SourceLocation references a location in a GraphQL source.

docs/dyn/firebasedataconnect_v1.projects.locations.services.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,10 @@ <h3>Method Details</h3>
254254
&quot;errors&quot;: [ # Errors of this response. If the data entry in the response is not present, the errors entry must be present. It conforms to https://spec.graphql.org/draft/#sec-Errors.
255255
{ # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body.
256256
&quot;extensions&quot;: { # GraphqlErrorExtensions contains additional information of `GraphqlError`. # Additional error information.
257+
&quot;code&quot;: &quot;A String&quot;, # Maps to canonical gRPC codes. If not specified, it represents `Code.INTERNAL`.
258+
&quot;debugDetails&quot;: &quot;A String&quot;, # More detailed error message to assist debugging. In the backend, only include it in admin authenticated API like ExecuteGraphql. In the emulator, always include it to assist debugging.
257259
&quot;file&quot;: &quot;A String&quot;, # The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`.
260+
&quot;resource&quot;: &quot;A String&quot;, # Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`).
258261
},
259262
&quot;locations&quot;: [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn&#x27;t have access access the underlying GQL source.
260263
{ # SourceLocation references a location in a GraphQL source.
@@ -311,7 +314,10 @@ <h3>Method Details</h3>
311314
&quot;errors&quot;: [ # Errors of this response. If the data entry in the response is not present, the errors entry must be present. It conforms to https://spec.graphql.org/draft/#sec-Errors.
312315
{ # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body.
313316
&quot;extensions&quot;: { # GraphqlErrorExtensions contains additional information of `GraphqlError`. # Additional error information.
317+
&quot;code&quot;: &quot;A String&quot;, # Maps to canonical gRPC codes. If not specified, it represents `Code.INTERNAL`.
318+
&quot;debugDetails&quot;: &quot;A String&quot;, # More detailed error message to assist debugging. In the backend, only include it in admin authenticated API like ExecuteGraphql. In the emulator, always include it to assist debugging.
314319
&quot;file&quot;: &quot;A String&quot;, # The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`.
320+
&quot;resource&quot;: &quot;A String&quot;, # Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`).
315321
},
316322
&quot;locations&quot;: [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn&#x27;t have access access the underlying GQL source.
317323
{ # SourceLocation references a location in a GraphQL source.

docs/dyn/firebasedataconnect_v1beta.projects.locations.services.connectors.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,10 @@ <h3>Method Details</h3>
243243
&quot;errors&quot;: [ # Errors of this response.
244244
{ # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body.
245245
&quot;extensions&quot;: { # GraphqlErrorExtensions contains additional information of `GraphqlError`. # Additional error information.
246+
&quot;code&quot;: &quot;A String&quot;, # Maps to canonical gRPC codes. If not specified, it represents `Code.INTERNAL`.
247+
&quot;debugDetails&quot;: &quot;A String&quot;, # More detailed error message to assist debugging. In the backend, only include it in admin authenticated API like ExecuteGraphql. In the emulator, always include it to assist debugging.
246248
&quot;file&quot;: &quot;A String&quot;, # The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`.
249+
&quot;resource&quot;: &quot;A String&quot;, # Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`).
247250
},
248251
&quot;locations&quot;: [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn&#x27;t have access access the underlying GQL source.
249252
{ # SourceLocation references a location in a GraphQL source.
@@ -291,7 +294,10 @@ <h3>Method Details</h3>
291294
&quot;errors&quot;: [ # Errors of this response.
292295
{ # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body.
293296
&quot;extensions&quot;: { # GraphqlErrorExtensions contains additional information of `GraphqlError`. # Additional error information.
297+
&quot;code&quot;: &quot;A String&quot;, # Maps to canonical gRPC codes. If not specified, it represents `Code.INTERNAL`.
298+
&quot;debugDetails&quot;: &quot;A String&quot;, # More detailed error message to assist debugging. In the backend, only include it in admin authenticated API like ExecuteGraphql. In the emulator, always include it to assist debugging.
294299
&quot;file&quot;: &quot;A String&quot;, # The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`.
300+
&quot;resource&quot;: &quot;A String&quot;, # Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`).
295301
},
296302
&quot;locations&quot;: [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn&#x27;t have access access the underlying GQL source.
297303
{ # SourceLocation references a location in a GraphQL source.

docs/dyn/firebasedataconnect_v1beta.projects.locations.services.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,10 @@ <h3>Method Details</h3>
254254
&quot;errors&quot;: [ # Errors of this response. If the data entry in the response is not present, the errors entry must be present. It conforms to https://spec.graphql.org/draft/#sec-Errors.
255255
{ # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body.
256256
&quot;extensions&quot;: { # GraphqlErrorExtensions contains additional information of `GraphqlError`. # Additional error information.
257+
&quot;code&quot;: &quot;A String&quot;, # Maps to canonical gRPC codes. If not specified, it represents `Code.INTERNAL`.
258+
&quot;debugDetails&quot;: &quot;A String&quot;, # More detailed error message to assist debugging. In the backend, only include it in admin authenticated API like ExecuteGraphql. In the emulator, always include it to assist debugging.
257259
&quot;file&quot;: &quot;A String&quot;, # The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`.
260+
&quot;resource&quot;: &quot;A String&quot;, # Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`).
258261
},
259262
&quot;locations&quot;: [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn&#x27;t have access access the underlying GQL source.
260263
{ # SourceLocation references a location in a GraphQL source.
@@ -311,7 +314,10 @@ <h3>Method Details</h3>
311314
&quot;errors&quot;: [ # Errors of this response. If the data entry in the response is not present, the errors entry must be present. It conforms to https://spec.graphql.org/draft/#sec-Errors.
312315
{ # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body.
313316
&quot;extensions&quot;: { # GraphqlErrorExtensions contains additional information of `GraphqlError`. # Additional error information.
317+
&quot;code&quot;: &quot;A String&quot;, # Maps to canonical gRPC codes. If not specified, it represents `Code.INTERNAL`.
318+
&quot;debugDetails&quot;: &quot;A String&quot;, # More detailed error message to assist debugging. In the backend, only include it in admin authenticated API like ExecuteGraphql. In the emulator, always include it to assist debugging.
314319
&quot;file&quot;: &quot;A String&quot;, # The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`.
320+
&quot;resource&quot;: &quot;A String&quot;, # Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`).
315321
},
316322
&quot;locations&quot;: [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn&#x27;t have access access the underlying GQL source.
317323
{ # SourceLocation references a location in a GraphQL source.

0 commit comments

Comments
 (0)