mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-14 17:02:49 +03:00
docs: document a new breaking change for v2 (related to extra GQL params)
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7378 Co-authored-by: Rob Dominguez <24390149+robertjdominguez@users.noreply.github.com> GitOrigin-RevId: 6dc830ed22e8e7196993f683c8cbed2c2bd2f4b5
This commit is contained in:
parent
7dffbc6a0d
commit
3070470728
@ -10,6 +10,8 @@ sidebar_position: 3
|
||||
sidebar_label: Updating to Hasura v2
|
||||
---
|
||||
|
||||
import GraphiQLIDE from '@site/src/components/GraphiQLIDE';
|
||||
|
||||
# Updating to Hasura GraphQL Engine v2
|
||||
|
||||
## Introduction
|
||||
@ -103,6 +105,40 @@ A detailed changelog with all the new features introduced in Hasura v2 is availa
|
||||
under one. i.e. if any migration throws an error, applying further Migrations will be stopped but the other
|
||||
successfully executed Migrations up till that point will not be rolled back.
|
||||
|
||||
- **Passing extra GQL params will now throw validation error**
|
||||
|
||||
According to the discussion in
|
||||
[this GitHub issue](https://github.com/hasura/graphql-engine/issues/9320#issue-1503972127), passing unused, required
|
||||
GQL params will now throw a validation error.
|
||||
|
||||
Per the [GraphQL spec](https://spec.graphql.org/June2018/#sec-All-Variables-Used), any variable - if defined by an
|
||||
operation as required - should be referenced/used in the operation.
|
||||
|
||||
In the example below, the `role_type` variable is defined but not referenced or used in operation. Thus, executing
|
||||
this query will result in a validation error.
|
||||
|
||||
<GraphiQLIDE
|
||||
query={`query fetch_users($role_type: String!) {
|
||||
users {
|
||||
displayName
|
||||
id
|
||||
role
|
||||
}
|
||||
}`}
|
||||
variables={`{ "role_type": "user" }`}
|
||||
response={`{
|
||||
"errors": [
|
||||
{
|
||||
"extensions": {
|
||||
"code": "validation-failed",
|
||||
"path": "$"
|
||||
},
|
||||
"message": "unexpected variables in variableValues: role_type"
|
||||
}
|
||||
]
|
||||
}`}
|
||||
/>
|
||||
|
||||
<div id="hasura-v2-env-changes" />
|
||||
|
||||
- **Deprecation of database specific env vars**
|
||||
|
Loading…
Reference in New Issue
Block a user