Commit 1552a182 authored by Sean Packham (GitLab)'s avatar Sean Packham (GitLab)

Merge branch 'docs-add-api-to-all-headings-ee' into 'master'

Add "API" to all API docs

See merge request !1922
parents 1cc966a4 09187d88
# Group and project access requests
# Group and project access requests API
>**Note:** This feature was introduced in GitLab 8.11
......
# Award Emoji
# Award Emoji API
> [Introduced][ce-4575] in GitLab 8.9, Snippet support in 8.12
......
# Boards
# Issue Boards API
Every API call to boards must be authenticated.
......
# Branches
# Branches API
## List repository branches
......
# Broadcast Messages
# Broadcast Messages API
> **Note:** This feature was introduced in GitLab 8.12.
......
# Build Variables
# Build Variables API
## List project variables
......
# Validate the .gitlab-ci.yml
# Validate the .gitlab-ci.yml (API)
> [Introduced][ce-5953] in GitLab 8.12.
......
# Runners API
# Register and Delete Runners API
API used by Runners to register and delete themselves.
......
# Adding deploy keys to multiple projects
# Adding deploy keys to multiple projects via API
If you want to easily add the same deploy key to multiple projects in the same
group, this can be achieved quite easily with the API.
......
# Deploy Keys
# Deploy Keys API
## List all deploy keys
......
# Environments
# Environments API
## List environments
......
# Groups
# Groups API
## List groups
......
# Issues
# Issues API
Every API call to issues must be authenticated.
......
# Keys
# Keys API
## Get SSH key with user by ID of an SSH key
......
# Labels
# Labels API
## List labels
......
# Group and project members
# Group and project members API
**Valid access levels**
......
# Merge requests
# Merge requests API
## List merge requests
......
# Milestones
# Milestones API
## List project milestones
......
# Namespaces
# Namespaces API
Usernames and groupnames fall under a special category called namespaces.
......
# Notes
# Notes API
Notes are comments on snippets, issues or merge requests.
......
# Notification settings
# Notification settings API
>**Note:** This feature was [introduced][ce-5632] in GitLab 8.12.
......
# Pipeline triggers
# Pipeline triggers API
You can read more about [triggering pipelines through the API](../ci/triggers/README.md).
......
# Projects
# Projects API
### Project visibility level
......@@ -17,8 +16,6 @@ Constants for project visibility levels are next:
* `public`:
The project can be cloned without any authentication.
## List projects
Get a list of visible projects for authenticated user. When being accessed without authentication, all public projects are returned.
......
# Repositories
# Repositories API
## List repository tree
......
# Repository files
# Repository files API
**CRUD for repository files**
......
# Services
# Services API
## Asana
......
# Session
# Session API
## Deprecation Notice
......
# Application settings
# Application settings API
These API calls allow you to read and modify GitLab instance application
settings as appear in `/admin/application_settings`. You have to be an
......
# Sidekiq Metrics
# Sidekiq Metrics API
>**Note:** This endpoint is only available on GitLab 8.9 and above.
......
# Snippets
# Snippets API
> [Introduced][ce-6373] in GitLab 8.15.
......
# System hooks
# System hooks API
All methods require administrator authorization.
......
# Tags
# Tags API
## List project repository tags
......
# Gitignores
# Gitignores API
## List gitignore templates
......
# GitLab CI YMLs
# GitLab CI YMLs API
## List GitLab CI YML templates
......
# Licenses
# Licenses API
## List license templates
......
# Todos
# Todos API
> [Introduced][ce-3188] in GitLab 8.10.
......
# Users
# Users API
## List users
......
# V3 to V4 version
# API V3 to API V4
Since GitLab 9.0, API V4 is the preferred version to be used.
......@@ -65,7 +65,6 @@ Below are the changes made between V3 and V4.
- Return 202 with JSON body on async removals on V4 API (`DELETE /projects/:id/repository/merged_branches` and `DELETE /projects/:id`) [!9449](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/9449)
- `GET /projects/:id/milestones?iid[]=x&iid[]=y` array filter has been renamed to `iids` [!9096](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/9096)
- Return basic info about pipeline in `GET /projects/:id/pipelines` [!8875](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/8875)
- Simplify project payload exposed on Environment endpoints [!9675](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/9675)
- Renamed all `build` references to `job` [!9463](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/9463)
- Drop `GET /projects/:id/repository/commits/:sha/jobs` [!9463](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/9463)
- Rename Build Triggers to be Pipeline Triggers API [!9713](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/9713)
......@@ -81,11 +80,4 @@ Below are the changes made between V3 and V4.
- `GET /projects/:id/repository/blobs/:sha` now returns JSON attributes for the blob identified by `:sha`, instead of finding the commit identified by `:sha` and returning the raw content of the blob in that commit identified by the required `?filepath=:filepath`
- Moved `GET /projects/:id/repository/commits/:sha/blob?file_path=:file_path` and `GET /projects/:id/repository/blobs/:sha?file_path=:file_path` to `GET /projects/:id/repository/files/:file_path/raw?ref=:sha`
- `GET /projects/:id/repository/tree` parameter `ref_name` has been renamed to `ref` for consistency
- `confirm` parameter for `POST /users` has been deprecated in favor of `skip_confirmation` parameter
#### EE-specific
- Remove the ProjectGitHook API. Use the ProjectPushRule API instead [!1301](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/1301)
- Removed `repository_storage` from `PUT /application/settings` and `GET /application/settings` (use `repository_storages` instead) [!1307](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/1307)
- Removed `elasticsearch_host` and `elasticsearch_port` from `PUT /application/settings` (use `elasticsearch_url` instead) [!1305](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/1305)
- Make approval API more RESTful. Use `POST /projects/:id/merge_requests/:merge_request_iid/unapprove` to unapprove a merge request. [!1518](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/1518)
- `confirm` parameter for `POST /users` has been deprecated in favor of `skip_confirmation` parameter
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment