mirror of https://github.com/wahyd4/gitlabhq.git synced 2026-08-15 07:36:41 +10:00

Files

T

Sebastian Ziebell 12a1f73b61 API projects documentation grouped into sections & updated with status codes

The API documentation for projects now is structured into major sections that describe
the different aspects when dealing with projects, e.g. hooks, branches, team members etc.
All described methods now contain a list of possible status codes the method can return. A few
methods have extra sample JSON responses and a description if a method is idempotent.
Idempotent methods can be called multiple times while returning the same status code.

2013-02-14 20:43:48 +01:00

groups.md

Add docs/tests for groups api

2013-02-01 14:59:22 +01:00

issues.md

Remove all references tp the project code parameter from the API

2012-12-21 18:47:04 +01:00

merge_requests.md

Remove all references tp the project code parameter from the API

2012-12-21 18:47:04 +01:00

milestones.md

Remove all references tp the project code parameter from the API

2012-12-21 18:47:04 +01:00

notes.md

Merge branch 'master' into fixes/api

2013-02-08 10:32:42 +01:00

projects.md

API projects documentation grouped into sections & updated with status codes

2013-02-14 20:43:48 +01:00

README.md

Add docs/tests for groups api

2013-02-01 14:59:22 +01:00

repositories.md

Changed function to not_found.

2013-02-09 21:01:17 +01:00

session.md

Add username to User and UserBasic entities in API and in examples in doc.

2012-12-12 18:51:20 +01:00

snippets.md

Remove all references tp the project code parameter from the API

2012-12-21 18:47:04 +01:00

users.md

Extended users API to support updating and deleting users.

2012-12-18 21:24:31 +02: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 defined in lib/api.rb.

Example of a valid API request:

GET http://example.com/api/v3/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

README.md

GitLab API

Pagination

Contents