Skip to content

G
gitlab-ce
Commit ac5289ea authored by Corinna Wiesner's avatar Corinna Wiesner Committed by Russell Dickenson
Browse files
Options

Add difference and values of pipeline to API docs 

There are two different API attributes for pipeline minutes in Users and
Groups. The difference is currently not clear when reading the docs.
To clarify this we will add information to make it clearer. Also adding
information for possible values for shared_runners_minutes_limit.
parent 6b553241
Hide whitespace changes
Inline Side-by-side
Showing with 8 additions and 8 deletions
doc/api/groups.md
View file @ ac5289ea
...@@ -667,8 +667,8 @@ Parameters: ...@@ -667,8 +667,8 @@ Parameters:
| `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. |
| `default_branch_protection` | integer | no | See [Options for `default_branch_protection`](#options-for-default_branch_protection). Default to the global level default branch protection setting. | | `default_branch_protection` | integer | no | See [Options for `default_branch_protection`](#options-for-default_branch_protection). Default to the global level default branch protection setting. |
| `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 (included in plan). Can be `nil` (default; inherit system default), `0` (unlimited) or `> 0` |
| `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 (purchased in addition to the minutes included in the plan). |
### Options for `default_branch_protection` ### Options for `default_branch_protection`
...@@ -741,8 +741,8 @@ PUT /groups/:id ...@@ -741,8 +741,8 @@ PUT /groups/:id
| `request_access_enabled` | boolean | no | Allow users to request member access. | | `request_access_enabled` | boolean | no | Allow users to request member access. |
| `default_branch_protection` | integer | no | See [Options for `default_branch_protection`](#options-for-default_branch_protection). | | `default_branch_protection` | integer | no | See [Options for `default_branch_protection`](#options-for-default_branch_protection). |
| `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 (included in plan). Can be `nil` (default; inherit system default), `0` (unlimited) or `> 0` |
| `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 (purchased in addition to the minutes included in the plan). |
NOTE: **Note:** NOTE: **Note:**
The `projects` and `shared_projects` attributes in the response are deprecated and will be [removed in API v5](https://gitlab.com/gitlab-org/gitlab/-/issues/213797). The `projects` and `shared_projects` attributes in the response are deprecated and will be [removed in API v5](https://gitlab.com/gitlab-org/gitlab/-/issues/213797).
......
doc/api/users.md
View file @ ac5289ea
...@@ -384,7 +384,7 @@ Parameters: ...@@ -384,7 +384,7 @@ Parameters:
| `email` | Yes | Email | | `email` | Yes | Email |
| `extern_uid` | No | External UID | | `extern_uid` | No | External UID |
| `external` | No | Flags the user as external - true or false (default) | | `external` | No | Flags the user as external - true or false (default) |
| `extra_shared_runners_minutes_limit` | No | Extra pipeline minutes quota for this user **(STARTER)** | | `extra_shared_runners_minutes_limit` | No | Extra pipeline minutes quota for this user (purchased in addition to the minutes included in the plan) **(STARTER)** |
| `force_random_password` | No | Set user password to a random value - true or false (default) | | `force_random_password` | No | Set user password to a random value - true or false (default) |
| `group_id_for_saml` | No | ID of group where SAML has been configured | | `group_id_for_saml` | No | ID of group where SAML has been configured |
| `linkedin` | No | LinkedIn | | `linkedin` | No | LinkedIn |
...@@ -398,7 +398,7 @@ Parameters: ...@@ -398,7 +398,7 @@ Parameters:
| `provider` | No | External provider name | | `provider` | No | External provider name |
| `public_email` | No | The public email of the user | | `public_email` | No | The public email of the user |
| `reset_password` | No | Send user password reset link - true or false(default) | | `reset_password` | No | Send user password reset link - true or false(default) |
| `shared_runners_minutes_limit` | No | Pipeline minutes quota for this user **(STARTER)** | | `shared_runners_minutes_limit` | No | Pipeline minutes quota for this user (included in plan). Can be `nil` (default; inherit system default), `0` (unlimited) or `> 0` **(STARTER)** |
| `skip_confirmation` | No | Skip confirmation - true or false (default) | | `skip_confirmation` | No | Skip confirmation - true or false (default) |
| `skype` | No | Skype ID | | `skype` | No | Skype ID |
| `theme_id` | No | The GitLab theme for the user (see [the user preference docs](../user/profile/preferences.md#navigation-theme) for more information) | | `theme_id` | No | The GitLab theme for the user (see [the user preference docs](../user/profile/preferences.md#navigation-theme) for more information) |
...@@ -426,7 +426,7 @@ Parameters: ...@@ -426,7 +426,7 @@ Parameters:
| `email` | No | Email | | `email` | No | Email |
| `extern_uid` | No | External UID | | `extern_uid` | No | External UID |
| `external` | No | Flags the user as external - true or false (default) | | `external` | No | Flags the user as external - true or false (default) |
| `extra_shared_runners_minutes_limit` | No | Extra pipeline minutes quota for this user **(STARTER)** | | `extra_shared_runners_minutes_limit` | No | Extra pipeline minutes quota for this user (purchased in addition to the minutes included in the plan) **(STARTER)** |
| `group_id_for_saml` | No | ID of group where SAML has been configured | | `group_id_for_saml` | No | ID of group where SAML has been configured |
| `id` | Yes | The ID of the user | | `id` | Yes | The ID of the user |
| `linkedin` | No | LinkedIn | | `linkedin` | No | LinkedIn |
...@@ -439,7 +439,7 @@ Parameters: ...@@ -439,7 +439,7 @@ Parameters:
| `projects_limit` | No | Limit projects each user can create | | `projects_limit` | No | Limit projects each user can create |
| `provider` | No | External provider name | | `provider` | No | External provider name |
| `public_email` | No | The public email of the user | | `public_email` | No | The public email of the user |
| `shared_runners_minutes_limit` | No | Pipeline minutes quota for this user **(STARTER)** | | `shared_runners_minutes_limit` | No | Pipeline minutes quota for this user (included in plan). Can be `nil` (default; inherit system default), `0` (unlimited) or `> 0` **(STARTER)** |
| `skip_reconfirmation` | No | Skip reconfirmation - true or false (default) | | `skip_reconfirmation` | No | Skip reconfirmation - true or false (default) |
| `skype` | No | Skype ID | | `skype` | No | Skype ID |
| `theme_id` | No | The GitLab theme for the user (see [the user preference docs](../user/profile/preferences.md#navigation-theme) for more information) | | `theme_id` | No | The GitLab theme for the user (see [the user preference docs](../user/profile/preferences.md#navigation-theme) for more information) |
......
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