Created by: dzaporozhets
- It should be json & available by next uri http://example.com/api/
- Api Controllers should be under api namespace in api directory
- All api calls should be covered with tests
Activity
Created by: dzaporozhets
I plan to start from next interface:
- projects list
- project last commits
- project merge requests
Something like
http://example.com/project_name/merge_requests.jsonBy Administrator on 2012-02-13T19:18:16 (imported from GitLab project)
By Administrator on 2012-02-13T19:18:16 (imported from GitLab)
Created by: rastersize
Maybe model it so that it is somewhat similar to GitHubs API (version 3)? See http://developer.github.com/v3/ for details.
For example:
- project/repos list would be:
https://api.example.com/user/repos(for the authenticated users projects/repos), - project merge requests:
https://api.example.com/repos/:user/:repo/pullsorhttps://api.example.com/repos/:user/:repo/merge_requestswhere:useris the owner of the repo and:repois the name of the project/repo.
Not sure if these URLs would be applicable with GitLab but it would be nice to be able to use API-clients designed for GitHubs API with GitLabs API.
By Administrator on 2012-02-13T19:41:11 (imported from GitLab project)
By Administrator on 2012-02-13T19:41:11 (imported from GitLab)
- project/repos list would be:
Created by: cweagans
It would be awesome if Gitlab's API = Github's API so that all the client software written against Github's API would continue to work on Gitlab.
By Administrator on 2012-02-16T08:18:54 (imported from GitLab project)
By Administrator on 2012-02-16T08:18:54 (imported from GitLab)
Created by: dfyx
I totally agree with @cweagans
I haven't really used Github's API myself but it would really great if we could just use the same client software we're used to.
By Administrator on 2012-03-03T04:27:54 (imported from GitLab project)
By Administrator on 2012-03-03T04:27:54 (imported from GitLab)
Created by: aleks
+1 @cweagans
By Administrator on 2012-04-02T11:56:43 (imported from GitLab project)
By Administrator on 2012-04-02T11:56:43 (imported from GitLab)
Created by: cweagans
@randx I'd love to hear your thoughts here. It would be very very cool to be interoperable with Redmine or Github out of the box, because that would enable a great many desktop tools to work with Gitlab.
By Administrator on 2012-04-09T02:17:47 (imported from GitLab project)
By Administrator on 2012-04-09T02:17:47 (imported from GitLab)
Created by: jrochkind
It might be neat to have an API for read only access to the public keys individual users have set up.
Not sure about the security implications of this, it might not be feasible.
But the neat intended use case would be so other software could authenticate people using the public keys they've set up in a central gitlab, and if users changed their public keys in gitlab, this other software would now want the new public key they had added or not accept the old public key they had deleted, etc. Basically, gitlab has a nice UI for updating your public keys, with an API other local in-house enterprisey software could piggyback on that.
By Administrator on 2012-04-23T16:58:26 (imported from GitLab project)
By Administrator on 2012-04-23T16:58:26 (imported from GitLab)
Created by: cweagans
@jrochkind If it's a reimplementation of Github's API, then that's covered: http://developer.github.com/v3/users/keys/
Seriously, if Gitlab's API is compatible with Github, we get a LOT of tool integration for free.
By Administrator on 2012-04-24T01:50:32 (imported from GitLab project)
By Administrator on 2012-04-24T01:50:32 (imported from GitLab)
Created by: siuying
@cweagans it would be really cool if it could be done!
By Administrator on 2012-04-24T03:16:47 (imported from GitLab project)
By Administrator on 2012-04-24T03:16:47 (imported from GitLab)
Created by: jrochkind
The Github version, if I understand it properly, requires authentication as the user whose public keys you want to see. Ie, an OAuth with that user interactively participating, at least to get initial auth. (and again when the OAuth expires).
That makes sense for github, but may or may not be appropriate for an 'enterprise' gitlab install, intended for the use case I described above.
Still, these are details, and if the API was there at all, someone could without too much trouble pull request an enhancement to allow gitlab api to optionally give "read public keys for all accounts" access to certain internal credentials.
By Administrator on 2012-04-24T03:24:46 (imported from GitLab project)
By Administrator on 2012-04-24T03:24:46 (imported from GitLab)
Created by: cweagans
Well, in an "enterprise install", they could just query the database, right? I'm more concerned with the developers that are going to be using the system, than the systems people who are going to be integrating the tool with other systems. The former needs good tool integration (which is currently lacking). The latter needs good system integration, which is completely possible right now by directly working with the database/gitolite.
By Administrator on 2012-04-24T04:12:12 (imported from GitLab project)
By Administrator on 2012-04-24T04:12:12 (imported from GitLab)
Created by: willsteinmetz
This may not be the right issue to add this to, but it's somewhat related. This may not necessarily fall in with what everyone so far has mentioned as APIs above, but a plug-in API would be awesome. My company is slowly making the transition from SVN to git (finally!) but we've run into a problem of finding an issue tracking system that has source control integration, can create e-mails based on tickets, is easy to set up (so far I've found a few that I think I'd be able to build and fly a rocket to Mars before I can get it set up), a few other things. Since GitLab already has an issue tracking system built in, it'd be awesome if I'd be able to just write a plug-in that could add the features that we want to GitLab's issue tracking for our install and have everything we need in one app.
By Administrator on 2012-05-22T15:05:28 (imported from GitLab project)
By Administrator on 2012-05-22T15:05:28 (imported from GitLab)
Created by: jnv
@willsteinmetz I think this is discussed in #330 (closed)
By Administrator on 2012-05-22T16:04:37 (imported from GitLab project)
By Administrator on 2012-05-22T16:04:37 (imported from GitLab)
Created by: willsteinmetz
@jnv My bad, I didn't see that when I looked, but it's my fault for going through quickly. Thanks for pointing me to that ticket and I will read through it later! :)
By Administrator on 2012-05-22T17:23:55 (imported from GitLab project)
By Administrator on 2012-05-22T17:23:55 (imported from GitLab)
Created by: dzaporozhets
It wont be == Github api. Subdomain for api is not our way.
It would be http://example.com/api/projects.json?token=dasd432432
By Administrator on 2012-06-07T15:24:07 (imported from GitLab project)
By Administrator on 2012-06-07T15:24:07 (imported from GitLab)
Created by: cweagans
I think the subdomain probably doesn't matter so much as the rest of the URL. As long as the paramaters and everything are the same, it shouldn't be difficult to make any Github-compatible application work with Gitlab.
By Administrator on 2012-06-07T18:31:58 (imported from GitLab project)
By Administrator on 2012-06-07T18:31:58 (imported from GitLab)
Created by: siuying
Agree @cweagans , more importantly, any API is better than none! :)
By Administrator on 2012-06-08T01:45:30 (imported from GitLab project)
By Administrator on 2012-06-08T01:45:30 (imported from GitLab)
Created by: dekz
Why are you asking for the document type in the URI, why not use headers in this instance, or just assume everything will be JSON by default.
Is this issue open for pull requests?
By Administrator on 2012-06-26T23:17:24 (imported from GitLab project)
By Administrator on 2012-06-26T23:17:24 (imported from GitLab)
Created by: siuying
Planned to create iOS app that work like GitHub issues but for GitLab. Will need to have issue api first though.
By Administrator on 2012-07-23T02:52:15 (imported from GitLab project)
By Administrator on 2012-07-23T02:52:15 (imported from GitLab)
