Commit a81a66b5 authored by Craig Norris's avatar Craig Norris

Merge branch '284446-unassigned-pages-futuretense-3' into 'master'

Remove yet MORE future tense from unowned docs

See merge request gitlab-org/gitlab!48176
parents c9a8a2f0 9cb82ddd
...@@ -16,7 +16,7 @@ If: ...@@ -16,7 +16,7 @@ If:
- No user with the given public email address is found, results from external avatar services are - No user with the given public email address is found, results from external avatar services are
returned. returned.
- Public visibility is restricted, response will be `403 Forbidden` when unauthenticated. - Public visibility is restricted, response is `403 Forbidden` when unauthenticated.
NOTE: **Note:** NOTE: **Note:**
This endpoint can be accessed without authentication. This endpoint can be accessed without authentication.
......
...@@ -9,7 +9,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -9,7 +9,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
Every API call to custom attributes must be authenticated as administrator. Every API call to custom attributes must be authenticated as administrator.
Custom attributes are currently available on users, groups, and projects, Custom attributes are currently available on users, groups, and projects,
which will be referred to as "resource" in this documentation. which is referred to as "resource" in this documentation.
## List custom attributes ## List custom attributes
...@@ -74,7 +74,7 @@ Example response: ...@@ -74,7 +74,7 @@ Example response:
## Set custom attribute ## Set custom attribute
Set a custom attribute on a resource. The attribute will be updated if it already exists, Set a custom attribute on a resource. The attribute is updated if it already exists,
or newly created otherwise. or newly created otherwise.
```plaintext ```plaintext
......
...@@ -41,11 +41,11 @@ The examples below: ...@@ -41,11 +41,11 @@ The examples below:
- Can be run directly against GitLab 11.0 or later, though some of the types and fields - Can be run directly against GitLab 11.0 or later, though some of the types and fields
may not be supported in older versions. may not be supported in older versions.
- Will work against GitLab.com without any further setup. Make sure you are signed in and - Works against GitLab.com without any further setup. Make sure you are signed in and
navigate to the [GraphiQL Explorer](https://gitlab.com/-/graphql-explorer). navigate to the [GraphiQL Explorer](https://gitlab.com/-/graphql-explorer).
If you want to run the queries locally, or on a self-managed instance, If you want to run the queries locally, or on a self-managed instance,
you will need to either: you must either:
- Create the `gitlab-org` group with a project called `graphql-sandbox` under it. Create - Create the `gitlab-org` group with a project called `graphql-sandbox` under it. Create
several issues within the project. several issues within the project.
...@@ -133,7 +133,7 @@ More about queries: ...@@ -133,7 +133,7 @@ More about queries:
### Authorization ### Authorization
Authorization uses the same engine as the GitLab application (and GitLab.com). So if you've signed in to GitLab Authorization uses the same engine as the GitLab application (and GitLab.com). So if you've signed in to GitLab
and use GraphiQL, all queries will be performed as you, the signed in user. For more information, see the and use GraphiQL, all queries are performed as you, the signed in user. For more information, see the
[GitLab API documentation](../README.md#authentication). [GitLab API documentation](../README.md#authentication).
### Mutations ### Mutations
...@@ -173,7 +173,7 @@ mutation { ...@@ -173,7 +173,7 @@ mutation {
``` ```
Example: Add a comment to the issue (we're using the ID of the `GitLab.com` issue - but Example: Add a comment to the issue (we're using the ID of the `GitLab.com` issue - but
if you're using a local instance, you'll need to get the ID of an issue you can write to). if you're using a local instance, you must get the ID of an issue you can write to).
```graphql ```graphql
mutation { mutation {
...@@ -314,9 +314,9 @@ Pagination is a way of only asking for a subset of the records (say, the first 1 ...@@ -314,9 +314,9 @@ Pagination is a way of only asking for a subset of the records (say, the first 1
If we want more of them, we can make another request for the next 10 from the server If we want more of them, we can make another request for the next 10 from the server
(in the form of something like "please give me the next 10 records"). (in the form of something like "please give me the next 10 records").
By default, GitLab's GraphQL API will return only the first 100 records of any collection. By default, GitLab's GraphQL API returns only the first 100 records of any collection.
This can be changed by using `first` or `last` arguments. Both arguments take a value, This can be changed by using `first` or `last` arguments. Both arguments take a value,
so `first: 10` will return the first 10 records, and `last: 10` the last 10 records. so `first: 10` returns the first 10 records, and `last: 10` the last 10 records.
Example: Retrieve only the first 2 issues (slicing). The `cursor` field gives us a position from which Example: Retrieve only the first 2 issues (slicing). The `cursor` field gives us a position from which
we can retrieve further records relative to that one. we can retrieve further records relative to that one.
......
...@@ -10,15 +10,15 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -10,15 +10,15 @@ info: To determine the technical writer assigned to the Stage/Group associated w
## Placeholder tokens ## Placeholder tokens
Badges support placeholders that will be replaced in real time in both the link and image URL. The allowed placeholders are: Badges support placeholders that are replaced in real time in both the link and image URL. The allowed placeholders are:
- **%{project_path}**: will be replaced by the project path. - **%{project_path}**: replaced by the project path.
- **%{project_id}**: will be replaced by the project ID. - **%{project_id}**: replaced by the project ID.
- **%{default_branch}**: will be replaced by the project default branch. - **%{default_branch}**: replaced by the project default branch.
- **%{commit_sha}**: will be replaced by the last project's commit SHA. - **%{commit_sha}**: replaced by the last project's commit SHA.
Because these endpoints aren't inside a project's context, the information used to replace the placeholders will be Because these endpoints aren't inside a project's context, the information used to replace the placeholders comes
from the first group's project by creation date. If the group hasn't got any project the original URL with the placeholders will be returned. from the first group's project by creation date. If the group hasn't got any project the original URL with the placeholders is returned.
## List all badges of a group ## List all badges of a group
......
This diff is collapsed.
...@@ -53,7 +53,7 @@ Import your projects from Bitbucket Server to GitLab via the API. ...@@ -53,7 +53,7 @@ Import your projects from Bitbucket Server to GitLab via the API.
NOTE: **Note:** NOTE: **Note:**
The Bitbucket Project Key is only used for finding the repository in Bitbucket. The Bitbucket Project Key is only used for finding the repository in Bitbucket.
You must specify a `target_namespace` if you want to import the repository to a GitLab group. You must specify a `target_namespace` if you want to import the repository to a GitLab group.
If you do not specify `target_namespace`, the project will import to your personal user namespace. If you do not specify `target_namespace`, the project imports to your personal user namespace.
```plaintext ```plaintext
POST /import/bitbucket_server POST /import/bitbucket_server
......
...@@ -12,7 +12,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -12,7 +12,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
Get a list of a given issue's [related issues](../user/project/issues/related_issues.md), Get a list of a given issue's [related issues](../user/project/issues/related_issues.md),
sorted by the relationship creation datetime (ascending). sorted by the relationship creation datetime (ascending).
Issues will be filtered according to the user authorizations. Issues are filtered according to the user authorizations.
```plaintext ```plaintext
GET /projects/:id/issues/:issue_iid/links GET /projects/:id/issues/:issue_iid/links
......
...@@ -9,7 +9,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -9,7 +9,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
Every API call to issues_statistics must be authenticated. Every API call to issues_statistics must be authenticated.
If a user is not a member of a project and the project is private, a `GET` If a user is not a member of a project and the project is private, a `GET`
request on that project will result to a `404` status code. request on that project results in a `404` status code.
## Get issues statistics ## Get issues statistics
...@@ -40,7 +40,7 @@ GET /issues_statistics?confidential=true ...@@ -40,7 +40,7 @@ GET /issues_statistics?confidential=true
| `author_id` | integer | no | Return issues created by the given user `id`. Mutually exclusive with `author_username`. Combine with `scope=all` or `scope=assigned_to_me`. | | `author_id` | integer | no | Return issues created by the given user `id`. Mutually exclusive with `author_username`. Combine with `scope=all` or `scope=assigned_to_me`. |
| `author_username` | string | no | Return issues created by the given `username`. Similar to `author_id` and mutually exclusive with `author_id`. | | `author_username` | string | no | Return issues created by the given `username`. Similar to `author_id` and mutually exclusive with `author_id`. |
| `assignee_id` | integer | no | Return issues assigned to the given user `id`. Mutually exclusive with `assignee_username`. `None` returns unassigned issues. `Any` returns issues with an assignee. | | `assignee_id` | integer | no | Return issues assigned to the given user `id`. Mutually exclusive with `assignee_username`. `None` returns unassigned issues. `Any` returns issues with an assignee. |
| `assignee_username` | string array | no | Return issues assigned to the given `username`. Similar to `assignee_id` and mutually exclusive with `assignee_id`. In GitLab CE `assignee_username` array should only contain a single value or an invalid parameter error will be returned otherwise. | | `assignee_username` | string array | no | Return issues assigned to the given `username`. Similar to `assignee_id` and mutually exclusive with `assignee_id`. In GitLab CE `assignee_username` array should only contain a single value or an invalid parameter error is returned otherwise. |
| `my_reaction_emoji` | string | no | Return issues reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. | | `my_reaction_emoji` | string | no | Return issues reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. |
| `iids[]` | integer array | no | Return only the issues having the given `iid` | | `iids[]` | integer array | no | Return only the issues having the given `iid` |
| `search` | string | no | Search issues against their `title` and `description` | | `search` | string | no | Search issues against their `title` and `description` |
...@@ -98,7 +98,7 @@ GET /groups/:id/issues_statistics?confidential=true ...@@ -98,7 +98,7 @@ GET /groups/:id/issues_statistics?confidential=true
| `author_id` | integer | no | Return issues created by the given user `id`. Mutually exclusive with `author_username`. Combine with `scope=all` or `scope=assigned_to_me`. | | `author_id` | integer | no | Return issues created by the given user `id`. Mutually exclusive with `author_username`. Combine with `scope=all` or `scope=assigned_to_me`. |
| `author_username` | string | no | Return issues created by the given `username`. Similar to `author_id` and mutually exclusive with `author_id`. | | `author_username` | string | no | Return issues created by the given `username`. Similar to `author_id` and mutually exclusive with `author_id`. |
| `assignee_id` | integer | no | Return issues assigned to the given user `id`. Mutually exclusive with `assignee_username`. `None` returns unassigned issues. `Any` returns issues with an assignee. | | `assignee_id` | integer | no | Return issues assigned to the given user `id`. Mutually exclusive with `assignee_username`. `None` returns unassigned issues. `Any` returns issues with an assignee. |
| `assignee_username` | string array | no | Return issues assigned to the given `username`. Similar to `assignee_id` and mutually exclusive with `assignee_id`. In GitLab CE `assignee_username` array should only contain a single value or an invalid parameter error will be returned otherwise. | | `assignee_username` | string array | no | Return issues assigned to the given `username`. Similar to `assignee_id` and mutually exclusive with `assignee_id`. In GitLab CE `assignee_username` array should only contain a single value or an invalid parameter error is returned otherwise. |
| `my_reaction_emoji` | string | no | Return issues reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. | | `my_reaction_emoji` | string | no | Return issues reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. |
| `search` | string | no | Search group issues against their `title` and `description` | | `search` | string | no | Search group issues against their `title` and `description` |
| `created_after` | datetime | no | Return issues created on or after the given time. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) | | `created_after` | datetime | no | Return issues created on or after the given time. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) |
...@@ -154,7 +154,7 @@ GET /projects/:id/issues_statistics?confidential=true ...@@ -154,7 +154,7 @@ GET /projects/:id/issues_statistics?confidential=true
| `author_id` | integer | no | Return issues created by the given user `id`. Mutually exclusive with `author_username`. Combine with `scope=all` or `scope=assigned_to_me`. | | `author_id` | integer | no | Return issues created by the given user `id`. Mutually exclusive with `author_username`. Combine with `scope=all` or `scope=assigned_to_me`. |
| `author_username` | string | no | Return issues created by the given `username`. Similar to `author_id` and mutually exclusive with `author_id`. | | `author_username` | string | no | Return issues created by the given `username`. Similar to `author_id` and mutually exclusive with `author_id`. |
| `assignee_id` | integer | no | Return issues assigned to the given user `id`. Mutually exclusive with `assignee_username`. `None` returns unassigned issues. `Any` returns issues with an assignee. | | `assignee_id` | integer | no | Return issues assigned to the given user `id`. Mutually exclusive with `assignee_username`. `None` returns unassigned issues. `Any` returns issues with an assignee. |
| `assignee_username` | string array | no | Return issues assigned to the given `username`. Similar to `assignee_id` and mutually exclusive with `assignee_id`. In GitLab CE `assignee_username` array should only contain a single value or an invalid parameter error will be returned otherwise. | | `assignee_username` | string array | no | Return issues assigned to the given `username`. Similar to `assignee_id` and mutually exclusive with `assignee_id`. In GitLab CE `assignee_username` array should only contain a single value or an invalid parameter error is returned otherwise. |
| `my_reaction_emoji` | string | no | Return issues reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. | | `my_reaction_emoji` | string | no | Return issues reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. |
| `search` | string | no | Search project issues against their `title` and `description` | | `search` | string | no | Search project issues against their `title` and `description` |
| `created_after` | datetime | no | Return issues created on or after the given time. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) | | `created_after` | datetime | no | Return issues created on or after the given time. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) |
......
...@@ -94,7 +94,7 @@ This is calculated differently depending on whether the license has expired or n ...@@ -94,7 +94,7 @@ This is calculated differently depending on whether the license has expired or n
Returns: Returns:
- `200 OK` with response containing the licenses in JSON format. This will be an empty JSON array if there are no licenses. - `200 OK` with response containing the licenses in JSON format. This is an empty JSON array if there are no licenses.
- `403 Forbidden` if the current user in not permitted to read the licenses. - `403 Forbidden` if the current user in not permitted to read the licenses.
## Add a new license ## Add a new license
......
...@@ -19,7 +19,7 @@ The access levels are defined in the `Gitlab::Access` module. Currently, these l ...@@ -19,7 +19,7 @@ The access levels are defined in the `Gitlab::Access` module. Currently, these l
CAUTION: **Caution:** CAUTION: **Caution:**
Due to [an issue](https://gitlab.com/gitlab-org/gitlab/-/issues/219299), Due to [an issue](https://gitlab.com/gitlab-org/gitlab/-/issues/219299),
projects in personal namespaces will not show owner (`50`) permission projects in personal namespaces don't show owner (`50`) permission
for owner. for owner.
## Limitations ## Limitations
......
...@@ -93,12 +93,12 @@ the `plan` parameter associated with a namespace: ...@@ -93,12 +93,12 @@ the `plan` parameter associated with a namespace:
] ]
``` ```
Users on GitLab.com will also see `max_seats_used` and `seats_in_use` parameters. Users on GitLab.com also see `max_seats_used` and `seats_in_use` parameters.
`max_seats_used` is the highest number of users the group had. `seats_in_use` is `max_seats_used` is the highest number of users the group had. `seats_in_use` is
the number of license seats currently being used. Both values are updated the number of license seats currently being used. Both values are updated
once a day. once a day.
`max_seats_used` and `seats_in_use` will be non-zero only for namespaces on paid plans. `max_seats_used` and `seats_in_use` are non-zero only for namespaces on paid plans.
```json ```json
[ [
......
...@@ -74,7 +74,7 @@ Asana - Teamwork without email ...@@ -74,7 +74,7 @@ Asana - Teamwork without email
Set Asana service for a project. Set Asana service for a project.
> This service adds commit messages as comments to Asana tasks. Once enabled, commit messages are checked for Asana task URLs (for example, `https://app.asana.com/0/123456/987654`) or task IDs starting with # (for example, `#987654`). Every task ID found will get the commit comment added to it. You can also close a task with a message containing: `fix #123456`. You can find your API Keys here: <https://developers.asana.com/docs/#authentication-basics>. > This service adds commit messages as comments to Asana tasks. Once enabled, commit messages are checked for Asana task URLs (for example, `https://app.asana.com/0/123456/987654`) or task IDs starting with # (for example, `#987654`). Every task ID found gets the commit comment added to it. You can also close a task with a message containing: `fix #123456`. You can find your API Keys here: <https://developers.asana.com/docs/#authentication-basics>.
```plaintext ```plaintext
PUT /projects/:id/services/asana PUT /projects/:id/services/asana
...@@ -84,8 +84,8 @@ Parameters: ...@@ -84,8 +84,8 @@ Parameters:
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `api_key` | string | true | User API token. User must have access to task, all comments will be attributed to this user. | | `api_key` | string | true | User API token. User must have access to task, all comments are attributed to this user. |
| `restrict_to_branch` | string | false | Comma-separated list of branches which will be automatically inspected. Leave blank to include all branches. | | `restrict_to_branch` | string | false | Comma-separated list of branches which are automatically inspected. Leave blank to include all branches. |
| `push_events` | boolean | false | Enable notifications for push events | | `push_events` | boolean | false | Enable notifications for push events |
### Delete Asana service ### Delete Asana service
...@@ -237,7 +237,7 @@ Parameters: ...@@ -237,7 +237,7 @@ Parameters:
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `token` | string | true | Buildkite project GitLab token | | `token` | string | true | Buildkite project GitLab token |
| `project_url` | string | true | Pipeline URL. For example, `https://buildkite.com/example/pipeline` | | `project_url` | string | true | Pipeline URL. For example, `https://buildkite.com/example/pipeline` |
| `enable_ssl_verification` | boolean | false | DEPRECATED: This parameter has no effect since SSL verification will always be enabled | | `enable_ssl_verification` | boolean | false | DEPRECATED: This parameter has no effect since SSL verification is always enabled |
| `push_events` | boolean | false | Enable notifications for push events | | `push_events` | boolean | false | Enable notifications for push events |
### Delete Buildkite service ### Delete Buildkite service
...@@ -482,7 +482,7 @@ Parameters: ...@@ -482,7 +482,7 @@ Parameters:
| `send_from_committer_email` | boolean | false | Send from committer | | `send_from_committer_email` | boolean | false | Send from committer |
| `push_events` | boolean | false | Enable notifications for push events | | `push_events` | boolean | false | Enable notifications for push events |
| `tag_push_events` | boolean | false | Enable notifications for tag push events | | `tag_push_events` | boolean | false | Enable notifications for tag push events |
| `branches_to_be_notified` | string | false | Branches to send notifications for. Valid options are "all", "default", "protected", and "default_and_protected". Notifications will be always fired for tag pushes. The default value is "all" | | `branches_to_be_notified` | string | false | Branches to send notifications for. Valid options are "all", "default", "protected", and "default_and_protected". Notifications are always fired for tag pushes. The default value is "all" |
### Delete Emails on push service ### Delete Emails on push service
...@@ -809,7 +809,7 @@ Parameters: ...@@ -809,7 +809,7 @@ Parameters:
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `url` | string | yes | The URL to the Jira project which is being linked to this GitLab project. For example, `https://jira.example.com`. | | `url` | string | yes | The URL to the Jira project which is being linked to this GitLab project. For example, `https://jira.example.com`. |
| `api_url` | string | no | The base URL to the Jira instance API. Web URL value will be used if not set. For example, `https://jira-api.example.com`. | | `api_url` | string | no | The base URL to the Jira instance API. Web URL value is used if not set. For example, `https://jira-api.example.com`. |
| `username` | string | yes | The username of the user created to be used with GitLab/Jira. | | `username` | string | yes | The username of the user created to be used with GitLab/Jira. |
| `password` | string | yes | The password of the user created to be used with GitLab/Jira. | | `password` | string | yes | The password of the user created to be used with GitLab/Jira. |
| `active` | boolean | no | Activates or deactivates the service. Defaults to false (deactivated). | | `active` | boolean | no | Activates or deactivates the service. Defaults to false (deactivated). |
...@@ -1015,7 +1015,7 @@ Parameters: ...@@ -1015,7 +1015,7 @@ Parameters:
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `token` | string | true | The PivotalTracker token | | `token` | string | true | The PivotalTracker token |
| `restrict_to_branch` | boolean | false | Comma-separated list of branches which will be automatically inspected. Leave blank to include all branches. | | `restrict_to_branch` | boolean | false | Comma-separated list of branches to automatically inspect. Leave blank to include all branches. |
| `push_events` | boolean | false | Enable notifications for push events | | `push_events` | boolean | false | Enable notifications for push events |
### Delete PivotalTracker service ### Delete PivotalTracker service
...@@ -1325,7 +1325,7 @@ A continuous integration and build server ...@@ -1325,7 +1325,7 @@ A continuous integration and build server
Set JetBrains TeamCity CI service for a project. Set JetBrains TeamCity CI service for a project.
> The build configuration in TeamCity must use the build format number `%build.vcs.number%` you will also want to configure monitoring of all branches so merge requests build, that setting is in the VSC root advanced settings. > The build configuration in TeamCity must use the build format number `%build.vcs.number%`. Configure monitoring of all branches so merge requests build. That setting is in the VSC root advanced settings.
```plaintext ```plaintext
PUT /projects/:id/services/teamcity PUT /projects/:id/services/teamcity
...@@ -1411,7 +1411,7 @@ Parameters: ...@@ -1411,7 +1411,7 @@ Parameters:
- `project_url` (**required**) - Jenkins project URL like `http://jenkins.example.com/job/my-project/` - `project_url` (**required**) - Jenkins project URL like `http://jenkins.example.com/job/my-project/`
- `multiproject_enabled` (optional) - Multi-project mode is configured in Jenkins GitLab Hook plugin - `multiproject_enabled` (optional) - Multi-project mode is configured in Jenkins GitLab Hook plugin
- `pass_unstable` (optional) - Unstable builds will be treated as passing - `pass_unstable` (optional) - Unstable builds are treated as passing
### Delete Jenkins CI (Deprecated) service ### Delete Jenkins CI (Deprecated) service
......
This diff is collapsed.
...@@ -55,9 +55,9 @@ POST /hooks ...@@ -55,9 +55,9 @@ POST /hooks
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `url` | string | yes | The hook URL | | `url` | string | yes | The hook URL |
| `token` | string | no | Secret token to validate received payloads; this will not be returned in the response | | `token` | string | no | Secret token to validate received payloads; this isn't returned in the response |
| `push_events` | boolean | no | When true, the hook will fire on push events | | `push_events` | boolean | no | When true, the hook fires on push events |
| `tag_push_events` | boolean | no | When true, the hook will fire on new tags being pushed | | `tag_push_events` | boolean | no | When true, the hook fires on new tags being pushed |
| `merge_requests_events` | boolean | no | Trigger hook on merge requests events | | `merge_requests_events` | boolean | no | Trigger hook on merge requests events |
| `repository_update_events` | boolean | no | Trigger hook on repository update events | | `repository_update_events` | boolean | no | Trigger hook on repository update events |
| `enable_ssl_verification` | boolean | no | Do SSL verification when triggering the hook | | `enable_ssl_verification` | boolean | no | Do SSL verification when triggering the hook |
......
...@@ -125,7 +125,7 @@ GET /templates/licenses/:key ...@@ -125,7 +125,7 @@ GET /templates/licenses/:key
NOTE: **Note:** NOTE: **Note:**
If you omit the `fullname` parameter but authenticate your request, the name of If you omit the `fullname` parameter but authenticate your request, the name of
the authenticated user will be used to replace the copyright holder placeholder. the authenticated user replaces the copyright holder placeholder.
```shell ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/templates/licenses/mit?project=My+Cool+Project curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/templates/licenses/mit?project=My+Cool+Project
......
...@@ -170,7 +170,7 @@ GET /users ...@@ -170,7 +170,7 @@ GET /users
] ]
``` ```
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. Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) also see the `shared_runners_minutes_limit`, and `extra_shared_runners_minutes_limit` parameters.
```json ```json
[ [
...@@ -184,7 +184,7 @@ Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) ...@@ -184,7 +184,7 @@ Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/)
] ]
``` ```
Users on GitLab [Silver or higher](https://about.gitlab.com/pricing/) will also see Users on GitLab [Silver or higher](https://about.gitlab.com/pricing/) also see
the `group_saml` provider option: the `group_saml` provider option:
```json ```json
...@@ -335,7 +335,7 @@ Example Responses: ...@@ -335,7 +335,7 @@ Example Responses:
NOTE: **Note:** NOTE: **Note:**
The `plan` and `trial` parameters are only available on GitLab Enterprise Edition. The `plan` and `trial` parameters are only available on GitLab Enterprise Edition.
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/) 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.
```json ```json
...@@ -348,7 +348,7 @@ the `shared_runners_minutes_limit`, and `extra_shared_runners_minutes_limit` par ...@@ -348,7 +348,7 @@ the `shared_runners_minutes_limit`, and `extra_shared_runners_minutes_limit` par
} }
``` ```
Users on GitLab.com [Silver, or higher](https://about.gitlab.com/pricing/) will also Users on GitLab.com [Silver, or higher](https://about.gitlab.com/pricing/) also
see the `group_saml` option: see the `group_saml` option:
```json ```json
...@@ -385,10 +385,10 @@ over `password`. In addition, `reset_password` and ...@@ -385,10 +385,10 @@ over `password`. In addition, `reset_password` and
`force_random_password` can be used together. `force_random_password` can be used together.
NOTE: **Note:** NOTE: **Note:**
From [GitLab 12.1](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/29888/), `private_profile` will default to `false`. From [GitLab 12.1](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/29888/), `private_profile` defaults to `false`.
NOTE: **Note:** NOTE: **Note:**
From [GitLab 13.2](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/35604), `bio` will default to `""` instead of `null`. From [GitLab 13.2](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/35604), `bio` defaults to `""` instead of `null`.
```plaintext ```plaintext
POST /users POST /users
...@@ -469,7 +469,7 @@ Parameters: ...@@ -469,7 +469,7 @@ Parameters:
| `username` | No | Username | | `username` | No | Username |
| `website_url` | No | Website URL | | `website_url` | No | Website URL |
On password update, user will be forced to change it upon next login. On password update, the user is forced to change it upon next login.
Note, at the moment this method does only return a `404` error, Note, at the moment this method does only return a `404` error,
even in cases where a `409` (Conflict) would be more appropriate. even in cases where a `409` (Conflict) would be more appropriate.
For example, when renaming the email address to some existing one. For example, when renaming the email address to some existing one.
...@@ -501,7 +501,7 @@ Parameters: ...@@ -501,7 +501,7 @@ Parameters:
- `id` (required) - The ID of the user - `id` (required) - The ID of the user
- `hard_delete` (optional) - If true, contributions that would usually be - `hard_delete` (optional) - If true, contributions that would usually be
[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. are deleted instead, as well as groups owned solely by this user.
## List current user (for normal users) ## List current user (for normal users)
...@@ -664,7 +664,7 @@ PUT /user/status ...@@ -664,7 +664,7 @@ PUT /user/status
| `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](https://github.com/bonusly/gemojione/blob/master/config/index.json). | | `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](https://github.com/bonusly/gemojione/blob/master/config/index.json). |
| `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. |
When both parameters `emoji` and `message` are empty, the status will be cleared. When both parameters `emoji` and `message` are empty, the status is cleared.
```shell ```shell
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --data "emoji=coffee" --data "message=I crave coffee" "https://gitlab.example.com/api/v4/user/status" curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --data "emoji=coffee" --data "message=I crave coffee" "https://gitlab.example.com/api/v4/user/status"
...@@ -792,7 +792,7 @@ Parameters: ...@@ -792,7 +792,7 @@ Parameters:
} }
``` ```
Will return created key with status `201 Created` on success. If an Returns a created key with status `201 Created` on success. If an
error occurs a `400 Bad Request` is returned with a message explaining the error: error occurs a `400 Bad Request` is returned with a message explaining the error:
```json ```json
...@@ -1147,7 +1147,7 @@ Parameters: ...@@ -1147,7 +1147,7 @@ Parameters:
} }
``` ```
Will return created email with status `201 Created` on success. If an Returns a created email with status `201 Created` on success. If an
error occurs a `400 Bad Request` is returned with a message explaining the error: error occurs a `400 Bad Request` is returned with a message explaining the error:
```json ```json
...@@ -1232,7 +1232,7 @@ Parameters: ...@@ -1232,7 +1232,7 @@ Parameters:
- `id` (required) - ID of specified user - `id` (required) - ID of specified user
Will return `201 OK` on success, `404 User Not Found` is user cannot be found or Returns `201 OK` on success, `404 User Not Found` is user cannot be found or
`403 Forbidden` when trying to unblock a user blocked by LDAP synchronization. `403 Forbidden` when trying to unblock a user blocked by LDAP synchronization.
## Deactivate user ## Deactivate user
...@@ -1379,11 +1379,11 @@ Example response: ...@@ -1379,11 +1379,11 @@ 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 can't 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.
You are only able to create impersonation tokens to impersonate the user and perform You are only able to create impersonation tokens to impersonate the user and perform
both API calls and Git reads and writes. The user will not see these tokens in their profile both API calls and Git reads and writes. The user can't see these tokens in their profile
settings page. settings page.
```plaintext ```plaintext
...@@ -1451,7 +1451,7 @@ CAUTION: **Warning:** ...@@ -1451,7 +1451,7 @@ CAUTION: **Warning:**
This feature might not be available to you. Check the **version history** note above for details. This feature might not be available to you. Check the **version history** note above for details.
> 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 can't access it again.
It creates a new personal access token. It creates a new personal access token.
......
...@@ -17,19 +17,19 @@ public access directory (`/public` under your GitLab instance), like at <https:/ ...@@ -17,19 +17,19 @@ public access directory (`/public` under your GitLab instance), like at <https:/
Public projects can be cloned **without any** authentication over HTTPS. Public projects can be cloned **without any** authentication over HTTPS.
They will be listed in the public access directory (`/public`) for all users. They are listed in the public access directory (`/public`) for all users.
**Any logged in user** will have [Guest permissions](../user/permissions.md) **Any logged in user** has [Guest permissions](../user/permissions.md)
on the repository. on the repository.
### Internal projects ### Internal projects
Internal projects can be cloned by any logged in user except [external users](../user/permissions.md#external-users). Internal projects can be cloned by any logged in user except [external users](../user/permissions.md#external-users).
They will also be listed in the public access directory (`/public`), but only for logged They are also listed in the public access directory (`/public`), but only for logged
in users. in users.
Any logged in user except [external users](../user/permissions.md#external-users) will have [Guest permissions](../user/permissions.md) Any logged in users except [external users](../user/permissions.md#external-users) have [Guest permissions](../user/permissions.md)
on the repository. on the repository.
NOTE: **Note:** NOTE: **Note:**
...@@ -42,7 +42,7 @@ visibility setting keep this setting. You can read more about the change in the ...@@ -42,7 +42,7 @@ visibility setting keep this setting. You can read more about the change in the
Private projects can only be cloned and viewed by project members (except for guests). Private projects can only be cloned and viewed by project members (except for guests).
They will appear in the public access directory (`/public`) for project members only. They appear in the public access directory (`/public`) for project members only.
### How to change project visibility ### How to change project visibility
...@@ -59,7 +59,7 @@ In previous versions, a group's page was always visible to all users. ...@@ -59,7 +59,7 @@ In previous versions, a group's page was always visible to all users.
Like with projects, the visibility of a group can be set to dictate whether Like with projects, the visibility of a group can be set to dictate whether
anonymous users, all signed in users, or only explicit group members can view anonymous users, all signed in users, or only explicit group members can view
it. The restriction for visibility levels on the application setting level also it. The restriction for visibility levels on the application setting level also
applies to groups, so if that's set to internal, the explore page will be empty applies to groups, so if that's set to internal, the explore page is empty
for anonymous users. The group page now has a visibility level icon. for anonymous users. The group page now has a visibility level icon.
Admin users cannot create subgroups or projects with higher visibility level than that of the immediate parent group. Admin users cannot create subgroups or projects with higher visibility level than that of the immediate parent group.
...@@ -96,7 +96,7 @@ For details, see [Restricted visibility levels](../user/admin_area/settings/visi ...@@ -96,7 +96,7 @@ For details, see [Restricted visibility levels](../user/admin_area/settings/visi
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/33358) in GitLab 12.6. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/33358) in GitLab 12.6.
Reducing a project's visibility level will remove the fork relationship between the project and Reducing a project's visibility level removes the fork relationship between the project and
any forked project. This is a potentially destructive action which requires confirmation before any forked project. This is a potentially destructive action which requires confirmation before
this can be saved. this can be saved.
......
...@@ -18,7 +18,7 @@ have finished, which otherwise may lead to data loss. ...@@ -18,7 +18,7 @@ have finished, which otherwise may lead to data loss.
When you remove LFS files from a repository's history, they become orphaned and continue to consume When you remove LFS files from a repository's history, they become orphaned and continue to consume
disk space. With this Rake task, you can remove invalid references from the database, which disk space. With this Rake task, you can remove invalid references from the database, which
will allow garbage collection of LFS files. allows garbage collection of LFS files.
For example: For example:
...@@ -44,7 +44,7 @@ By default, this task does not delete anything but shows how many file reference ...@@ -44,7 +44,7 @@ By default, this task does not delete anything but shows how many file reference
delete. Run the command with `DRY_RUN=false` if you actually want to delete. Run the command with `DRY_RUN=false` if you actually want to
delete the references. You can also use `LIMIT={number}` parameter to limit the number of deleted references. delete the references. You can also use `LIMIT={number}` parameter to limit the number of deleted references.
Note that this Rake task only removes the references to LFS files. Unreferenced LFS files will be garbage-collected Note that this Rake task only removes the references to LFS files. Unreferenced LFS files are garbage-collected
later (once a day). If you need to garbage collect them immediately, run later (once a day). If you need to garbage collect them immediately, run
`rake gitlab:cleanup:orphan_lfs_files` described below. `rake gitlab:cleanup:orphan_lfs_files` described below.
...@@ -149,7 +149,7 @@ I, [2018-08-02T10:26:47.764356 #45087] INFO -- : Moved to lost and found: @hash ...@@ -149,7 +149,7 @@ I, [2018-08-02T10:26:47.764356 #45087] INFO -- : Moved to lost and found: @hash
> - [`ionice` support fixed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28023) in GitLab 12.10. > - [`ionice` support fixed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28023) in GitLab 12.10.
NOTE: **Note:** NOTE: **Note:**
These commands will not work for artifacts stored on These commands don't work for artifacts stored on
[object storage](../administration/object_storage.md). [object storage](../administration/object_storage.md).
When you notice there are more job artifacts files and/or directories on disk than there When you notice there are more job artifacts files and/or directories on disk than there
...@@ -179,10 +179,10 @@ You can also limit the number of files to delete with `LIMIT`: ...@@ -179,10 +179,10 @@ You can also limit the number of files to delete with `LIMIT`:
sudo gitlab-rake gitlab:cleanup:orphan_job_artifact_files LIMIT=100 sudo gitlab-rake gitlab:cleanup:orphan_job_artifact_files LIMIT=100
``` ```
This will only delete up to 100 files from disk. You can use this to This deletes only up to 100 files from disk. You can use this to delete a small
delete a small set for testing purposes. set for testing purposes.
If you provide `DEBUG=1`, you'll see the full path of every file that Providing `DEBUG=1` displays the full path of every file that
is detected as being an orphan. is detected as being an orphan.
If `ionice` is installed, the tasks uses it to ensure the command is If `ionice` is installed, the tasks uses it to ensure the command is
......
...@@ -10,11 +10,11 @@ This Rake task enables [namespaces](../user/group/index.md#namespaces) for proje ...@@ -10,11 +10,11 @@ This Rake task enables [namespaces](../user/group/index.md#namespaces) for proje
## Enable usernames and namespaces for user projects ## Enable usernames and namespaces for user projects
This command will enable the namespaces feature introduced in GitLab 4.0. It will move every project in its namespace folder. This command enables the namespaces feature introduced in GitLab 4.0. It moves every project in its namespace folder.
Note: Note:
- The **repository location will change**, so you will need to **update all your Git URLs** to - The **repository location changes as part of this task**, so you must **update all your Git URLs** to
point to the new location. point to the new location.
- The username can be changed at **Profile > Account**. - The username can be changed at **Profile > Account**.
......
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