diff options
Diffstat (limited to 'doc/development/api_graphql_styleguide.md')
| -rw-r--r-- | doc/development/api_graphql_styleguide.md | 15 |
1 files changed, 11 insertions, 4 deletions
diff --git a/doc/development/api_graphql_styleguide.md b/doc/development/api_graphql_styleguide.md index 9a17ac4c813..afd745533c9 100644 --- a/doc/development/api_graphql_styleguide.md +++ b/doc/development/api_graphql_styleguide.md @@ -152,8 +152,8 @@ The `iid`, `title` and `description` are _scalar_ GraphQL types. `title` and `description` are regular `GraphQL::Types::String` types. Note that the old scalar types `GraphQL:ID`, `GraphQL::INT_TYPE`, `GraphQL::STRING_TYPE`, -and `GraphQL:BOOLEAN_TYPE` are no longer allowed. Please use `GraphQL::Types::ID`, -`GraphQL::Types::Int`, `GraphQL::Types::String`, and `GraphQL::Types::Boolean`. +`GraphQL:BOOLEAN_TYPE`, and `GraphQL::FLOAT_TYPE` are no longer allowed. Please use `GraphQL::Types::ID`, +`GraphQL::Types::Int`, `GraphQL::Types::String`, `GraphQL::Types::Boolean`, and `GraphQL::Types::Float`. When exposing a model through the GraphQL API, we do so by creating a new type in `app/graphql/types`. You can also declare custom GraphQL data types @@ -698,7 +698,10 @@ aware of the support. The documentation will mention that the old Global ID style is now deprecated. -See also [Aliasing and deprecating mutations](#aliasing-and-deprecating-mutations). +See also: + +- [Aliasing and deprecating mutations](#aliasing-and-deprecating-mutations). +- [How to filter Kibana for queries that used deprecated fields](graphql_guide/monitoring.md#queries-that-used-a-deprecated-field). ## Enums @@ -830,7 +833,7 @@ field :id, GraphQL::Types::ID, description: 'ID of the resource.' Descriptions of fields and arguments are viewable to users through: - The [GraphiQL explorer](#graphiql). -- The [static GraphQL API reference](../api/graphql/#reference). +- The [static GraphQL API reference](../api/graphql/reference/index.md). ### Description style guide @@ -2027,3 +2030,7 @@ elimination of laziness, where needed. For dealing with lazy values without forcing them, use `Gitlab::Graphql::Lazy.with_value`. + +## Monitoring GraphQL + +See the [Monitoring GraphQL](graphql_guide/monitoring.md) guide for tips on how to inspect logs of GraphQL requests and monitor the performance of your GraphQL queries. |