Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
7b894472
Commit
7b894472
authored
Jun 24, 2021
by
Luke Duncalfe
Committed by
Marcel Amirault
Jun 24, 2021
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Improve copy in GraphQL Global ID deprecation docs
parent
8b8e45b1
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
5 additions
and
7 deletions
+5
-7
doc/development/api_graphql_styleguide.md
doc/development/api_graphql_styleguide.md
+5
-7
No files found.
doc/development/api_graphql_styleguide.md
View file @
7b894472
...
...
@@ -674,26 +674,24 @@ support for the former argument style, remove the `Deprecation`:
DEPRECATIONS
=
[].
freeze
```
During the deprecation period the API accepts these values for the argument:
Formatted as either:
During the deprecation period the API will accept either of these formats for the argument value:
-
`"gid://gitlab/PrometheusService/1"`
-
`"gid://gitlab/Integrations::Prometheus/1"`
And query signatures recognizes the type under the old and new type names, accepting either
:
The API will also accept these types in the query signature for the argument
:
-
`PrometheusServiceID`
-
`IntegrationsPrometheusID`
NOTE:
Although queries that use the old
name (
`PrometheusServiceID`
in this example) would be
considered valid and executable by the API, validator tools w
ould consider them
invalid.
Although queries that use the old
type (
`PrometheusServiceID`
in this example) will be
considered valid and executable by the API, validator tools w
ill consider them to be
invalid.
This is because we are deprecating using a bespoke method outside of the
[
`@deprecated` directive
](
https://spec.graphql.org/June2018/#sec--deprecated
)
, so validators are not
aware of the support.
The documentation
mentions
that the old Global ID style is now deprecated.
The documentation
will mention
that the old Global ID style is now deprecated.
See also
[
Aliasing and deprecating mutations
](
#aliasing-and-deprecating-mutations
)
.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment