diff options
Diffstat (limited to 'doc/development/api_graphql_styleguide.md')
| -rw-r--r-- | doc/development/api_graphql_styleguide.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/development/api_graphql_styleguide.md b/doc/development/api_graphql_styleguide.md index 036eddd7c37..6d3c0cf0eac 100644 --- a/doc/development/api_graphql_styleguide.md +++ b/doc/development/api_graphql_styleguide.md @@ -1,6 +1,6 @@ -# GraphQL API +# GraphQL API style guide -This document outlines the styleguide for GitLab's [GraphQL API](../api/graphql/index.md). +This document outlines the style guide for GitLab's [GraphQL API](../api/graphql/index.md). ## How GitLab implements GraphQL @@ -12,7 +12,7 @@ which is exposed as an API endpoint at `/api/graphql`. ## Deep Dive -In March 2019, Nick Thomas hosted a [Deep Dive](https://gitlab.com/gitlab-org/create-stage/issues/1) +In March 2019, Nick Thomas hosted a Deep Dive (GitLab team members only: `https://gitlab.com/gitlab-org/create-stage/issues/1`) on GitLab's [GraphQL API](../api/graphql/index.md) to share his domain specific knowledge with anyone who may work in this part of the code base in the future. You can find the [recording on YouTube](https://www.youtube.com/watch?v=-9L_1MWrjkg), and the slides on @@ -102,7 +102,7 @@ be `id` fields. Further reading: - [GraphQL Best Practices Guide](https://graphql.org/learn/best-practices/#nullability) -- [Using nullability in GraphQL](https://blog.apollographql.com/using-nullability-in-graphql-2254f84c4ed7) +- [Using nullability in GraphQL](https://www.apollographql.com/blog/using-nullability-in-graphql-2254f84c4ed7) ### Exposing Global IDs @@ -110,7 +110,7 @@ When exposing an `ID` field on a type, we will by default try to expose a global ID by calling `to_global_id` on the resource being rendered. -To override this behaviour, you can implement an `id` method on the +To override this behavior, you can implement an `id` method on the type for which you are exposing an ID. Please make sure that when exposing a `GraphQL::ID_TYPE` using a custom method that it is globally unique. @@ -365,7 +365,7 @@ field :token, GraphQL::STRING_TYPE, null: true, The original `description:` of the field should be maintained, and should _not_ be updated to mention the deprecation. -### Deprecation reason styleguide +### Deprecation reason style guide Where the reason for deprecation is due to the field being replaced with another field, the `reason` must be: @@ -446,7 +446,7 @@ Descriptions of fields and arguments are viewable to users through: - The [GraphiQL explorer](#graphiql). - The [static GraphQL API reference](../api/graphql/#reference). -### Description styleguide +### Description style guide To ensure consistency, the following should be followed whenever adding or updating descriptions: @@ -598,7 +598,7 @@ ID. Otherwise use a [globally unique ID](#exposing-global-ids). We already have a `FullPathLoader` that can be included in other resolvers to quickly find Projects and Namespaces which will have a -lot of dependant objects. +lot of dependent objects. To limit the amount of queries performed, we can use `BatchLoader`. |