diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-11-02 12:09:38 +0300 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-11-02 12:09:38 +0300 |
| commit | aa84824d04b32ce9cd3abeac90a6bf78fb2be34c (patch) | |
| tree | 379dffa10441e382014909ed8a694f1c0c4ec927 /doc/development | |
| parent | 96100bc70c151404efe5d261813131aaf72b0d41 (diff) | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development')
| -rw-r--r-- | doc/development/api_graphql_styleguide.md | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/development/api_graphql_styleguide.md b/doc/development/api_graphql_styleguide.md index 3662b21eb9e..bb685c30631 100644 --- a/doc/development/api_graphql_styleguide.md +++ b/doc/development/api_graphql_styleguide.md @@ -154,7 +154,11 @@ developers must familiarize themselves with our [Deprecation and Removal process Breaking changes are: - Removing or renaming a field, argument, enum value, or mutation. -- Changing the type of a field, argument or enum value. +- Changing the type or type name of an argument. This is because the type of an argument + is declared by the client when [using variables](https://graphql.org/learn/queries/#variables), + and queries with the old type name would be rejected by the API. +- Changing the _scalar type_ of a field or enum value. Object types can be changed so long as all + scalar type fields of the object remain the same. - Raising the [complexity](#max-complexity) of a field or complexity multipliers in a resolver. - Changing a field from being _not_ nullable (`null: false`) to nullable (`null: true`), as discussed in [Nullable fields](#nullable-fields). |