kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity
gitlab-org--gitlab-foss/doc/api/graphql/index.md

90 lines
3.5 KiB
Markdown
Raw Normal View History

Remove `:graphql` feature flag - Remove `FeatureConstrainer` call wrapping api endpoint - Remove `Feature.enabled?(:graphql)` conditionals in back and frontend - Modify graphql test to be graphql flag agnostic - Remove api routing spec - Remove frontend feature flag via `gon`
2019-07-09 08:45:23 -04:00
# GraphQL API
Add `present_using` to types By specifying a presenter for the object type, we can keep the logic out of `GitlabSchema`. The presenter gets initialized using the object being presented, and the context (including the `current_user`).
2018-05-21 03:52:24 -04:00
Edit GraphQL general availability text
2019-07-10 14:11:06 -04:00
> - [Introduced][ce-19008] in GitLab 11.0 (enabled by feature flag `graphql`).
Add latest changes from gitlab-org/gitlab@master
2019-09-18 10:02:45 -04:00
> - [Always enabled](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/30444)
Edit GraphQL general availability text
2019-07-10 14:11:06 -04:00
in GitLab 12.1.
Add `present_using` to types By specifying a presenter for the object type, we can keep the logic out of `GitlabSchema`. The presenter gets initialized using the object being presented, and the context (including the `current_user`).
2018-05-21 03:52:24 -04:00
Add latest changes from gitlab-org/gitlab@master
2019-11-22 04:06:20 -05:00
## Getting Started
For those new to the GitLab GraphQL API, see
[Getting started with GitLab GraphQL API](getting_started.md).
### Quick Reference
- GitLab's GraphQL API endpoint is located at `/api/graphql`.
- Get an [introduction to GraphQL from graphql.org](https://graphql.org/).
- GitLab supports a wide range of resources, listed in the [GraphQL API Reference](reference/index.md).
#### GraphiQL
Explore the GraphQL API using the interactive [GraphiQL explorer](https://gitlab.com/-/graphql-explorer),
or on your self-managed GitLab instance on
`https://<your-gitlab-site.com>/-/graphql-explorer`.
See the [GitLab GraphQL overview](getting_started.md#graphiql) for more information about the GraphiQL Explorer.
## What is GraphQL?
Initial setup GraphQL using graphql-ruby 1.8 - All definitions have been replaced by classes: http://graphql-ruby.org/schema/class_based_api.html - Authorization & Presentation have been refactored to work in the class based system - Loaders have been replaced by resolvers - Times are now coersed as ISO 8601
2018-05-23 03:55:14 -04:00
[GraphQL](https://graphql.org/) is a query language for APIs that
allows clients to request exactly the data they need, making it
possible to get all required data in a limited number of requests.
Add `present_using` to types By specifying a presenter for the object type, we can keep the logic out of `GitlabSchema`. The presenter gets initialized using the object being presented, and the context (including the `current_user`).
2018-05-21 03:52:24 -04:00
Initial setup GraphQL using graphql-ruby 1.8 - All definitions have been replaced by classes: http://graphql-ruby.org/schema/class_based_api.html - Authorization & Presentation have been refactored to work in the class based system - Loaders have been replaced by resolvers - Times are now coersed as ISO 8601
2018-05-23 03:55:14 -04:00
The GraphQL data (fields) can be described in the form of types,
allowing clients to use [clientside GraphQL
libraries](https://graphql.org/code/#graphql-clients) to consume the
API and avoid manual parsing.
Add `present_using` to types By specifying a presenter for the object type, we can keep the logic out of `GitlabSchema`. The presenter gets initialized using the object being presented, and the context (including the `current_user`).
2018-05-21 03:52:24 -04:00
Initial setup GraphQL using graphql-ruby 1.8 - All definitions have been replaced by classes: http://graphql-ruby.org/schema/class_based_api.html - Authorization & Presentation have been refactored to work in the class based system - Loaders have been replaced by resolvers - Times are now coersed as ISO 8601
2018-05-23 03:55:14 -04:00
Since there's no fixed endpoints and datamodel, new abilities can be
added to the API without creating breaking changes. This allows us to
have a versionless API as described in [the GraphQL
documentation](https://graphql.org/learn/best-practices/#versioning).
Add `present_using` to types By specifying a presenter for the object type, we can keep the logic out of `GitlabSchema`. The presenter gets initialized using the object being presented, and the context (including the `current_user`).
2018-05-21 03:52:24 -04:00
First pass at a graphql vision
2019-05-01 11:19:54 -04:00
## Vision
We want the GraphQL API to be the **primary** means of interacting
programmatically with GitLab. To achieve this, it needs full coverage - anything
possible in the REST API should also be possible in the GraphQL API.
To help us meet this vision, the frontend should use GraphQL in preference to
Remove `:graphql` feature flag - Remove `FeatureConstrainer` call wrapping api endpoint - Remove `Feature.enabled?(:graphql)` conditionals in back and frontend - Modify graphql test to be graphql flag agnostic - Remove api routing spec - Remove frontend feature flag via `gon`
2019-07-09 08:45:23 -04:00
the REST API for new features.
First pass at a graphql vision
2019-05-01 11:19:54 -04:00
There are no plans to deprecate the REST API. To reduce the technical burden of
supporting two APIs in parallel, they should share implementations as much as
possible.
Add `present_using` to types By specifying a presenter for the object type, we can keep the logic out of `GitlabSchema`. The presenter gets initialized using the object being presented, and the context (including the `current_user`).
2018-05-21 03:52:24 -04:00
## Available queries
Add latest changes from gitlab-org/gitlab@master
2019-11-22 04:06:20 -05:00
The GraphQL API includes the following queries at the root level:
Mention group query in GraphQL documentation
2019-04-23 13:24:48 -04:00
Add latest changes from gitlab-org/gitlab@master
2019-11-22 04:06:20 -05:00
1. `project` : Project information, with many of its associations such as issues and merge requests also available.
Changing badges to use parentheses not brackets Previously, we used brackets to denote the tier badges, but this made Kramdown, the docs site Markdown renderer, show many warnings when building the site. This is now fixed by using parentheses instead of square brackets. This was caused by [PREMIUM] looking like a link to Kramdown, which couldn't find a URL there. See: - https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/484 - https://gitlab.com/gitlab-org/gitlab-ce/issues/63800
2019-07-08 04:50:38 -04:00
1. `group` : Basic group information and epics **(ULTIMATE)** are currently supported.
Add Namespace and ProjectStatistics to GraphQL API We can query namespaces, and nested projects. Projects now exposes statistics
2019-05-12 17:10:46 -04:00
1. `namespace` : Within a namespace it is also possible to fetch `projects`.
Add latest changes from gitlab-org/gitlab@master
2019-11-22 04:06:20 -05:00
1. `currentUser`: Information about the currently logged in user.
1. `metaData`: Metadata about GitLab and the GraphQL API.
Add latest changes from gitlab-org/gitlab@master
2019-12-10 02:53:40 -05:00
1. `snippets`: Snippets visible to the currently logged in user.
Add latest changes from gitlab-org/gitlab@master
2019-11-22 04:06:20 -05:00
Root-level queries are defined in
[`app/graphql/types/query_type.rb`](https://gitlab.com/gitlab-org/gitlab/blob/master/app/graphql/types/query_type.rb).
Add `present_using` to types By specifying a presenter for the object type, we can keep the logic out of `GitlabSchema`. The presenter gets initialized using the object being presented, and the context (including the `current_user`).
2018-05-21 03:52:24 -04:00
Enables GraphQL batch requests Enabling GraphQL batch requests allows for multiple queries to be sent in 1 request reducing the amount of requests we send to the server. Responses come come back in the same order as the queries were provided.
2019-05-09 05:27:07 -04:00
### Multiplex queries
GitLab supports batching queries into a single request using
Add latest changes from gitlab-org/gitlab@master
2019-10-07 14:06:24 -04:00
[apollo-link-batch-http](https://www.apollographql.com/docs/link/links/batch-http/). More
Enables GraphQL batch requests Enabling GraphQL batch requests allows for multiple queries to be sent in 1 request reducing the amount of requests we send to the server. Responses come come back in the same order as the queries were provided.
2019-05-09 05:27:07 -04:00
info about multiplexed queries is also available for
[graphql-ruby](https://graphql-ruby.org/queries/multiplex.html) the
library GitLab uses on the backend.
Improve Graphql Docs Adds more friendly docs for GraphQl implementation
2019-07-11 04:06:35 -04:00
## Reference
GitLab's GraphQL reference [is available](reference/index.md).
It is automatically generated from GitLab's GraphQL schema and embedded in a Markdown file.
Add latest changes from gitlab-org/gitlab@master
2019-10-31 23:06:26 -04:00
Machine-readable versions are also available:
- [JSON format](reference/gitlab_schema.json)
- [IDL format](reference/gitlab_schema.graphql)
Add latest changes from gitlab-org/gitlab@master
2019-09-18 10:02:45 -04:00
[ce-19008]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/19008
Initial setup GraphQL using graphql-ruby 1.8 - All definitions have been replaced by classes: http://graphql-ruby.org/schema/class_based_api.html - Authorization & Presentation have been refactored to work in the class based system - Loaders have been replaced by resolvers - Times are now coersed as ISO 8601
2018-05-23 03:55:14 -04:00
[features-api]: ../features.md
Copy permalink