ylqjgm
/
canvas-lms
mirror of https://github.com/instructure/canvas-lms.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updates a broken link in the GraphQL API doc 

fixes INTEROP-6822
flag=none

Test plan
- Access the URL /doc/api/file.graphql.html
- Reach the section "GraphQL in Canvas" > "Pagination"
- Check the "Relay Object Identification spec" link

Change-Id: I1c56cf30d017964537ff04b257d112286ec8a822
Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/266987
Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com>
Product-Review: Alexandre Trindade <alexandre.trindade@instructure.com>
Reviewed-by: Ryan Hawkins <ryan.hawkins@instructure.com>
Reviewed-by: Xander Moffatt <xmoffatt@instructure.com>
QA-Review: Xander Moffatt <xmoffatt@instructure.com>
This commit is contained in:
Alexandre Trindade 2021-06-11 17:58:40 -03:00
parent 01c7304e5c
commit be9b6d862f
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/api/graphql.md
View File

@ -105,7 +105,7 @@ curl https://<canvas>/api/graphql \
### `id` vs `_id` and the `node` field ### `id` vs `_id` and the `node` field
The Canvas LMS GraphQL API follows the [Relay Object Identification The Canvas LMS GraphQL API follows the [Relay Object Identification
spec](https://facebook.github.io/relay/docs/en/graphql-server-specification.html#object-identification). spec](https://relay.dev/graphql/objectidentification.htm).
Querying for an object's `id` will return a global identifier instead of the Querying for an object's `id` will return a global identifier instead of the
numeric ids that are used in the REST API. The traditional ids can be queried numeric ids that are used in the REST API. The traditional ids can be queried
by requesting the `_id` field. by requesting the `_id` field.