Commit 0546a98981870abaab655bb06f1fe34ba2f39845
Exists in
spb-stable
and in
3 other branches
Merge branch 'doc-readme-for-site' into 'master'
Doc-readme-for-site New readme files for doc.gitlab.com I also but the links for the api readme at the top.
Showing
9 changed files
with
66 additions
and
27 deletions
Show diff stats
| @@ -0,0 +1,17 @@ | @@ -0,0 +1,17 @@ | ||
| 1 | +## The GitLab Documentation covers the following subjects | ||
| 2 | + | ||
| 3 | ++ [API](api/README.md) | ||
| 4 | ++ [Development](development/README.md) | ||
| 5 | ++ [Install](install/README.md) | ||
| 6 | ++ [Integration](external-issue-tracker/README.md) | ||
| 7 | ++ [Legal](legal/README.md) | ||
| 8 | ++ [Markdown](markdown/markdown.md) | ||
| 9 | ++ [Permissions](permissions/permissions.md) | ||
| 10 | ++ [Public access](public_access/public_access.md) | ||
| 11 | ++ [Raketasks](raketasks/README.md) | ||
| 12 | ++ [Release](release/README.md) | ||
| 13 | ++ [Security](security/README.md) | ||
| 14 | ++ [System hooks](system_hooks/system_hooks.md) | ||
| 15 | ++ [Update](update/README.md) | ||
| 16 | ++ [Web hooks](web_hooks/web_hooks.md) | ||
| 17 | ++ [Workflow](workflow/workflow.md) |
doc/api/README.md
| 1 | # GitLab API | 1 | # GitLab API |
| 2 | 2 | ||
| 3 | +## End-points | ||
| 4 | + | ||
| 5 | ++ [Users](users.md) | ||
| 6 | ++ [Session](session.md) | ||
| 7 | ++ [Projects](projects.md) | ||
| 8 | ++ [Project Snippets](project_snippets.md) | ||
| 9 | ++ [Repositories](repositories.md) | ||
| 10 | ++ [Repository Files](repository_files.md) | ||
| 11 | ++ [Commits](commits.md) | ||
| 12 | ++ [Merge Requests](merge_requests.md) | ||
| 13 | ++ [Issues](issues.md) | ||
| 14 | ++ [Milestones](milestones.md) | ||
| 15 | ++ [Notes](notes.md) | ||
| 16 | ++ [Deploy Keys](deploy_keys.md) | ||
| 17 | ++ [System Hooks](system_hooks.md) | ||
| 18 | ++ [Groups](groups.md) | ||
| 19 | + | ||
| 20 | +## Clients | ||
| 21 | + | ||
| 22 | ++ [php-gitlab-api](https://github.com/m4tthumphrey/php-gitlab-api) - PHP | ||
| 23 | ++ [Ruby Wrapper](https://github.com/NARKOZ/gitlab) - Ruby | ||
| 24 | ++ [python-gitlab](https://github.com/Itxaka/python-gitlab) - Python | ||
| 25 | ++ [java-gitlab-api](https://github.com/timols/java-gitlab-api) - Java | ||
| 26 | + | ||
| 27 | +## Introduction | ||
| 28 | + | ||
| 3 | All API requests require authentication. You need to pass a `private_token` parameter by url or header. If passed as header, the header name must be "PRIVATE-TOKEN" (capital and with dash instead of underscore). You can find or reset your private token in your profile. | 29 | All API requests require authentication. You need to pass a `private_token` parameter by url or header. If passed as header, the header name must be "PRIVATE-TOKEN" (capital and with dash instead of underscore). You can find or reset your private token in your profile. |
| 4 | 30 | ||
| 5 | If no, or an invalid, `private_token` is provided then an error message will be returned with status code 401: | 31 | If no, or an invalid, `private_token` is provided then an error message will be returned with status code 401: |
| @@ -117,30 +143,3 @@ Issue | @@ -117,30 +143,3 @@ Issue | ||
| 117 | 143 | ||
| 118 | So if you want to get issue with api you use `http://host/api/v3/.../issues/:id.json` | 144 | So if you want to get issue with api you use `http://host/api/v3/.../issues/:id.json` |
| 119 | But when you want to create a link to web page - use `http:://host/project/issues/:iid.json` | 145 | But when you want to create a link to web page - use `http:://host/project/issues/:iid.json` |
| 120 | - | ||
| 121 | - | ||
| 122 | - | ||
| 123 | -## Contents | ||
| 124 | - | ||
| 125 | -+ [Users](users.md) | ||
| 126 | -+ [Session](session.md) | ||
| 127 | -+ [Projects](projects.md) | ||
| 128 | -+ [Project Snippets](project_snippets.md) | ||
| 129 | -+ [Repositories](repositories.md) | ||
| 130 | -+ [Repository Files](repository_files.md) | ||
| 131 | -+ [Commits](commits.md) | ||
| 132 | -+ [Merge Requests](merge_requests.md) | ||
| 133 | -+ [Issues](issues.md) | ||
| 134 | -+ [Milestones](milestones.md) | ||
| 135 | -+ [Notes](notes.md) | ||
| 136 | -+ [Deploy Keys](deploy_keys.md) | ||
| 137 | -+ [System Hooks](system_hooks.md) | ||
| 138 | -+ [Groups](groups.md) | ||
| 139 | - | ||
| 140 | - | ||
| 141 | -## Clients | ||
| 142 | - | ||
| 143 | -+ [php-gitlab-api](https://github.com/m4tthumphrey/php-gitlab-api) - PHP | ||
| 144 | -+ [Ruby Wrapper](https://github.com/NARKOZ/gitlab) - Ruby | ||
| 145 | -+ [python-gitlab](https://github.com/Itxaka/python-gitlab) - Python | ||
| 146 | -+ [java-gitlab-api](https://github.com/timols/java-gitlab-api) - Java |