deac/gitlabhq
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
gitlabhq/doc/api
History
Cyril 63d9373aa8 Validates presence of User#name 
The 2 reasons are :
- creation of user fail if name is empty : in after_save, it tries to create a
namespace with namespace.name = user.name and namespece validates presence
Namespace#name
- in the web app links to team members are broken with empty User#name because
they are of the form <a href'...'> user.name </a>
2012-12-12 17:53:43 +01:00
..
issues.md API: expose issues project id 2012-07-25 04:22:21 -07:00
merge_requests.md API: tests for merge_requests 2012-10-25 13:13:01 +03:00
milestones.md Add milestone API docs to doc/README and views/help/api 2012-08-29 08:45:00 -04:00
notes.md API: get a single wall note 2012-12-01 02:20:45 -08:00
projects.md Update doc/api/projects.md for hooks API 2012-10-12 10:38:15 +03:00
README.md update contents of API README 2012-12-01 02:07:57 -08:00
repositories.md separate project repositories API docs 2012-09-21 05:03:50 -07:00
session.md I want be able to get token via api. Used for mobile applications 2012-09-20 17:45:07 +03:00
snippets.md API: add project snippets listing 2012-10-08 02:13:53 -07:00
users.md Validates presence of User#name 2012-12-12 17:53:43 +01:00

README.md

GitLab API

All API requests require authentication. You need to pass a private_token parameter by url or header. You can find or reset your private token in your profile.

If no, or an invalid, private_token is provided then an error message will be returned with status code 401:

{
  "message": "401 Unauthorized"
}

API requests should be prefixed with api and the API version. The API version is equal to the GitLab major version number, which is defined in lib/api.rb.

Example of a valid API request:

GET http://example.com/api/v2/projects?private_token=QVy1PB7sTxfy4pqfZM1U

The API uses JSON to serialize data. You don't need to specify .json at the end of API URL.

Pagination

When listing resources you can pass the following parameters:

  • page (default: 1) - page number
  • per_page (default: 20, max: 100) - number of items to list per page

Contents