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
0
Merge Requests
0
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
Jérome Perrin
gitlab-ce
Commits
5b645e64
Commit
5b645e64
authored
Jun 08, 2017
by
Stan Hu
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Clarify API V5 being a compatability layer on top of GraphQL
[ci skip]
parent
b1bf6d88
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
7 additions
and
3 deletions
+7
-3
doc/api/README.md
doc/api/README.md
+7
-3
No files found.
doc/api/README.md
View file @
5b645e64
...
@@ -57,12 +57,16 @@ following locations:
...
@@ -57,12 +57,16 @@ following locations:
## Road to GraphQL
## Road to GraphQL
API v4 will be the last REST API that we support. Going forward, we will start
Going forward, we will start on moving to
on moving to GraphQL and deprecate the use of controller-specific
[
GraphQL
](
http://graphql.org/learn/best-practices/
)
and deprecate the use of
endpoints. GraphQL has a number of benefits:
controller-specific
endpoints. GraphQL has a number of benefits:
1.
We avoid having to maintain two different APIs.
1.
We avoid having to maintain two different APIs.
2.
Callers of the API can request only what they need.
2.
Callers of the API can request only what they need.
3.
It is versioned by default.
It will co-exist with the current V4 REST API. If we have a V5 API, this should be
compatability layer on top of GraphQL.
### Internal CI API
### Internal CI API
...
...
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