Skip to content

G
gitlab-ce
Commit 260659e1 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis
Browse files
Options

Merge branch 'docs-api-docs-followup-1' into 'master' 

Docs: Clean up EE api docs that were merged to CE

See merge request gitlab-org/gitlab-ce!30338
parents 9a4b5f08 8ac2c3ef
Expand all Show whitespace changes
Inline Side-by-side
Showing with 231 additions and 210 deletions
doc/api/group_boards.md
View file @ 260659e1
...@@ -5,7 +5,7 @@ Every API call to group boards must be authenticated. ...@@ -5,7 +5,7 @@ Every API call to group boards must be authenticated.
If a user is not a member of a group and the group is private, a `GET` If a user is not a member of a group and the group is private, a `GET`
request will result in `404` status code. request will result in `404` status code.
## Group Board ## List all group issue boards in a group
Lists Issue Boards in the given group. Lists Issue Boards in the given group.
...@@ -71,8 +71,7 @@ Example response: ...@@ -71,8 +71,7 @@ Example response:
``` ```
Users on GitLab [Premium, Silver, or higher](https://about.gitlab.com/pricing/) will see Users on GitLab [Premium, Silver, or higher](https://about.gitlab.com/pricing/) will see
different parameters, due to the ability to have multiple group boards. Refer to the table different parameters, due to the ability to have multiple group boards.
above to see what enpoint(s) belong to each tier.
Example response: Example response:
...@@ -123,9 +122,9 @@ Example response: ...@@ -123,9 +122,9 @@ Example response:
] ]
``` ```
## Single board ## Single group issue board
Gets a single board. Gets a single group issue board.
``` ```
GET /groups/:id/boards/:board_id GET /groups/:id/boards/:board_id
...@@ -188,7 +187,7 @@ Example response: ...@@ -188,7 +187,7 @@ Example response:
``` ```
Users on GitLab [Premium, Silver, or higher](https://about.gitlab.com/pricing/) will see Users on GitLab [Premium, Silver, or higher](https://about.gitlab.com/pricing/) will see
different parameters, due to the ability to have multiple group boards: different parameters, due to the ability to have multiple group issue boards.s
Example response: Example response:
...@@ -237,7 +236,7 @@ Example response: ...@@ -237,7 +236,7 @@ Example response:
} }
``` ```
## Create a Group Issue Board **[PREMIUM]** ## Create a group issue board **[PREMIUM]**
Creates a Group Issue Board. Creates a Group Issue Board.
...@@ -301,9 +300,9 @@ Example response: ...@@ -301,9 +300,9 @@ Example response:
} }
``` ```
## Update a Group Issue Board **[PREMIUM]** ## Update a group issue board **[PREMIUM]**
> [Introduced][ee-5954] in GitLab 11.1. > [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/5954) in GitLab 11.1.
Updates a Group Issue Board. Updates a Group Issue Board.
...@@ -321,7 +320,6 @@ PUT /groups/:id/boards/:board_id ...@@ -321,7 +320,6 @@ PUT /groups/:id/boards/:board_id
| `labels` | string | no | Comma-separated list of label names which the board should be scoped to | | `labels` | string | no | Comma-separated list of label names which the board should be scoped to |
| `weight` | integer | no | The weight range from 0 to 9, to which the board should be scoped to | | `weight` | integer | no | The weight range from 0 to 9, to which the board should be scoped to |
```bash ```bash
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/boards/1?name=new_name&milestone_id=44&assignee_id=1&labels=GroupLabel&weight=4 curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/boards/1?name=new_name&milestone_id=44&assignee_id=1&labels=GroupLabel&weight=4
``` ```
...@@ -370,7 +368,7 @@ Example response: ...@@ -370,7 +368,7 @@ Example response:
} }
``` ```
## Delete a Group Issue Board **[PREMIUM]** ## Delete a group issue board **[PREMIUM]**
Deletes a Group Issue Board. Deletes a Group Issue Board.
...@@ -387,7 +385,7 @@ DELETE /groups/:id/boards/:board_id ...@@ -387,7 +385,7 @@ DELETE /groups/:id/boards/:board_id
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/boards/1 curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/boards/1
``` ```
## List board lists ## List group issue board lists
Get a list of the board's lists. Get a list of the board's lists.
Does not include `open` and `closed` lists Does not include `open` and `closed` lists
...@@ -439,7 +437,7 @@ Example response: ...@@ -439,7 +437,7 @@ Example response:
] ]
``` ```
## Single board list ## Single group issue board list
Get a single board list. Get a single board list.
...@@ -471,7 +469,7 @@ Example response: ...@@ -471,7 +469,7 @@ Example response:
} }
``` ```
## New board list ## New group issue board list
Creates a new Issue Board list. Creates a new Issue Board list.
...@@ -503,7 +501,7 @@ Example response: ...@@ -503,7 +501,7 @@ Example response:
} }
``` ```
## Edit board list ## Edit group issue board list
Updates an existing Issue Board list. This call is used to change list position. Updates an existing Issue Board list. This call is used to change list position.
...@@ -536,7 +534,7 @@ Example response: ...@@ -536,7 +534,7 @@ Example response:
} }
``` ```
## Delete a board list ## Delete a group issue board list
Only for admins and group owners. Soft deletes the board list in question. Only for admins and group owners. Soft deletes the board list in question.
...@@ -553,5 +551,3 @@ DELETE /groups/:id/boards/:board_id/lists/:list_id ...@@ -553,5 +551,3 @@ DELETE /groups/:id/boards/:board_id/lists/:list_id
```bash ```bash
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/boards/1/lists/1 curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/boards/1/lists/1
``` ```
[ee-5954]: https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/5954
doc/api/groups.md
View file @ 260659e1
...@@ -8,7 +8,7 @@ authentication, only public groups are returned. ...@@ -8,7 +8,7 @@ authentication, only public groups are returned.
Parameters: Parameters:
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | ------------------------ | ----------------- | -------- | ---------- |
| `skip_groups` | array of integers | no | Skip the group IDs passed | | `skip_groups` | array of integers | no | Skip the group IDs passed |
| `all_available` | boolean | no | Show all the groups you have access to (defaults to `false` for authenticated users, `true` for admin); Attributes `owned` and `min_access_level` have precedence | | `all_available` | boolean | no | Show all the groups you have access to (defaults to `false` for authenticated users, `true` for admin); Attributes `owned` and `min_access_level` have precedence |
| `search` | string | no | Return the list of authorized groups matching the search criteria | | `search` | string | no | Return the list of authorized groups matching the search criteria |
...@@ -95,10 +95,10 @@ When accessed without authentication, only public groups are returned. ...@@ -95,10 +95,10 @@ When accessed without authentication, only public groups are returned.
Parameters: Parameters:
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | ------------------------ | ----------------- | -------- | ----------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) of the parent group | | `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) of the parent group |
| `skip_groups` | array of integers | no | Skip the group IDs passed | | `skip_groups` | array of integers | no | Skip the group IDs passed |
| `all_available` | boolean | no | Show all the groups you have access to (defaults to `false` for authenticated users, `true` for admin); Attributes `owned` and `min_access_level` have precedence | | `all_available` | boolean | no | Show all the groups you have access to (defaults to `false` for authenticated users, `true` for admin); Attributes `owned` and `min_access_level` have preceden |
| `search` | string | no | Return the list of authorized groups matching the search criteria | | `search` | string | no | Return the list of authorized groups matching the search criteria |
| `order_by` | string | no | Order groups by `name`, `path` or `id`. Default is `name` | | `order_by` | string | no | Order groups by `name`, `path` or `id`. Default is `name` |
| `sort` | string | no | Order groups in `asc` or `desc` order. Default is `asc` | | `sort` | string | no | Order groups in `asc` or `desc` order. Default is `asc` |
...@@ -143,7 +143,7 @@ GET /groups/:id/projects ...@@ -143,7 +143,7 @@ GET /groups/:id/projects
Parameters: Parameters:
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | ----------------------------- | -------------- | -------- | ----------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | | `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user |
| `archived` | boolean | no | Limit by archived status | | `archived` | boolean | no | Limit by archived status |
| `visibility` | string | no | Limit by visibility `public`, `internal`, or `private` | | `visibility` | string | no | Limit by visibility `public`, `internal`, or `private` |
...@@ -215,9 +215,9 @@ GET /groups/:id ...@@ -215,9 +215,9 @@ GET /groups/:id
Parameters: Parameters:
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | ------------------------ | -------------- | -------- | ----------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | | `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user. |
| `with_custom_attributes` | boolean | no | Include [custom attributes](custom_attributes.md) in response (admins only) | | `with_custom_attributes` | boolean | no | Include [custom attributes](custom_attributes.md) in response (admins only). |
| `with_projects` | boolean | no | Include details from projects that belong to the specified group (defaults to `true`). | | `with_projects` | boolean | no | Include details from projects that belong to the specified group (defaults to `true`). |
```bash ```bash
...@@ -378,11 +378,16 @@ Example response: ...@@ -378,11 +378,16 @@ Example response:
Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see
the `shared_runners_minutes_limit` and `extra_shared_runners_minutes_limit` parameters: the `shared_runners_minutes_limit` and `extra_shared_runners_minutes_limit` parameters:
Additional response parameters: **[STARTER]** Additional response parameters:
```json ```json
{
"id": 4,
"description": "Aliquid qui quis dignissimos distinctio ut commodi voluptas est.",
"shared_runners_minutes_limit": 133, "shared_runners_minutes_limit": 133,
"extra_shared_runners_minutes_limit": 133, "extra_shared_runners_minutes_limit": 133,
...
}
``` ```
When adding the parameter `with_projects=false`, projects will not be returned. When adding the parameter `with_projects=false`, projects will not be returned.
...@@ -421,12 +426,12 @@ POST /groups ...@@ -421,12 +426,12 @@ POST /groups
Parameters: Parameters:
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | ------------------------------------ | ------- | -------- | ----------- |
| `name` | string | yes | The name of the group | | `name` | string | yes | The name of the group. |
| `path` | string | yes | The path of the group | | `path` | string | yes | The path of the group. |
| `description` | string | no | The group's description | | `description` | string | no | The group's description. |
| `visibility` | string | no | The group's visibility. Can be `private`, `internal`, or `public`. | | `visibility` | string | no | The group's visibility. Can be `private`, `internal`, or `public`. |
| `lfs_enabled` | boolean | no | Enable/disable Large File Storage (LFS) for the projects in this group | | `lfs_enabled` | boolean | no | Enable/disable Large File Storage (LFS) for the projects in this group. |
| `request_access_enabled` | boolean | no | Allow users to request member access. | | `request_access_enabled` | boolean | no | Allow users to request member access. |
| `parent_id` | integer | no | The parent group ID for creating nested group. | | `parent_id` | integer | no | The parent group ID for creating nested group. |
| `shared_runners_minutes_limit` | integer | no | **[STARTER ONLY]** Pipeline minutes quota for this group. | | `shared_runners_minutes_limit` | integer | no | **[STARTER ONLY]** Pipeline minutes quota for this group. |
...@@ -443,7 +448,7 @@ POST /groups/:id/projects/:project_id ...@@ -443,7 +448,7 @@ POST /groups/:id/projects/:project_id
Parameters: Parameters:
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | ------------ | -------------- | -------- | ----------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | | `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user |
| `project_id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) | | `project_id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
...@@ -456,19 +461,19 @@ PUT /groups/:id ...@@ -456,19 +461,19 @@ PUT /groups/:id
``` ```
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | ------------------------------------ | ------- | -------- | ----------- |
| `id` | integer | yes | The ID of the group | | `id` | integer | yes | The ID of the group. |
| `name` | string | no | The name of the group | | `name` | string | no | The name of the group. |
| `path` | string | no | The path of the group | | `path` | string | no | The path of the group. |
| `description` | string | no | The description of the group | | `description` | string | no | The description of the group. |
| `membership_lock` | boolean | no | **[STARTER]** Prevent adding new members to project membership within this group | | `membership_lock` | boolean | no | **[STARTER]** Prevent adding new members to project membership within this group. |
| `share_with_group_lock` | boolean | no | Prevent sharing a project with another group within this group | | `share_with_group_lock` | boolean | no | Prevent sharing a project with another group within this group. |
| `visibility` | string | no | The visibility level of the group. Can be `private`, `internal`, or `public`. | | `visibility` | string | no | The visibility level of the group. Can be `private`, `internal`, or `public`. |
| `lfs_enabled` (optional) | boolean | no | Enable/disable Large File Storage (LFS) for the projects in this group | | `lfs_enabled` (optional) | boolean | no | Enable/disable Large File Storage (LFS) for the projects in this group. |
| `request_access_enabled` | boolean | no | Allow users to request member access. | | `request_access_enabled` | boolean | no | Allow users to request member access. |
| `file_template_project_id` | integer | no | **[PREMIUM]** The ID of a project to load custom file templates from | | `file_template_project_id` | integer | no | **[PREMIUM]** The ID of a project to load custom file templates from. |
| `shared_runners_minutes_limit` | integer | no | **[STARTER ONLY]** Pipeline minutes quota for this group | | `shared_runners_minutes_limit` | integer | no | **[STARTER ONLY]** Pipeline minutes quota for this group. |
| `extra_shared_runners_minutes_limit` | integer | no | **[STARTER ONLY]** Extra pipeline minutes quota for this group | | `extra_shared_runners_minutes_limit` | integer | no | **[STARTER ONLY]** Extra pipeline minutes quota for this group. |
```bash ```bash
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5?name=Experimental" curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5?name=Experimental"
......
doc/api/merge_requests.md
View file @ 260659e1
...@@ -850,9 +850,9 @@ If `approvals_before_merge` **[STARTER]** is not provided, it inherits the value ...@@ -850,9 +850,9 @@ If `approvals_before_merge` **[STARTER]** is not provided, it inherits the value
target project. If it is provided, then the following conditions must hold in target project. If it is provided, then the following conditions must hold in
order for it to take effect: order for it to take effect:
1. The target project's `approvals_before_merge` must be greater than zero. (A 1. The target project's `approvals_before_merge` must be greater than zero. A
value of zero disables approvals for that project.) value of zero disables approvals for that project.
2. The provided value of `approvals_before_merge` must be greater than the 1. The provided value of `approvals_before_merge` must be greater than the
target project's `approvals_before_merge`. target project's `approvals_before_merge`.
```json ```json
......
doc/api/namespaces.md
View file @ 260659e1
...@@ -68,7 +68,7 @@ the `plan` parameter associated with a namespace: ...@@ -68,7 +68,7 @@ the `plan` parameter associated with a namespace:
] ]
``` ```
**Note**: Only group maintainers/owners are presented with `members_count_with_descendants`, as well as `plan` **[BRONZE ONLY]**. NOTE: **Note:** Only group maintainers/owners are presented with `members_count_with_descendants`, as well as `plan` **[BRONZE ONLY]**.
## Search for namespace ## Search for namespace
......
doc/api/notification_settings.md
View file @ 260659e1
# Notification settings API # Notification settings API
>**Note:** This feature was [introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/5632) in GitLab 8.12. > [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/5632) in GitLab 8.12.
**Valid notification levels** ## Valid notification levels
The notification levels are defined in the `NotificationSetting.level` model enumeration. Currently, these levels are recognized: The notification levels are defined in the `NotificationSetting.level` model enumeration. Currently, these levels are recognized:
...@@ -33,7 +33,6 @@ If the `custom` level is used, specific email events can be controlled. Availabl ...@@ -33,7 +33,6 @@ If the `custom` level is used, specific email events can be controlled. Availabl
- `success_pipeline` - `success_pipeline`
- `new_epic` **[ULTIMATE]** - `new_epic` **[ULTIMATE]**
## Global notification settings ## Global notification settings
Get current notification settings and email address. Get current notification settings and email address.
......
doc/api/pipeline_schedules.md
View file @ 260659e1
...@@ -108,9 +108,9 @@ POST /projects/:id/pipeline_schedules ...@@ -108,9 +108,9 @@ POST /projects/:id/pipeline_schedules
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `description` | string | yes | The description of pipeline schedule | | `description` | string | yes | The description of pipeline schedule |
| `ref` | string | yes | The branch/tag name will be triggered | | `ref` | string | yes | The branch/tag name will be triggered |
| `cron ` | string | yes | The cron (e.g. `0 1 * * *`) ([Cron syntax](https://en.wikipedia.org/wiki/Cron)) | | `cron` | string | yes | The cron (e.g. `0 1 * * *`) ([Cron syntax](https://en.wikipedia.org/wiki/Cron)) |
| `cron_timezone ` | string | no | The timezone supported by `ActiveSupport::TimeZone` (e.g. `Pacific Time (US & Canada)`) (default: `'UTC'`) | | `cron_timezone` | string | no | The timezone supported by `ActiveSupport::TimeZone` (e.g. `Pacific Time (US & Canada)`) (default: `'UTC'`) |
| `active ` | boolean | no | The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially (default: `true`) | | `active` | boolean | no | The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially (default: `true`) |
```sh ```sh
curl --request POST --header "PRIVATE-TOKEN: k5ESFgWY2Qf5xEvDcFxZ" --form description="Build packages" --form ref="master" --form cron="0 1 * * 5" --form cron_timezone="UTC" --form active="true" "https://gitlab.example.com/api/v4/projects/29/pipeline_schedules" curl --request POST --header "PRIVATE-TOKEN: k5ESFgWY2Qf5xEvDcFxZ" --form description="Build packages" --form ref="master" --form cron="0 1 * * 5" --form cron_timezone="UTC" --form active="true" "https://gitlab.example.com/api/v4/projects/29/pipeline_schedules"
...@@ -153,9 +153,9 @@ PUT /projects/:id/pipeline_schedules/:pipeline_schedule_id ...@@ -153,9 +153,9 @@ PUT /projects/:id/pipeline_schedules/:pipeline_schedule_id
| `pipeline_schedule_id` | integer | yes | The pipeline schedule id | | `pipeline_schedule_id` | integer | yes | The pipeline schedule id |
| `description` | string | no | The description of pipeline schedule | | `description` | string | no | The description of pipeline schedule |
| `ref` | string | no | The branch/tag name will be triggered | | `ref` | string | no | The branch/tag name will be triggered |
| `cron ` | string | no | The cron (e.g. `0 1 * * *`) ([Cron syntax](https://en.wikipedia.org/wiki/Cron)) | | `cron` | string | no | The cron (e.g. `0 1 * * *`) ([Cron syntax](https://en.wikipedia.org/wiki/Cron)) |
| `cron_timezone ` | string | no | The timezone supported by `ActiveSupport::TimeZone` (e.g. `Pacific Time (US & Canada)`) or `TZInfo::Timezone` (e.g. `America/Los_Angeles`) | | `cron_timezone` | string | no | The timezone supported by `ActiveSupport::TimeZone` (e.g. `Pacific Time (US & Canada)`) or `TZInfo::Timezone` (e.g. `America/Los_Angeles`) |
| `active ` | boolean | no | The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially. | | `active` | boolean | no | The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially. |
```sh ```sh
curl --request PUT --header "PRIVATE-TOKEN: k5ESFgWY2Qf5xEvDcFxZ" --form cron="0 2 * * *" "https://gitlab.example.com/api/v4/projects/29/pipeline_schedules/13" curl --request PUT --header "PRIVATE-TOKEN: k5ESFgWY2Qf5xEvDcFxZ" --form cron="0 2 * * *" "https://gitlab.example.com/api/v4/projects/29/pipeline_schedules/13"
......
doc/api/projects.md
View file @ 260659e1
...@@ -55,8 +55,8 @@ GET /projects ...@@ -55,8 +55,8 @@ GET /projects
| `with_issues_enabled` | boolean | no | Limit by enabled issues feature | | `with_issues_enabled` | boolean | no | Limit by enabled issues feature |
| `with_merge_requests_enabled` | boolean | no | Limit by enabled merge requests feature | | `with_merge_requests_enabled` | boolean | no | Limit by enabled merge requests feature |
| `with_programming_language` | string | no | Limit by projects which use the given programming language | | `with_programming_language` | string | no | Limit by projects which use the given programming language |
| `wiki_checksum_failed` | boolean | no | **[PREMIUM]** Limit projects where the wiki checksum calculation has failed *([Introduced](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/6137) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.2)* | | `wiki_checksum_failed` | boolean | no | **[PREMIUM]** Limit projects where the wiki checksum calculation has failed ([Introduced](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/6137) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.2) |
| `repository_checksum_failed` | boolean | no | **[PREMIUM]** Limit projects where the repository checksum calculation has failed *([Introduced](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/6137) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.2)* | | `repository_checksum_failed` | boolean | no | **[PREMIUM]** Limit projects where the repository checksum calculation has failed ([Introduced](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/6137) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.2) |
| `min_access_level` | integer | no | Limit by current user minimal [access level](members.md) | | `min_access_level` | integer | no | Limit by current user minimal [access level](members.md) |
When `simple=true` or the user is unauthenticated this returns something like: When `simple=true` or the user is unauthenticated this returns something like:
...@@ -734,7 +734,7 @@ POST /projects ...@@ -734,7 +734,7 @@ POST /projects
| `mirror_trigger_builds` | boolean | no | **[STARTER]** Pull mirroring triggers builds | | `mirror_trigger_builds` | boolean | no | **[STARTER]** Pull mirroring triggers builds |
| `initialize_with_readme` | boolean | no | `false` by default | | `initialize_with_readme` | boolean | no | `false` by default |
>**Note**: If your HTTP repository is not publicly accessible, NOTE: **Note:** If your HTTP repository is not publicly accessible,
add authentication information to the URL: `https://username:password@gitlab.company.com/group/project.git` add authentication information to the URL: `https://username:password@gitlab.company.com/group/project.git`
where `password` is a public access key with the `api` scope enabled. where `password` is a public access key with the `api` scope enabled.
...@@ -779,7 +779,7 @@ POST /projects/user/:user_id ...@@ -779,7 +779,7 @@ POST /projects/user/:user_id
| `mirror` | boolean | no | **[STARTER]** Enables pull mirroring in a project | | `mirror` | boolean | no | **[STARTER]** Enables pull mirroring in a project |
| `mirror_trigger_builds` | boolean | no | **[STARTER]** Pull mirroring triggers builds | | `mirror_trigger_builds` | boolean | no | **[STARTER]** Pull mirroring triggers builds |
>**Note**: If your HTTP repository is not publicly accessible, NOTE: **Note:** If your HTTP repository is not publicly accessible,
add authentication information to the URL: `https://username:password@gitlab.company.com/group/project.git` add authentication information to the URL: `https://username:password@gitlab.company.com/group/project.git`
where `password` is a public access key with the `api` scope enabled. where `password` is a public access key with the `api` scope enabled.
...@@ -828,7 +828,7 @@ PUT /projects/:id ...@@ -828,7 +828,7 @@ PUT /projects/:id
| `mirror_overwrites_diverged_branches` | boolean | no | **[STARTER]** Pull mirror overwrites diverged branches | | `mirror_overwrites_diverged_branches` | boolean | no | **[STARTER]** Pull mirror overwrites diverged branches |
| `packages_enabled` | boolean | no | **[PREMIUM ONLY]** Enable or disable packages repository feature | | `packages_enabled` | boolean | no | **[PREMIUM ONLY]** Enable or disable packages repository feature |
>**Note**: If your HTTP repository is not publicly accessible, NOTE: **Note:** If your HTTP repository is not publicly accessible,
add authentication information to the URL: `https://username:password@gitlab.company.com/group/project.git` add authentication information to the URL: `https://username:password@gitlab.company.com/group/project.git`
where `password` is a public access key with the `api` scope enabled. where `password` is a public access key with the `api` scope enabled.
...@@ -1354,7 +1354,7 @@ Example response: ...@@ -1354,7 +1354,7 @@ Example response:
## Remove project ## Remove project
Removes a project including all associated resources (issues, merge requests etc.) Removes a project including all associated resources (issues, merge requests etc).
``` ```
DELETE /projects/:id DELETE /projects/:id
...@@ -1643,10 +1643,17 @@ GET /projects/:id/push_rule ...@@ -1643,10 +1643,17 @@ GET /projects/:id/push_rule
} }
``` ```
The following attributes are restricted to certain plans, and will not appear if Users on GitLab [Premium, Silver, or higher](https://about.gitlab.com/pricing/) will also see
you do not have access to those features: the `commit_committer_check` parameter:
* `commit_committer_check` only available on **[PREMIUM]** ```json
{
"id": 1,
"project_id": 3,
"commit_committer_check": false
...
}
```
### Add project push rule ### Add project push rule
......
doc/api/settings.md
View file @ 260659e1
This diff is collapsed.
doc/api/users.md
View file @ 260659e1
...@@ -71,7 +71,7 @@ GET /users ...@@ -71,7 +71,7 @@ GET /users
``` ```
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | ------------ | ------ | -------- | ----------- |
| `order_by` | string | no | Return users ordered by `id`, `name`, `username`, `created_at`, or `updated_at` fields. Default is `id` | | `order_by` | string | no | Return users ordered by `id`, `name`, `username`, `created_at`, or `updated_at` fields. Default is `id` |
| `sort` | string | no | Return users sorted in `asc` or `desc` order. Default is `desc` | | `sort` | string | no | Return users sorted in `asc` or `desc` order. Default is `desc` |
| `two_factor` | string | no | Filter users by Two-factor authentication. Filter values are `enabled` or `disabled`. By default it returns all users | | `two_factor` | string | no | Filter users by Two-factor authentication. Filter values are `enabled` or `disabled`. By default it returns all users |
...@@ -284,7 +284,19 @@ Example Responses: ...@@ -284,7 +284,19 @@ Example Responses:
Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see
the `shared_runners_minutes_limit` and `extra_shared_runners_minutes_limit` parameters. the `shared_runners_minutes_limit` and `extra_shared_runners_minutes_limit` parameters.
Users on GitLab Silver will also see the `group_saml` option:
```json
{
"id": 1,
"username": "john_smith",
"shared_runners_minutes_limit": 133,
"extra_shared_runners_minutes_limit": 133
...
}
```
Users on GitLab.com [Silver, or higher](https://about.gitlab.com/pricing/) will also
see the `group_saml` option:
```json ```json
{ {
...@@ -408,9 +420,7 @@ Parameters: ...@@ -408,9 +420,7 @@ Parameters:
[moved to the ghost user](../user/profile/account/delete_account.md#associated-records) [moved to the ghost user](../user/profile/account/delete_account.md#associated-records)
will be deleted instead, as well as groups owned solely by this user. will be deleted instead, as well as groups owned solely by this user.
## User ## List current user (for normal users)
### For normal users
Gets currently authenticated user. Gets currently authenticated user.
...@@ -456,7 +466,7 @@ GET /user ...@@ -456,7 +466,7 @@ GET /user
} }
``` ```
### For admins ## List current user (for admins)
Parameters: Parameters:
...@@ -536,7 +546,7 @@ GET /users/:id_or_username/status ...@@ -536,7 +546,7 @@ GET /users/:id_or_username/status
``` ```
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | ---------------- | ------ | -------- | ----------- |
| `id_or_username` | string | yes | The id or username of the user to get a status of | | `id_or_username` | string | yes | The id or username of the user to get a status of |
```bash ```bash
...@@ -562,7 +572,7 @@ PUT /user/status ...@@ -562,7 +572,7 @@ PUT /user/status
``` ```
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ------ | -------- | ----------- |
| `emoji` | string | no | The name of the emoji to use as status, if omitted `speech_balloon` is used. Emoji name can be one of the specified names in the [Gemojione index][gemojione-index]. | | `emoji` | string | no | The name of the emoji to use as status, if omitted `speech_balloon` is used. Emoji name can be one of the specified names in the [Gemojione index][gemojione-index]. |
| `message` | string | no | The message to set as a status. It can also contain emoji codes. | | `message` | string | no | The message to set as a status. It can also contain emoji codes. |
...@@ -584,7 +594,7 @@ Example responses ...@@ -584,7 +594,7 @@ Example responses
## List user projects ## List user projects
Please refer to the [List of user projects ](projects.md#list-user-projects). Please refer to the [List of user projects](projects.md#list-user-projects).
## List SSH keys ## List SSH keys
...@@ -761,7 +771,7 @@ GET /user/gpg_keys/:key_id ...@@ -761,7 +771,7 @@ GET /user/gpg_keys/:key_id
Parameters: Parameters:
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ------- | -------- | ----------- |
| `key_id` | integer | yes | The ID of the GPG key | | `key_id` | integer | yes | The ID of the GPG key |
```bash ```bash
...@@ -789,7 +799,7 @@ POST /user/gpg_keys ...@@ -789,7 +799,7 @@ POST /user/gpg_keys
Parameters: Parameters:
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ------ | -------- | ----------- |
| key | string | yes | The new GPG key | | key | string | yes | The new GPG key |
```bash ```bash
...@@ -819,7 +829,7 @@ DELETE /user/gpg_keys/:key_id ...@@ -819,7 +829,7 @@ DELETE /user/gpg_keys/:key_id
Parameters: Parameters:
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ------- | -------- | ----------- |
| `key_id` | integer | yes | The ID of the GPG key | | `key_id` | integer | yes | The ID of the GPG key |
```bash ```bash
...@@ -839,7 +849,7 @@ GET /users/:id/gpg_keys ...@@ -839,7 +849,7 @@ GET /users/:id/gpg_keys
Parameters: Parameters:
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ------- | -------- | ----------- |
| `id` | integer | yes | The ID of the user | | `id` | integer | yes | The ID of the user |
```bash ```bash
...@@ -869,7 +879,7 @@ GET /users/:id/gpg_keys/:key_id ...@@ -869,7 +879,7 @@ GET /users/:id/gpg_keys/:key_id
Parameters: Parameters:
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ------- | -------- | ----------- |
| `id` | integer | yes | The ID of the user | | `id` | integer | yes | The ID of the user |
| `key_id` | integer | yes | The ID of the GPG key | | `key_id` | integer | yes | The ID of the GPG key |
...@@ -898,7 +908,7 @@ POST /users/:id/gpg_keys ...@@ -898,7 +908,7 @@ POST /users/:id/gpg_keys
Parameters: Parameters:
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ------- | -------- | ----------- |
| `id` | integer | yes | The ID of the user | | `id` | integer | yes | The ID of the user |
| `key_id` | integer | yes | The ID of the GPG key | | `key_id` | integer | yes | The ID of the GPG key |
...@@ -929,7 +939,7 @@ DELETE /users/:id/gpg_keys/:key_id ...@@ -929,7 +939,7 @@ DELETE /users/:id/gpg_keys/:key_id
Parameters: Parameters:
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ------- | -------- | ----------- |
| `id` | integer | yes | The ID of the user | | `id` | integer | yes | The ID of the user |
| `key_id` | integer | yes | The ID of the GPG key | | `key_id` | integer | yes | The ID of the GPG key |
...@@ -1113,7 +1123,7 @@ GET /users/:user_id/impersonation_tokens ...@@ -1113,7 +1123,7 @@ GET /users/:user_id/impersonation_tokens
Parameters: Parameters:
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ------- | -------- | ---------------------------------------------------------- |
| `user_id` | integer | yes | The ID of the user | | `user_id` | integer | yes | The ID of the user |
| `state` | string | no | filter tokens based on state (`all`, `active`, `inactive`) | | `state` | string | no | filter tokens based on state (`all`, `active`, `inactive`) |
...@@ -1165,7 +1175,7 @@ GET /users/:user_id/impersonation_tokens/:impersonation_token_id ...@@ -1165,7 +1175,7 @@ GET /users/:user_id/impersonation_tokens/:impersonation_token_id
Parameters: Parameters:
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | ------------------------ | ------- | -------- | --------------------------------- |
| `user_id` | integer | yes | The ID of the user | | `user_id` | integer | yes | The ID of the user |
| `impersonation_token_id` | integer | yes | The ID of the impersonation token | | `impersonation_token_id` | integer | yes | The ID of the impersonation token |
...@@ -1193,7 +1203,6 @@ Example response: ...@@ -1193,7 +1203,6 @@ Example response:
## Create an impersonation token ## Create an impersonation token
> Requires admin permissions. > Requires admin permissions.
> Token values are returned once. Make sure you save it - you won't be able to access it again. > Token values are returned once. Make sure you save it - you won't be able to access it again.
It creates a new impersonation token. Note that only administrators can do this. It creates a new impersonation token. Note that only administrators can do this.
...@@ -1206,7 +1215,7 @@ POST /users/:user_id/impersonation_tokens ...@@ -1206,7 +1215,7 @@ POST /users/:user_id/impersonation_tokens
``` ```
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | ------------ | ------- | -------- | ----------- |
| `user_id` | integer | yes | The ID of the user | | `user_id` | integer | yes | The ID of the user |
| `name` | string | yes | The name of the impersonation token | | `name` | string | yes | The name of the impersonation token |
| `expires_at` | date | no | The expiration date of the impersonation token in ISO format (`YYYY-MM-DD`)| | `expires_at` | date | no | The expiration date of the impersonation token in ISO format (`YYYY-MM-DD`)|
...@@ -1257,15 +1266,15 @@ Parameters: ...@@ -1257,15 +1266,15 @@ Parameters:
### Get user activities (admin only) ### Get user activities (admin only)
>**Note:** This API endpoint is only available on 8.15 (EE) and 9.1 (CE) and above. NOTE: **Note:** This API endpoint is only available on 8.15 (EE) and 9.1 (CE) and above.
Get the last activity date for all users, sorted from oldest to newest. Get the last activity date for all users, sorted from oldest to newest.
The activities that update the timestamp are: The activities that update the timestamp are:
- Git HTTP/SSH activities (such as clone, push) - Git HTTP/SSH activities (such as clone, push)
- User logging in into GitLab - User logging in into GitLab
- User visiting pages related to Dashboards, Projects, Issues and Merge Requests ([introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/54947) in GitLab 11.8) - User visiting pages related to Dashboards, Projects, Issues and Merge Requests ([introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/54947) in GitLab 11.8)
By default, it shows the activity for all users in the last 6 months, but this can be By default, it shows the activity for all users in the last 6 months, but this can be
amended by using the `from` parameter. amended by using the `from` 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
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7