diff --git a/GITALY_SERVER_VERSION b/GITALY_SERVER_VERSION index d40df5d3c63..80c9cbf13c8 100644 --- a/GITALY_SERVER_VERSION +++ b/GITALY_SERVER_VERSION @@ -1 +1 @@ -fb8b7cec4f9d0e02933be679178d6c00ba6913e7 +faa2e2cf138777ba493edc43a01cc905d83d99be diff --git a/app/assets/javascripts/search/sidebar/components/blobs_filters.vue b/app/assets/javascripts/search/sidebar/components/blobs_filters.vue index b800b529fd1..2662a959a04 100644 --- a/app/assets/javascripts/search/sidebar/components/blobs_filters.vue +++ b/app/assets/javascripts/search/sidebar/components/blobs_filters.vue @@ -19,12 +19,12 @@ export default { mixins: [glFeatureFlagsMixin()], computed: { ...mapState(['searchType']), - ...mapGetters(['hasProjectContext']), + ...mapGetters(['hasMissingProjectContext']), showLanguageFilter() { return this.searchType === SEARCH_TYPE_ADVANCED; }, shouldShowZoektForksFilter() { - return this.searchType === SEARCH_TYPE_ZOEKT && this.hasProjectContext; + return this.searchType === SEARCH_TYPE_ZOEKT && this.hasMissingProjectContext; }, }, }; @@ -33,7 +33,7 @@ export default { diff --git a/app/assets/javascripts/search/sidebar/components/commits_filters.vue b/app/assets/javascripts/search/sidebar/components/commits_filters.vue index 5d0d012a73f..b88dc32a812 100644 --- a/app/assets/javascripts/search/sidebar/components/commits_filters.vue +++ b/app/assets/javascripts/search/sidebar/components/commits_filters.vue @@ -11,13 +11,13 @@ export default { FiltersTemplate, }, computed: { - ...mapGetters(['hasProjectContext']), + ...mapGetters(['hasMissingProjectContext']), }, }; diff --git a/app/assets/javascripts/search/sidebar/components/issues_filters.vue b/app/assets/javascripts/search/sidebar/components/issues_filters.vue index 907c1f04e40..fcf724671e9 100644 --- a/app/assets/javascripts/search/sidebar/components/issues_filters.vue +++ b/app/assets/javascripts/search/sidebar/components/issues_filters.vue @@ -21,7 +21,7 @@ export default { }, mixins: [glFeatureFlagsMixin()], computed: { - ...mapGetters(['hasProjectContext']), + ...mapGetters(['hasMissingProjectContext']), ...mapState(['searchType']), showLabelFilter() { return this.searchType === SEARCH_TYPE_ADVANCED; @@ -35,6 +35,6 @@ export default { - + diff --git a/app/assets/javascripts/search/sidebar/components/merge_requests_filters.vue b/app/assets/javascripts/search/sidebar/components/merge_requests_filters.vue index b0e3a52ac7d..28386a8a57b 100644 --- a/app/assets/javascripts/search/sidebar/components/merge_requests_filters.vue +++ b/app/assets/javascripts/search/sidebar/components/merge_requests_filters.vue @@ -15,11 +15,11 @@ export default { SourceBranchFilter, }, computed: { - ...mapGetters(['hasProjectContext']), + ...mapGetters(['hasMissingProjectContext']), ...mapState(['groupInitialJson']), shouldShowSourceBranchFilter() { // this will be changed https://gitlab.com/gitlab-org/gitlab/-/issues/480740 - return !this.hasProjectContext || this.groupInitialJson?.id; + return !this.hasMissingProjectContext || this.groupInitialJson?.id; }, }, }; @@ -28,7 +28,7 @@ export default { diff --git a/app/assets/javascripts/search/sidebar/components/milestones_filters.vue b/app/assets/javascripts/search/sidebar/components/milestones_filters.vue index 74f26dec334..73a844593b3 100644 --- a/app/assets/javascripts/search/sidebar/components/milestones_filters.vue +++ b/app/assets/javascripts/search/sidebar/components/milestones_filters.vue @@ -11,13 +11,13 @@ export default { FiltersTemplate, }, computed: { - ...mapGetters(['hasProjectContext']), + ...mapGetters(['hasMissingProjectContext']), }, }; diff --git a/app/assets/javascripts/search/sidebar/components/notes_filters.vue b/app/assets/javascripts/search/sidebar/components/notes_filters.vue index 01ea8dccf11..6e25733a98a 100644 --- a/app/assets/javascripts/search/sidebar/components/notes_filters.vue +++ b/app/assets/javascripts/search/sidebar/components/notes_filters.vue @@ -11,13 +11,13 @@ export default { FiltersTemplate, }, computed: { - ...mapGetters(['hasProjectContext']), + ...mapGetters(['hasMissingProjectContext']), }, }; diff --git a/app/assets/javascripts/search/sidebar/components/wiki_blobs_filters.vue b/app/assets/javascripts/search/sidebar/components/wiki_blobs_filters.vue index 2960a684e14..0650fe290e1 100644 --- a/app/assets/javascripts/search/sidebar/components/wiki_blobs_filters.vue +++ b/app/assets/javascripts/search/sidebar/components/wiki_blobs_filters.vue @@ -11,13 +11,13 @@ export default { FiltersTemplate, }, computed: { - ...mapGetters(['hasProjectContext']), + ...mapGetters(['hasMissingProjectContext']), }, }; diff --git a/app/assets/javascripts/search/store/getters.js b/app/assets/javascripts/search/store/getters.js index c5ffe16371f..51cb98b8b75 100644 --- a/app/assets/javascripts/search/store/getters.js +++ b/app/assets/javascripts/search/store/getters.js @@ -10,7 +10,7 @@ import { injectRegexSearch, } from '~/search/store/utils'; -import { PROJECT_DATA, SCOPE_BLOB } from '~/search/sidebar/constants'; +import { SCOPE_BLOB } from '~/search/sidebar/constants'; import { GROUPS_LOCAL_STORAGE_KEY, PROJECTS_LOCAL_STORAGE_KEY, ICON_MAP } from './constants'; const queryLabelFilters = (state) => state?.query?.[LABEL_FILTER_PARAM] || []; @@ -96,4 +96,4 @@ export const navigationItems = (state) => items: [], })); -export const hasProjectContext = (state) => !state.query?.[PROJECT_DATA.queryParam]; +export const hasMissingProjectContext = (state) => !state?.projectInitialJson?.id; diff --git a/app/assets/stylesheets/framework/sidebar.scss b/app/assets/stylesheets/framework/sidebar.scss index 69de34256f1..1dfdbad3b07 100644 --- a/app/assets/stylesheets/framework/sidebar.scss +++ b/app/assets/stylesheets/framework/sidebar.scss @@ -108,7 +108,7 @@ } .right-sidebar { - border-left: 1px solid $border-color; + @apply gl-border-l; &.right-sidebar-merge-requests { @include media-breakpoint-up(lg) { @@ -320,7 +320,7 @@ position: fixed; bottom: calc(#{$calc-application-footer-height} + var(--mr-review-bar-height)); right: 0; - background-color: $white; + @apply gl-bg-default; z-index: 200; overflow: hidden; @apply gl-transition-width; diff --git a/app/assets/stylesheets/themes/dark_mode_overrides.scss b/app/assets/stylesheets/themes/dark_mode_overrides.scss index 2ee4c103836..85e43ca2bec 100644 --- a/app/assets/stylesheets/themes/dark_mode_overrides.scss +++ b/app/assets/stylesheets/themes/dark_mode_overrides.scss @@ -64,10 +64,6 @@ border-color: $gray-800; } -aside.right-sidebar:not(.right-sidebar-merge-requests) { - background-color: $gray-10; -} - :root.gl-dark { .terms { .logo-text { diff --git a/app/finders/timelogs/timelogs_finder.rb b/app/finders/timelogs/timelogs_finder.rb index 610dba43317..74d54e71470 100644 --- a/app/finders/timelogs/timelogs_finder.rb +++ b/app/finders/timelogs/timelogs_finder.rb @@ -2,15 +2,15 @@ module Timelogs class TimelogsFinder - attr_reader :issuable, :params + attr_reader :parent, :params - def initialize(issuable, params = {}) - @issuable = issuable + def initialize(parent, params = {}) + @parent = parent @params = params end def execute - timelogs = issuable&.timelogs || Timelog.all + timelogs = parent&.timelogs || Timelog.all timelogs = by_time(timelogs) timelogs = by_user(timelogs) timelogs = by_group(timelogs) diff --git a/app/graphql/resolvers/timelog_resolver.rb b/app/graphql/resolvers/timelog_resolver.rb index d129b99ed0a..e954eae7bd7 100644 --- a/app/graphql/resolvers/timelog_resolver.rb +++ b/app/graphql/resolvers/timelog_resolver.rb @@ -74,20 +74,29 @@ module Resolvers end def validate_args!(object, args) - # sort is always provided because of its default value so we - # should check the remaining args to make sure at least one filter - # argument was provided - cleaned_args = args.except(:sort) + unless has_parent?(object, args) || for_current_user?(args) || admin_user? + raise_argument_error('Non-admin users must provide a group_id, project_id, or current username') + end - if cleaned_args.empty? && object.nil? - raise_argument_error('Provide at least one argument') - elsif args[:start_time] && args[:start_date] + if args[:start_time] && args[:start_date] raise_argument_error('Provide either a start date or time, but not both') elsif args[:end_time] && args[:end_date] raise_argument_error('Provide either an end date or time, but not both') end end + def has_parent?(object, args) + object || args[:group_id] || args[:project_id] + end + + def for_current_user?(args) + args[:username].present? && args[:username] == current_user&.username + end + + def admin_user? + current_user&.can_read_all_resources? + end + def parse_datetime_args(args) if times_provided?(args) args diff --git a/app/presenters/packages/helm/index_presenter.rb b/app/presenters/packages/helm/index_presenter.rb index e85a4f248cf..123e1e9fb6d 100644 --- a/app/presenters/packages/helm/index_presenter.rb +++ b/app/presenters/packages/helm/index_presenter.rb @@ -32,7 +32,9 @@ module Packages 'created' => package_file.created_at.utc.strftime('%Y-%m-%dT%H:%M:%S.%NZ'), 'digest' => package_file.file_sha256, 'urls' => ["charts/#{package_file.file_name}"] - }) + }).tap do |metadata| + metadata['appVersion'] = format('"%s"', metadata['appVersion']) if metadata.key?('appVersion') + end end result diff --git a/app/services/import/reassign_placeholder_user_records_service.rb b/app/services/import/reassign_placeholder_user_records_service.rb index ea13c40b418..6dec9419c0c 100644 --- a/app/services/import/reassign_placeholder_user_records_service.rb +++ b/app/services/import/reassign_placeholder_user_records_service.rb @@ -124,8 +124,8 @@ module Import # If user is a member (direct or inherited) with higher level, skip creating the membership. if existing_membership - if existing_membership.access_level >= placeholder_membership.access_level - log_create_membership_skipped('Existing membership of same or higher access level found for user, skipping', + if existing_membership.access_level > placeholder_membership.access_level + log_create_membership_skipped('Existing membership of higher access level found for user, skipping', placeholder_membership, existing_membership) return @@ -135,7 +135,9 @@ module Import # to this memberable between the time the import finished and the reassignment process began. # In this case, we don't override the existing direct membership, we skip creating it. if existing_membership.source == memberable - log_create_membership_skipped('Existing direct membership of lower access level found for user, skipping', + log_create_membership_skipped( + 'Existing direct membership of lower or equal access level found for user, ' \ + 'skipping', placeholder_membership, existing_membership) return diff --git a/app/views/projects/merge_requests/_widget.html.haml b/app/views/projects/merge_requests/_widget.html.haml index 241d9ab4a59..f261afcc299 100644 --- a/app/views/projects/merge_requests/_widget.html.haml +++ b/app/views/projects/merge_requests/_widget.html.haml @@ -12,7 +12,7 @@ window.gl.mrWidgetData.ci_troubleshooting_docs_path = '#{help_page_path('ci/debugging.md')}'; window.gl.mrWidgetData.mr_troubleshooting_docs_path = '#{help_page_path('user/project/merge_requests/reviews/index.md', anchor: 'troubleshooting')}'; window.gl.mrWidgetData.pipeline_must_succeed_docs_path = '#{help_page_path('user/project/merge_requests/merge_when_pipeline_succeeds.md', anchor: 'require-a-successful-pipeline-for-merge')}'; - window.gl.mrWidgetData.code_coverage_check_help_page_path = '#{help_page_path('ci/testing/code_coverage.md', anchor: 'coverage-check-approval-rule')}'; + window.gl.mrWidgetData.code_coverage_check_help_page_path = '#{help_page_path('ci/testing/code_coverage.md', anchor: 'add-a-coverage-check-approval-rule')}'; window.gl.mrWidgetData.security_configuration_path = '#{project_security_configuration_path(@project)}'; window.gl.mrWidgetData.license_compliance_docs_path = '#{help_page_path('user/compliance/license_scanning_of_cyclonedx_files/index.md')}'; window.gl.mrWidgetData.eligible_approvers_docs_path = '#{help_page_path('user/project/merge_requests/approvals/rules.md', anchor: 'eligible-approvers')}'; diff --git a/doc/administration/settings/jira_cloud_app.md b/doc/administration/settings/jira_cloud_app.md index 67ba02c348f..88ec3b9ca47 100644 --- a/doc/administration/settings/jira_cloud_app.md +++ b/doc/administration/settings/jira_cloud_app.md @@ -41,7 +41,8 @@ To create an OAuth application on your self-managed instance: 1. Clear the **Trusted** and **Confidential** checkboxes. NOTE: - You must clear these checkboxes to avoid errors. + You must clear these checkboxes to avoid [errors](jira_cloud_app_troubleshooting.md#error-failed-to-sign-in-to-gitlab). + 1. In **Scopes**, select the `api` checkbox only. 1. Select **Save application**. 1. Copy the **Application ID** value. diff --git a/doc/administration/settings/jira_cloud_app_troubleshooting.md b/doc/administration/settings/jira_cloud_app_troubleshooting.md index 70bf06f6d6f..cdbcf589506 100644 --- a/doc/administration/settings/jira_cloud_app_troubleshooting.md +++ b/doc/administration/settings/jira_cloud_app_troubleshooting.md @@ -318,3 +318,15 @@ To resolve this issue, ensure all prerequisites for your installation method hav - [Prerequisites for connecting the GitLab for Jira Cloud app](jira_cloud_app.md#prerequisites) - [Prerequisites for installing the GitLab for Jira Cloud app manually](jira_cloud_app.md#prerequisites-1) + +## Error: `Failed to sign in to GitLab` + +When you sign in to the GitLab for Jira Cloud app after you point the app +to your self-managed instance, you might get the following error: + +```plaintext +Failed to sign in to GitLab +``` + +To resolve this issue, ensure the **Trusted** and **Confidential** checkboxes are cleared in +the [OAuth application](jira_cloud_app.md#set-up-oauth-authentication) created for the app. diff --git a/doc/api/access_requests.md b/doc/api/access_requests.md index 73a17dcc9e2..629542476af 100644 --- a/doc/api/access_requests.md +++ b/doc/api/access_requests.md @@ -34,7 +34,7 @@ GET /projects/:id/access_requests | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | Example request: @@ -77,7 +77,7 @@ POST /projects/:id/access_requests | Attribute | Type | Required | Description | | --------- | -------------- | -------- |-----------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the group or project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group or project](rest/index.md#namespaced-paths) | Example request: @@ -110,7 +110,7 @@ PUT /projects/:id/access_requests/:user_id/approve | Attribute | Type | Required | Description | | -------------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `user_id` | integer | yes | The user ID of the access requester | | `access_level` | integer | no | A valid access level (defaults: `30`, the Developer role) | @@ -145,7 +145,7 @@ DELETE /projects/:id/access_requests/:user_id | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `user_id` | integer | yes | The user ID of the access requester | Example request: diff --git a/doc/api/alert_management_alerts.md b/doc/api/alert_management_alerts.md index c1f30ba04fb..7638336bd2f 100644 --- a/doc/api/alert_management_alerts.md +++ b/doc/api/alert_management_alerts.md @@ -21,7 +21,7 @@ POST /projects/:id/alert_management_alerts/:alert_iid/metric_images | Attribute | Type | Required | Description | |-------------|---------|----------|--------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `alert_iid` | integer | yes | The internal ID of a project's alert. | ```shell @@ -50,7 +50,7 @@ GET /projects/:id/alert_management_alerts/:alert_iid/metric_images | Attribute | Type | Required | Description | |-------------|---------|----------|--------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `alert_iid` | integer | yes | The internal ID of a project's alert. | ```shell @@ -88,7 +88,7 @@ PUT /projects/:id/alert_management_alerts/:alert_iid/metric_images/:image_id | Attribute | Type | Required | Description | |-------------|---------|----------|--------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `alert_iid` | integer | yes | The internal ID of a project's alert. | | `image_id` | integer | yes | The ID of the image. | | `url` | string | no | The URL to view more metrics information. | @@ -119,7 +119,7 @@ DELETE /projects/:id/alert_management_alerts/:alert_iid/metric_images/:image_id | Attribute | Type | Required | Description | |-------------|---------|----------|--------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `alert_iid` | integer | yes | The internal ID of a project's alert. | | `image_id` | integer | yes | The ID of the image. | diff --git a/doc/api/audit_events.md b/doc/api/audit_events.md index a6f67009242..827bdc71730 100644 --- a/doc/api/audit_events.md +++ b/doc/api/audit_events.md @@ -191,7 +191,7 @@ GET /groups/:id/audit_events | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `created_after` | string | no | Return group audit events created on or after the given time. Format: ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ)` | | `created_before` | string | no | Return group audit events created on or before the given time. Format: ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`) | @@ -255,7 +255,7 @@ GET /groups/:id/audit_events/:audit_event_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `audit_event_id` | integer | yes | The ID of the audit event | ```shell @@ -301,7 +301,7 @@ GET /projects/:id/audit_events | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `created_after` | string | no | Return project audit events created on or after the given time. Format: ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`) | | `created_before` | string | no | Return project audit events created on or before the given time. Format: ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`) | @@ -369,7 +369,7 @@ GET /projects/:id/audit_events/:audit_event_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `audit_event_id` | integer | yes | The ID of the audit event | ```shell diff --git a/doc/api/boards.md b/doc/api/boards.md index 4132c968977..6275f234b36 100644 --- a/doc/api/boards.md +++ b/doc/api/boards.md @@ -25,7 +25,7 @@ GET /projects/:id/boards | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | ```shell curl --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/projects/5/boards" @@ -109,7 +109,7 @@ GET /projects/:id/boards/:board_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `board_id` | integer | yes | The ID of a board. | ```shell @@ -186,7 +186,7 @@ POST /projects/:id/boards | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `name` | string | yes | The name of the new board. | ```shell @@ -227,7 +227,7 @@ PUT /projects/:id/boards/:board_id | Attribute | Type | Required | Description | | ---------------------------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `board_id` | integer | yes | The ID of a board. | | `name` | string | no | The new name of the board. | | `assignee_id` | integer | no | The assignee the board should be scoped to. Premium and Ultimate only. | @@ -307,7 +307,7 @@ DELETE /projects/:id/boards/:board_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `board_id` | integer | yes | The ID of a board. | ```shell @@ -325,7 +325,7 @@ GET /projects/:id/boards/:board_id/lists | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `board_id` | integer | yes | The ID of a board. | ```shell @@ -385,7 +385,7 @@ GET /projects/:id/boards/:board_id/lists/:list_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `board_id` | integer | yes | The ID of a board. | | `list_id`| integer | yes | The ID of a board's list. | @@ -420,7 +420,7 @@ POST /projects/:id/boards/:board_id/lists | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `board_id` | integer | yes | The ID of a board. | | `label_id` | integer | no | The ID of a label. | | `assignee_id` | integer | no | The ID of a user. Premium and Ultimate only. | @@ -463,7 +463,7 @@ PUT /projects/:id/boards/:board_id/lists/:list_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `board_id` | integer | yes | The ID of a board. | | `list_id` | integer | yes | The ID of a board's list. | | `position` | integer | yes | The position of the list. | @@ -499,7 +499,7 @@ DELETE /projects/:id/boards/:board_id/lists/:list_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `board_id` | integer | yes | The ID of a board. | | `list_id` | integer | yes | The ID of a board's list. | diff --git a/doc/api/branches.md b/doc/api/branches.md index 801dc626d6b..72ab9e89a79 100644 --- a/doc/api/branches.md +++ b/doc/api/branches.md @@ -30,7 +30,7 @@ Parameters: | Attribute | Type | Required | Description | |:----------|:---------------|:---------|:------------| -| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding).| +| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths).| | `search` | string | no | Return list of branches containing the search string. Use `^term` to find branches that begin with `term`, and `term$` to find branches that end with `term`. | | `regex` | string | no | Return list of branches with names matching a [re2](https://github.com/google/re2/wiki/Syntax) regular expression. | @@ -92,8 +92,8 @@ Parameters: | Attribute | Type | Required | Description | |-----------|-------------------|----------|-------------| -| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | -| `branch` | string | yes | [URL-encoded name](rest/index.md#namespaced-path-encoding) of the branch. | +| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | +| `branch` | string | yes | [URL-encoded name](rest/index.md#namespaced-paths) of the branch. | Example request: @@ -157,7 +157,7 @@ Parameters: | Attribute | Type | Required | Description | |-----------|---------|----------|-------------| -| `id` | integer | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `branch` | string | yes | Name of the branch. | | `ref` | string | yes | Branch name or commit SHA to create branch from. | @@ -216,7 +216,7 @@ Parameters: | Attribute | Type | Required | Description | |-----------|----------------|----------|-------------| -| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `branch` | string | yes | Name of the branch. | Example request: @@ -241,7 +241,7 @@ Parameters: | Attribute | Type | Required | Description | |:----------|:---------------|:---------|:-------------------------------------------------------------------------------------------------------------| -| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | Example request: diff --git a/doc/api/cluster_agents.md b/doc/api/cluster_agents.md index 15600fbbf0b..b93365a0abd 100644 --- a/doc/api/cluster_agents.md +++ b/doc/api/cluster_agents.md @@ -28,7 +28,7 @@ Parameters: | Attribute | Type | Required | Description | |-----------|-------------------|-----------|-----------------------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) maintained by the authenticated user | +| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) maintained by the authenticated user | Response: @@ -106,7 +106,7 @@ Parameters: | Attribute | Type | Required | Description | |------------|-------------------|----------|-----------------------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) maintained by the authenticated user | +| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) maintained by the authenticated user | | `agent_id` | integer | yes | ID of the agent | Response: @@ -168,7 +168,7 @@ Parameters: | Attribute | Type | Required | Description | |-----------|-------------------|----------|-----------------------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) maintained by the authenticated user | +| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) maintained by the authenticated user | | `name` | string | yes | Name for the agent | Response: @@ -232,7 +232,7 @@ Parameters: | Attribute | Type | Required | Description | |------------|-------------------|----------|-----------------------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) maintained by the authenticated user | +| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) maintained by the authenticated user | | `agent_id` | integer | yes | ID of the agent | Example request: @@ -257,7 +257,7 @@ Supported attributes: | Attribute | Type | Required | Description | |------------|-------------------|-----------|------------------------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) maintained by the authenticated user. | +| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) maintained by the authenticated user. | | `agent_id` | integer or string | yes | ID of the agent. | Response: @@ -326,7 +326,7 @@ Supported attributes: | Attribute | Type | Required | Description | |------------|-------------------|----------|-------------------------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) maintained by the authenticated user. | +| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) maintained by the authenticated user. | | `agent_id` | integer | yes | ID of the agent. | | `token_id` | integer | yes | ID of the token. | @@ -386,7 +386,7 @@ Supported attributes: | Attribute | Type | Required | Description | |---------------|-------------------|----------|------------------------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) maintained by the authenticated user. | +| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) maintained by the authenticated user. | | `agent_id` | integer | yes | ID of the agent. | | `name` | string | yes | Name for the token. | | `description` | string | no | Description for the token. | @@ -450,7 +450,7 @@ Supported attributes: | Attribute | Type | Required | Description | |------------|-------------------|----------|---------------------------------------------------------------------------------------------------------------- -| -| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) maintained by the authenticated user. | +| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) maintained by the authenticated user. | | `agent_id` | integer | yes | ID of the agent. | | `token_id` | integer | yes | ID of the token. | @@ -485,7 +485,7 @@ Supported attributes: | Attribute | Type | Required | Description | |------------|-------------------|-----------|-----------------------------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) maintained by the authenticated user. | +| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) maintained by the authenticated user. | | `agent_id` | integer or string | yes | ID of the agent. | Response: @@ -538,7 +538,7 @@ Supported attributes: | Attribute | Type | Required | Description | |------------------------|-------------------|----------|------------------------------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) maintained by the authenticated user. | +| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) maintained by the authenticated user. | | `agent_id` | integer | yes | ID of the agent. | | `url_configuration_id` | integer | yes | ID of the URL configuration. | @@ -592,7 +592,7 @@ Supported attributes: | Attribute | Type | Required | Description | |---------------|-------------------|----------|-----------------------------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) maintained by the authenticated user. | +| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) maintained by the authenticated user. | | `agent_id` | integer | yes | ID of the agent. | | `url` | string | yes | Agent URL for this URL configuration. | | `client_cert` | string | no | Client certificate in PEM format if mTLS authentication should be used. Must be provided with `client_key`. | @@ -669,7 +669,7 @@ Supported attributes: | Attribute | Type | Required | Description | |------------------------|-------------------|----------|-----------------------------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) maintained by the authenticated user. | +| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) maintained by the authenticated user. | | `agent_id` | integer | yes | ID of the agent. | | `url_configuration_id` | integer | yes | ID of the URL configuration. | diff --git a/doc/api/commits.md b/doc/api/commits.md index 91baef57d7d..5e8ecbad00e 100644 --- a/doc/api/commits.md +++ b/doc/api/commits.md @@ -35,7 +35,7 @@ GET /projects/:id/repository/commits | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `ref_name` | string | no | The name of a repository branch, tag or revision range, or if not given the default branch | | `since` | string | no | Only commits after or on this date are returned in ISO 8601 format `YYYY-MM-DDTHH:MM:SSZ` | | `until` | string | no | Only commits before or on this date are returned in ISO 8601 format `YYYY-MM-DDTHH:MM:SSZ` | @@ -105,12 +105,12 @@ POST /projects/:id/repository/commits | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `branch` | string | yes | Name of the branch to commit into. To create a new branch, also provide either `start_branch` or `start_sha`, and optionally `start_project`. | | `commit_message` | string | yes | Commit message | | `start_branch` | string | no | Name of the branch to start the new branch from | | `start_sha` | string | no | SHA of the commit to start the new branch from | -| `start_project` | integer/string | no | The project ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) to start the new branch from. Defaults to the value of `id`. | +| `start_project` | integer/string | no | The project ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) to start the new branch from. Defaults to the value of `id`. | | `actions[]` | array | yes | An array of action hashes to commit as a batch. See the next table for what attributes it can take. | | `author_email` | string | no | Specify the commit author's email address | | `author_name` | string | no | Specify the commit author's name | @@ -197,7 +197,7 @@ Example response: } ``` -GitLab supports [form encoding](rest/index.md#encoding-api-parameters-of-array-and-hash-types). The following is an example using Commit API with form encoding: +GitLab supports [form encoding](rest/index.md#array-and-hash-types). The following is an example using Commit API with form encoding: ```shell curl --request POST \ @@ -235,7 +235,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `sha` | string | yes | The commit hash or name of a repository branch or tag | | `stats` | boolean | no | Include commit stats. Default is true | @@ -291,7 +291,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `sha` | string | yes | The commit hash | | `type` | string | no | The scope of commits. Possible values `branch`, `tag`, `all`. Default is `all`. | @@ -328,7 +328,7 @@ Parameters: | Attribute | Type | Required | Description | | -------------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `sha` | string | yes | The commit hash. | | `first_parent` | boolean | no | Follow only the first parent commit upon seeing a merge commit. | @@ -359,7 +359,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `sha` | string | yes | The commit hash | | `branch` | string | yes | The name of the branch | | `dry_run` | boolean | no | Does not commit any changes. Default is false. | @@ -434,7 +434,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `sha` | string | yes | Commit SHA to revert | | `branch` | string | yes | Target branch name | | `dry_run` | boolean | no | Does not commit any changes. Default is false. | @@ -504,7 +504,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `sha` | string | yes | The commit hash or name of a repository branch or tag | | `unidiff` | boolean | no | Present diffs in the [unified diff](https://www.gnu.org/software/diffutils/manual/html_node/Detailed-Unified.html) format. Default is false. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/130610) in GitLab 16.5. | @@ -542,7 +542,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `sha` | string | yes | The commit hash or name of a repository branch or tag | ```shell @@ -596,7 +596,7 @@ POST /projects/:id/repository/commits/:sha/comments | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `sha` | string | yes | The commit SHA or name of a repository branch or tag | | `note` | string | yes | The text of the comment | | `path` | string | no | The file path relative to the repository | @@ -645,7 +645,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `sha` | string | yes | The commit hash or name of a repository branch or tag | ```shell @@ -705,7 +705,7 @@ GET /projects/:id/repository/commits/:sha/statuses | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `sha` | string | yes | The commit SHA | | `ref` | string | no | The name of a repository branch or tag or, if not given, the default branch | | `stage` | string | no | Filter by [build stage](../ci/yaml/index.md#stages), for example, `test` | @@ -781,7 +781,7 @@ POST /projects/:id/statuses/:sha | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `sha` | string | yes | The commit SHA | | `state` | string | yes | The state of the status. Can be one of the following: `pending`, `running`, `success`, `failed`, `canceled` | | `ref` | string | no | The `ref` (branch or tag) to which the status refers | @@ -834,7 +834,7 @@ GET /projects/:id/repository/commits/:sha/merge_requests | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `sha` | string | yes | The commit SHA | ```shell @@ -907,7 +907,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `sha` | string | yes | The commit hash or name of a repository branch or tag | ```shell diff --git a/doc/api/container_registry.md b/doc/api/container_registry.md index 41754965be7..7db5b1310ec 100644 --- a/doc/api/container_registry.md +++ b/doc/api/container_registry.md @@ -26,7 +26,7 @@ PUT /projects/:id/ | Attribute | Type | Required | Description | |-----------------------------------|----------------|----------|-------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) accessible by the authenticated user. | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) accessible by the authenticated user. | | `container_registry_access_level` | string | no | The desired visibility of the container registry. One of `enabled` (default), `private`, or `disabled`. | Descriptions of the possible values for `container_registry_access_level`: @@ -80,7 +80,7 @@ GET /projects/:id/registry/repositories | Attribute | Type | Required | Description | |--------------|----------------|----------|-------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) accessible by the authenticated user. | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) accessible by the authenticated user. | | `tags` | boolean | no | If the parameter is included as true, each repository includes an array of `"tags"` in the response. | | `tags_count` | boolean | no | If the parameter is included as true, each repository includes `"tags_count"` in the response . | @@ -127,7 +127,7 @@ GET /groups/:id/registry/repositories | Attribute | Type | Required | Description | |-----------|----------------|----------|-------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) accessible by the authenticated user. | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) accessible by the authenticated user. | ```shell curl --header "PRIVATE-TOKEN: " \ @@ -215,7 +215,7 @@ DELETE /projects/:id/registry/repositories/:repository_id | Attribute | Type | Required | Description | |-----------------|----------------|----------|-------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `repository_id` | integer | yes | The ID of registry repository. | ```shell @@ -237,7 +237,7 @@ GET /projects/:id/registry/repositories/:repository_id/tags | Attribute | Type | Required | Description | |-----------------|----------------|----------|-------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) accessible by the authenticated user. | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) accessible by the authenticated user. | | `repository_id` | integer | yes | The ID of registry repository. | ```shell @@ -272,7 +272,7 @@ GET /projects/:id/registry/repositories/:repository_id/tags/:tag_name | Attribute | Type | Required | Description | |-----------------|----------------|----------|-------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) accessible by the authenticated user. | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) accessible by the authenticated user. | | `repository_id` | integer | yes | The ID of registry repository. | | `tag_name` | string | yes | The name of tag. | @@ -306,7 +306,7 @@ DELETE /projects/:id/registry/repositories/:repository_id/tags/:tag_name | Attribute | Type | Required | Description | |-----------------|----------------|----------|-------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `repository_id` | integer | yes | The ID of registry repository. | | `tag_name` | string | yes | The name of tag. | @@ -331,7 +331,7 @@ DELETE /projects/:id/registry/repositories/:repository_id/tags | Attribute | Type | Required | Description | |---------------------|----------------|----------|-------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `repository_id` | integer | yes | The ID of registry repository. | | `name_regex` | string | no | The [re2](https://github.com/google/re2/wiki/Syntax) regex of the name to delete. To delete all tags specify `.*`. **Note:** `name_regex` is deprecated in favor of `name_regex_delete`. This field is validated. | | `name_regex_delete` | string | yes | The [re2](https://github.com/google/re2/wiki/Syntax) regex of the name to delete. To delete all tags specify `.*`. This field is validated. | diff --git a/doc/api/dependencies.md b/doc/api/dependencies.md index 3fe310d8f8a..c0c5a258d9c 100644 --- a/doc/api/dependencies.md +++ b/doc/api/dependencies.md @@ -34,7 +34,7 @@ GET /projects/:id/dependencies?package_manager=yarn,bundler | Attribute | Type | Required | Description | | ------------- | -------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `package_manager` | string array | no | Returns dependencies belonging to specified package manager. Valid values: `bundler`, `composer`, `conan`, `go`, `gradle`, `maven`, `npm`, `nuget`, `pip`, `pipenv`, `pnpm`, `yarn`, `sbt`, or `setuptools`. | ```shell diff --git a/doc/api/dependency_proxy.md b/doc/api/dependency_proxy.md index 379ff7e48f0..c114c011db9 100644 --- a/doc/api/dependency_proxy.md +++ b/doc/api/dependency_proxy.md @@ -21,7 +21,7 @@ DELETE /groups/:id/dependency_proxy/cache | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | Example request: diff --git a/doc/api/deploy_keys.md b/doc/api/deploy_keys.md index 726d0695ee2..3ab153f31a6 100644 --- a/doc/api/deploy_keys.md +++ b/doc/api/deploy_keys.md @@ -110,7 +110,7 @@ GET /projects/:id/deploy_keys | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | ```shell curl --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/projects/5/deploy_keys" @@ -214,7 +214,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `key_id` | integer | yes | The ID of the deploy key | ```shell @@ -249,7 +249,7 @@ POST /projects/:id/deploy_keys | Attribute | Type | Required | Description | | ----------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `key` | string | yes | New deploy key | | `title` | string | yes | New deploy key's title | | `can_push` | boolean | no | Can deploy key push to the project's repository | @@ -284,7 +284,7 @@ PUT /projects/:id/deploy_keys/:key_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `can_push` | boolean | no | Can deploy key push to the project's repository | | `title` | string | no | New deploy key's title | @@ -316,7 +316,7 @@ DELETE /projects/:id/deploy_keys/:key_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `key_id` | integer | yes | The ID of the deploy key | ```shell @@ -333,7 +333,7 @@ POST /projects/:id/deploy_keys/:key_id/enable | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `key_id` | integer | yes | The ID of the deploy key | ```shell diff --git a/doc/api/deploy_tokens.md b/doc/api/deploy_tokens.md index 381ac1f706d..1e1faae9adf 100644 --- a/doc/api/deploy_tokens.md +++ b/doc/api/deploy_tokens.md @@ -70,7 +70,7 @@ Parameters: | Attribute | Type | Required | Description | |:---------------|:---------------|:-----------------------|:------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `active` | boolean | No | Limit by active status. | Example request: @@ -110,7 +110,7 @@ Parameters: | Attribute | Type | Required | Description | | ---------- | -------------- | ---------------------- | ----------- | -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `token_id` | integer | Yes | ID of the deploy token | Example request: @@ -148,7 +148,7 @@ Parameters: | Attribute | Type | Required | Description | | ------------ | ---------------- | ---------------------- | ----------- | -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `name` | string | Yes | New deploy token's name | | `scopes` | array of strings | Yes | Indicates the deploy token scopes. Must be at least one of `read_repository`, `read_registry`, `write_registry`, `read_package_registry`, or `write_package_registry`. | | `expires_at` | datetime | No | Expiration date for the deploy token. Does not expire if no value is provided. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) | @@ -191,7 +191,7 @@ Parameters: | Attribute | Type | Required | Description | | ---------- | -------------- | ---------------------- | ----------- | -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `token_id` | integer | Yes | ID of the deploy token | Example request: @@ -218,7 +218,7 @@ Parameters: | Attribute | Type | Required | Description | |:---------------|:---------------|:-----------------------|:------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `active` | boolean | No | Limit by active status. | Example request: @@ -258,7 +258,7 @@ Parameters: | Attribute | Type | Required | Description | | ----------- | -------------- | ---------------------- | ----------- | -| `id` | integer/string | Yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `token_id` | integer | Yes | ID of the deploy token | Example request: @@ -296,7 +296,7 @@ Parameters: | Attribute | Type | Required | Description | | ------------ | ---- | --------- | ----------- | -| `id` | integer/string | Yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `name` | string | Yes | New deploy token's name | | `scopes` | array of strings | Yes | Indicates the deploy token scopes. Must be at least one of `read_repository`, `read_registry`, `write_registry`, `read_package_registry`, or `write_package_registry`. | | `expires_at` | datetime | No | Expiration date for the deploy token. Does not expire if no value is provided. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) | @@ -339,7 +339,7 @@ Parameters: | Attribute | Type | Required | Description | | ----------- | -------------- | ---------------------- | ----------- | -| `id` | integer/string | Yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `token_id` | integer | Yes | ID of the deploy token | Example request: diff --git a/doc/api/deployments.md b/doc/api/deployments.md index df4c98097c8..6db4bd4615b 100644 --- a/doc/api/deployments.md +++ b/doc/api/deployments.md @@ -22,7 +22,7 @@ GET /projects/:id/deployments | Attribute | Type | Required | Description | |-------------------|----------------|----------|-----------------------------------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `order_by` | string | no | Return deployments ordered by either one of `id`, `iid`, `created_at`, `updated_at`, `finished_at` or `ref` fields. Default is `id`. | | `sort` | string | no | Return deployments sorted in `asc` or `desc` order. Default is `asc`. | | `updated_after` | datetime | no | Return deployments updated after the specified date. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`). | @@ -200,7 +200,7 @@ GET /projects/:id/deployments/:deployment_id | Attribute | Type | Required | Description | |-----------|---------|----------|---------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `deployment_id` | integer | yes | The ID of the deployment | ```shell @@ -334,7 +334,7 @@ POST /projects/:id/deployments | Attribute | Type | Required | Description | |---------------|----------------|----------|-----------------------------------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding).| +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths).| | `environment` | string | yes | The [name of the environment](../ci/environments/index.md) to create the deployment for. | | `sha` | string | yes | The SHA of the commit that is deployed. | | `ref` | string | yes | The name of the branch or tag that is deployed. | @@ -392,7 +392,7 @@ PUT /projects/:id/deployments/:deployment_id | Attribute | Type | Required | Description | |------------------|----------------|----------|---------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `deployment_id` | integer | yes | The ID of the deployment to update. | | `status` | string | yes | The new status of the deployment. One of `running`, `success`, `failed`, or `canceled`. | @@ -462,7 +462,7 @@ DELETE /projects/:id/deployments/:deployment_id | Attribute | Type | Required | Description | |-----------|---------|----------|---------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `deployment_id` | integer | yes | The ID of the deployment | ```shell @@ -523,7 +523,7 @@ POST /projects/:id/deployments/:deployment_id/approval | Attribute | Type | Required | Description | |-----------------|----------------|----------|-----------------------------------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `deployment_id` | integer | yes | The ID of the deployment. | | `status` | string | yes | The status of the approval (either `approved` or `rejected`). | | `comment` | string | no | A comment to go with the approval | diff --git a/doc/api/discussions.md b/doc/api/discussions.md index b1df44b2cdf..9956a6f7ea5 100644 --- a/doc/api/discussions.md +++ b/doc/api/discussions.md @@ -54,7 +54,7 @@ GET /projects/:id/issues/:issue_iid/discussions | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | ------------ | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | yes | The IID of an issue. | ```json @@ -156,7 +156,7 @@ Parameters: | Attribute | Type | Required | Description | | --------------- | -------------- | -------- | ----------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | yes | The IID of an issue. | | `discussion_id` | integer | yes | The ID of a discussion item. | @@ -178,7 +178,7 @@ Parameters: | Attribute | Type | Required | Description | | --------------- | -------------- | -------- | ----------- | | `body` | string | yes | The content of the thread. | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | yes | The IID of an issue. | | `created_at` | string | no | Date time string, ISO 8601 formatted, such as `2016-03-11T03:45:40Z`. Requires administrator or project/group owner rights. | @@ -204,7 +204,7 @@ Parameters: | --------------- | -------------- | -------- | ----------- | | `body` | string | yes | The content of the note or reply. | | `discussion_id` | integer | yes | The ID of a thread. | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | yes | The IID of an issue. | | `note_id` | integer | yes | The ID of a thread note. | | `created_at` | string | no | Date time string, ISO 8601 formatted, such as `2016-03-11T03:45:40Z`. Requires administrator or project/group owner rights. | @@ -228,7 +228,7 @@ Parameters: | --------------- | -------------- | -------- | ----------- | | `body` | string | yes | The content of the note or reply. | | `discussion_id` | integer | yes | The ID of a thread. | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | yes | The IID of an issue. | | `note_id` | integer | yes | The ID of a thread note. | @@ -250,7 +250,7 @@ Parameters: | Attribute | Type | Required | Description | | --------------- | -------------- | -------- | ----------- | | `discussion_id` | integer | yes | The ID of a discussion. | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | yes | The IID of an issue. | | `note_id` | integer | yes | The ID of a discussion note. | @@ -271,7 +271,7 @@ GET /projects/:id/snippets/:snippet_id/discussions | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | ------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `snippet_id` | integer | yes | The ID of an snippet. | ```json @@ -374,7 +374,7 @@ Parameters: | Attribute | Type | Required | Description | | --------------- | -------------- | -------- | ----------- | | `discussion_id` | integer | yes | The ID of a discussion item. | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `snippet_id` | integer | yes | The ID of an snippet. | ```shell @@ -396,7 +396,7 @@ Parameters: | Attribute | Type | Required | Description | | --------------- | -------------- | -------- | ----------- | | `body` | string | yes | The content of a discussion. | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `snippet_id` | integer | yes | The ID of an snippet. | | `created_at` | string | no | Date time string, ISO 8601 formatted, such as `2016-03-11T03:45:40Z`. Requires administrator or project/group owner rights. | @@ -419,7 +419,7 @@ Parameters: | --------------- | -------------- | -------- | ----------- | | `body` | string | yes | The content of the note or reply. | | `discussion_id` | integer | yes | The ID of a thread. | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `note_id` | integer | yes | The ID of a thread note. | | `snippet_id` | integer | yes | The ID of an snippet. | | `created_at` | string | no | Date time string, ISO 8601 formatted, such as `2016-03-11T03:45:40Z`. Requires administrator or project/group owner rights. | @@ -443,7 +443,7 @@ Parameters: | --------------- | -------------- | -------- | ----------- | | `body` | string | yes | The content of the note or reply. | | `discussion_id` | integer | yes | The ID of a thread. | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `note_id` | integer | yes | The ID of a thread note. | | `snippet_id` | integer | yes | The ID of an snippet. | @@ -465,7 +465,7 @@ Parameters: | Attribute | Type | Required | Description | | --------------- | -------------- | -------- | ----------- | | `discussion_id` | integer | yes | The ID of a discussion. | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `note_id` | integer | yes | The ID of a discussion note. | | `snippet_id` | integer | yes | The ID of an snippet. | @@ -496,7 +496,7 @@ GET /groups/:id/epics/:epic_id/discussions | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | ------------ | | `epic_id` | integer | yes | The ID of an epic. | -| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | ```json [ @@ -600,7 +600,7 @@ Parameters: | --------------- | -------------- | -------- | ----------- | | `discussion_id` | integer | yes | The ID of a discussion item. | | `epic_id` | integer | yes | The ID of an epic. | -| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | ```shell curl --request POST --header "PRIVATE-TOKEN: " \ @@ -622,7 +622,7 @@ Parameters: | --------------- | -------------- | -------- | ----------- | | `body` | string | yes | The content of the thread. | | `epic_id` | integer | yes | The ID of an epic. | -| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `created_at` | string | no | Date time string, ISO 8601 formatted, such as `2016-03-11T03:45:40Z`. Requires administrator or project/group owner rights. | ```shell @@ -646,7 +646,7 @@ Parameters: | `body` | string | yes | The content of the note or reply. | | `discussion_id` | integer | yes | The ID of a thread. | | `epic_id` | integer | yes | The ID of an epic. | -| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `note_id` | integer | yes | The ID of a thread note. | | `created_at` | string | no | Date time string, ISO 8601 formatted, such as `2016-03-11T03:45:40Z`. Requires administrator or project/group owner rights. | @@ -670,7 +670,7 @@ Parameters: | `body` | string | yes | The content of note or reply. | | `discussion_id` | integer | yes | The ID of a thread. | | `epic_id` | integer | yes | The ID of an epic. | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `note_id` | integer | yes | The ID of a thread note. | ```shell @@ -692,7 +692,7 @@ Parameters: | --------------- | -------------- | -------- | ----------- | | `discussion_id` | integer | yes | The ID of a thread. | | `epic_id` | integer | yes | The ID of an epic. | -| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `note_id` | integer | yes | The ID of a thread note. | ```shell @@ -712,7 +712,7 @@ GET /projects/:id/merge_requests/:merge_request_iid/discussions | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | ------------ | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | yes | The IID of a merge request. | ```json @@ -881,7 +881,7 @@ Parameters: | Attribute | Type | Required | Description | | ------------------- | -------------- | -------- | ----------- | | `discussion_id` | string | yes | The ID of a discussion item. | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | yes | The IID of a merge request. | ```shell @@ -905,7 +905,7 @@ Parameters for all comments: | Attribute | Type | Required | Description | | ---------------------------------------- | -------------- |--------------------------------------| ----------- | | `body` | string | yes | The content of the thread. | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | yes | The IID of a merge request. | | `position[base_sha]` | string | yes (if `position*` is supplied) | Base commit SHA in the source branch. | | `position[head_sha]` | string | yes (if `position*` is supplied) | SHA referencing HEAD of this merge request. | @@ -1045,7 +1045,7 @@ Parameters: | Attribute | Type | Required | Description | | ------------------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `discussion_id` | string | yes | The ID of a thread. | | `merge_request_iid` | integer | yes | The IID of a merge request. | | `resolved` | boolean | yes | Resolve or unresolve the discussion. | @@ -1069,7 +1069,7 @@ Parameters: | Attribute | Type | Required | Description | | ------------------- | -------------- | -------- | ----------- | | `body` | string | yes | The content of the note or reply. | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `discussion_id` | string | yes | The ID of a thread. | | `merge_request_iid` | integer | yes | The IID of a merge request. | | `note_id` | integer | yes | The ID of a thread note. | @@ -1093,7 +1093,7 @@ Parameters: | Attribute | Type | Required | Description | | ------------------- | -------------- | -------- | ----------- | | `discussion_id` | string | yes | The ID of a thread. | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | yes | The IID of a merge request. | | `note_id` | integer | yes | The ID of a thread note. | | `body` | string | no | The content of the note or reply. Exactly one of `body` or `resolved` must be set. | @@ -1124,7 +1124,7 @@ Parameters: | Attribute | Type | Required | Description | | ------------------- | -------------- | -------- | ----------- | | `discussion_id` | string | yes | The ID of a thread. | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | yes | The IID of a merge request. | | `note_id` | integer | yes | The ID of a thread note. | @@ -1146,7 +1146,7 @@ GET /projects/:id/repository/commits/:commit_id/discussions | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | ------------ | | `commit_id` | string | yes | The SHA of a commit. | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | ```json [ @@ -1295,7 +1295,7 @@ Parameters: | ------------------- | -------------- | -------- | ----------- | | `commit_id` | string | yes | The SHA of a commit. | | `discussion_id` | string | yes | The ID of a discussion item. | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | ```shell curl --header "PRIVATE-TOKEN: " \ @@ -1317,7 +1317,7 @@ Parameters: | ------------------------- | -------------- |----------------------------------| ----------- | | `body` | string | yes | The content of the thread. | | `commit_id` | string | yes | The SHA of a commit. | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `position[base_sha]` | string | yes (if `position*` is supplied) | SHA of the parent commit. | | `position[head_sha]` | string | yes (if `position*` is supplied) | The SHA of this commit. Same as `commit_id`. | | `position[start_sha]` | string | yes (if `position*` is supplied) | SHA of the parent commit. | @@ -1362,7 +1362,7 @@ Parameters: | `body` | string | yes | The content of the note or reply. | | `commit_id` | string | yes | The SHA of a commit. | | `discussion_id` | string | yes | The ID of a thread. | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `note_id` | integer | yes | The ID of a thread note. | | `created_at` | string | no | Date time string, ISO 8601 formatted, such `2016-03-11T03:45:40Z`. Requires administrator or project/group owner rights. | @@ -1385,7 +1385,7 @@ Parameters: | ------------------- | -------------- | -------- | ----------- | | `commit_id` | string | yes | The SHA of a commit. | | `discussion_id` | string | yes | The ID of a thread. | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `note_id` | integer | yes | The ID of a thread note. | | `body` | string | no | The content of a note. | @@ -1413,7 +1413,7 @@ Parameters: | Attribute | Type | Required | Description | | ------------------- | -------------- | -------- | ----------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `commit_id` | string | yes | The SHA of a commit. | | `discussion_id` | string | yes | The ID of a thread. | | `note_id` | integer | yes | The ID of a thread note. | diff --git a/doc/api/dora/metrics.md b/doc/api/dora/metrics.md index eca1f3e8316..b4c00aedd26 100644 --- a/doc/api/dora/metrics.md +++ b/doc/api/dora/metrics.md @@ -24,7 +24,7 @@ GET /projects/:id/dora/metrics | Attribute | Type | Required | Description | |:---------------------|:-----------------|:---------|:------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-path-encoding) can be accessed by the authenticated user. | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-paths) can be accessed by the authenticated user. | | `metric` | string | yes | One of `deployment_frequency`, `lead_time_for_changes`, `time_to_restore_service` or `change_failure_rate`. | | `end_date` | string | no | Date range to end at. ISO 8601 Date format, for example `2021-03-01`. Default is the current date. | | `environment_tiers` | array of strings | no | The [tiers of the environments](../../ci/environments/index.md#deployment-tier-of-environments). Default is `production`. | @@ -62,7 +62,7 @@ GET /groups/:id/dora/metrics | Attribute | Type | Required | Description | |:--------------------|:-----------------|:---------|:------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-path-encoding) can be accessed by the authenticated user. | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-paths) can be accessed by the authenticated user. | | `metric` | string | yes | One of `deployment_frequency`, `lead_time_for_changes`, `time_to_restore_service` or `change_failure_rate`. | | `end_date` | string | no | Date range to end at. ISO 8601 Date format, for example `2021-03-01`. Default is the current date. | | `environment_tiers` | array of strings | no | The [tiers of the environments](../../ci/environments/index.md#deployment-tier-of-environments). Default is `production`. | diff --git a/doc/api/draft_notes.md b/doc/api/draft_notes.md index d6165c635da..4612d07eb40 100644 --- a/doc/api/draft_notes.md +++ b/doc/api/draft_notes.md @@ -28,7 +28,7 @@ GET /projects/:id/merge_requests/:merge_request_iid/draft_notes | Attribute | Type | Required | Description | |---------------------|-------------------|----------|-------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `merge_request_iid` | integer | yes | The IID of a project merge request | ```json @@ -71,7 +71,7 @@ GET /projects/:id/merge_requests/:merge_request_iid/draft_notes/:draft_note_id | Attribute | Type | Required | Description | |---------------------|-------------------|----------|-------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `draft_note_id` | integer | yes | The ID of a draft note. | | `merge_request_iid` | integer | yes | The IID of a project merge request. | @@ -115,7 +115,7 @@ POST /projects/:id/merge_requests/:merge_request_iid/draft_notes | Attribute | Type | Required | Description | | ---------------------------------------- | ----------------- | ----------- | --------------------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | yes | The IID of a project merge request. | | `note` | string | yes | The content of a note. | | `commit_id` | string | no | The SHA of a commit to associate the draft note to. | @@ -151,7 +151,7 @@ PUT /projects/:id/merge_requests/:merge_request_iid/draft_notes/:draft_note_id | Attribute | Type | Required | Description | | ------------------- | ----------------- | ----------- | --------------------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `draft_note_id` | integer | yes | The ID of a draft note. | | `merge_request_iid` | integer | yes | The IID of a project merge request. | | `note` | string | no | The content of a note. | @@ -187,7 +187,7 @@ DELETE /projects/:id/merge_requests/:merge_request_iid/draft_notes/:draft_note_i | Attribute | Type | Required | Description | | ------------------- | ---------------- | ----------- | --------------------- | | `draft_note_id` | integer | yes | The ID of a draft note. | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | yes | The IID of a project merge request. | ```shell @@ -207,7 +207,7 @@ PUT /projects/:id/merge_requests/:merge_request_iid/draft_notes/:draft_note_id/p | Attribute | Type | Required | Description | | ------------------- | ---------------- | ----------- | --------------------- | | `draft_note_id` | integer | yes | The ID of a draft note. | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | yes | The IID of a project merge request. | ```shell @@ -226,7 +226,7 @@ POST /projects/:id/merge_requests/:merge_request_iid/draft_notes/bulk_publish | Attribute | Type | Required | Description | |---------------------|-------------------|----------|-------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | yes | The IID of a project merge request. | ```shell diff --git a/doc/api/emoji_reactions.md b/doc/api/emoji_reactions.md index bb6360979c5..1e01e9fa661 100644 --- a/doc/api/emoji_reactions.md +++ b/doc/api/emoji_reactions.md @@ -44,7 +44,7 @@ Parameters: | Attribute | Type | Required | Description | |:---------------|:---------------|:---------|:-----------------------------------------------------------------------------| -| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid`/`merge_request_iid`/`snippet_id` | integer | yes | ID (`iid` for merge requests/issues, `id` for snippets) of an awardable. | Example request: @@ -109,7 +109,7 @@ Parameters: | Attribute | Type | Required | Description | |:---------------|:---------------|:---------|:-----------------------------------------------------------------------------| -| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid`/`merge_request_iid`/`snippet_id` | integer | yes | ID (`iid` for merge requests/issues, `id` for snippets) of an awardable. | | `award_id` | integer | yes | ID of the emoji reaction. | @@ -154,7 +154,7 @@ Parameters: | Attribute | Type | Required | Description | |:---------------|:---------------|:---------|:-----------------------------------------------------------------------------| -| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid`/`merge_request_iid`/`snippet_id` | integer | yes | ID (`iid` for merge requests/issues, `id` for snippets) of an awardable. | | `name` | string | yes | Name of the emoji without colons. | @@ -199,7 +199,7 @@ Parameters: | Attribute | Type | Required | Description | |:---------------|:---------------|:---------|:-----------------------------------------------------------------------------| -| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid`/`merge_request_iid`/`snippet_id` | integer | yes | ID (`iid` for merge requests/issues, `id` for snippets) of an awardable. | | `award_id` | integer | yes | ID of an emoji reaction. | @@ -231,7 +231,7 @@ Parameters: | Attribute | Type | Required | Description | |:------------|:---------------|:---------|:-----------------------------------------------------------------------------| -| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | yes | Internal ID of an issue. | | `note_id` | integer | yes | ID of a comment (note). | @@ -279,7 +279,7 @@ Parameters: | Attribute | Type | Required | Description | |:------------|:---------------|:---------|:-----------------------------------------------------------------------------| -| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | yes | Internal ID of an issue. | | `note_id` | integer | yes | ID of a comment (note). | | `award_id` | integer | yes | ID of the emoji reaction. | @@ -323,7 +323,7 @@ Parameters: | Attribute | Type | Required | Description | |:------------|:---------------|:---------|:-----------------------------------------------------------------------------| -| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | yes | Internal ID of an issue. | | `note_id` | integer | yes | ID of a comment (note). | | `name` | string | yes | Name of the emoji without colons. | @@ -369,7 +369,7 @@ Parameters: | Attribute | Type | Required | Description | |:------------|:---------------|:---------|:-----------------------------------------------------------------------------| -| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | yes | Internal ID of an issue. | | `note_id` | integer | yes | ID of a comment (note). | | `award_id` | integer | yes | ID of an emoji reaction. | diff --git a/doc/api/environments.md b/doc/api/environments.md index fc7a3644770..59ca179951b 100644 --- a/doc/api/environments.md +++ b/doc/api/environments.md @@ -22,7 +22,7 @@ GET /projects/:id/environments | Attribute | Type | Required | Description | |-----------|----------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded](rest/index.md#namespaced-path-encoding) path of the project. | +| `id` | integer/string | yes | The ID or [URL-encoded](rest/index.md#namespaced-paths) path of the project. | | `name` | string | no | Return the environment with this name. Mutually exclusive with `search`. | | `search` | string | no | Return list of environments matching the search criteria. Mutually exclusive with `name`. Must be at least 3 characters long. | | `states` | string | no | List all environments that match a specific state. Accepted values: `available`, `stopping`, or `stopped`. If no state value given, returns all environments. | @@ -62,7 +62,7 @@ GET /projects/:id/environments/:environment_id | Attribute | Type | Required | Description | |------------------|----------------|----------|--------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path](rest/index.md#namespaced-path-encoding) of the project. | +| `id` | integer/string | yes | The ID or [URL-encoded path](rest/index.md#namespaced-paths) of the project. | | `environment_id` | integer | yes | The ID of the environment. | ```shell @@ -200,7 +200,7 @@ POST /projects/:id/environments | Attribute | Type | Required | Description | |------------------------|----------------|----------|---------------------------------------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path](rest/index.md#namespaced-path-encoding) of the project. | +| `id` | integer/string | yes | The ID or [URL-encoded path](rest/index.md#namespaced-paths) of the project. | | `name` | string | yes | The name of the environment. | | `description` | string | no | The description of the environment. | | `external_url` | string | no | Place to link to for this environment. | @@ -246,7 +246,7 @@ PUT /projects/:id/environments/:environments_id | Attribute | Type | Required | Description | |------------------------|-----------------|----------|---------------------------------------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `environment_id` | integer | yes | The ID of the environment. | | `description` | string | no | The description of the environment. | | `external_url` | string | no | The new `external_url`. | @@ -288,7 +288,7 @@ DELETE /projects/:id/environments/:environment_id | Attribute | Type | Required | Description | |------------------|----------------|----------|--------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path](rest/index.md#namespaced-path-encoding) of the project. | +| `id` | integer/string | yes | The ID or [URL-encoded path](rest/index.md#namespaced-paths) of the project. | | `environment_id` | integer | yes | The ID of the environment. | ```shell @@ -309,7 +309,7 @@ DELETE /projects/:id/environments/review_apps | Attribute | Type | Required | Description | |-----------|----------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path](rest/index.md#namespaced-path-encoding) of the project. | +| `id` | integer/string | yes | The ID or [URL-encoded path](rest/index.md#namespaced-paths) of the project. | | `before` | datetime | no | The date before which environments can be deleted. Defaults to 30 days ago. Expected in ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`). | | `limit` | integer | no | Maximum number of environments to delete. Defaults to 100. | | `dry_run` | boolean | no | Defaults to `true` for safety reasons. It performs a dry run where no actual deletion is performed. Set to `false` to actually delete the environment. | @@ -350,7 +350,7 @@ POST /projects/:id/environments/:environment_id/stop | Attribute | Type | Required | Description | |------------------|----------------|----------|--------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path](rest/index.md#namespaced-path-encoding) of the project. | +| `id` | integer/string | yes | The ID or [URL-encoded path](rest/index.md#namespaced-paths) of the project. | | `environment_id` | integer | yes | The ID of the environment. | | `force` | boolean | no | Force environment to stop without executing `on_stop` actions. | @@ -384,7 +384,7 @@ POST /projects/:id/environments/stop_stale | Attribute | Type | Required | Description | |-----------|----------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path](rest/index.md#namespaced-path-encoding) of the project. | +| `id` | integer/string | yes | The ID or [URL-encoded path](rest/index.md#namespaced-paths) of the project. | | `before` | date | yes | Stop environments that have been modified or deployed to before the specified date. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`). Valid inputs are between 10 years ago and 1 week ago | ```shell diff --git a/doc/api/epic_issues.md b/doc/api/epic_issues.md index 839ada08ee2..861379ed144 100644 --- a/doc/api/epic_issues.md +++ b/doc/api/epic_issues.md @@ -38,7 +38,7 @@ GET /groups/:id/epics/:epic_iid/issues | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | ---------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `epic_iid` | integer/string | yes | The internal ID of the epic. | ```shell @@ -133,7 +133,7 @@ POST /groups/:id/epics/:epic_iid/issues/:issue_id | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | ---------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `epic_iid` | integer/string | yes | The internal ID of the epic. | | `issue_id` | integer/string | yes | The ID of the issue. | @@ -239,7 +239,7 @@ DELETE /groups/:id/epics/:epic_iid/issues/:epic_issue_id | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | -----------------------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `epic_iid` | integer/string | yes | The internal ID of the epic. | | `epic_issue_id` | integer/string | yes | The ID of the issue - epic association. | @@ -345,7 +345,7 @@ PUT /groups/:id/epics/:epic_iid/issues/:epic_issue_id | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | -----------------------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `epic_iid` | integer/string | yes | The internal ID of the epic. | | `epic_issue_id` | integer/string | yes | The ID of the issue - epic association. | | `move_before_id` | integer/string | no | The ID of the issue - epic association that should be placed before the link in the question. | diff --git a/doc/api/epic_links.md b/doc/api/epic_links.md index 0af1ce12318..02b4d650fea 100644 --- a/doc/api/epic_links.md +++ b/doc/api/epic_links.md @@ -35,7 +35,7 @@ GET /groups/:id/epics/:epic_iid/epics | Attribute | Type | Required | Description | | ---------- | -------------- | -------- | ------------------------------------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `epic_iid` | integer | yes | The internal ID of the epic. | ```shell @@ -89,7 +89,7 @@ POST /groups/:id/epics/:epic_iid/epics/:child_epic_id | Attribute | Type | Required | Description | | --------------- | -------------- | -------- | ------------------------------------------------------------------------------------------------------------------ | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `epic_iid` | integer | yes | The internal ID of the epic. | | `child_epic_id` | integer | yes | The global ID of the child epic. Internal ID can't be used because they can conflict with epics from other groups. | @@ -142,7 +142,7 @@ POST /groups/:id/epics/:epic_iid/epics | Attribute | Type | Required | Description | | --------------- | -------------- | -------- | ------------------------------------------------------------------------------------------------------------------ | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `epic_iid` | integer | yes | The internal ID of the (future parent) epic. | | `title` | string | yes | The title of a newly created epic. | | `confidential` | boolean | no | Whether the epic should be confidential. Parameter is ignored if `confidential_epics` feature flag is disabled. Defaults to the confidentiality state of the parent epic. | @@ -176,7 +176,7 @@ PUT /groups/:id/epics/:epic_iid/epics/:child_epic_id | Attribute | Type | Required | Description | | ---------------- | -------------- | -------- | ------------------------------------------------------------------------------------------------------------------ | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `epic_iid` | integer | yes | The internal ID of the epic. | | `child_epic_id` | integer | yes | The global ID of the child epic. Internal ID can't be used because they can conflict with epics from other groups. | | `move_before_id` | integer | no | The global ID of a sibling epic that should be placed before the child epic. | @@ -233,7 +233,7 @@ DELETE /groups/:id/epics/:epic_iid/epics/:child_epic_id | Attribute | Type | Required | Description | | --------------- | -------------- | -------- | ------------------------------------------------------------------------------------------------------------------ | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `epic_iid` | integer | yes | The internal ID of the epic. | | `child_epic_id` | integer | yes | The global ID of the child epic. Internal ID can't be used because they can conflict with epics from other groups. | diff --git a/doc/api/epics.md b/doc/api/epics.md index 0ebb4a393bf..e2076d872a7 100644 --- a/doc/api/epics.md +++ b/doc/api/epics.md @@ -65,7 +65,7 @@ GET /groups/:id/epics?state=opened | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `author_id` | integer | no | Return epics created by the given user `id` | | `author_username` | string | no | Return epics created by the user with the given `username`. | | `labels` | string | no | Return epics matching a comma-separated list of labels names. Label names from the epic group or a parent group can be used | @@ -205,7 +205,7 @@ GET /groups/:id/epics/:epic_iid | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | ---------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `epic_iid` | integer/string | yes | The internal ID of the epic. | ```shell @@ -284,7 +284,7 @@ POST /groups/:id/epics | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | ---------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `title` | string | yes | The title of the epic | | `labels` | string | no | The comma-separated list of labels | | `description` | string | no | The description of the epic. Limited to 1,048,576 characters. | @@ -368,7 +368,7 @@ PUT /groups/:id/epics/:epic_iid | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | ---------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `epic_iid` | integer/string | yes | The internal ID of the epic | | `add_labels` | string | no | Comma-separated label names to add to an issue. | | `confidential` | boolean | no | Whether the epic should be confidential | @@ -452,7 +452,7 @@ DELETE /groups/:id/epics/:epic_iid | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | ---------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `epic_iid` | integer/string | yes | The internal ID of the epic. | ```shell @@ -471,7 +471,7 @@ POST /groups/:id/epics/:epic_iid/todo | Attribute | Type | Required | Description | |-------------|---------|----------|--------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `epic_iid` | integer | yes | The internal ID of a group's epic | ```shell diff --git a/doc/api/error_tracking.md b/doc/api/error_tracking.md index 2a55558c4fa..593fa490917 100644 --- a/doc/api/error_tracking.md +++ b/doc/api/error_tracking.md @@ -23,7 +23,7 @@ GET /projects/:id/error_tracking/settings | Attribute | Type | Required | Description | | --------- | ------- | -------- | --------------------- | -| `id` | integer | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | ```shell curl --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/projects/1/error_tracking/settings" @@ -59,7 +59,7 @@ Supported attributes: | Attribute | Type | Required | Description | | ------------ | ------- |----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `id` | integer | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `active` | boolean | yes | Pass `true` to enable the error tracking setting configuration or `false` to disable it. | | `integrated` | boolean | yes | Pass `true` to enable the integrated error tracking backend. | @@ -92,7 +92,7 @@ PATCH /projects/:id/error_tracking/settings | Attribute | Type | Required | Description | | ------------ | ------- | -------- | --------------------- | -| `id` | integer | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `active` | boolean | yes | Pass `true` to enable the already configured error tracking settings or `false` to disable it. | | `integrated` | boolean | no | Pass `true` to enable the integrated error tracking backend. | @@ -125,7 +125,7 @@ GET /projects/:id/error_tracking/client_keys | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | ```shell curl --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/projects/5/error_tracking/client_keys" @@ -160,7 +160,7 @@ POST /projects/:id/error_tracking/client_keys | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | ```shell curl --request POST --header "PRIVATE-TOKEN: " --header "Content-Type: application/json" \ @@ -188,7 +188,7 @@ DELETE /projects/:id/error_tracking/client_keys/:key_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `key_id` | integer | yes | The ID of the client key. | ```shell diff --git a/doc/api/events.md b/doc/api/events.md index 5ebd98ada6f..97e7198811f 100644 --- a/doc/api/events.md +++ b/doc/api/events.md @@ -291,7 +291,7 @@ Parameters: | Attribute | Type | Required | Description | |---------------|----------------|----------|-----------------------------------------------------------------------------------------------------| -| `project_id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `project_id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `action` | string | no | Include only events of a particular [action type](#actions) | | `target_type` | string | no | Include only events of a particular [target type](#target-types) | | `before` | date | no | Include only events created before a particular date. [View how to format dates](#date-formatting). | diff --git a/doc/api/feature_flag_user_lists.md b/doc/api/feature_flag_user_lists.md index f32c13c2d92..baef25da1b3 100644 --- a/doc/api/feature_flag_user_lists.md +++ b/doc/api/feature_flag_user_lists.md @@ -31,7 +31,7 @@ GET /projects/:id/feature_flags_user_lists | Attribute | Type | Required | Description | | --------- | -------------- | -------- | -------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `search` | string | no | Return user lists matching the search criteria. | ```shell @@ -73,7 +73,7 @@ POST /projects/:id/feature_flags_user_lists | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | ---------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `name` | string | yes | The name of the list. | | `user_xids` | string | yes | A comma-separated list of external user IDs. | @@ -113,7 +113,7 @@ GET /projects/:id/feature_flags_user_lists/:iid | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | ---------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `iid` | integer/string | yes | The internal ID of the project's feature flag user list. | ```shell @@ -144,7 +144,7 @@ PUT /projects/:id/feature_flags_user_lists/:iid | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | ---------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `iid` | integer/string | yes | The internal ID of the project's feature flag user list. | | `name` | string | no | The name of the list. | | `user_xids` | string | no | A comma-separated list of external user IDs. | @@ -185,7 +185,7 @@ DELETE /projects/:id/feature_flags_user_lists/:iid | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | ---------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `iid` | integer/string | yes | The internal ID of the project's feature flag user list | ```shell diff --git a/doc/api/feature_flags.md b/doc/api/feature_flags.md index 9ba888ede37..c122ac882b0 100644 --- a/doc/api/feature_flags.md +++ b/doc/api/feature_flags.md @@ -32,7 +32,7 @@ GET /projects/:id/feature_flags | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `scope` | string | no | The condition of feature flags, one of: `enabled`, `disabled`. | ```shell @@ -132,7 +132,7 @@ GET /projects/:id/feature_flags/:feature_flag_name | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | ---------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `feature_flag_name` | string | yes | The name of the feature flag. | ```shell @@ -177,7 +177,7 @@ POST /projects/:id/feature_flags | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `name` | string | yes | The name of the feature flag. | | `version` | string | yes | **Deprecated** The version of the feature flag. Must be `new_version_flag`. Omit to create a Legacy feature flag. | | `description` | string | no | The description of the feature flag. | @@ -239,7 +239,7 @@ PUT /projects/:id/feature_flags/:feature_flag_name | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | ---------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `feature_flag_name` | string | yes | The current name of the feature flag. | | `description` | string | no | The description of the feature flag. | | `active` | boolean | no | The active state of the flag. | @@ -317,7 +317,7 @@ DELETE /projects/:id/feature_flags/:feature_flag_name | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | ---------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `feature_flag_name` | string | yes | The name of the feature flag. | ```shell diff --git a/doc/api/freeze_periods.md b/doc/api/freeze_periods.md index 32512d6d762..6fcb40e37b2 100644 --- a/doc/api/freeze_periods.md +++ b/doc/api/freeze_periods.md @@ -28,7 +28,7 @@ GET /projects/:id/freeze_periods | Attribute | Type | Required | Description | | ------------- | -------------- | -------- | ----------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | Example request: @@ -61,7 +61,7 @@ GET /projects/:id/freeze_periods/:freeze_period_id | Attribute | Type | Required | Description | | ------------- | -------------- | -------- | ----------------------------------------------------------------------------------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `freeze_period_id` | integer | yes | The ID of the freeze period. | Example request: @@ -93,7 +93,7 @@ POST /projects/:id/freeze_periods | Attribute | Type | Required | Description | | -------------------| --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `freeze_start` | string | yes | Start of the freeze period in [cron](https://crontab.guru/) format. | | `freeze_end` | string | yes | End of the freeze period in [cron](https://crontab.guru/) format. | | `cron_timezone` | string | no | The time zone for the cron fields, defaults to UTC if not provided. | @@ -129,7 +129,7 @@ PUT /projects/:id/freeze_periods/:freeze_period_id | Attribute | Type | Required | Description | | ------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `freeze_period_id` | integer | yes | The ID of the freeze period. | | `freeze_start` | string | no | Start of the freeze period in [cron](https://crontab.guru/) format. | | `freeze_end` | string | no | End of the freeze period in [cron](https://crontab.guru/) format. | @@ -166,7 +166,7 @@ DELETE /projects/:id/freeze_periods/:freeze_period_id | Attribute | Type | Required | Description | | ------------- | -------------- | -------- | ----------------------------------------------------------------------------------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `freeze_period_id` | integer | yes | The ID of the freeze period. | Example request: diff --git a/doc/api/graphql/custom_emoji.md b/doc/api/graphql/custom_emoji.md index e493f48758c..78d5dca60a0 100644 --- a/doc/api/graphql/custom_emoji.md +++ b/doc/api/graphql/custom_emoji.md @@ -21,7 +21,7 @@ Parameters: | Attribute | Type | Required | Description | | :----------- | :------------- | :--------------------- | :------------------------------------------------------------------------ | -| `group_path` | integer/string | Yes | ID or [URL-encoded path of the top-level group](../rest/index.md#namespaced-path-encoding) | +| `group_path` | integer/string | Yes | ID or [URL-encoded path of the top-level group](../rest/index.md#namespaced-paths) | | `name` | string | Yes | Name of the custom emoji. | | `file` | string | Yes | URL of the custom emoji image. | diff --git a/doc/api/group_access_tokens.md b/doc/api/group_access_tokens.md index 5e8624ddba7..9afc53b1309 100644 --- a/doc/api/group_access_tokens.md +++ b/doc/api/group_access_tokens.md @@ -27,7 +27,7 @@ GET /groups/:id/access_tokens?state=inactive | Attribute | Type | required | Description | |-----------|---------|----------|---------------------| -| `id` | integer or string | yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `state` | string | No | Limit results to tokens with specified state. Valid values are `active` and `inactive`. By default both states are returned. | ```shell @@ -77,7 +77,7 @@ GET /groups/:id/access_tokens/:token_id | Attribute | Type | required | Description | |-----------|---------|----------|---------------------| -| `id` | integer or string | yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `token_id` | integer | yes | ID of the group access token | ```shell @@ -113,7 +113,7 @@ POST /groups/:id/access_tokens | Attribute | Type | required | Description | |-----------|---------|----------|---------------------| -| `id` | integer or string | yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `name` | String | yes | Name of the group access token | | `scopes` | `Array[String]` | yes | [List of scopes](../user/group/settings/group_access_tokens.md#scopes-for-a-group-access-token) | | `access_level` | Integer | no | Access level. Valid values are `10` (Guest), `20` (Reporter), `30` (Developer), `40` (Maintainer), and `50` (Owner). | @@ -162,7 +162,7 @@ POST /groups/:id/access_tokens/:token_id/rotate | Attribute | Type | required | Description | |-----------|------------|----------|---------------------| -| `id` | integer or string | yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `token_id` | integer | yes | ID of the access token | | `expires_at` | date | no | Expiration date of the access token in ISO format (`YYYY-MM-DD`). [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/416795) in GitLab 16.6. | @@ -212,7 +212,7 @@ DELETE /groups/:id/access_tokens/:token_id | Attribute | Type | required | Description | |-----------|---------|----------|---------------------| -| `id` | integer or string | yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `token_id` | integer | yes | ID of the group access token | ```shell diff --git a/doc/api/group_badges.md b/doc/api/group_badges.md index 2d5a8176e86..219c03f2630 100644 --- a/doc/api/group_badges.md +++ b/doc/api/group_badges.md @@ -43,7 +43,7 @@ GET /groups/:id/badges | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `name` | string | no | Name of the badges to return (case-sensitive). | ```shell @@ -76,7 +76,7 @@ GET /groups/:id/badges/:badge_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `badge_id` | integer | yes | The badge ID | ```shell @@ -107,7 +107,7 @@ POST /groups/:id/badges | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `link_url` | string | yes | URL of the badge link | | `image_url` | string | yes | URL of the badge image | | `name` | string | no | Name of the badge | @@ -142,7 +142,7 @@ PUT /groups/:id/badges/:badge_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `badge_id` | integer | yes | The badge ID | | `link_url` | string | no | URL of the badge link | | `image_url` | string | no | URL of the badge image | @@ -177,7 +177,7 @@ DELETE /groups/:id/badges/:badge_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `badge_id` | integer | yes | The badge ID | ```shell @@ -194,7 +194,7 @@ GET /groups/:id/badges/render | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `link_url` | string | yes | URL of the badge link| | `image_url` | string | yes | URL of the badge image | diff --git a/doc/api/group_boards.md b/doc/api/group_boards.md index 18d6d2fb01c..b0ac527b495 100644 --- a/doc/api/group_boards.md +++ b/doc/api/group_boards.md @@ -25,7 +25,7 @@ GET /groups/:id/boards | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | ```shell curl --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/groups/5/boards" @@ -142,7 +142,7 @@ GET /groups/:id/boards/:board_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `board_id` | integer | yes | The ID of a board. | ```shell @@ -260,7 +260,7 @@ POST /groups/:id/boards | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `name` | string | yes | The name of the new board. | ```shell @@ -297,7 +297,7 @@ PUT /groups/:id/boards/:board_id | Attribute | Type | Required | Description | | ---------------------------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `board_id` | integer | yes | The ID of a board. | | `name` | string | no | The new name of the board. | | `hide_backlog_list` | boolean | no | Hide the Open list. | @@ -369,7 +369,7 @@ DELETE /groups/:id/boards/:board_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `board_id` | integer | yes | The ID of a board. | ```shell @@ -387,7 +387,7 @@ GET /groups/:id/boards/:board_id/lists | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `board_id` | integer | yes | The ID of a board. | ```shell @@ -438,7 +438,7 @@ GET /groups/:id/boards/:board_id/lists/:list_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `board_id` | integer | yes | The ID of a board. | | `list_id` | integer | yes | The ID of a board's list. | @@ -470,7 +470,7 @@ POST /groups/:id/boards/:board_id/lists | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `board_id` | integer | yes | The ID of a board. | | `label_id` | integer | yes | The ID of a label. | @@ -511,7 +511,7 @@ PUT /groups/:id/boards/:board_id/lists/:list_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `board_id` | integer | yes | The ID of a board. | | `list_id` | integer | yes | The ID of a board's list. | | `position` | integer | yes | The position of the list. | @@ -544,7 +544,7 @@ DELETE /groups/:id/boards/:board_id/lists/:list_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `board_id` | integer | yes | The ID of a board. | | `list_id` | integer | yes | The ID of a board's list. | diff --git a/doc/api/group_clusters.md b/doc/api/group_clusters.md index 1b4a51ce7c9..13217328a3c 100644 --- a/doc/api/group_clusters.md +++ b/doc/api/group_clusters.md @@ -32,7 +32,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ----------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | Example request: @@ -101,7 +101,7 @@ Parameters: | Attribute | Type | Required | Description | | ------------ | -------------- | -------- | ----------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `cluster_id` | integer | yes | The ID of the cluster | Example request: @@ -170,7 +170,7 @@ Parameters: | Attribute | Type | Required | Description | | ---------------------------------------------------- | -------------- | -------- | --------------------------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `name` | string | yes | The name of the cluster | | `domain` | string | no | The [base domain](../user/group/clusters/index.md#base-domain) of the cluster | | `management_project_id` | integer | no | The ID of the [management project](../user/clusters/management_project.md) for the cluster | @@ -241,7 +241,7 @@ Parameters: | Attribute | Type | Required | Description | | ----------------------------------------- | -------------- | -------- | ------------------------------------------------------------------------------------------ | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `cluster_id` | integer | yes | The ID of the cluster | | `name` | string | no | The name of the cluster | | `domain` | string | no | The [base domain](../user/group/clusters/index.md#base-domain) of the cluster | @@ -326,7 +326,7 @@ Parameters: | Attribute | Type | Required | Description | | ------------ | -------------- | -------- | ----------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `cluster_id` | integer | yes | The ID of the cluster | Example request: diff --git a/doc/api/group_epic_boards.md b/doc/api/group_epic_boards.md index 1365ef1bced..83b604d85ce 100644 --- a/doc/api/group_epic_boards.md +++ b/doc/api/group_epic_boards.md @@ -27,7 +27,7 @@ GET /groups/:id/epic_boards | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) accessible by the authenticated user | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) accessible by the authenticated user | ```shell curl --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/groups/5/epic_boards" @@ -110,7 +110,7 @@ GET /groups/:id/epic_boards/:board_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) accessible by the authenticated user | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) accessible by the authenticated user | | `board_id` | integer | yes | The ID of an epic board | ```shell @@ -193,7 +193,7 @@ GET /groups/:id/epic_boards/:board_id/lists | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) accessible by the authenticated user | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) accessible by the authenticated user | | `board_id` | integer | yes | The ID of an epic board | ```shell @@ -252,7 +252,7 @@ GET /groups/:id/epic_boards/:board_id/lists/:list_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) accessible by the authenticated user | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) accessible by the authenticated user | | `board_id` | integer | yes | The ID of an epic board | | `list_id` | integer | yes | The ID of an epic board's list | diff --git a/doc/api/group_labels.md b/doc/api/group_labels.md index b99966d0f47..0f4ec650888 100644 --- a/doc/api/group_labels.md +++ b/doc/api/group_labels.md @@ -24,7 +24,7 @@ GET /groups/:id/labels | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `with_counts` | boolean | no | Whether or not to include issue and merge request counts. Defaults to `false`. | | `include_ancestor_groups` | boolean | no | Include ancestor groups. Defaults to `true`. | | `include_descendant_groups` | boolean | no | Include descendant groups. Defaults to `false`. | @@ -76,7 +76,7 @@ GET /groups/:id/labels/:label_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `label_id` | integer or string | yes | The ID or title of a group's label. | | `include_ancestor_groups` | boolean | no | Include ancestor groups. Defaults to `true`. | | `include_descendant_groups` | boolean | no | Include descendant groups. Defaults to `false`. | @@ -113,7 +113,7 @@ POST /groups/:id/labels | Attribute | Type | Required | Description | | ------------- | ------- | -------- | ---------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `name` | string | yes | The name of the label | | `color` | string | yes | The color of the label given in 6-digit hex notation with leading '#' sign (for example, #FFAABB) or one of the [CSS color names](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value#Color_keywords) | | `description` | string | no | The description of the label, | @@ -151,7 +151,7 @@ PUT /groups/:id/labels/:label_id | Attribute | Type | Required | Description | | ------------- | ------- | -------- | ---------------------------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `label_id` | integer or string | yes | The ID or title of a group's label. | | `new_name` | string | no | The new name of the label | | `color` | string | no | The color of the label given in 6-digit hex notation with leading '#' sign (for example, #FFAABB) or one of the [CSS color names](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value#Color_keywords) | @@ -192,7 +192,7 @@ DELETE /groups/:id/labels/:label_id | Attribute | Type | Required | Description | | --------- | ------- | -------- | --------------------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `label_id` | integer or string | yes | The ID or title of a group's label. | ```shell @@ -213,7 +213,7 @@ POST /groups/:id/labels/:label_id/subscribe | Attribute | Type | Required | Description | | ---------- | ----------------- | -------- | ------------------------------------ | -| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `label_id` | integer or string | yes | The ID or title of a group's label. | ```shell @@ -249,7 +249,7 @@ POST /groups/:id/labels/:label_id/unsubscribe | Attribute | Type | Required | Description | | ---------- | ----------------- | -------- | ------------------------------------ | -| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `label_id` | integer or string | yes | The ID or title of a group's label. | ```shell diff --git a/doc/api/group_ldap_links.md b/doc/api/group_ldap_links.md index 11db78aae47..b2b3f1f9503 100644 --- a/doc/api/group_ldap_links.md +++ b/doc/api/group_ldap_links.md @@ -24,7 +24,7 @@ Supported attributes: | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | Example request: @@ -65,7 +65,7 @@ Supported attributes: | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `group_access` | integer | yes | [Role (`access_level`)](members.md#roles) for members of the LDAP group. | | `provider` | string | yes | LDAP provider ID for the LDAP group link. | | `cn` | string | yes/no | The CN of an LDAP group. Provide either a `cn` or a `filter`, but not both. | @@ -106,7 +106,7 @@ Supported attributes: | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `provider` | string | yes | LDAP provider ID for the LDAP group link. | | `cn` | string | yes/no | The CN of an LDAP group. Provide either a `cn` or a `filter`, but not both. | | `filter` | string | yes/no | The LDAP filter for the group. Provide either a `cn` or a `filter`, but not both. | @@ -136,7 +136,7 @@ DELETE /groups/:id/ldap_group_links/:cn | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `cn` | string | yes | The CN of an LDAP group | Delete an LDAP group link for a specific LDAP provider: @@ -147,6 +147,6 @@ DELETE /groups/:id/ldap_group_links/:provider/:cn | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `cn` | string | yes | The CN of an LDAP group | | `provider` | string | yes | LDAP provider for the LDAP group link | diff --git a/doc/api/group_level_variables.md b/doc/api/group_level_variables.md index 297926f2761..d068ba5f44f 100644 --- a/doc/api/group_level_variables.md +++ b/doc/api/group_level_variables.md @@ -20,7 +20,7 @@ GET /groups/:id/variables | Attribute | Type | Required | Description | |-----------|----------------|----------|-------------| -| `id` | integer/string | Yes | The ID of a group or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | The ID of a group or [URL-encoded path of the group](rest/index.md#namespaced-paths) | ```shell curl --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/groups/1/variables" @@ -64,7 +64,7 @@ GET /groups/:id/variables/:key | Attribute | Type | Required | Description | |-----------|----------------|----------|-------------| -| `id` | integer/string | Yes | The ID of a group or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | The ID of a group or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `key` | string | Yes | The `key` of a variable | | `filter` | hash | No | Available filters: `[environment_scope]`. See the [`filter` parameter details](#the-filter-parameter). | @@ -95,7 +95,7 @@ POST /groups/:id/variables | Attribute | Type | Required | Description | |---------------------------------------|----------------|----------|-------------| -| `id` | integer/string | Yes | The ID of a group or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The ID of a group or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `key` | string | Yes | The `key` of a variable; must have no more than 255 characters; only `A-Z`, `a-z`, `0-9`, and `_` are allowed. | | `value` | string | Yes | The `value` of a variable. | | `description` | string | No | The `description` of the variable; must have no more than 255 characters. Default: `null`. | @@ -136,7 +136,7 @@ PUT /groups/:id/variables/:key | Attribute | Type | Required | Description | |---------------------------------------|----------------|----------|-------------| -| `id` | integer/string | Yes | The ID of a group or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | The ID of a group or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `key` | string | Yes | The `key` of a variable | | `value` | string | Yes | The `value` of a variable | | `description` | string | No | The description of the variable. Default: `null`. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/409641) in GitLab 16.2. | @@ -178,7 +178,7 @@ DELETE /groups/:id/variables/:key | Attribute | Type | Required | Description | |-----------|----------------|----------|-------------| -| `id` | integer/string | Yes | The ID of a group or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | The ID of a group or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `key` | string | Yes | The `key` of a variable | | `filter` | hash | No | Available filters: `[environment_scope]`. See the [`filter` parameter details](#the-filter-parameter). | diff --git a/doc/api/group_markdown_uploads.md b/doc/api/group_markdown_uploads.md index 32e876dba94..d401883514b 100644 --- a/doc/api/group_markdown_uploads.md +++ b/doc/api/group_markdown_uploads.md @@ -27,7 +27,7 @@ GET /groups/:id/uploads | Attribute | Type | Required | Description | |-----------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | Example request: @@ -74,7 +74,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `upload_id` | integer | Yes | The ID of the upload. | Example request: @@ -99,7 +99,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `secret` | string | Yes | The 32-character secret of the upload. | | `filename` | string | Yes | The filename of the upload. | @@ -125,7 +125,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `upload_id` | integer | Yes | The ID of the upload. | Example request: @@ -150,7 +150,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `secret` | string | Yes | The 32-character secret of the upload. | | `filename` | string | Yes | The filename of the upload. | diff --git a/doc/api/group_milestones.md b/doc/api/group_milestones.md index c8402e1cd0a..2219f37a420 100644 --- a/doc/api/group_milestones.md +++ b/doc/api/group_milestones.md @@ -37,7 +37,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ------ | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `iids[]` | integer array | no | Return only the milestones having the given `iid`. Ignored if `include_ancestors` is `true`. | | `state` | string | no | Return only `active` or `closed` milestones. | | `title` | string | no | Return only the milestones having the given `title` (case-sensitive). | @@ -89,7 +89,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ------ | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `milestone_id` | integer | yes | The ID of the group milestone | ## Create new milestone @@ -104,7 +104,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ------ | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `title` | string | yes | The title of a milestone | | `description` | string | no | The description of the milestone | | `due_date` | date | no | The due date of the milestone, in ISO 8601 format (`YYYY-MM-DD`) | @@ -122,7 +122,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ------ | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `milestone_id` | integer | yes | The ID of a group milestone | | `title` | string | no | The title of a milestone | | `description` | string | no | The description of a milestone | @@ -142,7 +142,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ------ | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `milestone_id` | integer | yes | The ID of the group's milestone | ## Get all issues assigned to a single milestone @@ -157,7 +157,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ------ | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `milestone_id` | integer | yes | The ID of a group milestone | Currently, this API endpoint doesn't return issues from any subgroups. @@ -177,7 +177,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ------ | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `milestone_id` | integer | yes | The ID of a group milestone | ## Get all burndown chart events for a single milestone @@ -196,5 +196,5 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ------ | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `milestone_id` | integer | yes | The ID of a group milestone | diff --git a/doc/api/group_protected_branches.md b/doc/api/group_protected_branches.md index 5793a765542..396c392af9e 100644 --- a/doc/api/group_protected_branches.md +++ b/doc/api/group_protected_branches.md @@ -46,7 +46,7 @@ GET /groups/:id/protected_branches | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `search` | string | no | Name or part of the name of protected branches to be searched for. | ```shell @@ -120,7 +120,7 @@ GET /groups/:id/protected_branches/:name | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `name` | string | yes | The name of the branch or wildcard. | ```shell @@ -172,7 +172,7 @@ curl --request POST --header "PRIVATE-TOKEN: " \ | Attribute | Type | Required | Description | | -------------------------------------------- | ---- | -------- | ----------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `name` | string | yes | The name of the branch or wildcard. | | `allow_force_push` | boolean | no | Allow all users with push access to force push. Default: `false`. | | `allowed_to_merge` | array | no | Array of access levels allowed to merge, with each described by a hash of the form `{user_id: integer}`, `{group_id: integer}`, or `{access_level: integer}`. | @@ -352,7 +352,7 @@ curl --request DELETE --header "PRIVATE-TOKEN: " \ | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `name` | string | yes | The name of the branch. | Example response: @@ -387,7 +387,7 @@ curl --request PATCH --header "PRIVATE-TOKEN: " \ | Attribute | Type | Required | Description | | -------------------------------------------- | ---- | -------- | ----------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `name` | string | yes | The name of the branch. | | `allow_force_push` | boolean | no | When enabled, members who can push to this branch can also force push. | | `allowed_to_push` | array | no | Array of push access levels, with each described by a hash. | diff --git a/doc/api/group_protected_environments.md b/doc/api/group_protected_environments.md index 5ec7cbaa582..faa2e9eab81 100644 --- a/doc/api/group_protected_environments.md +++ b/doc/api/group_protected_environments.md @@ -37,7 +37,7 @@ GET /groups/:id/protected_environments | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) maintained by the authenticated user. | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) maintained by the authenticated user. | ```shell curl --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/groups/5/protected_environments/" @@ -73,7 +73,7 @@ GET /groups/:id/protected_environments/:name | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) maintained by the authenticated user. | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) maintained by the authenticated user. | | `name` | string | yes | The deployment tier of the protected environment. One of `production`, `staging`, `testing`, `development`, or `other`. Read more about [deployment tiers](../ci/environments/index.md#deployment-tier-of-environments).| ```shell @@ -108,7 +108,7 @@ POST /groups/:id/protected_environments | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) maintained by the authenticated user. | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) maintained by the authenticated user. | | `name` | string | yes | The deployment tier of the protected environment. One of `production`, `staging`, `testing`, `development`, or `other`. Read more about [deployment tiers](../ci/environments/index.md#deployment-tier-of-environments).| | `deploy_access_levels` | array | yes | Array of access levels allowed to deploy, with each described by a hash. One of `user_id`, `group_id` or `access_level`. They take the form of `{user_id: integer}`, `{group_id: integer}` or `{access_level: integer}` respectively. | | `approval_rules` | array | no | Array of access levels allowed to approve, with each described by a hash. One of `user_id`, `group_id` or `access_level`. They take the form of `{user_id: integer}`, `{group_id: integer}` or `{access_level: integer}` respectively. You can also specify the number of required approvals from the specified entity with `required_approvals` field. See [Multiple approval rules](../ci/environments/deployment_approvals.md#add-multiple-approval-rules) for more information. | @@ -163,7 +163,7 @@ PUT /groups/:id/protected_environments/:name | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) maintained by the authenticated user. | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) maintained by the authenticated user. | | `name` | string | yes | The deployment tier of the protected environment. One of `production`, `staging`, `testing`, `development`, or `other`. Read more about [deployment tiers](../ci/environments/index.md#deployment-tier-of-environments).| | `deploy_access_levels` | array | no | Array of access levels allowed to deploy, with each described by a hash. One of `user_id`, `group_id` or `access_level`. They take the form of `{user_id: integer}`, `{group_id: integer}` or `{access_level: integer}` respectively. | | `required_approval_count` | integer | no | The number of approvals required to deploy to this environment. | @@ -329,7 +329,7 @@ DELETE /groups/:id/protected_environments/:name | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) maintained by the authenticated user. | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) maintained by the authenticated user. | | `name` | string | yes | The deployment tier of the protected environment. One of `production`, `staging`, `testing`, `development`, or `other`. Read more about [deployment tiers](../ci/environments/index.md#deployment-tier-of-environments).| ```shell diff --git a/doc/api/group_push_rules.md b/doc/api/group_push_rules.md index be4ca9061f3..9a534255891 100644 --- a/doc/api/group_push_rules.md +++ b/doc/api/group_push_rules.md @@ -26,7 +26,7 @@ Supported attributes: | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID of the group or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID of the group or [URL-encoded path of the group](rest/index.md#namespaced-paths). | Example request: @@ -70,7 +70,7 @@ Supported attribues: | Attribute | Type | Required | Description | | --------------------------------------------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `deny_delete_tag` | boolean | no | Deny deleting a tag. | | `member_check` | boolean | no | Allow only GitLab users to author commits. | | `prevent_secrets` | boolean | no | Reject files that are likely to [contain secrets](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/lib/gitlab/checks/files_denylist.yml). | @@ -127,7 +127,7 @@ PUT /groups/:id/push_rule | Attribute | Type | Required | Description | | --------------------------------------------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `deny_delete_tag` | boolean | no | Deny deleting a tag. | | `member_check` | boolean | no | Allow only GitLab users to author commits. | | `prevent_secrets` | boolean | no | Reject files that are likely to [contain secrets](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/lib/gitlab/checks/files_denylist.yml). | @@ -184,7 +184,7 @@ Supported attribues: | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | Example request: diff --git a/doc/api/group_releases.md b/doc/api/group_releases.md index d76db2336a2..d9ec9db2d03 100644 --- a/doc/api/group_releases.md +++ b/doc/api/group_releases.md @@ -31,7 +31,7 @@ Parameters: | Attribute | Type | Required | Description | |---------------------|----------------|----------|---------------------------------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `sort` | string | no | The direction of the order. Either `desc` (default) for descending order or `asc` for ascending order. | | `simple` | boolean | no | Return only limited fields for each release. | diff --git a/doc/api/group_service_accounts.md b/doc/api/group_service_accounts.md index 968c37666ea..3659f0fb9b5 100644 --- a/doc/api/group_service_accounts.md +++ b/doc/api/group_service_accounts.md @@ -32,7 +32,7 @@ Parameters: | Attribute | Type | Required | Description | |:-------------|:---------|:-----------|:----------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the target group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the target group](rest/index.md#namespaced-paths). | | `order_by` | string | no | Orders list of users by `username` or `id`. Default is `id`. | | `sort` | string | no | Specifies sorting by `asc` or `desc`. Default is `desc`. | @@ -77,7 +77,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:---------------------------|:---------------|:--------------------------|:-------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the target group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the target group](rest/index.md#namespaced-paths). | | `name` | string | no | The name of the user. If not specified, the default `Service account user` name is used. | | `username` | string | no | The username of the user. If not specified, it's automatically generated. | @@ -113,7 +113,7 @@ Parameters: | Attribute | Type | Required | Description | |:---------------------------|:---------------|:--------------------------|:-------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the target group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the target group](rest/index.md#namespaced-paths). | | `user_id` | integer | yes | The ID of a service account user. | | `hard_delete` | boolean | no | If true, contributions that would usually be [moved to a Ghost User](../user/profile/account/delete_account.md#associated-records) are instead deleted, as well as groups owned solely by this service account user. | @@ -137,7 +137,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | --------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the target group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the target group](rest/index.md#namespaced-paths). | | `user_id` | integer | yes | The ID of a service account user. | | `name` | string | yes | The name of the personal access token. | | `scopes` | array | yes | Array of scopes of the personal access token. See [personal access token scopes](../user/profile/personal_access_tokens.md#personal-access-token-scopes) for possible values. | @@ -180,7 +180,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | --------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the target group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the target group](rest/index.md#namespaced-paths). | | `user_id` | integer | yes | The ID of the service account user. | | `token_id` | integer | yes | The ID of the token. | diff --git a/doc/api/group_webhooks.md b/doc/api/group_webhooks.md index 12920aedbee..6bf2bec3070 100644 --- a/doc/api/group_webhooks.md +++ b/doc/api/group_webhooks.md @@ -29,7 +29,7 @@ Supported attributes: | Attribute | Type | Required | Description | | --------- | --------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | Example request: @@ -95,7 +95,7 @@ Supported attributes: | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `hook_id` | integer | yes | The ID of a group hook. | Example request: @@ -159,7 +159,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-----------|-------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `hook_id` | integer | Yes | The ID of a project hook. | | `status` | integer or string | No | The response status code of the events, for example: `200` or `500`. You can search by status category: `successful` (200-299), `client_failure` (400-499), and `server_failure` (500-599). | | `page` | integer | No | Page to retrieve. Defaults to `1`. | @@ -440,7 +440,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-----------|------------------|----------|-------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `hook_id` | integer | Yes | The ID of a group hook. | | `hook_event_id` | integer | Yes | The ID of a hook event. | @@ -470,7 +470,7 @@ Supported attributes: | Attribute | Type | Required | Description | | -----------------------------| -------------- |----------| ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `url` | string | yes | The hook URL. | | `name` | string | no | Name of the hook ([introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/460887) in GitLab 17.1). | | `description` | string | no | Description of the hook ([introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/460887) in GitLab 17.1). | @@ -554,7 +554,7 @@ Supported attributes: | Attribute | Type | Required | Description | | ---------------------------- | -------------- | -------- | ----------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `hook_id` | integer | yes | The ID of the group hook. | | `url` | string | yes | The hook URL. | | `name` | string | no | Name of the hook ([introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/460887) in GitLab 17.1). | @@ -646,7 +646,7 @@ Supported attributes: | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `hook_id` | integer | yes | The ID of the group hook. | Example request: @@ -675,7 +675,7 @@ POST /groups/:id/hooks/:hook_id/test/:trigger | Attribute | Type | Required | Description | |-----------|-------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `hook_id` | integer | Yes | The ID of the group hook. | -| `id` | integer or string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `trigger` | string | Yes | One of `push_events`, `tag_push_events`, `issues_events`, `confidential_issues_events`, `note_events`, `merge_requests_events`, `job_events`, `pipeline_events`, `wiki_page_events`, `releases_events`, `emoji_events`, or `resource_access_token_events`. | Example request: @@ -704,7 +704,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-----------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `hook_id` | integer | Yes | The ID of the group hook. | | `key` | string | Yes | The key of the custom header. | | `value` | string | Yes | The value of the custom header. | @@ -731,7 +731,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-----------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `hook_id` | integer | Yes | The ID of the group hook. | | `key` | string | Yes | The key of the custom header. | diff --git a/doc/api/group_wikis.md b/doc/api/group_wikis.md index 43e436aec4e..d0ac2cea23b 100644 --- a/doc/api/group_wikis.md +++ b/doc/api/group_wikis.md @@ -23,7 +23,7 @@ GET /groups/:id/wikis | Attribute | Type | Required | Description | | -------------- | -------------- | -------- | ----------- | -| `id` | integer/string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `with_content` | boolean | No | Include pages' content. | ```shell @@ -67,7 +67,7 @@ GET /groups/:id/wikis/:slug | Attribute | Type | Required | Description | | ------------- | -------------- | -------- | ----------- | -| `id` | integer/string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `slug` | string | Yes | URL-encoded slug (a unique string) of the wiki page, such as `dir%2Fpage_name`. | | `render_html` | boolean | No | Return the rendered HTML of the wiki page. | | `version` | string | No | Wiki page version SHA. | @@ -98,7 +98,7 @@ POST /projects/:id/wikis | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ----------- | -| `id` | integer/string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `content` | string | Yes | The content of the wiki page. | | `title` | string | Yes | The title of the wiki page. | | `format` | string | No | The format of the wiki page. Available formats are: `markdown` (default), `rdoc`, `asciidoc`, and `org`. | @@ -131,7 +131,7 @@ PUT /groups/:id/wikis/:slug | Attribute | Type | Required | Description | | --------- | -------------- | ---------------------------------- | ----------- | -| `id` | integer/string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `content` | string | Yes, if `title` is not provided | The content of the wiki page. | | `title` | string | Yes, if `content` is not provided | The title of the wiki page. | | `format` | string | No | The format of the wiki page. Available formats are `markdown` (default), `rdoc`, `asciidoc`, and `org`. | @@ -165,7 +165,7 @@ DELETE /groups/:id/wikis/:slug | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ----------- | -| `id` | integer/string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `slug` | string | Yes | URL-encoded slug (a unique string) of the wiki page, such as `dir%2Fpage_name`. | ```shell @@ -185,7 +185,7 @@ POST /groups/:id/wikis/attachments | Attribute | Type | Required | Description | | ------------- | -------------- | -------- | ----------- | -| `id` | integer/string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `file` | string | Yes | The attachment to be uploaded. | | `branch` | string | No | The name of the branch. Defaults to the wiki repository default branch. | diff --git a/doc/api/groups.md b/doc/api/groups.md index 91948a2a914..9c8f688513d 100644 --- a/doc/api/groups.md +++ b/doc/api/groups.md @@ -202,7 +202,7 @@ Parameters: | Attribute | Type | Required | Description | | ------------------------ | ----------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) of the immediate parent group | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) of the immediate parent group | | `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 administrators); Attributes `owned` and `min_access_level` have precedence | | `search` | string | no | Return the list of authorized groups matching the search criteria. Only subgroup short paths are searched (not full paths) | @@ -277,7 +277,7 @@ Parameters: | Attribute | Type | Required | Description | | ------------------------ | ----------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) of the immediate parent group | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) of the immediate parent group | | `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 administrators). Attributes `owned` and `min_access_level` have precedence | | `search` | string | no | Return the list of authorized groups matching the search criteria. Only descendant group short paths are searched (not full paths) | @@ -394,7 +394,7 @@ Parameters: | Attribute | Type | Required | Description | | -------------------------------------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `archived` | boolean | no | Limit by archived status | | `visibility` | string | no | Limit by visibility `public`, `internal`, or `private` | | `order_by` | string | no | Return projects ordered by `id`, `name`, `path`, `created_at`, `updated_at`, `similarity` 1, `star_count` or `last_activity_at` fields. Default is `created_at` | @@ -476,7 +476,7 @@ Parameters: | Attribute | Type | Required | Description | | ------------------------------------- | ----------------- | -------- | ---------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `skip_groups` | array of integers | no | Skip the specified group IDs | | `search` | string | no | Return the list of authorized groups matching the search criteria | | `order_by` | string | no | Order groups by `name`, `path`, `id`, or `similarity`. Default is `name` | @@ -555,7 +555,7 @@ Parameters: | Attribute | Type | Required | Description | | ------------------------------------- | ----------------- | -------- | ---------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `search` | string | no | Return the list of authorized groups matching the search criteria | | `min_access_level` | integer | no | Limit to groups where current user has at least the specified [role (`access_level`)](members.md#roles) | | `relation` | array of strings | no | Filter the groups by relation (direct or inherited) | @@ -633,7 +633,7 @@ Parameters: | Attribute | Type | Required | Description | | ----------------------------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `archived` | boolean | no | Limit by archived status | | `visibility` | string | no | Limit by visibility `public`, `internal`, or `private` | | `order_by` | string | no | Return projects ordered by `id`, `name`, `path`, `created_at`, `updated_at`, `star_count` or `last_activity_at` fields. Default is `created_at` | @@ -771,7 +771,7 @@ Parameters: | Attribute | Type | Required | Description | | ------------------------ | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `with_custom_attributes` | boolean | no | Include [custom attributes](custom_attributes.md) in response (administrators only). | | `with_projects` | boolean | no | Include details from projects that belong to the specified group (defaults to `true`). (Deprecated, [scheduled for removal in API v5](https://gitlab.com/gitlab-org/gitlab/-/issues/213797). To get the details of all projects within a group, use the [list a group's projects endpoint](#list-a-groups-projects).) | @@ -1129,8 +1129,8 @@ Parameters: | Attribute | Type | Required | Description | | ------------ | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the target group](rest/index.md#namespaced-path-encoding) | -| `project_id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the target group](rest/index.md#namespaced-paths) | +| `project_id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | ```shell curl --request POST --header "PRIVATE-TOKEN: " \ @@ -1149,7 +1149,7 @@ GET /groups/:id/transfer_locations | Attribute | Type | Required | Description | |-------------|----------------|------------------------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the group to be transferred](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the group to be transferred](rest/index.md#namespaced-paths). | | `search` | string | No | The group names to search for. | Example request: @@ -1406,7 +1406,7 @@ Parameters: | Attribute | Type | Required | Description | |----------------------|------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `permanently_remove` | boolean/string | no | Immediately deletes a subgroup if it is marked for deletion. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/368276) in GitLab 15.4. Premium and Ultimate only. | | `full_path` | string | no | Full path of subgroup to use with `permanently_remove`. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/368276) in GitLab 15.4. To find the subgroup path, see the [group details](groups.md#details-of-a-group). Premium and Ultimate only. | @@ -1431,7 +1431,7 @@ Parameters: | Attribute | Type | Required | Description | | --------------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | ## Search for group @@ -1470,7 +1470,7 @@ Parameters: | Attribute | Type | Required | Description | |:-----------------|:---------------|:---------|:-------------------------------------------------------------------------| -| `id` | integer/string | yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `username` | string | no | Return single user with a specific username | | `search` | string | no | Search users by name, email, username | | `active` | boolean | no | Return only active users | @@ -1556,7 +1556,7 @@ Parameters: | Attribute | Type | Required | Description | |:---------------------------|:---------------|:--------------------------|:-------------------------------------------------------------------------------| -| `id` | integer/string | yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `include_saml_users` | boolean | yes (see description) | Include users with a SAML identity. Either this value or `include_service_accounts` must be `true`. | | `include_service_accounts` | boolean | yes (see description) | Include service account users. Either this value or `include_saml_users` must be `true`. | | `search` | string | no | Search users by name, email, username. | @@ -1671,7 +1671,7 @@ POST /groups/:id/share | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `group_id` | integer | yes | The ID of the group to share with | | `group_access` | integer | yes | The [role (`access_level`)](members.md#roles) to grant the group | | `expires_at` | string | no | Share expiration date in ISO 8601 format: 2016-09-26 | @@ -1686,7 +1686,7 @@ DELETE /groups/:id/share/:group_id | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `group_id` | integer | yes | The ID of the group to share with | ## Revoke Token @@ -1721,7 +1721,7 @@ POST /groups/:id/tokens/revoke | Attribute | Type | Required | Description | |-------------|----------------|------------------------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `token` | string | Yes | The plaintext token. | If successful, returns [`200 OK`](rest/index.md#status-codes) and diff --git a/doc/api/invitations.md b/doc/api/invitations.md index d7b6cab31c4..0af0a7d6d43 100644 --- a/doc/api/invitations.md +++ b/doc/api/invitations.md @@ -37,7 +37,7 @@ POST /projects/:id/invitations | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](rest/index.md#namespaced-paths) | | `email` | string | yes (if `user_id` isn't provided) | The email of the new member or multiple emails separated by commas. | | `user_id` | integer/string | yes (if `email` isn't provided) | The ID of the new member or multiple IDs separated by commas. | | `access_level` | integer | yes | A valid access level | @@ -87,7 +87,7 @@ GET /projects/:id/invitations | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](rest/index.md#namespaced-paths) | | `page` | integer | no | Page to retrieve | | `per_page`| integer | no | Number of member invitations to return per page | | `query` | string | no | A query string to search for invited members by invite email. Query text must match email address exactly. When empty, returns all invitations. | @@ -124,7 +124,7 @@ PUT /projects/:id/invitations/:email | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](rest/index.md#namespaced-paths). | | `email` | string | yes | The email address the invitation was previously sent to. | | `access_level` | integer | no | A valid access level (defaults: `30`, the Developer role). | | `expires_at` | string | no | A date string in ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`). | @@ -154,7 +154,7 @@ DELETE /projects/:id/invitations/:email | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](rest/index.md#namespaced-paths) | | `email` | string | yes | The email address to which the invitation was previously sent | ```shell diff --git a/doc/api/issue_links.md b/doc/api/issue_links.md index 5c4256aad0c..99a94861017 100644 --- a/doc/api/issue_links.md +++ b/doc/api/issue_links.md @@ -26,7 +26,7 @@ Parameters: | Attribute | Type | Required | Description | |-------------|---------|----------|--------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `issue_iid` | integer | yes | The internal ID of a project's issue | ```json @@ -81,7 +81,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-----------------|----------------|------------------------|-----------------------------------------------------------------------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | Yes | Internal ID of a project's issue. | | `issue_link_id` | integer/string | Yes | ID of an issue relationship. | @@ -178,9 +178,9 @@ POST /projects/:id/issues/:issue_iid/links | Attribute | Type | Required | Description | |---------------------|----------------|----------|--------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `issue_iid` | integer | yes | The internal ID of a project's issue | -| `target_project_id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) of a target project | +| `target_project_id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) of a target project | | `target_issue_iid` | integer/string | yes | The internal ID of a target project's issue | | `link_type` | string | no | The type of the relation (`relates_to`, `blocks`, `is_blocked_by`), defaults to `relates_to`). | @@ -266,7 +266,7 @@ DELETE /projects/:id/issues/:issue_iid/links/:issue_link_id | Attribute | Type | Required | Description | |-------------|---------|----------|--------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `issue_iid` | integer | yes | The internal ID of a project's issue | | `issue_link_id` | integer/string | yes | The ID of an issue relationship | | `link_type` | string | no | The type of the relation (`relates_to`, `blocks`, `is_blocked_by`), defaults to `relates_to` | diff --git a/doc/api/issues.md b/doc/api/issues.md index 851ece95c04..4b7d3eb5fca 100644 --- a/doc/api/issues.md +++ b/doc/api/issues.md @@ -286,7 +286,7 @@ Supported attributes: | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `id` | integer/string | Yes | The global ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The global ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `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, the `assignee_username` array should only contain a single value. Otherwise, an invalid parameter error is returned. | | `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`. | @@ -493,7 +493,7 @@ Supported attributes: | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `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, the `assignee_username` array should only contain a single value. Otherwise, an invalid parameter error is returned. | | `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`. | @@ -865,7 +865,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------|---------|----------|--------------------------------------| -| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | Yes | The internal ID of a project's issue. | Example request: @@ -1027,7 +1027,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------------------------------------|----------------|----------|--------------| -| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `assignee_id` | integer | No | The ID of the user to assign the issue to. Only appears on GitLab Free. | | `assignee_ids` | integer array | No | The IDs of the users to assign the issue to. Premium and Ultimate only.| | `confidential` | boolean | No | Set an issue to be confidential. Default is `false`. | @@ -1199,7 +1199,7 @@ Supported attributes: | Attribute | Type | Required | Description | |----------------|---------|----------|------------------------------------------------------------------------------------------------------------| -| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | Yes | The internal ID of a project's issue. | | `add_labels` | string | No | Comma-separated label names to add to an issue. If a label does not already exist, this creates a new project label and assigns it to the issue. | | `assignee_ids` | integer array | No | The ID of the users to assign the issue to. Set to `0` or provide an empty value to unassign all assignees. | @@ -1361,7 +1361,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------|---------|----------|--------------------------------------| -| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | Yes | The internal ID of a project's issue. | Example request: @@ -1386,7 +1386,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------|---------|----------|--------------------------------------| -| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | Yes | The internal ID of the project's issue. | | `move_after_id` | integer | No | The global ID of a project's issue that should be placed after this issue. | | `move_before_id` | integer | No | The global ID of a project's issue that should be placed before this issue. | @@ -1416,7 +1416,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-----------------|---------|----------|--------------------------------------| -| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | Yes | The internal ID of a project's issue. | | `to_project_id` | integer | Yes | The ID of the new project. | @@ -1570,7 +1570,7 @@ Supported attributes: | Attribute | Type | Required | Description | | --------------- | -------------- | ---------------------- | --------------------------------- | -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | Yes | Internal ID of a project's issue. | | `to_project_id` | integer | Yes | ID of the new project. | | `with_notes` | boolean | No | Clone the issue with [notes](notes.md). Default is `false`. | @@ -1688,7 +1688,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------|---------|----------|--------------------------------------| -| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | Yes | The internal ID of a project's issue. | Example request: @@ -1837,7 +1837,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------|---------|----------|--------------------------------------| -| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | Yes | The internal ID of a project's issue. | Example request: @@ -1917,7 +1917,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------|---------|----------|--------------------------------------| -| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | Yes | The internal ID of a project's issue. | Example request: @@ -2047,7 +2047,7 @@ Supported attributes: | Attribute | Type | Required | Description | | :---------- | :------------- | :------- | :---------- | -| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | Yes | The internal ID of a project's issue. | | `body` | String | Yes | The content of a note. Must contain `/promote` at the start of a new line. If the note only contains `/promote`, promotes the issue, but doesn't add a comment. Otherwise, the other lines form a comment.| @@ -2106,7 +2106,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------|---------|----------|------------------------------------------| | `duration` | string | Yes | The duration in human-readable format. For example: `3h30m`. | -| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | Yes | The internal ID of a project's issue. | Example request: @@ -2140,7 +2140,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------|---------|----------|--------------------------------------| -| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | Yes | The internal ID of a project's issue. | Example request: @@ -2175,7 +2175,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------|---------|----------|------------------------------------------| | `duration` | string | Yes | The duration in human-readable format. For example: `3h30m` | -| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | Yes | The internal ID of a project's issue. | | `summary` | string | No | A summary of how the time was spent. | @@ -2210,7 +2210,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------|---------|----------|--------------------------------------| -| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | Yes | The internal ID of a project's issue. | Example request: @@ -2247,7 +2247,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------|---------|----------|--------------------------------------| -| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | Yes | The internal ID of a project's issue. | Example request: @@ -2287,7 +2287,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------|---------|----------|--------------------------------------| -| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | Yes | The internal ID of a project's issue. | Example request: @@ -2452,7 +2452,7 @@ Supported attributes: | Attribute | Type | Required | Description | | ----------- | ---------------| -------- | ---------------------------------- | -| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | Yes | The internal ID of a project issue. | Example request: @@ -2536,7 +2536,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------|---------|----------|--------------------------------------| -| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | Yes | The internal ID of a project's issue. | Example request: @@ -2588,7 +2588,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------|---------|----------|--------------------------------------| -| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | Yes | The internal ID of a project's issue. | Example request: @@ -2633,7 +2633,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------|---------|----------|--------------------------------------| -| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | Yes | The internal ID of a project's issue. | | `file` | file | Yes | The image file to be uploaded. | | `url` | string | No | The URL to view more metric information. | @@ -2676,7 +2676,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------|---------|----------|--------------------------------------| -| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | Yes | The internal ID of a project's issue. | Example request: @@ -2721,7 +2721,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------|---------|----------|--------------------------------------| -| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | Yes | The internal ID of a project's issue. | | `image_id` | integer | Yes | The ID of the image. | | `url` | string | No | The URL to view more metric information. | @@ -2764,7 +2764,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------|---------|----------|--------------------------------------| -| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The global ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | Yes | The internal ID of a project's issue. | | `image_id` | integer | Yes | The ID of the image. | diff --git a/doc/api/issues_statistics.md b/doc/api/issues_statistics.md index 0e6e189540b..dd74c891f83 100644 --- a/doc/api/issues_statistics.md +++ b/doc/api/issues_statistics.md @@ -95,7 +95,7 @@ GET /groups/:id/issues_statistics?confidential=true | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `labels` | string | no | Comma-separated list of label names, issues must have all labels to be returned. `None` lists all issues with no labels. `Any` lists all issues with at least one label. | | `iids[]` | integer array | no | Return only the issues having the given `iid` | | `milestone` | string | no | The milestone title. `None` lists all issues with no milestone. `Any` lists all issues that have an assigned milestone. | @@ -151,7 +151,7 @@ GET /projects/:id/issues_statistics?confidential=true | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `iids[]` | integer array | no | Return only the milestone having the given `iid` | | `labels` | string | no | Comma-separated list of label names, issues must have all labels to be returned. `None` lists all issues with no labels. `Any` lists all issues with at least one label. | | `milestone` | string | no | The milestone title. `None` lists all issues with no milestone. `Any` lists all issues that have an assigned milestone. | diff --git a/doc/api/job_artifacts.md b/doc/api/job_artifacts.md index aaa5db9743d..93c10a1bfb3 100644 --- a/doc/api/job_artifacts.md +++ b/doc/api/job_artifacts.md @@ -30,7 +30,7 @@ GET /projects/:id/jobs/:job_id/artifacts | Attribute | Type | Required | Description | |-------------------------------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `job_id` | integer | Yes | ID of a job. | | `job_token` | string | No | To be used with [triggers](../ci/jobs/job_artifacts.md#with-a-cicd-job-token) for multi-project pipelines. It should be invoked only in a CI/CD job defined in the `.gitlab-ci.yml` file. The value is always `$CI_JOB_TOKEN`. The job associated with the `$CI_JOB_TOKEN` must be running when this token is used. Premium and Ultimate only. | @@ -103,7 +103,7 @@ Parameters | Attribute | Type | Required | Description | |-------------------------------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `job` | string | Yes | The name of the job. | | `ref_name` | string | Yes | Branch or tag name in repository. HEAD or SHA references are not supported. | | `job_token` | string | No | To be used with [triggers](../ci/jobs/job_artifacts.md#with-a-cicd-job-token) for multi-project pipelines. It should be invoked only in a CI/CD job defined in the `.gitlab-ci.yml` file. The value is always `$CI_JOB_TOKEN`. The job associated with the `$CI_JOB_TOKEN` must be running when this token is used. Premium and Ultimate only. | @@ -167,7 +167,7 @@ Parameters | Attribute | Type | Required | Description | |-------------------------------|----------------|----------|-------------| | `artifact_path` | string | Yes | Path to a file inside the artifacts archive. | -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `job_id` | integer | Yes | The unique job identifier. | | `job_token` | string | No | To be used with [triggers](../ci/jobs/job_artifacts.md#with-a-cicd-job-token) for multi-project pipelines. It should be invoked only in a CI/CD job defined in the `.gitlab-ci.yml` file. The value is always `$CI_JOB_TOKEN`. The job associated with the `$CI_JOB_TOKEN` must be running when this token is used. Premium and Ultimate only. | @@ -213,7 +213,7 @@ Parameters: | Attribute | Type | Required | Description | |-------------------------------|----------------|----------|-------------| | `artifact_path` | string | Yes | Path to a file inside the artifacts archive. | -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `job` | string | Yes | The name of the job. | | `ref_name` | string | Yes | Branch or tag name in repository. `HEAD` or `SHA` references are not supported. | | `job_token` | string | No | To be used with [triggers](../ci/jobs/job_artifacts.md#with-a-cicd-job-token) for multi-project pipelines. It should be invoked only in a CI/CD job defined in the `.gitlab-ci.yml` file. The value is always `$CI_JOB_TOKEN`. The job associated with the `$CI_JOB_TOKEN` must be running when this token is used. Premium and Ultimate only. | @@ -247,7 +247,7 @@ Parameters | Attribute | Type | Required | Description | |-----------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `job_id` | integer | Yes | ID of a job. | Example request: @@ -304,7 +304,7 @@ DELETE /projects/:id/jobs/:job_id/artifacts | Attribute | Type | Required | Description | |-----------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `job_id` | integer | Yes | ID of a job. | Example request: @@ -341,7 +341,7 @@ DELETE /projects/:id/artifacts | Attribute | Type | Required | Description | |-----------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | Example request: diff --git a/doc/api/jobs.md b/doc/api/jobs.md index 5d2d3074a0d..bc9498239bc 100644 --- a/doc/api/jobs.md +++ b/doc/api/jobs.md @@ -28,7 +28,7 @@ GET /projects/:id/jobs | Attribute | Type | Required | Description | |-----------|--------------------------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `scope` | string **or** array of strings | No | Scope of jobs to show. Either one of or an array of the following: `created`, `pending`, `running`, `failed`, `success`, `canceled`, `skipped`, `waiting_for_resource`, or `manual`. All jobs are returned if `scope` is not provided. | ```shell @@ -215,7 +215,7 @@ GET /projects/:id/pipelines/:pipeline_id/jobs | Attribute | Type | Required | Description | |-------------------|--------------------------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `pipeline_id` | integer | Yes | ID of a pipeline. Can also be obtained in CI jobs via the [predefined CI variable](../ci/variables/predefined_variables.md) `CI_PIPELINE_ID`. | | `include_retried` | boolean | No | Include retried jobs in the response. Defaults to `false`. | | `scope` | string **or** array of strings | No | Scope of jobs to show. Either one of or an array of the following: `created`, `pending`, `running`, `failed`, `success`, `canceled`, `skipped`, `waiting_for_resource`, or `manual`. All jobs are returned if `scope` is not provided. | @@ -395,7 +395,7 @@ GET /projects/:id/pipelines/:pipeline_id/bridges | Attribute | Type | Required | Description | |---------------|--------------------------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `pipeline_id` | integer | Yes | ID of a pipeline. | | `scope` | string **or** array of strings | No | Scope of jobs to show. Either one of or an array of the following: `created`, `pending`, `running`, `failed`, `success`, `canceled`, `skipped`, `waiting_for_resource`, or `manual`. All jobs are returned if `scope` is not provided. | @@ -641,7 +641,7 @@ GET /projects/:id/jobs/:job_id | Attribute | Type | Required | Description | |-----------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `job_id` | integer | Yes | ID of a job. | ```shell @@ -724,7 +724,7 @@ GET /projects/:id/jobs/:job_id/trace | Attribute | Type | Required | Description | |-----------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `job_id` | integer | Yes | ID of a job. | ```shell @@ -748,7 +748,7 @@ POST /projects/:id/jobs/:job_id/cancel | Attribute | Type | Required | Description | |-----------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `job_id` | integer | Yes | ID of a job. | ```shell @@ -804,7 +804,7 @@ POST /projects/:id/jobs/:job_id/retry | Attribute | Type | Required | Description | |-----------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `job_id` | integer | Yes | ID of a job. | ```shell @@ -865,7 +865,7 @@ Parameters | Attribute | Type | Required | Description | |-----------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `job_id` | integer | Yes | ID of a job. | Example of request @@ -928,7 +928,7 @@ POST /projects/:id/jobs/:job_id/play | Attribute | Type | Required | Description | |----------------------------|-----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `job_id` | integer | Yes | ID of a job. | | `job_variables_attributes` | array of hashes | No | An array containing the custom variables available to the job. | diff --git a/doc/api/labels.md b/doc/api/labels.md index 20fc5102b6a..a3ffde00261 100644 --- a/doc/api/labels.md +++ b/doc/api/labels.md @@ -24,7 +24,7 @@ GET /projects/:id/labels | Attribute | Type | Required | Description | | --------- | ------- | -------- | --------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `with_counts` | boolean | no | Whether or not to include issue and merge request counts. Defaults to `false`. | | `include_ancestor_groups` | boolean | no | Include ancestor groups. Defaults to `true`. | | `search` | string | no | Keyword to filter labels by. | @@ -120,7 +120,7 @@ GET /projects/:id/labels/:label_id | Attribute | Type | Required | Description | | --------- | ------- | -------- | --------------------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `label_id` | integer or string | yes | The ID or title of a project's label. | | `include_ancestor_groups` | boolean | no | Include ancestor groups. Defaults to `true`. | @@ -157,7 +157,7 @@ POST /projects/:id/labels | Attribute | Type | Required | Description | | ------------- | ------- | -------- | ---------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `name` | string | yes | The name of the label | | `color` | string | yes | The color of the label given in 6-digit hex notation with leading '#' sign (for example, #FFAABB) or one of the [CSS color names](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value#Color_keywords) | | `description` | string | no | The description of the label | @@ -196,7 +196,7 @@ DELETE /projects/:id/labels/:label_id | Attribute | Type | Required | Description | | --------- | ------- | -------- | --------------------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `label_id` | integer or string | yes | The ID or title of a group's label. | ```shell @@ -217,7 +217,7 @@ PUT /projects/:id/labels/:label_id | Attribute | Type | Required | Description | | --------------- | ------- | --------------------------------- | ------------------------------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `label_id` | integer or string | yes | The ID or title of a group's label. | | `new_name` | string | yes if `color` is not provided | The new name of the label | | `color` | string | yes if `new_name` is not provided | The color of the label given in 6-digit hex notation with leading '#' sign (for example, #FFAABB) or one of the [CSS color names](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value#Color_keywords) | @@ -261,7 +261,7 @@ PUT /projects/:id/labels/:label_id/promote | Attribute | Type | Required | Description | | --------------- | ------- | --------------------------------- | ------------------------------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `label_id` | integer or string | yes | The ID or title of a group's label. | ```shell @@ -299,7 +299,7 @@ POST /projects/:id/labels/:label_id/subscribe | Attribute | Type | Required | Description | | ---------- | ----------------- | -------- | ------------------------------------ | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `label_id` | integer or string | yes | The ID or title of a project's label | ```shell @@ -337,7 +337,7 @@ POST /projects/:id/labels/:label_id/unsubscribe | Attribute | Type | Required | Description | | ---------- | ----------------- | -------- | ------------------------------------ | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `label_id` | integer or string | yes | The ID or title of a project's label | ```shell diff --git a/doc/api/linked_epics.md b/doc/api/linked_epics.md index 34cafc0f1d2..b2a6899034d 100644 --- a/doc/api/linked_epics.md +++ b/doc/api/linked_epics.md @@ -33,7 +33,7 @@ Supported attributes: | Attribute | Type | Required | Description | | ---------- | -------------- | ---------------------- | ------------------------------------------------------------------------- | -| `id` | integer/string | Yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `created_after` | string | no | Return related epic links created on or after the given time. Format: ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`) | | `created_before` | string | no | Return related epic links created on or before the given time. Format: ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`) | | `updated_after` | string | no | Return related epic links updated on or after the given time. Format: ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`) | @@ -155,7 +155,7 @@ Supported attributes: | Attribute | Type | Required | Description | | ---------- | -------------- | ---------------------- | ------------------------------------------------------------------------- | | `epic_iid` | integer | Yes | Internal ID of a group's epic | -| `id` | integer/string | Yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | Example request: @@ -233,9 +233,9 @@ Supported attributes: | Attribute | Type | Required | Description | |---------------------|----------------|-----------------------------|---------------------------------------| | `epic_iid` | integer | Yes | Internal ID of a group's epic. | -| `id` | integer/string | Yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `target_epic_iid` | integer/string | Yes | Internal ID of a target group's epic. | -| `target_group_id` | integer/string | Yes | ID or [URL-encoded path of the target group](rest/index.md#namespaced-path-encoding). | +| `target_group_id` | integer/string | Yes | ID or [URL-encoded path of the target group](rest/index.md#namespaced-paths). | | `link_type` | string | No | Type of the relation (`relates_to`, `blocks`, `is_blocked_by`), defaults to `relates_to`. | Example request: @@ -354,7 +354,7 @@ Supported attributes: | Attribute | Type | Required | Description | |--------------------------|----------------|-----------------------------|---------------------------------------| | `epic_iid` | integer | Yes | Internal ID of a group's epic. | -| `id` | integer/string | Yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `related_epic_link_id` | integer/string | Yes | Internal ID of a related epic link. | Example request: diff --git a/doc/api/member_roles.md b/doc/api/member_roles.md index 4bdb3a041a2..bb5ee96dcdb 100644 --- a/doc/api/member_roles.md +++ b/doc/api/member_roles.md @@ -206,7 +206,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:----------|:--------|:---------|:-------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) of the group | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) of the group | Example request: @@ -289,7 +289,7 @@ Parameters: | Attribute | Type | Required | Description | |:----------|:--------|:---------|:-------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) of the group. | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) of the group. | | `admin_cicd_variables` | boolean | no | Permission to create, read, update, and delete CI/CD variables. | | `admin_compliance_framework` | boolean | no | Permission to administer compliance frameworks. | | `admin_group_member` | boolean | no | Permission to add, remove and assign members in a group. | @@ -365,7 +365,7 @@ DELETE /groups/:id/member_roles/:member_role_id | Attribute | Type | Required | Description | |:----------|:--------|:---------|:-------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) of the group. | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) of the group. | | `member_role_id` | integer | yes | The ID of the member role. | If successful, returns [`204`](rest/index.md#status-codes) and an empty response. diff --git a/doc/api/members.md b/doc/api/members.md index 700672c5d44..673449405b9 100644 --- a/doc/api/members.md +++ b/doc/api/members.md @@ -44,7 +44,7 @@ GET /projects/:id/members | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](rest/index.md#namespaced-paths) | | `query` | string | no | A query string to search for members | | `user_ids` | array of integers | no | Filter the results on the given user IDs | | `skip_users` | array of integers | no | Filter skipped users out of the results | @@ -139,7 +139,7 @@ GET /projects/:id/members/all | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](rest/index.md#namespaced-paths). | | `query` | string | no | A query string to search for members. | | `user_ids` | array of integers | no | Filter the results on the given user IDs. | | `show_seat_info` | boolean | no | Show seat information for users. | @@ -233,7 +233,7 @@ GET /projects/:id/members/:user_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](rest/index.md#namespaced-paths) | | `user_id` | integer | yes | The user ID of the member | ```shell @@ -288,7 +288,7 @@ GET /projects/:id/members/all/:user_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](rest/index.md#namespaced-paths) | | `user_id` | integer | yes | The user ID of the member | ```shell @@ -342,7 +342,7 @@ GET /groups/:id/billable_members | Attribute | Type | Required | Description | | ----------------------------- | --------------- | --------- |-------------------------------------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `search` | string | no | A query string to search for group members by name, username, or public email. | | `sort` | string | no | A query string containing parameters that specify the sort attribute and order. See supported values below. | @@ -433,7 +433,7 @@ GET /groups/:id/billable_members/:user_id/memberships | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `user_id` | integer | yes | The user ID of the billable member | ```shell @@ -497,7 +497,7 @@ GET /groups/:id/billable_members/:user_id/indirect | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `user_id` | integer | yes | The user ID of the billable member | ```shell @@ -537,7 +537,7 @@ DELETE /groups/:id/billable_members/:user_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `user_id` | integer | yes | The user ID of the member | ```shell @@ -558,7 +558,7 @@ PUT /groups/:id/members/:user_id/state | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `user_id` | integer | yes | The user ID of the member. | | `state` | string | yes | The new state for the user. State is either `awaiting` or `active`. | @@ -585,7 +585,7 @@ POST /projects/:id/members | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](rest/index.md#namespaced-paths). | | `user_id` | integer/string | yes, if `username` is not provided | The user ID of the new member or multiple IDs separated by commas. | | `username` | string | yes, if `user_id` is not provided | The username of the new member or multiple usernames separated by commas. | | `access_level` | integer | yes | [A valid access level](access_requests.md#valid-access-levels). | @@ -637,7 +637,7 @@ PUT /projects/:id/members/:user_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](rest/index.md#namespaced-paths) | | `user_id` | integer | yes | The user ID of the member | | `access_level` | integer | yes | A [valid access level](access_requests.md#valid-access-levels) | | `expires_at` | string | no | A date string in the format `YEAR-MONTH-DAY` | @@ -685,7 +685,7 @@ POST /groups/:id/members/:user_id/override | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `user_id` | integer | yes | The user ID of the member | ```shell @@ -729,7 +729,7 @@ DELETE /groups/:id/members/:user_id/override | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `user_id` | integer | yes | The user ID of the member | ```shell @@ -778,7 +778,7 @@ DELETE /projects/:id/members/:user_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](rest/index.md#namespaced-paths) | | `user_id` | integer | yes | The user ID of the member | | `skip_subresources` | boolean | false | Whether the deletion of direct memberships of the removed member in subgroups and projects should be skipped. Default is `false`. | | `unassign_issuables` | boolean | false | Whether the removed member should be unassigned from any issues or merge requests inside a given group or project. Default is `false`. | @@ -800,7 +800,7 @@ PUT /groups/:id/members/:member_id/approve | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the root group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the root group](rest/index.md#namespaced-paths) | | `member_id` | integer | yes | The ID of the member | Example request: @@ -819,7 +819,7 @@ POST /groups/:id/members/approve_all | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the root group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the root group](rest/index.md#namespaced-paths) | Example request: @@ -847,7 +847,7 @@ GET /groups/:id/pending_members | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | ```shell curl --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/groups/:id/pending_members" diff --git a/doc/api/merge_request_approvals.md b/doc/api/merge_request_approvals.md index a7900469346..34cc7aaef7e 100644 --- a/doc/api/merge_request_approvals.md +++ b/doc/api/merge_request_approvals.md @@ -47,7 +47,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-----------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-paths). | Example request: @@ -116,7 +116,7 @@ Supported attributes: | Attribute | Type | Required | Description | |----------------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of a group](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of a group](rest/index.md#namespaced-paths). | | `approvals_required` | integer | Yes | The number of required approvals for this rule. | | `name` | string | Yes | The name of the approval rule. | | `group_ids` | array | No | The IDs of groups as approvers. | @@ -191,7 +191,7 @@ Supported attributes: | Attribute | Type | Required | Description | |----------------------|-------------------|----------|-------------| | `approval_rule_id`. | integer | Yes | The ID of the approval rule. | -| `id` | integer or string | Yes | The ID or [URL-encoded path of a group](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of a group](rest/index.md#namespaced-paths). | | `approvals_required` | string | No | The number of required approvals for this rule. | | `group_ids` | integer | No | The IDs of users as approvers. | | `name` | string | No | The name of the approval rule. | @@ -266,7 +266,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-----------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-paths). | ```json { @@ -295,7 +295,7 @@ Supported attributes: | Attribute | Type | Required | Description | |--------------------------------------------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-paths). | | `approvals_before_merge` (deprecated) | integer | No | Number of required approvals before a merge request can merge. [Deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/11132) in GitLab 12.3. Use [Approval Rules](#create-project-level-rule) instead. | | `disable_overriding_approvers_per_merge_request` | boolean | No | Allow or prevent overriding approvers per merge request. | | `merge_requests_author_approval` | boolean | No | Allow or prevent authors from self approving merge requests; `true` means authors can self approve. | @@ -337,7 +337,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-----------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-paths). | ```json [ @@ -519,7 +519,7 @@ Supported attributes: | Attribute | Type | Required | Description | |--------------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-paths). | | `approval_rule_id` | integer | Yes | The ID of a approval rule. | ```json @@ -621,7 +621,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------------------------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-paths). | | `approvals_required` | integer | Yes | The number of required approvals for this rule. | | `name` | string | Yes | The name of the approval rule. | | `applies_to_all_protected_branches` | boolean | No | Whether to apply the rule to all protected branches. If set to `true`, ignores the value of `protected_branch_ids`. Default is `false`. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/335316) in GitLab 15.3. | @@ -756,7 +756,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------------------------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-paths). | | `approvals_required` | integer | Yes | The number of required approvals for this rule. | | `approval_rule_id` | integer | Yes | The ID of a approval rule. | | `name` | string | Yes | The name of the approval rule. | @@ -861,7 +861,7 @@ Supported attributes: | Attribute | Type | Required | Description | |--------------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-paths). | | `approval_rule_id` | integer | Yes | The ID of a approval rule. | ## Merge request-level MR approvals @@ -879,7 +879,7 @@ Supported attributes: | Attribute | Type | Required | Description | |---------------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The IID of the merge request. | ```json @@ -928,7 +928,7 @@ Supported attributes: | Attribute | Type | Required | Description | |---------------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The IID of the merge request. | ```json @@ -997,7 +997,7 @@ Supported attributes: | Attribute | Type | Required | Description | |---------------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The IID of the merge request. | ```json @@ -1129,7 +1129,7 @@ Supported attributes: | Attribute | Type | Required | Description | |---------------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-paths). | | `approval_rule_id` | integer | Yes | The ID of an approval rule. | | `merge_request_iid` | integer | Yes | The IID of a merge request. | @@ -1204,7 +1204,7 @@ Supported attributes: | Attribute | Type | Required | Description | |----------------------------|-------------------|------------------------|------------------------------------------------------------------------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-paths) | | `approvals_required` | integer | Yes | The number of required approvals for this rule. | | `merge_request_iid` | integer | Yes | The IID of the merge request. | | `name` | string | Yes | The name of the approval rule. | @@ -1291,7 +1291,7 @@ Supported attributes: | Attribute | Type | Required | Description | |------------------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-paths). | | `approval_rule_id` | integer | Yes | The ID of an approval rule. | | `merge_request_iid` | integer | Yes | The IID of a merge request. | | `approvals_required` | integer | No | The number of required approvals for this rule. | @@ -1373,7 +1373,7 @@ Supported attributes: | Attribute | Type | Required | Description | |---------------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-paths). | | `approval_rule_id` | integer | Yes | The ID of an approval rule. | | `merge_request_iid` | integer | Yes | The IID of the merge request. | @@ -1389,7 +1389,7 @@ Supported attributes: | Attribute | Type | Required | Description | |---------------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-paths). | | `approval_password` | string | No | Current user's password. Required if [**Require user re-authentication to approve**](../user/project/merge_requests/approvals/settings.md#require-user-re-authentication-to-approve) is enabled in the project settings. Always fails if the group or self-managed instance is configured to force SAML authentication. | | `merge_request_iid` | integer | Yes | The IID of the merge request. | | `sha` | string | No | The `HEAD` of the merge request. | @@ -1450,7 +1450,7 @@ Supported attributes: | Attribute | Type | Required | Description | |---------------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of a project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The IID of a merge request. | ## Reset approvals of a merge request @@ -1466,7 +1466,7 @@ PUT /projects/:id/merge_requests/:merge_request_iid/reset_approvals | Attribute | Type | Required | Description | |---------------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The internal ID of the merge request. | ```shell diff --git a/doc/api/merge_request_context_commits.md b/doc/api/merge_request_context_commits.md index 81aacf679da..d4b38fda178 100644 --- a/doc/api/merge_request_context_commits.md +++ b/doc/api/merge_request_context_commits.md @@ -23,7 +23,7 @@ Parameters: | Attribute | Type | Required | Description | |---------------------|---------|----------|-------------| -| `id` | integer | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The internal ID of the merge request. | ```json @@ -57,7 +57,7 @@ Parameters: | Attribute | Type | Required | Description | |---------------------|---------|----------|-------------| -| `id` | integer | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `merge_request_iid` | integer | Yes | The internal ID of the merge request. | | `commits` | string array | Yes | The context commits' SHAs. | @@ -108,5 +108,5 @@ Parameters: | Attribute | Type | Required | Description | |---------------------|--------------|----------|--------------| | `commits` | string array | Yes | The context commits' SHA. | -| `id` | integer | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The internal ID of the merge request. | diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md index fa60ee7e506..f7623270d1c 100644 --- a/doc/api/merge_requests.md +++ b/doc/api/merge_requests.md @@ -241,7 +241,7 @@ Supported attributes: | Attribute | Type | Required | Description | | ------------------------------- | -------------- | -------- | ----------- | -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `approved_by_ids` | integer array | No | Returns merge requests approved by all the users with the given `id`, up to 5 users. `None` returns merge requests with no approvals. `Any` returns merge requests with an approval. Premium and Ultimate only. | | `approver_ids` | integer array | No | Returns merge requests which have specified all the users with the given `id` as individual approvers. `None` returns merge requests without approvers. `Any` returns merge requests with an approver. Premium and Ultimate only. | | `approved` | string | No | Filters merge requests by their `approved` status. `yes` returns only approved merge requests. `no` returns only non-approved merge requests. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/3159) in GitLab 15.11. Available only when the feature flag `mr_approved_filter` is enabled. | @@ -490,7 +490,7 @@ Supported attributes: | Attribute | Type | Required | Description | | ------------------------------- | -------------- | -------- | ----------- | -| `id` | integer or string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `approved_by_ids` | integer array | No | Returns the merge requests approved by all the users with the given `id`, up to 5 users. `None` returns merge requests with no approvals. `Any` returns merge requests with an approval. Premium and Ultimate only. | | `approved_by_usernames` | string array | No | Returns the merge requests approved by all the users with the given `username`, up to 5 users. `None` returns merge requests with no approvals. `Any` returns merge requests with an approval. Premium and Ultimate only. | | `approver_ids` | integer array | No | Returns merge requests which have specified all the users with the given `id` as individual approvers. `None` returns merge requests without approvers. `Any` returns merge requests with an approver. Premium and Ultimate only. | @@ -666,7 +666,7 @@ Supported attributes: | Attribute | Type | Required | Description | |----------------------------------|----------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The internal ID of the merge request. | | `include_diverged_commits_count` | boolean | No | If `true`, response includes the commits behind the target branch. | | `include_rebase_in_progress` | boolean | No | If `true`, response includes whether a rebase operation is in progress. | @@ -945,7 +945,7 @@ Supported attributes: | Attribute | Type | Required | Description | |---------------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The internal ID of the merge request. | Example response: @@ -983,7 +983,7 @@ Supported attributes: | Attribute | Type | Required | Description | |---------------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The internal ID of the merge request. | Example response: @@ -1029,7 +1029,7 @@ Supported attributes: | Attribute | Type | Required | Description | |---------------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | Internal ID of the merge request. | If successful, returns [`200 OK`](rest/index.md#status-codes) and the following @@ -1112,7 +1112,7 @@ Supported attributes: | Attribute | Type | Required | Description | |---------------------|----------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | Example request: @@ -1368,7 +1368,7 @@ Supported attributes: | Attribute | Type | Required | Description | |---------------------|----------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) owned by the authenticated user. | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) owned by the authenticated user. | | `merge_request_iid` | integer | Yes | The internal ID of the merge request. | | `block_id` | integer | Yes | The internal ID of the block. | @@ -1402,7 +1402,7 @@ Supported attributes: | Attribute | Type | Required | Description | |---------------------|----------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The internal ID of the merge request. | | `access_raw_diffs` | boolean | No | Retrieve change diffs through Gitaly. | | `unidiff` | boolean | No | Present change diffs in the [unified diff](https://www.gnu.org/software/diffutils/manual/html_node/Detailed-Unified.html) format. Default is false. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/130610) in GitLab 16.5. | @@ -1540,7 +1540,7 @@ Supported attributes: | Attribute | Type | Required | Description | |---------------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The internal ID of the merge request. | | `page` | integer | No | The page of results to return. Defaults to 1. | | `per_page` | integer | No | The number of results per page. Defaults to 20. | @@ -1613,7 +1613,7 @@ Supported attributes: | Attribute | Type | Required | Description | |---------------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The internal ID of the merge request. | To restrict the list of merge request pipelines, use the pagination parameters `page` and @@ -1652,7 +1652,7 @@ Supported attributes: | Attribute | Type | Required | Description | |---------------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The internal ID of the merge request. | Example response: @@ -1706,7 +1706,7 @@ POST /projects/:id/merge_requests | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `source_branch` | string | Yes | The source branch. | | `target_branch` | string | Yes | The target branch. | | `title` | string | Yes | Title of MR. | @@ -1862,7 +1862,7 @@ PUT /projects/:id/merge_requests/:merge_request_iid | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The ID of a merge request. | | `add_labels` | string | No | Comma-separated label names to add to a merge request. If a label does not already exist, this creates a new project label and assigns it to the merge request. | | `allow_collaboration` | boolean | No | Allow commits from members who can merge to the target branch. | @@ -2036,7 +2036,7 @@ DELETE /projects/:id/merge_requests/:merge_request_iid | Attribute | Type | Required | Description | |---------------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The internal ID of the merge request. | ```shell @@ -2057,7 +2057,7 @@ Supported attributes: | Attribute | Type | Required | Description | |--------------------------------|----------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The internal ID of the merge request. | | `merge_commit_message` | string | No | Custom merge commit message. | | `merge_when_pipeline_succeeds` | boolean | No | If `true`, the merge request merges when the pipeline succeeds. | @@ -2237,7 +2237,7 @@ Supported attributes: | Attribute | Type | Required | Description | |---------------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The internal ID of the merge request. | This API returns specific HTTP status codes: @@ -2267,7 +2267,7 @@ Supported attributes: | Attribute | Type | Required | Description | |---------------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The internal ID of the merge request. | This API returns specific HTTP status codes: @@ -2431,7 +2431,7 @@ PUT /projects/:id/merge_requests/:merge_request_iid/rebase | Attribute | Type | Required | Description | |---------------------|----------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The internal ID of the merge request. | | `skip_ci` | boolean | No | Set to `true` to skip creating a CI pipeline. | @@ -2507,7 +2507,7 @@ Supported attributes: | Attribute | Type | Required | Description | |---------------------|----------------|----------|-------------| -| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | Internal ID of the merge request. | If successful, returns [`200 OK`](rest/index.md#status-codes) and the following @@ -2665,7 +2665,7 @@ GET /projects/:id/merge_requests/:merge_request_iid/related_issues | Attribute | Type | Required | Description | |---------------------|----------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The internal ID of the merge request. | ```shell @@ -2741,7 +2741,7 @@ POST /projects/:id/merge_requests/:merge_request_iid/subscribe | Attribute | Type | Required | Description | |---------------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The internal ID of the merge request. | If the user is already subscribed to the merge request, the endpoint returns the @@ -2906,7 +2906,7 @@ POST /projects/:id/merge_requests/:merge_request_iid/unsubscribe | Attribute | Type | Required | Description | |---------------------|----------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The internal ID of the merge request. | ```shell @@ -3072,7 +3072,7 @@ POST /projects/:id/merge_requests/:merge_request_iid/todo | Attribute | Type | Required | Description | |---------------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The internal ID of the merge request. | ```shell @@ -3397,7 +3397,7 @@ POST /projects/:id/merge_requests/:merge_request_iid/time_estimate | Attribute | Type | Required | Description | |---------------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The internal ID of the merge request. | | `duration` | string | Yes | The duration in human format, such as `3h30m`. | @@ -3428,7 +3428,7 @@ POST /projects/:id/merge_requests/:merge_request_iid/reset_time_estimate | Attribute | Type | Required | Description | |---------------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The internal ID of a project's merge request. | ```shell @@ -3458,7 +3458,7 @@ POST /projects/:id/merge_requests/:merge_request_iid/add_spent_time | Attribute | Type | Required | Description | |---------------------|----------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The internal ID of the merge request. | | `duration` | string | Yes | The duration in human format, such as `3h30m` | | `summary` | string | No | A summary of how the time was spent. | @@ -3490,7 +3490,7 @@ POST /projects/:id/merge_requests/:merge_request_iid/reset_spent_time | Attribute | Type | Required | Description | |---------------------|----------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The internal ID of a project's merge request. | ```shell @@ -3518,7 +3518,7 @@ GET /projects/:id/merge_requests/:merge_request_iid/time_stats | Attribute | Type | Required | Description | |---------------------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The internal ID of the merge request. | ```shell diff --git a/doc/api/merge_trains.md b/doc/api/merge_trains.md index 84278308469..3037c56bbad 100644 --- a/doc/api/merge_trains.md +++ b/doc/api/merge_trains.md @@ -34,7 +34,7 @@ GET /projects/:id/merge_trains?scope=complete | Attribute | Type | Required | Description | |-----------|----------------|----------|-------------| -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `scope` | string | No | Return Merge Trains filtered by the given scope. Available scopes are `active` (to be merged) and `complete` (have been merged). | | `sort` | string | No | Return Merge Trains sorted in `asc` or `desc` order. Default: `desc`. | @@ -98,7 +98,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-----------------|----------------|----------|-------------| -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `target_branch` | string | Yes | The target branch of the merge train. | | `scope` | string | No | Return Merge Trains filtered by the given scope. Available scopes are `active` (to be merged) and `complete` (have been merged). | | `sort` | string | No | Return Merge Trains sorted in `asc` or `desc` order. Default: `desc`. | @@ -168,7 +168,7 @@ Supported attributes: | Attribute | Type | Required | Description | |---------------------|----------------|----------|-------------| -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The internal ID of the merge request. | Example request: @@ -234,7 +234,7 @@ Supported attributes: | Attribute | Type | Required | Description | |--------------------------|----------------|----------|-------------| -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `merge_request_iid` | integer | Yes | The internal ID of the merge request. | | `sha` | string | No | If present, the SHA must match the `HEAD` of the source branch, otherwise the merge fails. | | `squash` | boolean | No | If true, the commits are squashed into a single commit on merge. | diff --git a/doc/api/milestones.md b/doc/api/milestones.md index d4fb68aa3ac..e449fc45536 100644 --- a/doc/api/milestones.md +++ b/doc/api/milestones.md @@ -33,7 +33,7 @@ Parameters: | Attribute | Type | Required | Description | | ---------------------------- | ------ | -------- | ----------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `iids[]` | integer array | no | Return only the milestones having the given `iid`. Ignored if `include_ancestors` is `true`. | | `state` | string | no | Return only `active` or `closed` milestones | | `title` | string | no | Return only the milestones having the given `title` | @@ -79,7 +79,7 @@ Parameters: | Attribute | Type | Required | Description | |----------------|----------------|----------|-----------------------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `milestone_id` | integer | yes | The ID of the project's milestone | ## Create new milestone @@ -94,7 +94,7 @@ Parameters: | Attribute | Type | Required | Description | |---------------|----------------|----------|-----------------------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `title` | string | yes | The title of a milestone | | `description` | string | no | The description of the milestone | | `due_date` | string | no | The due date of the milestone (`YYYY-MM-DD`) | @@ -112,7 +112,7 @@ Parameters: | Attribute | Type | Required | Description | |----------------|----------------|----------|-----------------------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `milestone_id` | integer | yes | The ID of the project's milestone | | `title` | string | no | The title of a milestone | | `description` | string | no | The description of the milestone | @@ -134,7 +134,7 @@ Parameters: | Attribute | Type | Required | Description | |----------------|----------------|----------|-----------------------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `milestone_id` | integer | yes | The ID of the project's milestone | ## Get all issues assigned to a single milestone @@ -149,7 +149,7 @@ Parameters: | Attribute | Type | Required | Description | |----------------|----------------|----------|-----------------------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `milestone_id` | integer | yes | The ID of the project's milestone | ## Get all merge requests assigned to a single milestone @@ -164,7 +164,7 @@ Parameters: | Attribute | Type | Required | Description | |----------------|----------------|----------|-----------------------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `milestone_id` | integer | yes | The ID of the project's milestone | ## Promote project milestone to a group milestone @@ -181,7 +181,7 @@ Parameters: | Attribute | Type | Required | Description | |----------------|----------------|----------|-----------------------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `milestone_id` | integer | yes | The ID of the project's milestone | ## Get all burndown chart events for a single milestone @@ -200,5 +200,5 @@ Parameters: | Attribute | Type | Required | Description | |----------------|----------------|----------|-----------------------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `milestone_id` | integer | yes | The ID of the project's milestone | diff --git a/doc/api/model_registry.md b/doc/api/model_registry.md index 096f83f5a0a..3e6facb977c 100644 --- a/doc/api/model_registry.md +++ b/doc/api/model_registry.md @@ -23,7 +23,7 @@ Parameters: | Attribute | Type | Required | Description | |--------------------|-------------------|----------|----------------------------------------------------------------------------------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `model_version_id` | integer | yes | The model version ID for the file | | `path` | string | yes | File directory path | | `filename` | string | yes | Filename | diff --git a/doc/api/namespaces.md b/doc/api/namespaces.md index 979b83b8514..c54b95d1349 100644 --- a/doc/api/namespaces.md +++ b/doc/api/namespaces.md @@ -154,7 +154,7 @@ GET /namespaces/:id | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | ID or [URL-encoded path of the namespace](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | ID or [URL-encoded path of the namespace](rest/index.md#namespaced-paths) | Example request: diff --git a/doc/api/notes.md b/doc/api/notes.md index b6d66f1a891..19039572f96 100644 --- a/doc/api/notes.md +++ b/doc/api/notes.md @@ -56,7 +56,7 @@ GET /projects/:id/issues/:issue_iid/notes?sort=asc&order_by=updated_at | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `issue_iid` | integer | yes | The IID of an issue | | `sort` | string | no | Return issue notes sorted in `asc` or `desc` order. Default is `desc` | | `order_by` | string | no | Return issue notes ordered by `created_at` or `updated_at` fields. Default is `created_at` | @@ -132,7 +132,7 @@ Parameters: | Attribute | Type | Required | Description | |-------------|----------------|----------|---------------------------------------------------------------------------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `issue_iid` | integer | yes | The IID of a project issue | | `note_id` | integer | yes | The ID of an issue note | @@ -152,7 +152,7 @@ Parameters: | Attribute | Type | Required | Description | |----------------|----------------|----------|------------------------------------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | yes | The IID of an issue. | | `body` | string | yes | The content of a note. Limited to 1,000,000 characters. | | `confidential` | boolean | no | **Deprecated:** Scheduled to be removed in GitLab 16.0 and renamed to `internal`. The confidential flag of a note. Default is false. | @@ -175,7 +175,7 @@ Parameters: | Attribute | Type | Required | Description | |----------------|----------------|-------------|----------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `issue_iid` | integer | yes | The IID of an issue. | | `note_id` | integer | yes | The ID of a note. | | `body` | string | no | The content of a note. Limited to 1,000,000 characters. | @@ -197,7 +197,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `issue_iid` | integer | yes | The IID of an issue | | `note_id` | integer | yes | The ID of a note | @@ -220,7 +220,7 @@ GET /projects/:id/snippets/:snippet_id/notes?sort=asc&order_by=updated_at | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `snippet_id` | integer | yes | The ID of a project snippet | | `sort` | string | no | Return snippet notes sorted in `asc` or `desc` order. Default is `desc` | | `order_by` | string | no | Return snippet notes ordered by `created_at` or `updated_at` fields. Default is `created_at` | @@ -241,7 +241,7 @@ Parameters: | Attribute | Type | Required | Description | |--------------|----------------|----------|---------------------------------------------------------------------------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `snippet_id` | integer | yes | The ID of a project snippet | | `note_id` | integer | yes | The ID of a snippet note | @@ -290,7 +290,7 @@ Parameters: | Attribute | Type | Required | Description | |--------------|----------------|----------|------------------------------------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `snippet_id` | integer | yes | The ID of a snippet | | `body` | string | yes | The content of a note. Limited to 1,000,000 characters. | | `created_at` | string | no | Date time string, ISO 8601 formatted. Example: `2016-03-11T03:45:40Z` (requires administrator or project/group owner rights) | @@ -311,7 +311,7 @@ Parameters: | Attribute | Type | Required | Description | |--------------|----------------|----------|------------------------------------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `snippet_id` | integer | yes | The ID of a snippet | | `note_id` | integer | yes | The ID of a snippet note | | `body` | string | yes | The content of a note. Limited to 1,000,000 characters. | @@ -332,7 +332,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `snippet_id` | integer | yes | The ID of a snippet | | `note_id` | integer | yes | The ID of a note | @@ -353,7 +353,7 @@ GET /projects/:id/merge_requests/:merge_request_iid/notes?sort=asc&order_by=upda | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `merge_request_iid` | integer | yes | The IID of a project merge request | | `sort` | string | no | Return merge request notes sorted in `asc` or `desc` order. Default is `desc` | | `order_by` | string | no | Return merge request notes ordered by `created_at` or `updated_at` fields. Default is `created_at` | @@ -374,7 +374,7 @@ Parameters: | Attribute | Type | Required | Description | |---------------------|----------------|----------|---------------------------------------------------------------------------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `merge_request_iid` | integer | yes | The IID of a project merge request | | `note_id` | integer | yes | The ID of a merge request note | @@ -426,7 +426,7 @@ Parameters: | Attribute | Type | Required | Description | |---------------------|----------------|----------|------------------------------------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `merge_request_iid` | integer | yes | The IID of a project merge request | | `body` | string | yes | The content of a note. Limited to 1,000,000 characters. | | `created_at` | string | no | Date time string, ISO 8601 formatted. Example: `2016-03-11T03:45:40Z` (requires administrator or project/group owner rights) | @@ -444,7 +444,7 @@ Parameters: | Attribute | Type | Required | Description | |---------------------|-------------------|----------|----------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `merge_request_iid` | integer | yes | The IID of a project merge request | | `note_id` | integer | no | The ID of a note | | `body` | string | yes | The content of a note. Limited to 1,000,000 characters. | @@ -466,7 +466,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `merge_request_iid` | integer | yes | The IID of a merge request | | `note_id` | integer | yes | The ID of a note | @@ -501,7 +501,7 @@ GET /groups/:id/epics/:epic_id/notes?sort=asc&order_by=updated_at | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | ----------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `epic_id` | integer | yes | The ID of a group epic | | `sort` | string | no | Return epic notes sorted in `asc` or `desc` order. Default is `desc` | | `order_by` | string | no | Return epic notes ordered by `created_at` or `updated_at` fields. Default is `created_at` | @@ -522,7 +522,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ----------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `epic_id` | integer | yes | The ID of an epic | | `note_id` | integer | yes | The ID of a note | @@ -573,7 +573,7 @@ Parameters: | --------- | -------------- | -------- | ----------- | | `body` | string | yes | The content of a note. Limited to 1,000,000 characters. | | `epic_id` | integer | yes | The ID of an epic | -| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `confidential` | boolean | no | **Deprecated:** Scheduled to be removed in GitLab 16.0 and is renamed to `internal`. The confidential flag of a note. Default is `false`. | | `internal` | boolean | no | The internal flag of a note. Overrides `confidential` when both parameters are submitted. Default is `false`. | @@ -593,7 +593,7 @@ Parameters: | Attribute | Type | Required | Description | | ---------------| ----------------- | -------- | ---------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `epic_id` | integer | yes | The ID of an epic | | `note_id` | integer | yes | The ID of a note | | `body` | string | yes | The content of a note. Limited to 1,000,000 characters. | @@ -615,7 +615,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ----------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `epic_id` | integer | yes | The ID of an epic | | `note_id` | integer | yes | The ID of a note | diff --git a/doc/api/notification_settings.md b/doc/api/notification_settings.md index 3c1468c180e..aacd835c525 100644 --- a/doc/api/notification_settings.md +++ b/doc/api/notification_settings.md @@ -125,7 +125,7 @@ curl --header "PRIVATE-TOKEN: " "https://gitlab.example.com/a | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer or string | yes | The ID, or [URL-encoded path, of the group or project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID, or [URL-encoded path, of the group or project](rest/index.md#namespaced-paths). | Example response: @@ -151,7 +151,7 @@ curl --request PUT --header "PRIVATE-TOKEN: " "https://gitlab | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer or string | yes | The ID, or [URL-encoded path, of the group or project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID, or [URL-encoded path, of the group or project](rest/index.md#namespaced-paths) | | `level` | string | no | The global notification level | | `new_note` | boolean | no | Enable/disable this notification | | `new_issue` | boolean | no | Enable/disable this notification | diff --git a/doc/api/packages.md b/doc/api/packages.md index 65d3b86b478..944f1991d32 100644 --- a/doc/api/packages.md +++ b/doc/api/packages.md @@ -29,7 +29,7 @@ GET /projects/:id/packages | Attribute | Type | Required | Description | |:----------------------|:---------------|:---------|:------------| -| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `order_by` | string | no | The field to use as order. One of `created_at` (default), `name`, `version`, or `type`. | | `sort` | string | no | The direction of the order, either `asc` (default) for ascending order or `desc` for descending order. | | `package_type` | string | no | Filter the returned packages by type. One of `conan`, `maven`, `npm`, `pypi`, `composer`, `nuget`, `helm`, `terraform_module`, or `golang`. | @@ -98,7 +98,7 @@ GET /groups/:id/packages | Attribute | Type | Required | Description | |:----------------------|:---------------|:---------|:------------| -| `id` | integer/string | yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `exclude_subgroups` | boolean | no | If the parameter is included as true, packages from projects from subgroups are not listed. Default is `false`. | | `order_by` | string | no | The field to use as order. One of `created_at` (default), `name`, `version`, `type`, or `project_path`. | | `sort` | string | no | The direction of the order, either `asc` (default) for ascending order or `desc` for descending order. | @@ -195,7 +195,7 @@ GET /projects/:id/packages/:package_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `package_id` | integer | yes | ID of a package. | ```shell @@ -275,7 +275,7 @@ GET /projects/:id/packages/:package_id/package_files | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `package_id` | integer | yes | ID of a package. | ```shell @@ -350,7 +350,7 @@ GET /projects/:id/packages/:package_id/pipelines | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `package_id` | integer | yes | ID of a package. | ```shell @@ -414,7 +414,7 @@ DELETE /projects/:id/packages/:package_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `package_id` | integer | yes | ID of a package. | ```shell @@ -443,7 +443,7 @@ DELETE /projects/:id/packages/:package_id/package_files/:package_file_id | Attribute | Type | Required | Description | | ----------------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `package_id` | integer | yes | ID of a package. | | `package_file_id` | integer | yes | ID of a package file. | diff --git a/doc/api/packages/debian_group_distributions.md b/doc/api/packages/debian_group_distributions.md index 68e4c9b8724..386c092cfa2 100644 --- a/doc/api/packages/debian_group_distributions.md +++ b/doc/api/packages/debian_group_distributions.md @@ -43,7 +43,7 @@ GET /groups/:id/-/debian_distributions | Attribute | Type | Required | Description | | ---------- | --------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](../rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](../rest/index.md#namespaced-paths). | | `codename` | string | no | Filter with specific `codename`. | | `suite` | string | no | Filter with specific `suite`. | @@ -85,7 +85,7 @@ GET /groups/:id/-/debian_distributions/:codename | Attribute | Type | Required | Description | | ---------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](../rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](../rest/index.md#namespaced-paths). | | `codename` | string | yes | The `codename` of a distribution. | ```shell @@ -124,7 +124,7 @@ GET /groups/:id/-/debian_distributions/:codename/key.asc | Attribute | Type | Required | Description | | ---------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](../rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](../rest/index.md#namespaced-paths). | | `codename` | string | yes | The `codename` of a distribution. | ```shell @@ -161,7 +161,7 @@ POST /groups/:id/-/debian_distributions | Attribute | Type | Required | Description | | ----------------------------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](../rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](../rest/index.md#namespaced-paths). | | `codename` | string | yes | The codename of a Debian distribution. | | `suite` | string | no | The suite of the new Debian distribution. | | `origin` | string | no | The origin of the new Debian distribution. | @@ -208,7 +208,7 @@ PUT /groups/:id/-/debian_distributions/:codename | Attribute | Type | Required | Description | | ----------------------------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](../rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](../rest/index.md#namespaced-paths). | | `codename` | string | yes | The Debian distribution's new codename. | | `suite` | string | no | The Debian distribution's new suite. | | `origin` | string | no | The Debian distribution's new origin. | @@ -255,7 +255,7 @@ DELETE /groups/:id/-/debian_distributions/:codename | Attribute | Type | Required | Description | | ---------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](../rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](../rest/index.md#namespaced-paths). | | `codename` | string | yes | The codename of the Debian distribution. | ```shell diff --git a/doc/api/packages/debian_project_distributions.md b/doc/api/packages/debian_project_distributions.md index 7b92322069f..fef10c6730c 100644 --- a/doc/api/packages/debian_project_distributions.md +++ b/doc/api/packages/debian_project_distributions.md @@ -42,7 +42,7 @@ GET /projects/:id/debian_distributions | Attribute | Type | Required | Description | | ---------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-paths). | | `codename` | string | no | Filter with a specific `codename`. | | `suite` | string | no | Filter with a specific `suite`. | @@ -84,7 +84,7 @@ GET /projects/:id/debian_distributions/:codename | Attribute | Type | Required | Description | | ---------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-paths). | | `codename` | string | yes | The `codename` of a distribution. | ```shell @@ -123,7 +123,7 @@ GET /projects/:id/debian_distributions/:codename/key.asc | Attribute | Type | Required | Description | | ---------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-paths). | | `codename` | string | yes | The `codename` of a distribution. | ```shell @@ -160,7 +160,7 @@ POST /projects/:id/debian_distributions | Attribute | Type | Required | Description | | ----------------------------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-paths). | | `codename` | string | yes | The Debian distribution's codename. | | `suite` | string | no | The new Debian distribution's suite. | | `origin` | string | no | The new Debian distribution's origin. | @@ -207,7 +207,7 @@ PUT /projects/:id/debian_distributions/:codename | Attribute | Type | Required | Description | | ----------------------------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-paths). | | `codename` | string | yes | The Debian distribution's codename. | | `suite` | string | no | The Debian distribution's new suite. | | `origin` | string | no | The Debian distribution's new origin. | @@ -254,7 +254,7 @@ DELETE /projects/:id/debian_distributions/:codename | Attribute | Type | Required | Description | | ---------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-paths). | | `codename` | string | yes | The Debian distribution's codename. | ```shell diff --git a/doc/api/pages.md b/doc/api/pages.md index 66f24158db5..39802a577e0 100644 --- a/doc/api/pages.md +++ b/doc/api/pages.md @@ -28,7 +28,7 @@ DELETE /projects/:id/pages | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ---------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | ```shell curl --request 'DELETE' --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/projects/2/pages" @@ -52,7 +52,7 @@ Supported attributes: | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ---------------------------------------- | -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | If successful, returns [`200`](rest/index.md#status-codes) and the following response attributes: @@ -119,7 +119,7 @@ Supported attributes: | Attribute | Type | Required | Description | | --------------------------------| -------------- | -------- | --------------------------------------------------------------------------------------------------------------------| -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `pages_unique_domain_enabled` | boolean | No | Whether to use unique domain | | `pages_https_only` | boolean | No | Whether to force HTTPs | diff --git a/doc/api/pages_domains.md b/doc/api/pages_domains.md index 0b48175bdc3..9c9c632e093 100644 --- a/doc/api/pages_domains.md +++ b/doc/api/pages_domains.md @@ -55,7 +55,7 @@ GET /projects/:id/pages/domains | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ---------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | ```shell curl --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/projects/5/pages/domains" @@ -91,7 +91,7 @@ GET /projects/:id/pages/domains/:domain | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ---------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `domain` | string | yes | The custom domain indicated by the user | ```shell @@ -133,7 +133,7 @@ POST /projects/:id/pages/domains | Attribute | Type | Required | Description | | -------------------| -------------- | -------- | ---------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `domain` | string | yes | The custom domain indicated by the user | | `auto_ssl_enabled` | boolean | no | Enables [automatic generation](../user/project/pages/custom_domains_ssl_tls_certification/lets_encrypt_integration.md) of SSL certificates issued by Let's Encrypt for custom domains. | | `certificate` | file/string | no | The certificate in PEM format with intermediates following in most specific to least specific order.| @@ -186,7 +186,7 @@ PUT /projects/:id/pages/domains/:domain | Attribute | Type | Required | Description | | ------------------ | -------------- | -------- | ---------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `domain` | string | yes | The custom domain indicated by the user | | `auto_ssl_enabled` | boolean | no | Enables [automatic generation](../user/project/pages/custom_domains_ssl_tls_certification/lets_encrypt_integration.md) of SSL certificates issued by Let's Encrypt for custom domains. | | `certificate` | file/string | no | The certificate in PEM format with intermediates following in most specific to least specific order.| @@ -264,7 +264,7 @@ DELETE /projects/:id/pages/domains/:domain | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ---------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `domain` | string | yes | The custom domain indicated by the user | ```shell diff --git a/doc/api/pipeline_schedules.md b/doc/api/pipeline_schedules.md index cd2fb5ddbf3..985546b267b 100644 --- a/doc/api/pipeline_schedules.md +++ b/doc/api/pipeline_schedules.md @@ -22,7 +22,7 @@ GET /projects/:id/pipeline_schedules | Attribute | Type | Required | Description | |-----------|----------------|----------|-------------| -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `scope` | string | No | The scope of pipeline schedules, must be one of: `active`, `inactive` | ```shell @@ -63,7 +63,7 @@ GET /projects/:id/pipeline_schedules/:pipeline_schedule_id | Attribute | Type | Required | Description | |------------------------|----------------|----------|-------------| -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `pipeline_schedule_id` | integer | Yes | The pipeline schedule ID | ```shell @@ -120,7 +120,7 @@ Supported attributes: | Attribute | Type | Required | Description | |------------------------|----------------|----------|-------------| -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `pipeline_schedule_id` | integer | Yes | The pipeline schedule ID. | Example request: @@ -172,7 +172,7 @@ POST /projects/:id/pipeline_schedules |-----------------|----------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `cron` | string | Yes | The [cron](https://en.wikipedia.org/wiki/Cron) schedule, for example: `0 1 * * *`. | | `description` | string | Yes | The description of the pipeline schedule. | -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `ref` | string | Yes | The branch or tag name that is triggered. Both the short (e.g. `main`) and full (e.g. `refs/heads/main` or `refs/tags/main`) ref versions are accepted. If a short version is provided, it is automatically expanded to the full ref version but, if the ref is [ambiguous](../ci/pipelines/schedules.md#ambiguous-refs), it will be rejected | | `active` | boolean | No | The activation of pipeline schedule. If false is set, the pipeline schedule is initially deactivated (default: `true`). | | `cron_timezone` | string | No | The time zone supported by `ActiveSupport::TimeZone`, for example: `Pacific Time (US & Canada)` (default: `UTC`). | @@ -216,7 +216,7 @@ PUT /projects/:id/pipeline_schedules/:pipeline_schedule_id | Attribute | Type | Required | Description | |------------------------|----------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `pipeline_schedule_id` | integer | Yes | The pipeline schedule ID. | | `active` | boolean | No | The activation of pipeline schedule. If false is set, the pipeline schedule is initially deactivated. | | `cron_timezone` | string | No | The time zone supported by `ActiveSupport::TimeZone` (for example `Pacific Time (US & Canada)`), or `TZInfo::Timezone` (for example `America/Los_Angeles`). | @@ -267,7 +267,7 @@ POST /projects/:id/pipeline_schedules/:pipeline_schedule_id/take_ownership | Attribute | Type | Required | Description | |------------------------|----------------|----------|-------------| -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `pipeline_schedule_id` | integer | Yes | The pipeline schedule ID | ```shell @@ -312,7 +312,7 @@ DELETE /projects/:id/pipeline_schedules/:pipeline_schedule_id | Attribute | Type | Required | Description | |------------------------|----------------|----------|-------------| -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `pipeline_schedule_id` | integer | Yes | The pipeline schedule ID | ```shell @@ -358,7 +358,7 @@ POST /projects/:id/pipeline_schedules/:pipeline_schedule_id/play | Attribute | Type | Required | Description | |------------------------|----------------|----------|-------------| -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `pipeline_schedule_id` | integer | Yes | The pipeline schedule ID | Example request: @@ -387,7 +387,7 @@ POST /projects/:id/pipeline_schedules/:pipeline_schedule_id/variables | Attribute | Type | Required | Description | |------------------------|----------------|----------|-------------| -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `key` | string | Yes | The `key` of a variable; must have no more than 255 characters; only `A-Z`, `a-z`, `0-9`, and `_` are allowed | | `pipeline_schedule_id` | integer | Yes | The pipeline schedule ID | | `value` | string | Yes | The `value` of a variable | @@ -416,7 +416,7 @@ PUT /projects/:id/pipeline_schedules/:pipeline_schedule_id/variables/:key | Attribute | Type | Required | Description | |------------------------|----------------|----------|-------------| -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `key` | string | Yes | The `key` of a variable | | `pipeline_schedule_id` | integer | Yes | The pipeline schedule ID | | `value` | string | Yes | The `value` of a variable | @@ -446,7 +446,7 @@ DELETE /projects/:id/pipeline_schedules/:pipeline_schedule_id/variables/:key | Attribute | Type | Required | Description | |------------------------|----------------|----------|-------------| -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `key` | string | Yes | The `key` of a variable | | `pipeline_schedule_id` | integer | Yes | The pipeline schedule ID | diff --git a/doc/api/pipeline_triggers.md b/doc/api/pipeline_triggers.md index edd1d223498..ce25fcf2f77 100644 --- a/doc/api/pipeline_triggers.md +++ b/doc/api/pipeline_triggers.md @@ -22,7 +22,7 @@ GET /projects/:id/triggers | Attribute | Type | Required | Description | |-----------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | ```shell curl --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/projects/1/triggers" @@ -55,7 +55,7 @@ GET /projects/:id/triggers/:trigger_id | Attribute | Type | Required | Description | |--------------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `trigger_id` | integer | Yes | The trigger ID | ```shell @@ -85,7 +85,7 @@ POST /projects/:id/triggers | Attribute | Type | Required | Description | |---------------|----------------|----------|-------------| | `description` | string | Yes | The trigger name | -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | ```shell curl --request POST --header "PRIVATE-TOKEN: " \ @@ -114,7 +114,7 @@ PUT /projects/:id/triggers/:trigger_id | Attribute | Type | Required | Description | |---------------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `trigger_id` | integer | Yes | The trigger ID | | `description` | string | No | The trigger name | @@ -145,7 +145,7 @@ DELETE /projects/:id/triggers/:trigger_id | Attribute | Type | Required | Description | |--------------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `trigger_id` | integer | Yes | The trigger ID | ```shell @@ -171,7 +171,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `ref` | string | Yes | The branch or tag to run the pipeline on. | | `token` | string | Yes | The trigger token or CI/CD job token. | | `variables` | hash | No | A map of key-valued strings containing the pipeline variables. For example: `{ VAR1: "value1", VAR2: "value2" }`. | diff --git a/doc/api/pipelines.md b/doc/api/pipelines.md index 49633c4b625..cda35b8abb1 100644 --- a/doc/api/pipelines.md +++ b/doc/api/pipelines.md @@ -37,7 +37,7 @@ GET /projects/:id/pipelines | Attribute | Type | Required | Description | |------------------|----------------|----------|-------------| -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `name` | string | No | Return pipelines with the specified name. | | `order_by` | string | No | Order pipelines by `id`, `status`, `ref`, `updated_at` or `user_id` (default: `id`) | | `ref` | string | No | The ref of pipelines | @@ -104,7 +104,7 @@ GET /projects/:id/pipelines/:pipeline_id | Attribute | Type | Required | Description | |---------------|----------------|----------|-------------| -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `pipeline_id` | integer | Yes | The ID of a pipeline | ```shell @@ -233,7 +233,7 @@ GET /projects/:id/pipelines/:pipeline_id/variables | Attribute | Type | Required | Description | |---------------|----------------|----------|-------------| -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `pipeline_id` | integer | Yes | The ID of a pipeline | ```shell @@ -267,7 +267,7 @@ GET /projects/:id/pipelines/:pipeline_id/test_report | Attribute | Type | Required | Description | |---------------|----------------|----------|-------------| -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `pipeline_id` | integer | Yes | The ID of a pipeline | Sample request: @@ -321,7 +321,7 @@ GET /projects/:id/pipelines/:pipeline_id/test_report_summary | Attribute | Type | Required | Description | |---------------|----------------|----------|-------------| -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `pipeline_id` | integer | Yes | The ID of a pipeline | Sample request: @@ -371,7 +371,7 @@ POST /projects/:id/pipeline | Attribute | Type | Required | Description | |-------------|----------------|----------|-------------| -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `ref` | string | Yes | The branch or tag to run the pipeline on. For merge request pipelines use the [merge requests endpoint](merge_requests.md#create-merge-request-pipeline). | | `variables` | array | No | An [array of hashes](rest/index.md#array-of-hashes) containing the variables available in the pipeline, matching the structure `[{ 'key': 'UPLOAD_TO_S3', 'variable_type': 'file', 'value': 'true' }, {'key': 'TEST', 'value': 'test variable'}]`. If `variable_type` is excluded, it defaults to `env_var`. | @@ -424,7 +424,7 @@ POST /projects/:id/pipelines/:pipeline_id/retry | Attribute | Type | Required | Description | |---------------|----------------|----------|-------------| -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `pipeline_id` | integer | Yes | The ID of a pipeline | ```shell @@ -472,7 +472,7 @@ POST /projects/:id/pipelines/:pipeline_id/cancel | Attribute | Type | Required | Description | |---------------|----------------|----------|-------------| -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `pipeline_id` | integer | Yes | The ID of a pipeline | ```shell @@ -529,7 +529,7 @@ DELETE /projects/:id/pipelines/:pipeline_id | Attribute | Type | Required | Description | |---------------|----------------|----------|-------------| -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `pipeline_id` | integer | Yes | The ID of a pipeline | ```shell @@ -546,7 +546,7 @@ PUT /projects/:id/pipelines/:pipeline_id/metadata | Attribute | Type | Required | Description | |---------------|----------------|----------|-------------| -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `name` | string | Yes | The new name of the pipeline | | `pipeline_id` | integer | Yes | The ID of a pipeline | diff --git a/doc/api/project_access_tokens.md b/doc/api/project_access_tokens.md index 47873fd7945..5ba156570b8 100644 --- a/doc/api/project_access_tokens.md +++ b/doc/api/project_access_tokens.md @@ -27,7 +27,7 @@ GET projects/:id/access_tokens?state=inactive | Attribute | Type | required | Description | |-----------|---------|----------|---------------------| -| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `state` | string | No | Limit results to tokens with specified state. Valid values are `active` and `inactive`. By default both states are returned. | ```shell @@ -77,7 +77,7 @@ GET projects/:id/access_tokens/:token_id | Attribute | Type | required | Description | |-----------|---------|----------|---------------------| -| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `token_id` | integer | yes | ID of the project access token | ```shell @@ -119,7 +119,7 @@ POST projects/:id/access_tokens | Attribute | Type | required | Description | |-----------|---------|----------|---------------------------------------------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `name` | string | yes | Name of the project access token | | `scopes` | `Array[String]` | yes | [List of scopes](../user/project/settings/project_access_tokens.md#scopes-for-a-project-access-token) | | `access_level` | integer | no | Access level. Valid values are `10` (Guest), `20` (Reporter), `30` (Developer), `40` (Maintainer), and `50` (Owner). Defaults to `40`. | @@ -168,7 +168,7 @@ POST /projects/:id/access_tokens/:token_id/rotate | Attribute | Type | required | Description | |-----------|------------|----------|---------------------| -| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `token_id` | integer | yes | ID of the project access token | | `expires_at` | date | no | Expiration date of the access token in ISO format (`YYYY-MM-DD`). [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/416795) in GitLab 16.6. | @@ -218,7 +218,7 @@ DELETE projects/:id/access_tokens/:token_id | Attribute | Type | required | Description | |-----------|---------|----------|---------------------| -| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `token_id` | integer | yes | ID of the project access token | ```shell diff --git a/doc/api/project_badges.md b/doc/api/project_badges.md index 5101b4b8d90..011ad60bb55 100644 --- a/doc/api/project_badges.md +++ b/doc/api/project_badges.md @@ -40,7 +40,7 @@ GET /projects/:id/badges | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `name` | string | no | Name of the badges to return (case-sensitive). | ```shell @@ -82,7 +82,7 @@ GET /projects/:id/badges/:badge_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `badge_id` | integer | yes | The badge ID | ```shell @@ -113,7 +113,7 @@ POST /projects/:id/badges | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `link_url` | string | yes | URL of the badge link | | `image_url` | string | yes | URL of the badge image | | `name` | string | no | Name of the badge | @@ -148,7 +148,7 @@ PUT /projects/:id/badges/:badge_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `badge_id` | integer | yes | The badge ID | | `link_url` | string | no | URL of the badge link | | `image_url` | string | no | URL of the badge image | @@ -182,7 +182,7 @@ DELETE /projects/:id/badges/:badge_id | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `badge_id` | integer | yes | The badge ID | ```shell @@ -199,7 +199,7 @@ GET /projects/:id/badges/render | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `link_url` | string | yes | URL of the badge link| | `image_url` | string | yes | URL of the badge image | diff --git a/doc/api/project_clusters.md b/doc/api/project_clusters.md index e6acab310fa..edf6b4afa44 100644 --- a/doc/api/project_clusters.md +++ b/doc/api/project_clusters.md @@ -27,7 +27,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ------- | -------- | ----------------------------------------------------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | Example request: @@ -97,7 +97,7 @@ Parameters: | Attribute | Type | Required | Description | | ------------ | ------- | -------- | ----------------------------------------------------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `cluster_id` | integer | yes | The ID of the cluster | Example request: @@ -191,7 +191,7 @@ Parameters: | Attribute | Type | Required | Description | | ---------------------------------------------------- | ------- | -------- | ----------------------------------------------------------------------------------------------------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `name` | string | yes | The name of the cluster | | `domain` | string | no | The [base domain](../user/project/clusters/gitlab_managed_clusters.md#base-domain) of the cluster | | `management_project_id` | integer | no | The ID of the [management project](../user/clusters/management_project.md) for the cluster | @@ -288,7 +288,7 @@ Parameters: | Attribute | Type | Required | Description | | ------------------------------------------- | ------- | -------- | ------------------------------------------------------------------------------------------ | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `cluster_id` | integer | yes | The ID of the cluster | | `name` | string | no | The name of the cluster | | `domain` | string | no | The [base domain](../user/project/clusters/gitlab_managed_clusters.md#base-domain) of the cluster | @@ -399,7 +399,7 @@ Parameters: | Attribute | Type | Required | Description | | ------------ | ------- | -------- | ----------------------------------------------------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `cluster_id` | integer | yes | The ID of the cluster | Example request: diff --git a/doc/api/project_container_registry_protection_rules.md b/doc/api/project_container_registry_protection_rules.md index c45a777be30..2e78443e226 100644 --- a/doc/api/project_container_registry_protection_rules.md +++ b/doc/api/project_container_registry_protection_rules.md @@ -33,7 +33,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------------------------|-----------------|----------|--------------------------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | If successful, returns [`200`](rest/index.md#status-codes) and a list of container registry protection rules. @@ -86,7 +86,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-----------------------------------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `repository_path_pattern` | string | Yes | Container repository path pattern protected by the protection rule. For example `flight/flight-*`. Wildcard character `*` allowed. | | `minimum_access_level_for_push` | string | No | Minimum GitLab access level to allow to push container images to the container registry. For example `maintainer`, `owner` or `admin`. Must be provided when `minimum_access_level_for_delete` is not set. | | `minimum_access_level_for_delete` | string | No | Minimum GitLab access level to allow to delete container images in the container registry. For example `maintainer`, `owner`, `admin`. Must be provided when `minimum_access_level_for_push` is not set. | @@ -130,7 +130,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-----------------------------------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `protection_rule_id` | integer | Yes | ID of the protection rule to be updated. | | `repository_path_pattern` | string | No | Container repository path pattern protected by the protection rule. For example `flight/flight-*`. Wildcard character `*` allowed. | | `minimum_access_level_for_push` | string | No | Minimum GitLab access level to allow to push container images to the container registry. For example `maintainer`, `owner` or `admin`. Must be provided when `minimum_access_level_for_delete` is not set. To unset the value, use an empty string `""`. | @@ -173,7 +173,7 @@ Supported attributes: | Attribute | Type | Required | Description | |----------------------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `protection_rule_id` | integer | Yes | ID of the container registry protection rule to be deleted. | If successful, returns [`204 No Content`](rest/index.md#status-codes). diff --git a/doc/api/project_import_export.md b/doc/api/project_import_export.md index 93c06e96660..94bc02ff651 100644 --- a/doc/api/project_import_export.md +++ b/doc/api/project_import_export.md @@ -59,7 +59,7 @@ POST /projects/:id/export | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ---------------------------------------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `upload[url]` | string | yes | The URL to upload the project. | | `description` | string | no | Overrides the project description. | | `upload` | hash | no | Hash that contains the information to upload the exported project to a web server. | @@ -88,7 +88,7 @@ GET /projects/:id/export | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ---------------------------------------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | ```shell curl --header "PRIVATE-TOKEN: " \ @@ -137,7 +137,7 @@ GET /projects/:id/export/download | Attribute | Type | Required | Description | | --------- | ----------------- | -------- | ---------------------------------------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | ```shell curl --header "PRIVATE-TOKEN: " --remote-header-name \ @@ -328,7 +328,7 @@ GET /projects/:id/relation-imports | Attribute | Type | Required | Description | | --------- |--------------------| -------- |--------------------------------------------------------------------------------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | ```shell curl --header "PRIVATE-TOKEN: " \ @@ -439,7 +439,7 @@ GET /projects/:id/import | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ---------------------------------------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | ```shell curl --header "PRIVATE-TOKEN: " \ diff --git a/doc/api/project_job_token_scopes.md b/doc/api/project_job_token_scopes.md index 860b74ce906..17eb927c4a3 100644 --- a/doc/api/project_job_token_scopes.md +++ b/doc/api/project_job_token_scopes.md @@ -28,7 +28,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-----------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | If successful, returns [`200`](rest/index.md#status-codes) and the following response attributes: @@ -66,7 +66,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-----------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `enabled` | boolean | Yes | Indicates if the [**Limit access _to_ this project** setting](../ci/jobs/ci_job_token.md#add-a-group-or-project-to-the-job-token-allowlist) should be enabled. | If successful, returns [`204`](rest/index.md#status-codes) and no response body. @@ -93,7 +93,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-----------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | This endpoint supports [offset-based pagination](rest/index.md#offset-based-pagination). @@ -160,7 +160,7 @@ Supported attributes: | Attribute | Type | Required | Description | |---------------------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `target_project_id` | integer | Yes | The ID of the project added to the CI/CD job token inbound allowlist. | If successful, returns [`201`](rest/index.md#status-codes) and the following response attributes: @@ -201,7 +201,7 @@ Supported attributes: | Attribute | Type | Required | Description | |---------------------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `target_project_id` | integer | Yes | The ID of the project that is removed from the CI/CD job token inbound allowlist. | If successful, returns [`204`](rest/index.md#status-codes) and no response body. @@ -227,7 +227,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-----------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | This endpoint supports [offset-based pagination](rest/index.md#offset-based-pagination). @@ -266,7 +266,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `target_group_id` | integer | Yes | The ID of the group added to the CI/CD job token groups allowlist. | If successful, returns [`201`](rest/index.md#status-codes) and the following response attributes: @@ -307,7 +307,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `target_group_id` | integer | Yes | The ID of the group that is removed from the CI/CD job token groups allowlist. | If successful, returns [`204`](rest/index.md#status-codes) and no response body. diff --git a/doc/api/project_level_variables.md b/doc/api/project_level_variables.md index 2a764c96daa..cf5c953b09d 100644 --- a/doc/api/project_level_variables.md +++ b/doc/api/project_level_variables.md @@ -20,7 +20,7 @@ GET /projects/:id/variables | Attribute | Type | Required | Description | |-----------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | Example request: @@ -66,7 +66,7 @@ GET /projects/:id/variables/:key | Attribute | Type | Required | Description | |-----------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `key` | string | Yes | The `key` of a variable | | `filter` | hash | No | Available filters: `[environment_scope]`. See the [`filter` parameter details](#the-filter-parameter). | @@ -103,7 +103,7 @@ POST /projects/:id/variables | Attribute | Type | Required | Description | |---------------------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `key` | string | Yes | The `key` of a variable; must have no more than 255 characters; only `A-Z`, `a-z`, `0-9`, and `_` are allowed | | `value` | string | Yes | The `value` of a variable | | `description` | string | No | The description of the variable. Default: `null`. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/409641) in GitLab 16.2. | @@ -146,7 +146,7 @@ PUT /projects/:id/variables/:key | Attribute | Type | Required | Description | |---------------------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `key` | string | Yes | The `key` of a variable | | `value` | string | Yes | The `value` of a variable | | `description` | string | No | The description of the variable. Default: `null`. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/409641) in GitLab 16.2. | @@ -190,7 +190,7 @@ DELETE /projects/:id/variables/:key | Attribute | Type | Required | Description | |-----------|----------------|----------|-------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `key` | string | Yes | The `key` of a variable | | `filter` | hash | No | Available filters: `[environment_scope]`. See the [`filter` parameter details](#the-filter-parameter). | diff --git a/doc/api/project_markdown_uploads.md b/doc/api/project_markdown_uploads.md index e8073806bc3..d8eb73c058c 100644 --- a/doc/api/project_markdown_uploads.md +++ b/doc/api/project_markdown_uploads.md @@ -30,7 +30,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:----------|:------------------|:---------|:------------| | `file` | string | Yes | File to be uploaded. | -| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | To upload a file from your file system, use the `--form` argument. This causes cURL to post data using the `Content-Type: multipart/form-data` header. The `file=` parameter must point to a file on your file system and be @@ -78,7 +78,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:----------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | Example request: @@ -129,7 +129,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:------------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `upload_id` | integer | Yes | ID of the upload. | If successful, returns [`200`](rest/index.md#status-codes) and the uploaded file in the response body. @@ -158,7 +158,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:-----------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `secret` | string | Yes | 32-character secret of the upload. | | `filename` | string | Yes | Filename of the upload. | @@ -188,7 +188,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:------------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `upload_id` | integer | Yes | ID of the upload. | If successful, returns [`204`](rest/index.md#status-codes) status code without any response body. @@ -217,7 +217,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:-----------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `secret` | string | Yes | 32-character secret of the upload. | | `filename` | string | Yes | Filename of the upload. | diff --git a/doc/api/project_packages_protection_rules.md b/doc/api/project_packages_protection_rules.md index 5877395875e..2b6f91cecf7 100644 --- a/doc/api/project_packages_protection_rules.md +++ b/doc/api/project_packages_protection_rules.md @@ -33,7 +33,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------------------------|-----------------|----------|--------------------------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | If successful, returns [`200`](rest/index.md#status-codes) and a list of package protection rules. @@ -84,7 +84,7 @@ Supported attributes: | Attribute | Type | Required | Description | |---------------------------------------|-----------------|----------|--------------------------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `package_name_pattern` | string | Yes | Package name protected by the protection rule. For example `@my-scope/my-package-*`. Wildcard character `*` allowed. | | `package_type` | string | Yes | Package type protected by the protection rule. For example `npm`. | | `minimum_access_level_for_push` | string | Yes | Minimum GitLab access level able to push a package. Must be at least `maintainer`. For example `maintainer`, `owner` or `admin`. | @@ -126,7 +126,7 @@ Supported attributes: | Attribute | Type | Required | Description | |---------------------------------------|-----------------|----------|--------------------------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `package_protection_rule_id` | integer | Yes | ID of the package protection rule to be updated. | | `package_name_pattern` | string | No | Package name protected by the protection rule. For example `@my-scope/my-package-*`. Wildcard character `*` allowed. | | `package_type` | string | No | Package type protected by the protection rule. For example `npm`. | @@ -167,7 +167,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------------------------|-----------------|----------|--------------------------------| -| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `package_protection_rule_id` | integer | Yes | ID of the package protection rule to be deleted. | If successful, returns [`204 No Content`](rest/index.md#status-codes). diff --git a/doc/api/project_push_rules.md b/doc/api/project_push_rules.md index 21158bb9cf1..7dbfb96fe93 100644 --- a/doc/api/project_push_rules.md +++ b/doc/api/project_push_rules.md @@ -24,7 +24,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:----------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | Example response: @@ -61,7 +61,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:--------------------------------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `author_email_regex` | string | No | All commit author emails must match this regular expression. | | `branch_name_regex` | string | No | All branch names must match this regular expression. | | `commit_message_negative_regex` | string | No | No commit message is allowed to match this regular expression. | @@ -88,7 +88,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:--------------------------------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `author_email_regex` | string | No | All commit author emails must match this regular expression. | | `branch_name_regex` | string | No | All branch names must match this regular expression. | | `commit_message_negative_regex` | string | No | No commit message is allowed to match this regular expression. | @@ -115,4 +115,4 @@ Supported attributes: | Attribute | Type | Required | Description | |:----------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | diff --git a/doc/api/project_snippets.md b/doc/api/project_snippets.md index 148e41a3f0a..e423d6237ed 100644 --- a/doc/api/project_snippets.md +++ b/doc/api/project_snippets.md @@ -39,7 +39,7 @@ Parameters: | Attribute | Type | Required | Description | |-----------|----------------|----------|-------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | ## Single snippet @@ -53,7 +53,7 @@ Parameters: | Attribute | Type | Required | Description | |--------------|----------------|----------|-------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `snippet_id` | integer | yes | The ID of a project's snippet. | ```json @@ -92,7 +92,7 @@ Parameters: | Attribute | Type | Required | Description | |:------------------|:----------------|:---------|:------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `files:content` | string | yes | Content of the snippet file. | | `files:file_path` | string | yes | File path of the snippet file. | | `title` | string | yes | Title of a snippet. | @@ -141,7 +141,7 @@ Parameters: | Attribute | Type | Required | Description | |:----------------------|:----------------|:---------|:------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `files:action` | string | yes | Type of action to perform on the file. One of: `create`, `update`, `delete`, `move`. | | `snippet_id` | integer | yes | The ID of a project's snippet. | | `content` | string | no | Deprecated: Use `files` instead. Content of a snippet. | @@ -192,7 +192,7 @@ Parameters: | Attribute | Type | Required | Description | |:-------------|:---------------|:---------|:------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `snippet_id` | integer | yes | The ID of a project's snippet. | Example request: @@ -214,7 +214,7 @@ Parameters: | Attribute | Type | Required | Description | |:-------------|:---------------|:---------|:----------------------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `snippet_id` | integer | yes | The ID of a project's snippet. | Example request: @@ -236,7 +236,7 @@ Parameters: | Attribute | Type | Required | Description | |:-------------|:---------------|:---------|:------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `file_path` | string | yes | The URL-encoded path to the file, for example, `snippet%2Erb`. | | `ref` | string | yes | The name of a branch, tag or commit, for example, `main`. | | `snippet_id` | integer | yes | The ID of a project's snippet. | @@ -258,7 +258,7 @@ GET /projects/:id/snippets/:snippet_id/user_agent_detail | Attribute | Type | Required | Description | |--------------|----------------|----------|-------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `snippet_id` | Integer | yes | The ID of a snippet. | Example request: diff --git a/doc/api/project_statistics.md b/doc/api/project_statistics.md index 6a2b95b1d85..0c5fead5d9b 100644 --- a/doc/api/project_statistics.md +++ b/doc/api/project_statistics.md @@ -28,7 +28,7 @@ GET /projects/:id/statistics | Attribute | Type | Required | Description | | ---------- | ------ | -------- | ----------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | Example response: diff --git a/doc/api/project_templates.md b/doc/api/project_templates.md index 0fca241eb26..c62cd727b7b 100644 --- a/doc/api/project_templates.md +++ b/doc/api/project_templates.md @@ -33,7 +33,7 @@ GET /projects/:id/templates/:type | Attribute | Type | Required | Description | | ---------- | ------ | -------- | ----------- | -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `type` | string | Yes | The type of the template. Accepted values are: `dockerfiles`, `gitignores`, `gitlab_ci_ymls`, `licenses`, `issues`, or `merge_requests`. | Example response (licenses): @@ -99,7 +99,7 @@ GET /projects/:id/templates/:type/:name | Attribute | Type | Required | Description | | ---------- | ------ | -------- | ----------- | -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `name` | string | Yes | The key of the template, as obtained from the collection endpoint. | | `type` | string | Yes | The type of the template. One of: `dockerfiles`, `gitignores`, `gitlab_ci_ymls`, `licenses`, `issues`, or `merge_requests`. | | `fullname` | string | No | The full name of the copyright holder to use when expanding placeholders in the template. Affects only licenses. | diff --git a/doc/api/project_vulnerabilities.md b/doc/api/project_vulnerabilities.md index 75fcd35db0e..a3b1a4b243a 100644 --- a/doc/api/project_vulnerabilities.md +++ b/doc/api/project_vulnerabilities.md @@ -49,7 +49,7 @@ GET /projects/:id/vulnerabilities | Attribute | Type | Required | Description | | ------------- | -------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | ```shell curl --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/projects/4/vulnerabilities" @@ -121,7 +121,7 @@ POST /projects/:id/vulnerabilities?finding_id= | Attribute | Type | Required | Description | | ------------------- | ----------------- | ---------- | -----------------------------------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) which the authenticated user is a member of | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) which the authenticated user is a member of | | `finding_id` | integer or string | yes | The ID of a Vulnerability Finding to create the new Vulnerability from | The other attributes of a newly created Vulnerability are populated from diff --git a/doc/api/project_webhooks.md b/doc/api/project_webhooks.md index 9e041f3cade..da9c7ab6e81 100644 --- a/doc/api/project_webhooks.md +++ b/doc/api/project_webhooks.md @@ -29,7 +29,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:----------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | ## Get a project webhook @@ -44,7 +44,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:----------|:------------------|:---------|:------------| | `hook_id` | integer | Yes | ID of a project webhook. | -| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | Example response: @@ -99,7 +99,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:-----------|:------------------|:---------|:------------| | `hook_id` | integer | Yes | ID of a project webhook. | -| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `status` | integer or string | No | Response status code of the events, for example: `200` or `500`. You can search by status category: `successful` (200-299), `client_failure` (400-499), and `server_failure` (500-599). | | `page` | integer | No | Page to retrieve. Defaults to `1`. | | `per_page` | integer | No | Number of records to return per page. Defaults to `20`. | @@ -398,7 +398,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:-------------------------------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `url` | string | Yes | Project webhook URL. | | `name` | string | No | Name of the project webhook. | | `description` | string | No | Description of the webhook. | @@ -437,7 +437,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:-------------------------------|:------------------|:---------|:------------| | `hook_id` | integer | Yes | ID of the project webhook. | -| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `url` | string | Yes | Project webhook URL. | | `name` | string | No | Name of the project webhook. | | `description` | string | No | Description of the project webhook. | @@ -475,7 +475,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:----------|:------------------|:---------|:------------| | `hook_id` | integer | Yes | ID of the project webhook. | -| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | Note the JSON response differs if the project webhook is available or not. If the project hook is available before it's returned in the JSON response or an empty response @@ -505,7 +505,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:----------|:------------------|:---------|:------------| | `hook_id` | integer | Yes | ID of the project webhook. | -| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `trigger` | string | Yes | One of `push_events`, `tag_push_events`, `issues_events`, `confidential_issues_events`, `note_events`, `merge_requests_events`, `job_events`, `pipeline_events`, `wiki_page_events`, `releases_events`, `emoji_events`, or `resource_access_token_events`. | Example response: @@ -526,7 +526,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:----------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `hook_id` | integer | Yes | ID of the project webhook. | | `key` | string | Yes | Key of the custom header. | | `value` | string | Yes | Value of the custom header. | @@ -545,7 +545,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:----------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `hook_id` | integer | Yes | ID of the project webhook. | | `key` | string | Yes | Key of the custom header. | diff --git a/doc/api/projects.md b/doc/api/projects.md index 90e063382a5..bd53d9626f0 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -1133,7 +1133,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:-------------------------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `license` | boolean | No | Include project license data. | | `statistics` | boolean | No | Include project statistics. Available only to users with at least the Reporter role. | | `with_custom_attributes` | boolean | No | Include [custom attributes](custom_attributes.md) in response. _(administrators only)_ | @@ -1411,7 +1411,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:-------------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `search` | string | No | Search for specific users. | | `skip_users` | integer array | No | Filter out users with the specified IDs. | @@ -1450,7 +1450,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:--------------------------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `search` | string | No | Search for specific groups. | | `shared_min_access_level` | integer | No | Limit to shared groups with at least this [role (`access_level`)](members.md#roles). | | `shared_visible_only` | boolean | No | Limit to shared groups user has access to. | @@ -1492,7 +1492,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:----------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `search` | string | No | Search for specific groups. | Example response: @@ -1765,7 +1765,7 @@ Supported general project attributes: | Attribute | Type | Required | Description | |:---------------------------------------------------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `allow_merge_on_skipped_pipeline` | boolean | No | Set whether or not merge requests can be merged with skipped jobs. | | `allow_pipeline_trigger_approve_deployment` | boolean | No | Set whether or not a pipeline triggerer is allowed to approve deployments. Premium and Ultimate only. | | `only_allow_merge_if_all_status_checks_passed` | boolean | No | Indicates that merges of merge requests should be blocked unless all status checks have passed. Defaults to false.

[Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/369859) in GitLab 15.5 with feature flag `only_allow_merge_if_all_status_checks_passed` disabled by default. The feature flag was enabled by default in GitLab 15.9. Ultimate only. | @@ -1898,7 +1898,7 @@ POST /projects/:id/fork | Attribute | Type | Required | Description | |:-------------------------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `branches` | string | No | Branches to fork (empty for all branches). | | `description` | string | No | The description assigned to the resultant project after forking. | | `mr_default_target_self` | boolean | No | For forked projects, target merge requests to this project. If `false`, the target is the upstream project. | @@ -1921,7 +1921,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:------------------------------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `archived` | boolean | No | Limit by archived status. | | `membership` | boolean | No | Limit by projects that the current user is a member of. | | `min_access_level` | integer | No | Limit by current user minimal [role (`access_level`)](members.md#roles). | @@ -2047,7 +2047,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:-----------------|:------------------|:---------|:------------| | `forked_from_id` | ID | Yes | The ID of the project that was forked from. | -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | ## Delete a fork relationship between projects @@ -2065,7 +2065,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:----------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | ## Star a project @@ -2079,7 +2079,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:----------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | Example request: @@ -2178,8 +2178,6 @@ Example response: } ``` -Returns status code `304` if the project is already starred. - ## Unstar a project Unstar a project. @@ -2192,7 +2190,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:----------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | Example request: @@ -2305,7 +2303,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:----------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `search` | string | No | Search for specific users. | Example request: @@ -2361,7 +2359,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:-------------------------|:-----------------|:---------|:------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `search` | string | no | Return the list of authorized groups matching the search criteria | | `min_access_level` | integer | no | Limit to groups where current user has at least the specified [role (`access_level`)](members.md#roles) | | `relation` | array of strings | no | Filter the groups by relation (direct or inherited) | @@ -2394,7 +2392,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:----------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | Example request: @@ -2431,7 +2429,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:----------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | Example request: @@ -2573,7 +2571,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:----------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | Example request: @@ -2726,7 +2724,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:---------------------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `full_path` | string | no | Full path of project to use with `permanently_remove`. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/396500) in GitLab 15.11. To find the project path, use `path_with_namespace` from [get single project](projects.md#get-a-single-project). Premium and Ultimate only. | | `permanently_remove` | boolean/string | no | Immediately deletes a project if it is marked for deletion. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/396500) in GitLab 15.11. Premium and Ultimate only. | @@ -2746,7 +2744,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:----------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | ## Upload a project avatar @@ -2761,7 +2759,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:----------|:------------------|:---------|:------------| | `avatar` | string | Yes | The file to be uploaded. | -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | To upload an avatar from your file system, use the `--form` argument. This causes cURL to post data using the header `Content-Type: multipart/form-data`. The @@ -2797,7 +2795,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:----------|:------------------|:---------|:------------| -| `id` | integer or string | yes | ID or [URL-encoded path](rest/index.md#namespaced-path-encoding) of the project. | +| `id` | integer or string | yes | ID or [URL-encoded path](rest/index.md#namespaced-paths) of the project. | Example request: @@ -2832,7 +2830,7 @@ Supported attributes: |:---------------|:------------------|:---------|:------------| | `group_access` | integer | Yes | The [role (`access_level`)](members.md#roles) to grant the group. | | `group_id` | integer | Yes | The ID of the group to share with. | -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `expires_at` | string | No | Share expiration date in ISO 8601 format. For example, `2016-09-26`. | ## Delete a shared project link within a group @@ -2848,7 +2846,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:-----------|:------------------|:---------|:------------| | `group_id` | integer | Yes | The ID of the group. | -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | Example request: @@ -2873,8 +2871,8 @@ Supported attributes: | Attribute | Type | Required | Description | |:-------------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path](rest/index.md#namespaced-path-encoding) of the target project to receive the members. | -| `project_id` | integer or string | Yes | The ID or [URL-encoded path](rest/index.md#namespaced-path-encoding) of the source project to import the members from. | +| `id` | integer or string | Yes | The ID or [URL-encoded path](rest/index.md#namespaced-paths) of the target project to receive the members. | +| `project_id` | integer or string | Yes | The ID or [URL-encoded path](rest/index.md#namespaced-paths) of the source project to import the members from. | Example request: @@ -2911,9 +2909,9 @@ Example responses: - When there is a system error (`404` and `422` HTTP status codes): - ```json - { "message": "Import failed" } - ``` +```json +{ "message": "Import failed" } +``` ## Search for projects by name @@ -2950,7 +2948,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:----------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `task` | string | No | `prune` to trigger manual prune of unreachable objects or `eager` to trigger eager housekeeping. | ## Get groups to which a user can transfer a project @@ -2967,7 +2965,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:----------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `search` | string | No | The group names to search for. | Example request: @@ -3014,7 +3012,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:------------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `namespace` | integer or string | Yes | The ID or path of the namespace to transfer to project to. | Example request: @@ -3155,7 +3153,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-----------|-------------------|----------|-------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | Example request: @@ -3208,7 +3206,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:----------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | Example request: @@ -3303,7 +3301,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:----------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | Example request: @@ -3330,7 +3328,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:----------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `wiki` | boolean | No | Whether to download the wiki, rather than project, repository. | ## Get the path to repository storage @@ -3348,7 +3346,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:----------|:------------------|:---------|:------------| -| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | ```json [ diff --git a/doc/api/protected_branches.md b/doc/api/protected_branches.md index 2bc6ffe41f6..6636132c9a8 100644 --- a/doc/api/protected_branches.md +++ b/doc/api/protected_branches.md @@ -35,7 +35,7 @@ GET /projects/:id/protected_branches | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `search` | string | no | Name or part of the name of protected branches to be searched for | ```shell @@ -151,7 +151,7 @@ GET /projects/:id/protected_branches/:name | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `name` | string | yes | The name of the branch or wildcard | ```shell @@ -232,7 +232,7 @@ curl --request POST --header "PRIVATE-TOKEN: " "https://gitla | Attribute | Type | Required | Description | | -------------------------------------------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `name` | string | yes | The name of the branch or wildcard. | | `allow_force_push` | boolean | no | When enabled, members who can push to this branch can also force push. (default: `false`) | | `allowed_to_merge` | array | no | Array of merge access levels, with each described by a hash of the form `{user_id: integer}`, `{group_id: integer}`, or `{access_level: integer}`. Premium and Ultimate only. | @@ -508,7 +508,7 @@ curl --request DELETE --header "PRIVATE-TOKEN: " "https://git | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `name` | string | yes | The name of the branch | ## Update a protected branch @@ -528,7 +528,7 @@ curl --request PATCH --header "PRIVATE-TOKEN: " "https://gitl | Attribute | Type | Required | Description | | -------------------------------------------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `name` | string | yes | The name of the branch or wildcard. | | `allow_force_push` | boolean | no | When enabled, members who can push to this branch can also force push. | | `allowed_to_merge` | array | no | Array of merge access levels, with each described by a hash of the form `{user_id: integer}`, `{group_id: integer}`, or `{access_level: integer}`. Premium and Ultimate only. | diff --git a/doc/api/protected_environments.md b/doc/api/protected_environments.md index 892755bae19..9b8830f89a2 100644 --- a/doc/api/protected_environments.md +++ b/doc/api/protected_environments.md @@ -41,7 +41,7 @@ GET /projects/:id/protected_environments | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | ```shell curl --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/projects/5/protected_environments/" @@ -78,7 +78,7 @@ GET /projects/:id/protected_environments/:name | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `name` | string | yes | The name of the protected environment | ```shell @@ -114,7 +114,7 @@ POST /projects/:id/protected_environments | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `name` | string | yes | The name of the environment. | | `deploy_access_levels` | array | yes | Array of access levels allowed to deploy, with each described by a hash. | | `approval_rules` | array | no | Array of access levels allowed to approve, with each described by a hash. See [Multiple approval rules](../ci/environments/deployment_approvals.md#add-multiple-approval-rules). | @@ -183,7 +183,7 @@ PUT /projects/:id/protected_environments/:name | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `name` | string | yes | The name of the environment. | | `deploy_access_levels` | array | no | Array of access levels allowed to deploy, with each described by a hash. | | `approval_rules` | array | no | Array of access levels allowed to approve, with each described by a hash. See [Multiple approval rules](../ci/environments/deployment_approvals.md#add-multiple-approval-rules) for more information. | @@ -352,7 +352,7 @@ DELETE /projects/:id/protected_environments/:name | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `name` | string | yes | The name of the protected environment. | ```shell diff --git a/doc/api/protected_tags.md b/doc/api/protected_tags.md index 095b4039d02..3e502127372 100644 --- a/doc/api/protected_tags.md +++ b/doc/api/protected_tags.md @@ -31,7 +31,7 @@ GET /projects/:id/protected_tags | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | ```shell curl --header "PRIVATE-TOKEN: " \ @@ -72,7 +72,7 @@ GET /projects/:id/protected_tags/:name | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `name` | string | yes | The name of the tag or wildcard. | ```shell @@ -124,7 +124,7 @@ curl --request POST --header "PRIVATE-TOKEN: " \ | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `name` | string | yes | The name of the tag or wildcard. | | `allowed_to_create` | array | no | Array of access levels allowed to create tags, with each described by a hash of the form `{user_id: integer}`, `{group_id: integer}`, `{deploy_key_id: integer}`, or `{access_level: integer}`. Premium and Ultimate only. | | `create_access_level` | string | no | Access levels allowed to create. Default: `40`, for Maintainer role. | @@ -159,7 +159,7 @@ curl --request DELETE --header "PRIVATE-TOKEN: " \ | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `name` | string | yes | The name of the tag. | ## Related topics diff --git a/doc/api/releases/index.md b/doc/api/releases/index.md index 7d5f3e0c37c..04c52009b50 100644 --- a/doc/api/releases/index.md +++ b/doc/api/releases/index.md @@ -33,7 +33,7 @@ GET /projects/:id/releases | Attribute | Type | Required | Description | | ------------- | -------------- | -------- | ----------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-paths). | | `order_by` | string | no | The field to use as order. Either `released_at` (default) or `created_at`. | | `sort` | string | no | The direction of the order. Either `desc` (default) for descending order or `asc` for ascending order. | | `include_html_description` | boolean | no | If `true`, a response includes HTML rendered Markdown of the release description. | @@ -259,7 +259,7 @@ GET /projects/:id/releases/:tag_name | Attribute | Type | Required | Description | |----------------------------| -------------- | -------- | ----------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-paths). | | `tag_name` | string | yes | The Git tag the release is associated with. | | `include_html_description` | boolean | no | If `true`, a response includes HTML rendered Markdown of the release description. | @@ -414,7 +414,7 @@ GET /projects/:id/releases/:tag_name/downloads/:direct_asset_path | Attribute | Type | Required | Description | |----------------------------| -------------- | -------- | ----------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-paths). | | `tag_name` | string | yes | The Git tag the release is associated with. | | `direct_asset_path` | string | yes | Path to the release asset file as specified when [creating](links.md#create-a-release-link) or [updating](links.md#update-a-release-link) its link. | @@ -465,7 +465,7 @@ POST /projects/:id/releases | Attribute | Type | Required | Description | | -------------------| --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-paths). | | `name` | string | no | The release name. | | `tag_name` | string | yes | The tag where the release is created from. | | `tag_message` | string | no | Message to use if creating a new annotated tag. | @@ -617,7 +617,7 @@ POST /projects/:id/releases/:tag_name/evidence | Attribute | Type | Required | Description | | ------------- | -------------- | -------- | ----------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-paths). | | `tag_name` | string | yes | The Git tag the release is associated with. | Example request: @@ -644,7 +644,7 @@ PUT /projects/:id/releases/:tag_name | Attribute | Type | Required | Description | | ------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-paths). | | `tag_name` | string | yes | The Git tag the release is associated with. | | `name` | string | no | The release name. | | `description` | string | no | The description of the release. You can use [Markdown](../../user/markdown.md). | @@ -751,7 +751,7 @@ DELETE /projects/:id/releases/:tag_name | Attribute | Type | Required | Description | | ------------- | -------------- | -------- | ----------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-paths). | | `tag_name` | string | yes | The Git tag the release is associated with. | Example request: diff --git a/doc/api/releases/links.md b/doc/api/releases/links.md index 9fec47cfb5d..2f9aa499514 100644 --- a/doc/api/releases/links.md +++ b/doc/api/releases/links.md @@ -27,7 +27,7 @@ GET /projects/:id/releases/:tag_name/assets/links | Attribute | Type | Required | Description | | ------------- | -------------- | -------- | --------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-paths). | | `tag_name` | string | yes | The tag associated with the Release. | Example request: @@ -65,7 +65,7 @@ GET /projects/:id/releases/:tag_name/assets/links/:link_id | Attribute | Type | Required | Description | | ------------- | -------------- | -------- | --------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-paths). | | `tag_name` | string | yes | The tag associated with the Release. | | `link_id` | integer | yes | The ID of the link. | @@ -96,7 +96,7 @@ POST /projects/:id/releases/:tag_name/assets/links | Attribute | Type | Required | Description | |----------------------|----------------|----------|---------------------------------------------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-paths). | | `tag_name` | string | yes | The tag associated with the Release. | | `name` | string | yes | The name of the link. Link names must be unique in the release. | | `url` | string | yes | The URL of the link. Link URLs must be unique in the release. | @@ -136,7 +136,7 @@ PUT /projects/:id/releases/:tag_name/assets/links/:link_id | Attribute | Type | Required | Description | | -------------------- | -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-paths). | | `tag_name` | string | yes | The tag associated with the Release. | | `link_id` | integer | yes | The ID of the link. | | `name` | string | no | The name of the link. | @@ -176,7 +176,7 @@ DELETE /projects/:id/releases/:tag_name/assets/links/:link_id | Attribute | Type | Required | Description | | ------------- | -------------- | -------- | --------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../rest/index.md#namespaced-paths). | | `tag_name` | string | yes | The tag associated with the Release. | | `link_id` | integer | yes | The ID of the link. | diff --git a/doc/api/remote_mirrors.md b/doc/api/remote_mirrors.md index df49a03dc71..10c47a2bd67 100644 --- a/doc/api/remote_mirrors.md +++ b/doc/api/remote_mirrors.md @@ -197,7 +197,7 @@ Supported attributes: | Attribute | Type | Required | Description | |-------------|-------------------|----------|--------------------------------------------------------------------------------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `mirror_id` | Integer | Yes | The remote mirror ID. | If successful, returns [`204`](rest/index.md#status-codes). diff --git a/doc/api/repositories.md b/doc/api/repositories.md index 6963dca836e..21abe93e1a4 100644 --- a/doc/api/repositories.md +++ b/doc/api/repositories.md @@ -35,7 +35,7 @@ Supported attributes: | Attribute | Type | Required | Description | | :---------- | :------------- | :------- | :---------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `page_token` | string | no | The tree record ID at which to fetch the next page. Used only with keyset pagination. | | `pagination` | string | no | If `keyset`, use the [keyset-based pagination method](rest/index.md#keyset-based-pagination). | | `path` | string | no | The path inside the repository. Used to get content of subdirectories. | @@ -111,7 +111,7 @@ Supported attributes: | Attribute | Type | Required | Description | | :-------- | :------------- | :------- | :---------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `sha` | string | yes | The blob SHA. | ## Raw blob content @@ -127,7 +127,7 @@ Supported attributes: | Attribute | Type | Required | Description | | :-------- | :------- | :------- | :---------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `sha` | string | yes | The blob SHA. | ## Get file archive @@ -158,7 +158,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:------------|:---------------|:---------|:----------------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `path` | string | no | The subpath of the repository to download. If an empty string, defaults to the whole repository. | | `sha` | string | no | The commit SHA to download. A tag, branch reference, or SHA can be used. If not specified, defaults to the tip of the default branch. | @@ -183,7 +183,7 @@ Supported attributes: | Attribute | Type | Required | Description | | :--------- | :------------- | :------- | :---------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `from` | string | yes | The commit SHA or branch name. | | `to` | string | yes | The commit SHA or branch name. | | `from_project_id` | integer | no | The ID to compare from. | @@ -247,7 +247,7 @@ Supported attributes: | Attribute | Type | Required | Description | | :--------- | :------------- | :------- | :---------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `ref` | string | no | The name of a repository branch or tag. If not given, the default branch. | | `order_by` | string | no | Return contributors ordered by `name`, `email`, or `commits` (orders by commit date) fields. Default is `commits`. | | `sort` | string | no | Return contributors sorted in `asc` or `desc` order. Default is `asc`. | @@ -287,7 +287,7 @@ GET /projects/:id/repository/merge_base | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ---------------------------------------------------------------------------------- | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `refs` | array | yes | The refs to find the common ancestor of. Accepts multiple refs. | Example request, with the refs truncated for readability: diff --git a/doc/api/repository_files.md b/doc/api/repository_files.md index 1e06f78e07a..1ef30e8a76b 100644 --- a/doc/api/repository_files.md +++ b/doc/api/repository_files.md @@ -42,7 +42,7 @@ curl --header "PRIVATE-TOKEN: " \ | Attribute | Type | Required | Description | |-------------|----------------|----------|-------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `file_path` | string | yes | URL encoded full path to new file, such as `lib%2Fclass%2Erb`. | | `ref` | string | yes | The name of branch, tag or commit. | @@ -111,7 +111,7 @@ GET /projects/:id/repository/files/:file_path/blame | Attribute | Type | Required | Description | |-----------------|-------------------|----------|-------------| | `file_path` | string | yes | URL-encoded full path to new file, such as`lib%2Fclass%2Erb`. | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `range[end]` | integer | yes | The last line of the range to blame. | | `range[start]` | integer | yes | The first line of the range to blame. | | `ref` | string | yes | The name of branch, tag or commit. | @@ -226,7 +226,7 @@ GET /projects/:id/repository/files/:file_path/raw | Attribute | Type | Required | Description | |-------------|----------------|----------|------------| | `file_path` | string | yes | URL-encoded full path to new file, such as `lib%2Fclass%2Erb`. | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `lfs` | boolean | no | Determines if the response should be Git LFS file contents, rather than the pointer. Ignored if the file is not tracked by Git LFS. Defaults to `false`. | | `ref` | string | no | The name of branch, tag or commit. Default is the `HEAD` of the project. | @@ -253,7 +253,7 @@ POST /projects/:id/repository/files/:file_path | `commit_message` | string | yes | The commit message. | | `content` | string | yes | The file's content. | | `file_path` | string | yes | URL-encoded full path to new file. For example: `lib%2Fclass%2Erb`. | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `author_email` | string | no | The commit author's email address. | | `author_name` | string | no | The commit author's name. | | `encoding` | string | no | Change encoding to `base64`. Default is `text`. | @@ -293,7 +293,7 @@ PUT /projects/:id/repository/files/:file_path | `commit_message` | string | yes | The commit message. | | `content` | string | yes | The file's content. | | `file_path` | string | yes | URL-encoded full path to new file. For example: `lib%2Fclass%2Erb`. | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `author_email` | string | no | The commit author's email address. | | `author_name` | string | no | The commit author's name. | | `encoding` | string | no | Change encoding to `base64`. Default is `text`. | @@ -342,7 +342,7 @@ DELETE /projects/:id/repository/files/:file_path | `branch` | string | yes | Name of the new branch to create. The commit is added to this branch. | | `commit_message` | string | yes | The commit message. | | `file_path` | string | yes | URL-encoded full path to new file. For example: `lib%2Fclass%2Erb`. | -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `author_email` | string | no | The commit author's email address. | | `author_name` | string | no | The commit author's name. | | `last_commit_id` | string | no | Last known file commit ID. | diff --git a/doc/api/repository_submodules.md b/doc/api/repository_submodules.md index 5e2552e592b..a2747757f49 100644 --- a/doc/api/repository_submodules.md +++ b/doc/api/repository_submodules.md @@ -23,7 +23,7 @@ PUT /projects/:id/repository/submodules/:submodule | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `submodule` | string | yes | URL-encoded full path to the submodule. For example, `lib%2Fclass%2Erb` | | `branch` | string | yes | Name of the branch to commit into | | `commit_sha` | string | yes | Full commit SHA to update the submodule to | diff --git a/doc/api/resource_groups.md b/doc/api/resource_groups.md index ea13e76571f..b5f86936aae 100644 --- a/doc/api/resource_groups.md +++ b/doc/api/resource_groups.md @@ -20,7 +20,7 @@ GET /projects/:id/resource_groups | Attribute | Type | Required | Description | |-----------|---------|----------|---------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | ```shell curl --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/projects/1/resource_groups" @@ -48,7 +48,7 @@ GET /projects/:id/resource_groups/:key | Attribute | Type | Required | Description | |-----------|---------|----------|---------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `key` | string | yes | The key of the resource group | ```shell @@ -75,7 +75,7 @@ GET /projects/:id/resource_groups/:key/upcoming_jobs | Attribute | Type | Required | Description | |-----------|---------|----------|---------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `key` | string | yes | The key of the resource group | ```shell @@ -174,7 +174,7 @@ PUT /projects/:id/resource_groups/:key | Attribute | Type | Required | Description | | --------------- | ------- | --------------------------------- | ------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `key` | string | yes | The key of the resource group | | `process_mode` | string | no | The process mode of the resource group. One of `unordered`, `oldest_first` or `newest_first`. Read [process modes](../ci/resource_groups/index.md#process-modes) for more information. | diff --git a/doc/api/resource_iteration_events.md b/doc/api/resource_iteration_events.md index 91db624de62..e5dc2c1b28f 100644 --- a/doc/api/resource_iteration_events.md +++ b/doc/api/resource_iteration_events.md @@ -26,7 +26,7 @@ GET /projects/:id/issues/:issue_iid/resource_iteration_events | Attribute | Type | Required | Description | | ----------- | -------------- | -------- | ------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `issue_iid` | integer | yes | The IID of an issue | Example request: @@ -108,7 +108,7 @@ Parameters: | Attribute | Type | Required | Description | | ----------------------------- | -------------- | -------- | ------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path](rest/index.md#namespaced-path-encoding) of the project | +| `id` | integer/string | yes | The ID or [URL-encoded path](rest/index.md#namespaced-paths) of the project | | `issue_iid` | integer | yes | The IID of an issue | | `resource_iteration_event_id` | integer | yes | The ID of an iteration event | diff --git a/doc/api/resource_label_events.md b/doc/api/resource_label_events.md index 6e41ffd23c6..7b459360b54 100644 --- a/doc/api/resource_label_events.md +++ b/doc/api/resource_label_events.md @@ -25,7 +25,7 @@ GET /projects/:id/issues/:issue_iid/resource_label_events | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | ------------ | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `issue_iid` | integer | yes | The IID of an issue | ```json @@ -91,7 +91,7 @@ Parameters: | Attribute | Type | Required | Description | | --------------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `issue_iid` | integer | yes | The IID of an issue | | `resource_label_event_id` | integer | yes | The ID of a label event | @@ -120,7 +120,7 @@ GET /groups/:id/epics/:epic_id/resource_label_events | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | ------------ | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `epic_id` | integer | yes | The ID of an epic | ```json @@ -186,7 +186,7 @@ Parameters: | Attribute | Type | Required | Description | | --------------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `epic_id` | integer | yes | The ID of an epic | | `resource_label_event_id` | integer | yes | The ID of a label event | @@ -206,7 +206,7 @@ GET /projects/:id/merge_requests/:merge_request_iid/resource_label_events | Attribute | Type | Required | Description | | ------------------- | ---------------- | ---------- | ------------ | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `merge_request_iid` | integer | yes | The IID of a merge request | ```json @@ -272,7 +272,7 @@ Parameters: | Attribute | Type | Required | Description | | ------------------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `merge_request_iid` | integer | yes | The IID of a merge request | | `resource_label_event_id` | integer | yes | The ID of a label event | diff --git a/doc/api/resource_milestone_events.md b/doc/api/resource_milestone_events.md index 8426b7cecb2..2033e5097c5 100644 --- a/doc/api/resource_milestone_events.md +++ b/doc/api/resource_milestone_events.md @@ -27,7 +27,7 @@ GET /projects/:id/issues/:issue_iid/resource_milestone_events | Attribute | Type | Required | Description | | ----------- | -------------- | -------- | ------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `issue_iid` | integer | yes | The IID of an issue | Example request: @@ -111,7 +111,7 @@ Parameters: | Attribute | Type | Required | Description | | ----------------------------- | -------------- | -------- | ------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path](rest/index.md#namespaced-path-encoding) of the project | +| `id` | integer/string | yes | The ID or [URL-encoded path](rest/index.md#namespaced-paths) of the project | | `issue_iid` | integer | yes | The IID of an issue | | `resource_milestone_event_id` | integer | yes | The ID of a milestone event | @@ -133,7 +133,7 @@ GET /projects/:id/merge_requests/:merge_request_iid/resource_milestone_events | Attribute | Type | Required | Description | | ------------------- | -------------- | -------- | ------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path](rest/index.md#namespaced-path-encoding) of the project | +| `id` | integer/string | yes | The ID or [URL-encoded path](rest/index.md#namespaced-paths) of the project | | `merge_request_iid` | integer | yes | The IID of a merge request | Example request: @@ -217,7 +217,7 @@ Parameters: | Attribute | Type | Required | Description | | ----------------------------- | -------------- | -------- | ------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `merge_request_iid` | integer | yes | The IID of a merge request | | `resource_milestone_event_id` | integer | yes | The ID of a milestone event | diff --git a/doc/api/resource_state_events.md b/doc/api/resource_state_events.md index 0f09b38fa06..6a81d308d75 100644 --- a/doc/api/resource_state_events.md +++ b/doc/api/resource_state_events.md @@ -30,7 +30,7 @@ GET /projects/:id/issues/:issue_iid/resource_state_events | Attribute | Type | Required | Description | | ----------- | -------------- | -------- | ------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `issue_iid` | integer | yes | The IID of an issue | Example request: @@ -88,7 +88,7 @@ Parameters: | Attribute | Type | Required | Description | | ----------------------------- | -------------- | -------- | ------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path](rest/index.md#namespaced-path-encoding) of the project | +| `id` | integer/string | yes | The ID or [URL-encoded path](rest/index.md#namespaced-paths) of the project | | `issue_iid` | integer | yes | The IID of an issue | | `resource_state_event_id` | integer | yes | The ID of a state event | @@ -130,7 +130,7 @@ GET /projects/:id/merge_requests/:merge_request_iid/resource_state_events | Attribute | Type | Required | Description | | ------------------- | -------------- | -------- | ------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path](rest/index.md#namespaced-path-encoding) of the project | +| `id` | integer/string | yes | The ID or [URL-encoded path](rest/index.md#namespaced-paths) of the project | | `merge_request_iid` | integer | yes | The IID of a merge request | Example request: @@ -188,7 +188,7 @@ Parameters: | Attribute | Type | Required | Description | | ----------------------------- | -------------- | -------- | ------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `merge_request_iid` | integer | yes | The IID of a merge request | | `resource_state_event_id` | integer | yes | The ID of a state event | @@ -237,7 +237,7 @@ GET /groups/:id/epics/:epic_id/resource_state_events | Attribute | Type | Required | Description | |-------------| -------------- | -------- |--------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `epic_id` | integer | yes | The ID of an epic. | Example request: @@ -295,7 +295,7 @@ Parameters: | Attribute | Type | Required | Description | |---------------------------| -------------- | -------- |-------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `epic_id` | integer | yes | The ID of an epic. | | `resource_state_event_id` | integer | yes | The ID of a state event. | diff --git a/doc/api/resource_weight_events.md b/doc/api/resource_weight_events.md index 6334a4d24ff..61e1e63359a 100644 --- a/doc/api/resource_weight_events.md +++ b/doc/api/resource_weight_events.md @@ -26,7 +26,7 @@ GET /projects/:id/issues/:issue_iid/resource_weight_events | Attribute | Type | Required | Description | | ----------- | -------------- | -------- | ------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `issue_iid` | integer | yes | The IID of an issue | Example request: @@ -82,7 +82,7 @@ Parameters: | Attribute | Type | Required | Description | | ----------------------------- | -------------- | -------- | ------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path](rest/index.md#namespaced-path-encoding) of the project | +| `id` | integer/string | yes | The ID or [URL-encoded path](rest/index.md#namespaced-paths) of the project | | `issue_iid` | integer | yes | The IID of an issue | | `resource_weight_event_id` | integer | yes | The ID of a weight event | diff --git a/doc/api/rest/index.md b/doc/api/rest/index.md index 6d70a4a3c82..298f0651b1c 100644 --- a/doc/api/rest/index.md +++ b/doc/api/rest/index.md @@ -294,14 +294,197 @@ GET /projects?private_token=&sudo=23 curl --header "PRIVATE-TOKEN: " --header "Sudo: 23" "https://gitlab.example.com/api/v4/projects" ``` -## Redirects +## Request requirements + +Some REST API requests have specific requirements, including the data format and encoding used. + +### Request payload + +API requests can use parameters sent as [query strings](https://en.wikipedia.org/wiki/Query_string) +or as a [payload body](https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-p3-payload-14#section-3.2). +GET requests usually send a query string, while PUT or POST requests usually +send the payload body: + +- Query string: + + ```shell + curl --request POST "https://gitlab/api/v4/projects?name=&description=" + ``` + +- Request payload (JSON): + + ```shell + curl --request POST --header "Content-Type: application/json" \ + --data '{"name":"", "description":""}' "https://gitlab/api/v4/projects" + ``` + +URL encoded query strings have a length limitation. Requests that are too large +result in a `414 Request-URI Too Large` error message. This can be resolved by +using a payload body instead. + +### Path parameters + +If an endpoint has path parameters, the documentation displays them with a +preceding colon. + +For example: + +```plaintext +DELETE /projects/:id/share/:group_id +``` + +The `:id` path parameter needs to be replaced with the project ID, and the +`:group_id` needs to be replaced with the ID of the group. The colons `:` +shouldn't be included. + +The resulting cURL request for a project with ID `5` and a group ID of `17` is then: + +```shell +curl --request DELETE --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/projects/5/share/17" +``` + +Path parameters that are required to be URL-encoded must be followed. If not, +it doesn't match an API endpoint and responds with a 404. If there's +something in front of the API (for example, Apache), ensure that it doesn't decode +the URL-encoded path parameters. + +### `id` vs `iid` + +Some API resources have two similarly-named fields. For example, [issues](../issues.md), +[merge requests](../merge_requests.md), and [project milestones](../merge_requests.md). +The fields are: + +- `id`: ID that is unique across all projects. +- `iid`: Additional, internal ID (displayed in the web UI) that's unique in the + scope of a single project. + +If a resource has both the `iid` field and the `id` field, the `iid` field is +usually used instead of `id` to fetch the resource. + +For example, suppose a project with `id: 42` has an issue with `id: 46` and +`iid: 5`. In this case: + +- A valid API request to retrieve the issue is `GET /projects/42/issues/5`. +- An invalid API request to retrieve the issue is `GET /projects/42/issues/46`. + +Not all resources with the `iid` field are fetched by `iid`. For guidance +regarding which field to use, see the documentation for the specific resource. + +### Encoding + +When making a REST API request, some content must be encoded to account for special characters and +data structures. + +#### Namespaced paths + +If using namespaced API requests, make sure that the `NAMESPACE/PROJECT_PATH` is +URL-encoded. + +For example, `/` is represented by `%2F`: + +```plaintext +GET /api/v4/projects/diaspora%2Fdiaspora +``` + +A project's _path_ isn't necessarily the same as its _name_. A project's path is +found in the project's URL or in the project's settings, under +**General > Advanced > Change path**. + +#### File path, branches, and tags name + +If a file path, branch or tag contains a `/`, make sure it is URL-encoded. + +For example, `/` is represented by `%2F`: + +```plaintext +GET /api/v4/projects/1/repository/files/src%2FREADME.md?ref=master +GET /api/v4/projects/1/branches/my%2Fbranch/commits +GET /api/v4/projects/1/repository/tags/my%2Ftag +``` + +#### Array and hash types + +You can request the API with `array` and `hash` types parameters: + +##### `array` + +`import_sources` is a parameter of type `array`: + +```shell +curl --request POST --header "PRIVATE-TOKEN: " \ +-d "import_sources[]=github" \ +-d "import_sources[]=bitbucket" \ +"https://gitlab.example.com/api/v4/some_endpoint" +``` + +##### `hash` + +`override_params` is a parameter of type `hash`: + +```shell +curl --request POST --header "PRIVATE-TOKEN: " \ +--form "namespace=email" \ +--form "path=impapi" \ +--form "file=@/path/to/somefile.txt" \ +--form "override_params[visibility]=private" \ +--form "override_params[some_other_param]=some_value" \ +"https://gitlab.example.com/api/v4/projects/import" +``` + +##### Array of hashes + +`variables` is a parameter of type `array` containing hash key/value pairs +`[{ 'key': 'UPLOAD_TO_S3', 'value': 'true' }]`: + +```shell +curl --globoff --request POST --header "PRIVATE-TOKEN: " \ +"https://gitlab.example.com/api/v4/projects/169/pipeline?ref=master&variables[0][key]=VAR1&variables[0][value]=hello&variables[1][key]=VAR2&variables[1][value]=world" + +curl --request POST --header "PRIVATE-TOKEN: " \ +--header "Content-Type: application/json" \ +--data '{ "ref": "master", "variables": [ {"key": "VAR1", "value": "hello"}, {"key": "VAR2", "value": "world"} ] }' \ +"https://gitlab.example.com/api/v4/projects/169/pipeline" +``` + +#### Encoding `+` in ISO 8601 dates + +If you need to include a `+` in a query parameter, you may need to use `%2B` +instead, due to a [W3 recommendation](https://www.w3.org/Addressing/URL/4_URI_Recommentations.html) +that causes a `+` to be interpreted as a space. For example, in an ISO 8601 date, +you may want to include a specific time in ISO 8601 format, such as: + +```plaintext +2017-10-17T23:11:13.000+05:30 +``` + +The correct encoding for the query parameter would be: + +```plaintext +2017-10-17T23:11:13.000%2B05:30 +``` + +## Evaluating a response + +In some circumstances the API response may not be as you expect. Issues can include null values and +redirection. If you receive a numeric status code in the response, see +[Status codes](#status-codes). + +### `null` vs `false` + +In API responses, some boolean fields can have `null` values. +A `null` boolean has no default value and is neither `true` nor `false`. +GitLab treats `null` values in boolean fields the same as `false`. + +In boolean arguments, you should only set `true` or `false` values (not `null`). + +### Redirects > - Introduced in GitLab 16.4 [with a flag](../../user/feature_flags.md) named `api_redirect_moved_projects`. Disabled by default. > - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/137578) in GitLab 16.7. Feature flag `api_redirect_moved_projects` removed. After [path changes](../../user/project/repository/index.md#repository-path-changes) the -REST API can respond with a redirect and users should be able to handle such responses. -The users should follow the redirect and repeat the request to the URI specified in the `Location` header. +REST API might respond with a message noting that the endpoint has moved. When this happens, used +the endpoint specified in the `Location` header. Example of a project moved to a different path: @@ -393,14 +576,14 @@ x-total-pages: 3 GitLab also returns the following additional pagination headers: -| Header | Description | -|:----------------|:-----------------------------------------------| -| `x-next-page` | The index of the next page. | +| Header | Description | +|:----------------|:------------| +| `x-next-page` | The index of the next page. | | `x-page` | The index of the current page (starting at 1). | -| `x-per-page` | The number of items per page. | -| `x-prev-page` | The index of the previous page. | -| `x-total` | The total number of items. | -| `x-total-pages` | The total number of pages. | +| `x-per-page` | The number of items per page. | +| `x-prev-page` | The index of the previous page. | +| `x-total` | The total number of items. | +| `x-total-pages` | The total number of pages. | For GitLab.com users, [some pagination headers may not be returned](../../user/gitlab_com/index.md#pagination-response-headers). @@ -413,11 +596,11 @@ collection. This method is controlled by the following parameters. `order_by` and `sort` are both mandatory. | Parameter | Required | Description | -|--------------| ------------ | --------- | -| `pagination` | yes | `keyset` (to enable keyset pagination). | -| `per_page` | no | Number of items to list per page (default: `20`, max: `100`). | -| `order_by` | yes | Column by which to order by. | -| `sort` | yes | Sort order (`asc` or `desc`) | +|--------------|----------|-------------| +| `pagination` | yes | `keyset` (to enable keyset pagination). | +| `per_page` | no | Number of items to list per page (default: `20`, max: `100`). | +| `order_by` | yes | Column by which to order by. | +| `sort` | yes | Sort order (`asc` or `desc`) | In the following example, we list 50 [projects](../projects.md) per page, ordered by `id` ascending. @@ -480,18 +663,18 @@ pagination headers. Keyset-based pagination is supported only for selected resources and ordering options: -| Resource | Options | Availability | -|:-------------------------------------------------------------------------------|:---------------------------------|:-----------------------------------------| -| [Group audit events](../audit_events.md#retrieve-all-group-audit-events) | `order_by=id`, `sort=desc` only | Authenticated users only. | -| [Groups](../groups.md#list-groups) | `order_by=name`, `sort=asc` only | Unauthenticated users only. | -| [Instance audit events](../audit_events.md#retrieve-all-instance-audit-events) | `order_by=id`, `sort=desc` only | Authenticated users only. | -| [Package pipelines](../packages.md#list-package-pipelines) | `order_by=id`, `sort=desc` only | Authenticated users only. | -| [Project jobs](../jobs.md#list-project-jobs) | `order_by=id`, `sort=desc` only | Authenticated users only. | -| [Project audit events](../audit_events.md#retrieve-all-project-audit-events) | `order_by=id`, `sort=desc` only | Authenticated users only. | -| [Projects](../projects.md) | `order_by=id` only | Authenticated and unauthenticated users. | -| [Users](../users.md) | `order_by=id`, `order_by=name`, `order_by=username` | Authenticated and unauthenticated users. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/419556) in GitLab 16.5. | -| [Registry Repository Tags](../container_registry.md) | `order_by=name`, `sort=asc`, or `sort=desc` only. | Authenticated users only. | -| [List repository tree](../repositories.md#list-repository-tree) | | Authenticated and unauthenticated users. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/154897) in GitLab 17.1. | +| Resource | Options | Availability | +|:-------------------------------------------------------------------------------|:----------------------------------------------------|:-------------| +| [Group audit events](../audit_events.md#retrieve-all-group-audit-events) | `order_by=id`, `sort=desc` only | Authenticated users only. | +| [Groups](../groups.md#list-groups) | `order_by=name`, `sort=asc` only | Unauthenticated users only. | +| [Instance audit events](../audit_events.md#retrieve-all-instance-audit-events) | `order_by=id`, `sort=desc` only | Authenticated users only. | +| [Package pipelines](../packages.md#list-package-pipelines) | `order_by=id`, `sort=desc` only | Authenticated users only. | +| [Project jobs](../jobs.md#list-project-jobs) | `order_by=id`, `sort=desc` only | Authenticated users only. | +| [Project audit events](../audit_events.md#retrieve-all-project-audit-events) | `order_by=id`, `sort=desc` only | Authenticated users only. | +| [Projects](../projects.md) | `order_by=id` only | Authenticated and unauthenticated users. | +| [Users](../users.md) | `order_by=id`, `order_by=name`, `order_by=username` | Authenticated and unauthenticated users. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/419556) in GitLab 16.5. | +| [Registry Repository Tags](../container_registry.md) | `order_by=name`, `sort=asc`, or `sort=desc` only. | Authenticated users only. | +| [List repository tree](../repositories.md#list-repository-tree) | N/A | Authenticated and unauthenticated users. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/154897) in GitLab 17.1. | ### Pagination response headers @@ -502,207 +685,6 @@ doesn't return the following headers: - `x-total-pages`. - `rel="last"` `link` -## Path parameters - -If an endpoint has path parameters, the documentation displays them with a -preceding colon. - -For example: - -```plaintext -DELETE /projects/:id/share/:group_id -``` - -The `:id` path parameter needs to be replaced with the project ID, and the -`:group_id` needs to be replaced with the ID of the group. The colons `:` -shouldn't be included. - -The resulting cURL request for a project with ID `5` and a group ID of `17` is then: - -```shell -curl --request DELETE --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/projects/5/share/17" -``` - -Path parameters that are required to be URL-encoded must be followed. If not, -it doesn't match an API endpoint and responds with a 404. If there's -something in front of the API (for example, Apache), ensure that it doesn't decode -the URL-encoded path parameters. - -## Namespaced path encoding - -If using namespaced API requests, make sure that the `NAMESPACE/PROJECT_PATH` is -URL-encoded. - -For example, `/` is represented by `%2F`: - -```plaintext -GET /api/v4/projects/diaspora%2Fdiaspora -``` - -A project's _path_ isn't necessarily the same as its _name_. A project's path is -found in the project's URL or in the project's settings, under -**General > Advanced > Change path**. - -## File path, branches, and tags name encoding - -If a file path, branch or tag contains a `/`, make sure it is URL-encoded. - -For example, `/` is represented by `%2F`: - -```plaintext -GET /api/v4/projects/1/repository/files/src%2FREADME.md?ref=master -GET /api/v4/projects/1/branches/my%2Fbranch/commits -GET /api/v4/projects/1/repository/tags/my%2Ftag -``` - -## Request Payload - -API Requests can use parameters sent as [query strings](https://en.wikipedia.org/wiki/Query_string) -or as a [payload body](https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-p3-payload-14#section-3.2). -GET requests usually send a query string, while PUT or POST requests usually -send the payload body: - -- Query string: - - ```shell - curl --request POST "https://gitlab/api/v4/projects?name=&description=" - ``` - -- Request payload (JSON): - - ```shell - curl --request POST --header "Content-Type: application/json" \ - --data '{"name":"", "description":""}' "https://gitlab/api/v4/projects" - ``` - -URL encoded query strings have a length limitation. Requests that are too large -result in a `414 Request-URI Too Large` error message. This can be resolved by -using a payload body instead. - -## Encoding API parameters of `array` and `hash` types - -You can request the API with `array` and `hash` types parameters: - -### `array` - -`import_sources` is a parameter of type `array`: - -```shell -curl --request POST --header "PRIVATE-TOKEN: " \ --d "import_sources[]=github" \ --d "import_sources[]=bitbucket" \ -"https://gitlab.example.com/api/v4/some_endpoint" -``` - -### `hash` - -`override_params` is a parameter of type `hash`: - -```shell -curl --request POST --header "PRIVATE-TOKEN: " \ ---form "namespace=email" \ ---form "path=impapi" \ ---form "file=@/path/to/somefile.txt" \ ---form "override_params[visibility]=private" \ ---form "override_params[some_other_param]=some_value" \ -"https://gitlab.example.com/api/v4/projects/import" -``` - -### Array of hashes - -`variables` is a parameter of type `array` containing hash key/value pairs -`[{ 'key': 'UPLOAD_TO_S3', 'value': 'true' }]`: - -```shell -curl --globoff --request POST --header "PRIVATE-TOKEN: " \ -"https://gitlab.example.com/api/v4/projects/169/pipeline?ref=master&variables[0][key]=VAR1&variables[0][value]=hello&variables[1][key]=VAR2&variables[1][value]=world" - -curl --request POST --header "PRIVATE-TOKEN: " \ ---header "Content-Type: application/json" \ ---data '{ "ref": "master", "variables": [ {"key": "VAR1", "value": "hello"}, {"key": "VAR2", "value": "world"} ] }' \ -"https://gitlab.example.com/api/v4/projects/169/pipeline" -``` - -## `id` vs `iid` - -Some resources have two similarly-named fields. For example, [issues](../issues.md), -[merge requests](../merge_requests.md), and [project milestones](../merge_requests.md). -The fields are: - -- `id`: ID that is unique across all projects. -- `iid`: Additional, internal ID (displayed in the web UI) that's unique in the - scope of a single project. - -If a resource has both the `iid` field and the `id` field, the `iid` field is -usually used instead of `id` to fetch the resource. - -For example, suppose a project with `id: 42` has an issue with `id: 46` and -`iid: 5`. In this case: - -- A valid API request to retrieve the issue is `GET /projects/42/issues/5`. -- An invalid API request to retrieve the issue is `GET /projects/42/issues/46`. - -Not all resources with the `iid` field are fetched by `iid`. For guidance -regarding which field to use, see the documentation for the specific resource. - -## `null` vs `false` - -In API responses, some boolean fields can have `null` values. -A `null` boolean has no default value and is neither `true` nor `false`. -GitLab treats `null` values in boolean fields the same as `false`. - -In boolean arguments, you should only set `true` or `false` values (not `null`). - -## Encoding `+` in ISO 8601 dates - -If you need to include a `+` in a query parameter, you may need to use `%2B` -instead, due to a [W3 recommendation](https://www.w3.org/Addressing/URL/4_URI_Recommentations.html) -that causes a `+` to be interpreted as a space. For example, in an ISO 8601 date, -you may want to include a specific time in ISO 8601 format, such as: - -```plaintext -2017-10-17T23:11:13.000+05:30 -``` - -The correct encoding for the query parameter would be: - -```plaintext -2017-10-17T23:11:13.000%2B05:30 -``` - -## Resolve requests detected as spam - -REST API requests can be detected as spam. If a request is detected as spam and: - -- A CAPTCHA service is not configured, an error response is returned. For example: - - ```json - {"message":{"error":"Your snippet has been recognized as spam and has been discarded."}} - ``` - -- A CAPTCHA service is configured, you receive a response with: - - `needs_captcha_response` set to `true`. - - The `spam_log_id` and `captcha_site_key` fields set. - - For example: - - ```json - {"needs_captcha_response":true,"spam_log_id":42,"captcha_site_key":"REDACTED","message":{"error":"Your snippet has been recognized as spam. Please, change the content or solve the reCAPTCHA to proceed."}} - ``` - -- Use the `captcha_site_key` to obtain a CAPTCHA response value using the appropriate CAPTCHA API. - Only [Google reCAPTCHA v2](https://developers.google.com/recaptcha/docs/display) is supported. -- Resubmit the request with the `X-GitLab-Captcha-Response` and `X-GitLab-Spam-Log-Id` headers set. - - ```shell - export CAPTCHA_RESPONSE="" - export SPAM_LOG_ID="" - curl --request POST --header "PRIVATE-TOKEN: $PRIVATE_TOKEN" --header "X-GitLab-Captcha- - Response: $CAPTCHA_RESPONSE" --header "X-GitLab-Spam-Log-Id: $SPAM_LOG_ID" - "https://gitlab.example.com/api/v4/snippets? - title=Title&file_name=FileName&content=Content&visibility=public" - ``` - ## Troubleshooting When working with the REST API, you might encounter an issue. @@ -826,3 +808,36 @@ To include the HTTP exit code, include the `--fail` option: curl --fail "https://gitlab.example.com/api/v4/does-not-exist" curl: (22) The requested URL returned error: 404 ``` + +### Requests detected as spam + +REST API requests can be detected as spam. If a request is detected as spam and: + +- A CAPTCHA service is not configured, an error response is returned. For example: + + ```json + {"message":{"error":"Your snippet has been recognized as spam and has been discarded."}} + ``` + +- A CAPTCHA service is configured, you receive a response with: + - `needs_captcha_response` set to `true`. + - The `spam_log_id` and `captcha_site_key` fields set. + + For example: + + ```json + {"needs_captcha_response":true,"spam_log_id":42,"captcha_site_key":"REDACTED","message":{"error":"Your snippet has been recognized as spam. Please, change the content or solve the reCAPTCHA to proceed."}} + ``` + + - Use the `captcha_site_key` to obtain a CAPTCHA response value using the appropriate CAPTCHA API. + Only [Google reCAPTCHA v2](https://developers.google.com/recaptcha/docs/display) is supported. + - Resubmit the request with the `X-GitLab-Captcha-Response` and `X-GitLab-Spam-Log-Id` headers set. + + ```shell + export CAPTCHA_RESPONSE="" + export SPAM_LOG_ID="" + curl --request POST --header "PRIVATE-TOKEN: $PRIVATE_TOKEN" --header "X-GitLab-Captcha- + Response: $CAPTCHA_RESPONSE" --header "X-GitLab-Spam-Log-Id: $SPAM_LOG_ID" + "https://gitlab.example.com/api/v4/snippets? + title=Title&file_name=FileName&content=Content&visibility=public" + ``` diff --git a/doc/api/runners.md b/doc/api/runners.md index 902d8899b4c..2a80d9e16c6 100644 --- a/doc/api/runners.md +++ b/doc/api/runners.md @@ -604,7 +604,7 @@ GET /projects/:id/runners?tag_list=tag1,tag2 | Attribute | Type | Required | Description | |------------------|----------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `scope` | string | no | Deprecated: Use `type` or `status` instead. The scope of runners to return, one of: `active`, `paused`, `online` and `offline`; showing all runners if none provided | | `type` | string | no | The type of runners to return, one of: `instance_type`, `group_type`, `project_type` | | `status` | string | no | The status of runners to return, one of: `online`, `offline`, `stale`, or `never_contacted`.
Other possible values are the deprecated `active` and `paused`.
Requesting `offline` runners might also return `stale` runners because `stale` is included in `offline`. | @@ -679,7 +679,7 @@ POST /projects/:id/runners | Attribute | Type | Required | Description | |-------------|---------|----------|---------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `runner_id` | integer | yes | The ID of a runner | ```shell @@ -729,7 +729,7 @@ DELETE /projects/:id/runners/:runner_id | Attribute | Type | Required | Description | |-------------|---------|----------|---------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) | | `runner_id` | integer | yes | The ID of a runner | ```shell diff --git a/doc/api/saml.md b/doc/api/saml.md index 7a872277fe9..cb08cb2e76d 100644 --- a/doc/api/saml.md +++ b/doc/api/saml.md @@ -28,7 +28,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:------------------|:--------|:---------|:----------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | If successful, returns [`200`](rest/index.md#status-codes) and the following response attributes: @@ -67,7 +67,7 @@ Supported attributes: | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `uid` | string | yes | External UID of the user. | Example request: @@ -101,7 +101,7 @@ Supported attributes: | Attribute | Type | Required | Description | | --------- | ------ | -------- | ------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `uid` | string | yes | External UID of the user. | Example request: @@ -124,7 +124,7 @@ Supported attributes: | Attribute | Type | Required | Description | | --------- | ------- | -------- | ------------------------- | -| `id` | integer | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `uid` | string | yes | External UID of the user. | Example request: @@ -178,7 +178,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:----------|:---------------|:---------|:------------| -| `id` | integer/string | yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | If successful, returns [`200`](rest/index.md#status-codes) and the following response attributes: @@ -223,7 +223,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:------------------|:---------------|:---------|:------------| -| `id` | integer/string | yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `saml_group_name` | string | yes | Name of the SAML group. | If successful, returns [`200`](rest/index.md#status-codes) and the following response attributes: @@ -262,7 +262,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:------------------|:------------------|:---------|:------------| -| `id` | integer or string | yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `saml_group_name` | string | yes | Name of the SAML group. | | `access_level` | integer | yes | [Role (`access_level`)](members.md#roles) for members of the SAML group. | | `member_role_id` | integer | no | [Member Role ID (`member_role_id`)](member_roles.md) for members of the SAML group. | @@ -303,7 +303,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:------------------|:---------------|:---------|:------------| -| `id` | integer/string | yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `saml_group_name` | string | yes | Name of the SAML group. | Example request: diff --git a/doc/api/scim.md b/doc/api/scim.md index e62321e1a40..d6ca45e31ae 100644 --- a/doc/api/scim.md +++ b/doc/api/scim.md @@ -40,7 +40,7 @@ Supported attributes: | Attribute | Type | Required | Description | |:------------------|:--------|:---------|:----------------------| -| `id` | integer/string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | If successful, returns [`200`](rest/index.md#status-codes) and the following response attributes: @@ -82,7 +82,7 @@ Supported attributes: | Attribute | Type | Required | Description | | --------- | ------- | -------- | ------------------------- | -| `id` | integer | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `uid` | string | yes | External UID of the user. | Example request: @@ -119,7 +119,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ------ | -------- | ------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths) | | `uid` | string | yes | External UID of the user. | Example request: @@ -142,7 +142,7 @@ Supported attributes: | Attribute | Type | Required | Description | | --------- | ------- | -------- | ------------------------- | -| `id` | integer | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `uid` | string | yes | External UID of the user. | Example request: diff --git a/doc/api/search.md b/doc/api/search.md index 9e41536e6db..74b4fdd884b 100644 --- a/doc/api/search.md +++ b/doc/api/search.md @@ -458,7 +458,7 @@ GET /groups/:id/search | Attribute | Type | Required | Description | | --------- | ---- | -------- | -------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-paths). | | `scope` | string | Yes | The scope to search in. Values include `projects`, `issues`, `merge_requests`, `milestones`, and `users`. Additional scopes are `wiki_blobs`, `commits`, `blobs`, and `notes`. | | `search` | string | Yes | The search term. | | `confidential` | boolean | No | Filter by confidentiality. Supports only `issues` scope; other scopes are ignored. | @@ -853,7 +853,7 @@ GET /projects/:id/search | Attribute | Type | Required | Description | | --------- | ---- | -------- | ------------| -| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `scope` | string | Yes | The scope to search in. Values include `issues`, `merge_requests`, `milestones`, and `users`. Additional scopes are `wiki_blobs`, `commits`, `blobs`, and `notes`. | | `search` | string | Yes | The search term. | | `confidential` | boolean | No | Filter by confidentiality. Supports `issues` scope; other scopes are ignored. | diff --git a/doc/api/secure_files.md b/doc/api/secure_files.md index 52accb2975f..f9dc4b78218 100644 --- a/doc/api/secure_files.md +++ b/doc/api/secure_files.md @@ -33,7 +33,7 @@ Supported attributes: | Attribute | Type | Required | Description | |--------------|----------------|----------|-------------| -| `project_id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `project_id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | Example request: @@ -95,7 +95,7 @@ Supported attributes: | Attribute | Type | Required | Description | |--------------|----------------|----------|-------------| | `id` | integer | Yes | The ID of a secure file. | -| `project_id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `project_id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | Example request: @@ -131,7 +131,7 @@ Supported attributes: |-----------------|----------------|----------|-------------| | `file` | file | Yes | The file being uploaded (5 MB limit). | | `name` | string | Yes | The name of the file being uploaded. The filename must be unique in the project. | -| `project_id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `project_id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | Example request: @@ -167,7 +167,7 @@ Supported attributes: | Attribute | Type | Required | Description | |--------------|----------------|----------|-------------| | `id` | integer | Yes | The ID of a secure file. | -| `project_id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `project_id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | Example request: @@ -188,7 +188,7 @@ Supported attributes: | Attribute | Type | Required | Description | |--------------|----------------|----------|-------------| | `id` | integer | Yes | The ID of a secure file. | -| `project_id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `project_id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | Example request: diff --git a/doc/api/tags.md b/doc/api/tags.md index b36687856d2..2fd0b982b3f 100644 --- a/doc/api/tags.md +++ b/doc/api/tags.md @@ -31,7 +31,7 @@ Parameters: | Attribute | Type | Required | Description | |------------|-------------------|----------|-------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `order_by` | string | no | Return tags ordered by `name`, `updated`, or `version`. Default is `updated`. | | `sort` | string | no | Return tags sorted in `asc` or `desc` order. Default is `desc`. | | `search` | string | no | Return a list of tags matching the search criteria. You can use `^term` and `term$` to find tags that begin and end with `term`. No other regular expressions are supported. | @@ -90,7 +90,7 @@ Parameters: | Attribute | Type | Required | Description | |------------|-------------------|----------|-------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `tag_name` | string | yes | The name of a tag. | ```shell @@ -141,7 +141,7 @@ Parameters: | Attribute | Type | Required | Description | |------------|-------------------|----------|-------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `tag_name` | string | yes | The name of a tag. | | `ref` | string | yes | Create a tag from a commit SHA, another tag name, or branch name. | | `message` | string | no | Create an annotated tag. | @@ -206,7 +206,7 @@ Parameters: | Attribute | Type | Required | Description | |------------|-------------------|----------|-------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `tag_name` | string | yes | The name of a tag. | ## Get X.509 signature of a tag @@ -224,7 +224,7 @@ Parameters: | Attribute | Type | Required | Description | |------------|-------------------|----------|-------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer or string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `tag_name` | string | yes | The name of a tag. | ```shell diff --git a/doc/api/vulnerability_exports.md b/doc/api/vulnerability_exports.md index 39884d02b4f..a598235e9cd 100644 --- a/doc/api/vulnerability_exports.md +++ b/doc/api/vulnerability_exports.md @@ -28,7 +28,7 @@ POST /security/projects/:id/vulnerability_exports | Attribute | Type | Required | Description | | ------------------- | ----------------- | ---------- | -----------------------------------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | The ID or [URL-encoded path](rest/index.md#namespaced-path-encoding) of the project which the authenticated user is a member of | +| `id` | integer or string | yes | The ID or [URL-encoded path](rest/index.md#namespaced-paths) of the project which the authenticated user is a member of | ```shell curl --request POST --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/security/projects/1/vulnerability_exports" @@ -71,7 +71,7 @@ POST /security/groups/:id/vulnerability_exports | Attribute | Type | Required | Description | | ------------------- | ----------------- | ---------- | -----------------------------------------------------------------------------------------------------------------------------| -| `id` | integer or string | yes | The ID or [URL-encoded path](rest/index.md#namespaced-path-encoding) of the group which the authenticated user is a member of | +| `id` | integer or string | yes | The ID or [URL-encoded path](rest/index.md#namespaced-paths) of the group which the authenticated user is a member of | ```shell curl --request POST --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/security/groups/1/vulnerability_exports" diff --git a/doc/api/vulnerability_findings.md b/doc/api/vulnerability_findings.md index 59a643bb716..1ed40d3f08c 100644 --- a/doc/api/vulnerability_findings.md +++ b/doc/api/vulnerability_findings.md @@ -52,7 +52,7 @@ GET /projects/:id/vulnerability_findings?pipeline_id=42 | Attribute | Type | Required | Description | | ------------- | -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding) which the authenticated user is a member of. | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths) which the authenticated user is a member of. | | `report_type` | string array | no | Returns vulnerability findings belonging to specified report type. Valid values: `sast`, `dast`, `dependency_scanning`, or `container_scanning`. Defaults to all. | | `scope` | string | no | Returns vulnerability findings for the given scope: `all` or `dismissed`. Defaults to `dismissed`. | | `severity` | string array | no | Returns vulnerability findings belonging to specified severity level: `info`, `unknown`, `low`, `medium`, `high`, or `critical`. Defaults to all. | diff --git a/doc/api/wikis.md b/doc/api/wikis.md index 1f51c66a4b9..849be6512d7 100644 --- a/doc/api/wikis.md +++ b/doc/api/wikis.md @@ -23,7 +23,7 @@ GET /projects/:id/wikis | Attribute | Type | Required | Description | | -------------- | -------------- | -------- | ----------- | -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `with_content` | boolean | No | Include pages' content. | ```shell @@ -67,7 +67,7 @@ GET /projects/:id/wikis/:slug | Attribute | Type | Required | Description | | ------------- | -------------- | -------- | ----------- | -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `slug` | string | Yes | URL encoded slug (a unique string) of the wiki page, such as `dir%2Fpage_name`. | | `render_html` | boolean | No | Return the rendered HTML of the wiki page. | | `version` | string | No | Wiki page version SHA. | @@ -98,7 +98,7 @@ POST /projects/:id/wikis | Attribute | Type | Required | Description | | ----------| -------------- | -------- | ----------- | -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `content` | string | Yes | The content of the wiki page. | | `title` | string | Yes | The title of the wiki page. | | `format` | string | No | The format of the wiki page. Available formats are: `markdown` (default), `rdoc`, `asciidoc`, and `org`. | @@ -130,7 +130,7 @@ PUT /projects/:id/wikis/:slug | Attribute | Type | Required | Description | | --------- | ------- | --------------------------------- | ----------- | -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `content` | string | Yes, if `title` is not provided | The content of the wiki page. | | `title` | string | Yes, if `content` is not provided | The title of the wiki page. | | `format` | string | No | The format of the wiki page. Available formats are: `markdown` (default), `rdoc`, `asciidoc`, and `org`. | @@ -163,7 +163,7 @@ DELETE /projects/:id/wikis/:slug | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ----------- | -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `slug` | string | Yes | URL-encoded slug (a unique string) of the wiki page, such as `dir%2Fpage_name`. | ```shell @@ -183,7 +183,7 @@ POST /projects/:id/wikis/attachments | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ----------- | -| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | Yes | The ID or [URL-encoded path of the project](rest/index.md#namespaced-paths). | | `file` | string | Yes | The attachment to be uploaded. | | `branch` | string | No | The name of the branch. Defaults to the wiki repository default branch. | diff --git a/doc/ci/runners/configure_runners.md b/doc/ci/runners/configure_runners.md index bdcc18fdf46..5f5cec7f503 100644 --- a/doc/ci/runners/configure_runners.md +++ b/doc/ci/runners/configure_runners.md @@ -221,8 +221,8 @@ To reset the runner authentication token: ### Automatically rotate runner authentication tokens -You can specify an interval for runner authentication tokens to rotate. -This rotation helps ensure the security of the tokens assigned to your runners. +You can specify an interval to rotate runner authentication tokens. +Regularly rotating runner authentication tokens helps minimize the risk of unauthorized access to your GitLab instance through compromised tokens. Prerequisites: diff --git a/doc/development/internal_api/gitlab_subscriptions.md b/doc/development/internal_api/gitlab_subscriptions.md index 5f498095c61..fb266d97a94 100644 --- a/doc/development/internal_api/gitlab_subscriptions.md +++ b/doc/development/internal_api/gitlab_subscriptions.md @@ -87,7 +87,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | ID or [URL-encoded path of the namespace](../../api/rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | ID or [URL-encoded path of the namespace](../../api/rest/index.md#namespaced-paths) | Example request: @@ -132,7 +132,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | -------------- | -------- | ----------- | -| `id` | integer/string | yes | ID or [URL-encoded path of the namespace](../../api/rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | ID or [URL-encoded path of the namespace](../../api/rest/index.md#namespaced-paths) | | `shared_runners_minutes_limit` | integer | no | Compute minutes quota | | `extra_shared_runners_minutes_limit` | integer | no | Extra compute minutes | | `additional_purchased_storage_size` | integer | no | Additional storage size | diff --git a/doc/development/internal_api/index.md b/doc/development/internal_api/index.md index dec580acc7a..fe14cfa343b 100644 --- a/doc/development/internal_api/index.md +++ b/doc/development/internal_api/index.md @@ -506,7 +506,7 @@ agent to be authorized is [not yet implemented](https://gitlab.com/gitlab-org/gi | Attribute | Type | Required | Description | |:----------|:-------|:---------|:------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../../api/rest/index.md#namespaced-path-encoding) | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../../api/rest/index.md#namespaced-paths) | ```plaintext GET /internal/kubernetes/project_info diff --git a/doc/development/spam_protection_and_captcha/index.md b/doc/development/spam_protection_and_captcha/index.md index 1b71b11a2f9..0dad9bbb303 100644 --- a/doc/development/spam_protection_and_captcha/index.md +++ b/doc/development/spam_protection_and_captcha/index.md @@ -18,7 +18,7 @@ To add this support, you must implement the following areas as applicable: for a feature which does not yet have support. 1. [REST API](rest_api.md): The changes needed to add spam or CAPTCHA support to Grape REST API endpoints. Refer to the related - [REST API documentation](../../api/rest/index.md#resolve-requests-detected-as-spam). + [REST API documentation](../../api/rest/index.md#requests-detected-as-spam). 1. [GraphQL API](graphql_api.md): The changes needed to add spam or CAPTCHA support to GraphQL mutations. Refer to the related [GraphQL API documentation](../../api/graphql/index.md#resolve-mutations-detected-as-spam). @@ -48,6 +48,6 @@ The possible values include: ## Related topics - [Spam and CAPTCHA support in the GraphQL API](../../api/graphql/index.md#resolve-mutations-detected-as-spam) -- [Spam and CAPTCHA support in the REST API](../../api/rest/index.md#resolve-requests-detected-as-spam) +- [Spam and CAPTCHA support in the REST API](../../api/rest/index.md#requests-detected-as-spam) - [reCAPTCHA Spam and Anti-bot Protection](../../integration/recaptcha.md) - [Akismet and spam logs](../../integration/akismet.md) diff --git a/doc/development/spam_protection_and_captcha/rest_api.md b/doc/development/spam_protection_and_captcha/rest_api.md index 4e5cd2ce3cb..165aa00929f 100644 --- a/doc/development/spam_protection_and_captcha/rest_api.md +++ b/doc/development/spam_protection_and_captcha/rest_api.md @@ -32,7 +32,7 @@ The main steps are: - Raise a Grape `#error!` exception with a descriptive spam-specific error message. - Include the relevant information added as error fields to the response. For more details on these fields, refer to the section in the REST API documentation on - [Resolve requests detected as spam](../../api/rest/index.md#resolve-requests-detected-as-spam). + [Resolve requests detected as spam](../../api/rest/index.md#requests-detected-as-spam). NOTE: If you use the standard ApolloLink or Axios interceptor CAPTCHA support described diff --git a/doc/user/custom_roles.md b/doc/user/custom_roles.md index 3ec04ddc1c5..75695426bcc 100644 --- a/doc/user/custom_roles.md +++ b/doc/user/custom_roles.md @@ -199,7 +199,7 @@ If you are assigning a custom role to an existing: Where: - - ``: The `id` or [URL-encoded path of the project or group](../api/rest/index.md#namespaced-path-encoding) associated with the membership receiving the custom role. + - ``: The `id` or [URL-encoded path of the project or group](../api/rest/index.md#namespaced-paths) associated with the membership receiving the custom role. - ``: The `id` of the member role created in the previous section. - ``: The `id` of the user receiving a custom role. diff --git a/doc/user/packages/generic_packages/index.md b/doc/user/packages/generic_packages/index.md index 7f6c9201c20..8f65d3873b3 100644 --- a/doc/user/packages/generic_packages/index.md +++ b/doc/user/packages/generic_packages/index.md @@ -47,7 +47,7 @@ PUT /projects/:id/packages/generic/:package_name/:package_version/:file_name?sta | Attribute | Type | Required | Description | |-------------------|----------------|----------|-------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../../../api/rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../../../api/rest/index.md#namespaced-paths). | | `package_name` | string | yes | The package name. It can contain only lowercase letters (`a-z`), uppercase letter (`A-Z`), numbers (`0-9`), dots (`.`), hyphens (`-`), or underscores (`_`). | | `package_version` | string | yes | The package version. The following regex validates this: `\A(\.?[\w\+-]+\.?)+\z`. You can test your version strings on [Rubular](https://rubular.com/r/aNCV0wG5K14uq8). | | `file_name` | string | yes | The filename. It can contain only lowercase letters (`a-z`), uppercase letter (`A-Z`), numbers (`0-9`), dots (`.`), hyphens (`-`), underscores (`_`), or slashes (`/`). | @@ -161,7 +161,7 @@ GET /projects/:id/packages/generic/:package_name/:package_version/:file_name | Attribute | Type | Required | Description | |-------------------|----------------|----------|-------------| -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../../../api/rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../../../api/rest/index.md#namespaced-paths). | | `package_name` | string | yes | The package name. | | `package_version` | string | yes | The package version. | | `file_name` | string | yes | The filename. | diff --git a/doc/user/packages/helm_repository/index.md b/doc/user/packages/helm_repository/index.md index 3b749b8df8e..78b615a6981 100644 --- a/doc/user/packages/helm_repository/index.md +++ b/doc/user/packages/helm_repository/index.md @@ -57,7 +57,7 @@ Once built, a chart can be uploaded to the desired channel with `curl` or `helm - ``: the GitLab username or the deploy token username. - ``: the personal access token or the deploy token. - ``: the project ID (like `42`) or the - [URL-encoded](../../../api/rest/index.md#namespaced-path-encoding) path of the project (like `group%2Fproject`). + [URL-encoded](../../../api/rest/index.md#namespaced-paths) path of the project (like `group%2Fproject`). - ``: the name of the channel (like `stable`). - With the [`helm cm-push`](https://github.com/chartmuseum/helm-push/#readme) plugin: diff --git a/doc/user/packages/pypi_repository/index.md b/doc/user/packages/pypi_repository/index.md index c493ffa4364..9813c56b10b 100644 --- a/doc/user/packages/pypi_repository/index.md +++ b/doc/user/packages/pypi_repository/index.md @@ -53,7 +53,7 @@ password = ``` The `` is either the project's -[URL-encoded](../../../api/rest/index.md#namespaced-path-encoding) +[URL-encoded](../../../api/rest/index.md#namespaced-paths) path (for example, `group%2Fproject`), or the project's ID (for example `42`). ### Authenticate with a deploy token @@ -72,7 +72,7 @@ password = ``` The `` is either the project's -[URL-encoded](../../../api/rest/index.md#namespaced-path-encoding) +[URL-encoded](../../../api/rest/index.md#namespaced-paths) path (for example, `group%2Fproject`), or the project's ID (for example `42`). ### Authenticate with a CI job token @@ -224,7 +224,7 @@ pip install --index-url https://:` is the package name. - `` is a personal access token name with the `read_api` scope. - `` is a personal access token with the `read_api` scope. -- `` is either the project's [URL-encoded](../../../api/rest/index.md#namespaced-path-encoding) +- `` is either the project's [URL-encoded](../../../api/rest/index.md#namespaced-paths) path (for example, `group%2Fproject`), or the project's ID (for example `42`). In these commands, you can use `--extra-index-url` instead of `--index-url`. However, using diff --git a/doc/user/packages/terraform_module_registry/index.md b/doc/user/packages/terraform_module_registry/index.md index abb69ef9c05..d6f259fffd6 100644 --- a/doc/user/packages/terraform_module_registry/index.md +++ b/doc/user/packages/terraform_module_registry/index.md @@ -63,7 +63,7 @@ PUT /projects/:id/packages/terraform/modules/:module-name/:module-system/:module | Attribute | Type | Required | Description | | -------------------| --------------- | ---------| -------------------------------------------------------------------------------------------------------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../../../api/rest/index.md#namespaced-path-encoding). | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](../../../api/rest/index.md#namespaced-paths). | | `module-name` | string | yes | The module name. **Supported syntax**: One to 64 ASCII characters, including lowercase letters (a-z) and digits (0-9). The module name can't exceed 64 characters. | | `module-system` | string | yes | The module system. **Supported syntax**: One to 64 ASCII characters, including lowercase letters (a-z) and digits (0-9). The module system can't exceed 64 characters. More information can be found in the [Terraform Module Registry protocol documentation](https://www.terraform.io/internals/module-registry-protocol). | | `module-version` | string | yes | The module version. It must be valid according to the [semantic versioning specification](https://semver.org/). | diff --git a/doc/user/project/issues/create_issues.md b/doc/user/project/issues/create_issues.md index b8bd2025c2e..b244138ed06 100644 --- a/doc/user/project/issues/create_issues.md +++ b/doc/user/project/issues/create_issues.md @@ -160,10 +160,10 @@ HTML page to create issues with certain fields prefilled. | Field | URL parameter | Notes | | -------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| Title | `issue[title]` | Must be [URL-encoded](../../../api/rest/index.md#namespaced-path-encoding). | +| Title | `issue[title]` | Must be [URL-encoded](../../../api/rest/index.md#namespaced-paths). | | Issue type | `issue[issue_type]` | Either `incident` or `issue`. | -| Description template | `issuable_template` | Must be [URL-encoded](../../../api/rest/index.md#namespaced-path-encoding). | -| Description | `issue[description]` | Must be [URL-encoded](../../../api/rest/index.md#namespaced-path-encoding). If used in combination with `issuable_template` or a [default issue template](../description_templates.md#set-a-default-template-for-merge-requests-and-issues), the `issue[description]` value is appended to the template. | +| Description template | `issuable_template` | Must be [URL-encoded](../../../api/rest/index.md#namespaced-paths). | +| Description | `issue[description]` | Must be [URL-encoded](../../../api/rest/index.md#namespaced-paths). If used in combination with `issuable_template` or a [default issue template](../description_templates.md#set-a-default-template-for-merge-requests-and-issues), the `issue[description]` value is appended to the template. | | Confidential | `issue[confidential]` | If `true`, the issue is marked as confidential. | | Relate to… | `add_related_issue` | A numeric issue ID. If present, the issue form shows a [**Relate to** checkbox](#from-another-issue-or-incident) to optionally link the new issue to the specified existing issue. | diff --git a/doc/user/project/repository/index.md b/doc/user/project/repository/index.md index 53733215423..22ee2fb9157 100644 --- a/doc/user/project/repository/index.md +++ b/doc/user/project/repository/index.md @@ -179,7 +179,7 @@ After you change a path, you must update the existing URL in the following resou - [Include statements](../../../ci/yaml/includes.md) except [`include:component`](../../../ci/components/index.md), otherwise pipelines fail with a syntax error. CI/CD component references can follow redirects. -- Namespaced API calls that use the [encoded path](../../../api/rest/index.md#namespaced-path-encoding) +- Namespaced API calls that use the [encoded path](../../../api/rest/index.md#namespaced-paths) instead of the numeric namespace and project IDs. - [Docker image references](../../../ci/yaml/index.md#image). - Variables that specify a project or namespace. diff --git a/spec/factories/packages/helm/file_metadatum.rb b/spec/factories/packages/helm/file_metadatum.rb index a15f9f386d5..5658a4238c0 100644 --- a/spec/factories/packages/helm/file_metadatum.rb +++ b/spec/factories/packages/helm/file_metadatum.rb @@ -4,6 +4,7 @@ FactoryBot.define do factory :helm_file_metadatum, class: 'Packages::Helm::FileMetadatum' do transient do description { nil } + app_version { nil } end package_file { association(:helm_package_file, without_loaded_metadatum: true) } @@ -15,6 +16,7 @@ FactoryBot.define do apiVersion: 'v2' }.tap do |defaults| defaults['description'] = description if description + defaults['appVersion'] = app_version if app_version end end end diff --git a/spec/factories/packages/package_files.rb b/spec/factories/packages/package_files.rb index 8260bb8706e..98cbe129031 100644 --- a/spec/factories/packages/package_files.rb +++ b/spec/factories/packages/package_files.rb @@ -231,11 +231,16 @@ FactoryBot.define do sequence(:package_version) { |n| package&.version || "v#{n}" } channel { 'stable' } description { nil } + app_version { nil } end after :create do |package_file, evaluator| unless evaluator.without_loaded_metadatum - create :helm_file_metadatum, package_file: package_file, channel: evaluator.channel, description: evaluator.description + create :helm_file_metadatum, + package_file: package_file, + channel: evaluator.channel, + description: evaluator.description, + app_version: evaluator.app_version end end end diff --git a/spec/frontend/dompurify_verison_spec.js b/spec/frontend/dompurify_verison_spec.js new file mode 100644 index 00000000000..a253fcf274c --- /dev/null +++ b/spec/frontend/dompurify_verison_spec.js @@ -0,0 +1,13 @@ +describe('dompurify dependency', () => { + it('should not be updated unless mermaid is verified', () => { + // why: We use `require` so that we don't have to manually dig through node_modules + // eslint-disable-next-line global-require + const { version } = require('dompurify/package.json'); + + // NOTE: Bumping this to 3.1.7 breaks mermaid diagrams. When upgrading DOMPurify, you **must** manually verify that + // mermaid diagrams work visually before fixing this test. For more context: + // - https://gitlab.com/gitlab-org/gitlab/-/merge_requests/167644 + // - https://github.com/cure53/DOMPurify/issues/1002#issuecomment-2381258197 + expect(version).toEqual('3.1.6'); + }); +}); diff --git a/spec/frontend/fixtures/timelogs.rb b/spec/frontend/fixtures/timelogs.rb index c66e2447ea6..ccd858024af 100644 --- a/spec/frontend/fixtures/timelogs.rb +++ b/spec/frontend/fixtures/timelogs.rb @@ -8,7 +8,6 @@ RSpec.describe 'Timelogs (GraphQL fixtures)', feature_category: :team_planning d include GraphqlHelpers include JavaScriptFixturesHelpers - let_it_be(:guest) { create(:user) } let_it_be(:developer) { create(:user) } context 'for time tracking timelogs' do @@ -19,12 +18,11 @@ RSpec.describe 'Timelogs (GraphQL fixtures)', feature_category: :team_planning d let(:query) { get_graphql_query_as_string(query_path) } before_all do - project.add_guest(guest) project.add_developer(developer) end it "graphql/get_timelogs_empty_response.json" do - post_graphql(query, current_user: guest, variables: { username: guest.username }) + post_graphql(query, current_user: developer, variables: { username: developer.username }) expect_graphql_errors_to_be_empty end @@ -33,7 +31,7 @@ RSpec.describe 'Timelogs (GraphQL fixtures)', feature_category: :team_planning d let_it_be(:timelogs) { create_list(:timelog, 6, user: developer, issue: issue, time_spent: 4 * 60 * 60) } it "graphql/get_non_paginated_timelogs_response.json" do - post_graphql(query, current_user: guest, variables: { username: developer.username }) + post_graphql(query, current_user: developer, variables: { username: developer.username }) expect_graphql_errors_to_be_empty end @@ -43,7 +41,7 @@ RSpec.describe 'Timelogs (GraphQL fixtures)', feature_category: :team_planning d let_it_be(:timelogs) { create_list(:timelog, 30, user: developer, issue: issue, time_spent: 4 * 60 * 60) } it "graphql/get_paginated_timelogs_response.json" do - post_graphql(query, current_user: guest, variables: { username: developer.username, first: 25 }) + post_graphql(query, current_user: developer, variables: { username: developer.username, first: 25 }) expect_graphql_errors_to_be_empty end diff --git a/spec/frontend/search/sidebar/components/blobs_filters_spec.js b/spec/frontend/search/sidebar/components/blobs_filters_spec.js index b5cbffadd2b..1ae2636e3b7 100644 --- a/spec/frontend/search/sidebar/components/blobs_filters_spec.js +++ b/spec/frontend/search/sidebar/components/blobs_filters_spec.js @@ -20,7 +20,7 @@ describe('GlobalSearch BlobsFilters', () => { const defaultGetters = { currentScope: () => 'blobs', - hasProjectContext: () => true, + hasMissingProjectContext: () => true, }; const createComponent = (initialState = { searchType: SEARCH_TYPE_ADVANCED }) => { @@ -70,7 +70,7 @@ describe('GlobalSearch BlobsFilters', () => { ${SEARCH_TYPE_ZOEKT} | ${false} | ${false} `('sidebar blobs fork filter:', ({ searchType, hasProjectContent, isShown }) => { beforeEach(() => { - defaultGetters.hasProjectContext = () => hasProjectContent; + defaultGetters.hasMissingProjectContext = () => hasProjectContent; createComponent({ searchType }); }); @@ -89,7 +89,7 @@ describe('GlobalSearch BlobsFilters', () => { ${SEARCH_TYPE_ZOEKT} | ${false} | ${false} `('sidebar blobs archived filter:', ({ searchType, hasProjectContent, isShown }) => { beforeEach(() => { - defaultGetters.hasProjectContext = () => hasProjectContent; + defaultGetters.hasMissingProjectContext = () => hasProjectContent; createComponent({ searchType }); }); diff --git a/spec/frontend/search/sidebar/components/commits_filters_spec.js b/spec/frontend/search/sidebar/components/commits_filters_spec.js index 64fb6e6203d..4ff50c87bd1 100644 --- a/spec/frontend/search/sidebar/components/commits_filters_spec.js +++ b/spec/frontend/search/sidebar/components/commits_filters_spec.js @@ -12,7 +12,7 @@ describe('GlobalSearch CommitsFilters', () => { let wrapper; const defaultGetters = { - hasProjectContext: () => true, + hasMissingProjectContext: () => true, }; const createComponent = () => { @@ -41,9 +41,9 @@ describe('GlobalSearch CommitsFilters', () => { }); }); - describe('hasProjectContext getter', () => { + describe('hasMissingProjectContext getter', () => { beforeEach(() => { - defaultGetters.hasProjectContext = () => false; + defaultGetters.hasMissingProjectContext = () => false; createComponent(); }); diff --git a/spec/frontend/search/sidebar/components/issues_filters_spec.js b/spec/frontend/search/sidebar/components/issues_filters_spec.js index 811960eef7b..473c8895230 100644 --- a/spec/frontend/search/sidebar/components/issues_filters_spec.js +++ b/spec/frontend/search/sidebar/components/issues_filters_spec.js @@ -17,7 +17,7 @@ describe('GlobalSearch IssuesFilters', () => { const defaultGetters = { currentScope: () => 'issues', - hasProjectContext: () => true, + hasMissingProjectContext: () => true, }; const createComponent = ({ initialState = {} } = {}) => { @@ -83,9 +83,9 @@ describe('GlobalSearch IssuesFilters', () => { }); }); - describe('hasProjectContext getter', () => { + describe('hasMissingProjectContext getter', () => { beforeEach(() => { - defaultGetters.hasProjectContext = () => false; + defaultGetters.hasMissingProjectContext = () => false; createComponent(); }); diff --git a/spec/frontend/search/sidebar/components/merge_requests_filters_spec.js b/spec/frontend/search/sidebar/components/merge_requests_filters_spec.js index 7ab035af2b8..c9ef8488b38 100644 --- a/spec/frontend/search/sidebar/components/merge_requests_filters_spec.js +++ b/spec/frontend/search/sidebar/components/merge_requests_filters_spec.js @@ -16,7 +16,7 @@ describe('GlobalSearch MergeRequestsFilters', () => { const defaultGetters = { currentScope: () => 'merge_requests', - hasProjectContext: () => true, + hasMissingProjectContext: () => true, }; const createComponent = (initialState = {}) => { @@ -77,9 +77,9 @@ describe('GlobalSearch MergeRequestsFilters', () => { }); }); - describe('hasProjectContext getter', () => { + describe('hasMissingProjectContext getter', () => { beforeEach(() => { - defaultGetters.hasProjectContext = () => false; + defaultGetters.hasMissingProjectContext = () => false; createComponent(); }); diff --git a/spec/frontend/search/sidebar/components/milestones_filters_spec.js b/spec/frontend/search/sidebar/components/milestones_filters_spec.js index 2a4989e48fc..4183bdc558e 100644 --- a/spec/frontend/search/sidebar/components/milestones_filters_spec.js +++ b/spec/frontend/search/sidebar/components/milestones_filters_spec.js @@ -12,7 +12,7 @@ describe('GlobalSearch MilestonesFilters', () => { let wrapper; const defaultGetters = { - hasProjectContext: () => true, + hasMissingProjectContext: () => true, }; const findArchivedFilter = () => wrapper.findComponent(ArchivedFilter); @@ -41,9 +41,9 @@ describe('GlobalSearch MilestonesFilters', () => { }); }); - describe('hasProjectContext getter', () => { + describe('hasMissingProjectContext getter', () => { beforeEach(() => { - defaultGetters.hasProjectContext = () => false; + defaultGetters.hasMissingProjectContext = () => false; createComponent(); }); diff --git a/spec/frontend/search/sidebar/components/notes_filters_spec.js b/spec/frontend/search/sidebar/components/notes_filters_spec.js index 17b197507e6..d10cdffacbe 100644 --- a/spec/frontend/search/sidebar/components/notes_filters_spec.js +++ b/spec/frontend/search/sidebar/components/notes_filters_spec.js @@ -12,7 +12,7 @@ describe('GlobalSearch ProjectsFilters', () => { let wrapper; const defaultGetters = { - hasProjectContext: () => true, + hasMissingProjectContext: () => true, }; const createComponent = () => { @@ -41,9 +41,9 @@ describe('GlobalSearch ProjectsFilters', () => { }); }); - describe('hasProjectContext getter', () => { + describe('hasMissingProjectContext getter', () => { beforeEach(() => { - defaultGetters.hasProjectContext = () => false; + defaultGetters.hasMissingProjectContext = () => false; createComponent(); }); diff --git a/spec/frontend/search/sidebar/components/wiki_blobs_filters_spec.js b/spec/frontend/search/sidebar/components/wiki_blobs_filters_spec.js index ddb820d0543..2e6d438db93 100644 --- a/spec/frontend/search/sidebar/components/wiki_blobs_filters_spec.js +++ b/spec/frontend/search/sidebar/components/wiki_blobs_filters_spec.js @@ -12,7 +12,7 @@ describe('GlobalSearch WikiBlobsFilters', () => { let wrapper; const defaultGetters = { - hasProjectContext: () => true, + hasMissingProjectContext: () => true, }; const createComponent = () => { @@ -41,9 +41,9 @@ describe('GlobalSearch WikiBlobsFilters', () => { }); }); - describe('hasProjectContext getter', () => { + describe('hasMissingProjectContext getter', () => { beforeEach(() => { - defaultGetters.hasProjectContext = () => false; + defaultGetters.hasMissingProjectContext = () => false; createComponent(); }); diff --git a/spec/frontend/search/store/getters_spec.js b/spec/frontend/search/store/getters_spec.js index e3c4240d9ed..a610353663f 100644 --- a/spec/frontend/search/store/getters_spec.js +++ b/spec/frontend/search/store/getters_spec.js @@ -159,15 +159,19 @@ describe('Global Search Store Getters', () => { expect(getters.unappliedNewLabels(state).map(({ key }) => key)).toStrictEqual(['6', '73']); }); }); - describe('hasProjectContext', () => { - it('returns true project_id is NOT in query', () => { - state.query.project_id = undefined; - expect(getters.hasProjectContext(state)).toBe(true); + describe('hasMissingProjectContext', () => { + it('returns true projectInitialJson.id is NOT in query', () => { + state.projectInitialJson = { + id: undefined, + }; + expect(getters.hasMissingProjectContext(state)).toBe(true); }); - it('returns false project_id is in query', () => { - state.query.project_id = 'test'; - expect(getters.hasProjectContext(state)).toBe(false); + it('returns false projectInitialJson.id is in query', () => { + state.projectInitialJson = { + id: 'test', + }; + expect(getters.hasMissingProjectContext(state)).toBe(false); }); }); }); diff --git a/spec/graphql/resolvers/timelog_resolver_spec.rb b/spec/graphql/resolvers/timelog_resolver_spec.rb index c4253f4b9bc..8dacb254f15 100644 --- a/spec/graphql/resolvers/timelog_resolver_spec.rb +++ b/spec/graphql/resolvers/timelog_resolver_spec.rb @@ -224,7 +224,7 @@ RSpec.describe Resolvers::TimelogResolver, feature_category: :team_planning do end end - shared_examples 'with a user' do + shared_examples 'with the current user' do let_it_be(:short_time_ago) { 5.days.ago.beginning_of_day } let_it_be(:medium_time_ago) { 15.days.ago.beginning_of_day } @@ -235,8 +235,8 @@ RSpec.describe Resolvers::TimelogResolver, feature_category: :team_planning do let_it_be(:timelog2) { create(:issue_timelog, issue: issue, user: create(:user)) } let_it_be(:timelog3) { create(:merge_request_timelog, merge_request: merge_request, user: current_user) } - it 'blah' do - if user_found + it 'returns the expected records' do + if timelogs_found expect(timelogs).to contain_exactly(timelog1, timelog3) else expect(timelogs).to be_empty @@ -276,9 +276,9 @@ RSpec.describe Resolvers::TimelogResolver, feature_category: :team_planning do let(:object) { current_user } let(:extra_args) { {} } let(:args) { {} } - let(:user_found) { true } + let(:timelogs_found) { true } - it_behaves_like 'with a user' + it_behaves_like 'with the current user' end context 'with a user filter' do @@ -287,16 +287,19 @@ RSpec.describe Resolvers::TimelogResolver, feature_category: :team_planning do context 'when the user has timelogs' do let(:extra_args) { { username: current_user.username } } - let(:user_found) { true } + let(:timelogs_found) { true } - it_behaves_like 'with a user' + it_behaves_like 'with the current user' end context 'when the user doest not have timelogs' do - let(:extra_args) { { username: 'not_existing_user' } } - let(:user_found) { false } + let(:user) { create(:user) } - it_behaves_like 'with a user' + let(:extra_args) { { username: user.username } } + let(:args) { { user: user } } + let(:timelogs_found) { false } + + it_behaves_like 'with the current user' end end @@ -306,7 +309,10 @@ RSpec.describe Resolvers::TimelogResolver, feature_category: :team_planning do let(:extra_args) { {} } it 'generates an error' do - expect_graphql_error_to_be_created(error_class, /Provide at least one argument/) do + expect_graphql_error_to_be_created( + error_class, + /Non-admin users must provide a group_id, project_id, or current username/ + ) do timelogs end end diff --git a/spec/presenters/packages/helm/index_presenter_spec.rb b/spec/presenters/packages/helm/index_presenter_spec.rb index 38e1dc17f49..848b22f5b6c 100644 --- a/spec/presenters/packages/helm/index_presenter_spec.rb +++ b/spec/presenters/packages/helm/index_presenter_spec.rb @@ -11,7 +11,13 @@ RSpec.describe Packages::Helm::IndexPresenter do let_it_be(:package_files3_2) { create(:helm_package_file, package: packages[2], file_sha256: '3_2', file_name: 'file3_2') } let_it_be(:package_files4_1) { create(:helm_package_file, package: packages[3], file_sha256: '4_1', file_name: 'file4_1') } let_it_be(:package_files4_2) { create(:helm_package_file, package: packages[3], file_sha256: '4_2', file_name: 'file4_2') } - let_it_be(:package_files4_3) { create(:helm_package_file, package: packages[3], file_sha256: '4_3', file_name: 'file4_3') } + let_it_be(:package_files4_3) do + create(:helm_package_file, + package: packages[3], + file_sha256: '4_3', + file_name: 'file4_3', + app_version: '1234e004') + end let(:project_id_param) { project.id } let(:channel) { 'stable' } @@ -34,6 +40,12 @@ RSpec.describe Packages::Helm::IndexPresenter do expect(raw['created']).to eq(file.created_at.utc.strftime('%Y-%m-%dT%H:%M:%S.%NZ')) expect(raw['digest']).to eq(file.file_sha256) expect(raw['urls']).to eq(["charts/#{file.file_name}"]) + + if file.helm_file_metadatum.metadata['appVersion'] + expect(raw['appVersion']).to eq("\"1234e004\"") + else + expect(raw).not_to have_key('appVersion') + end end end diff --git a/spec/requests/api/graphql/timelogs_spec.rb b/spec/requests/api/graphql/timelogs_spec.rb new file mode 100644 index 00000000000..71264fcd8ae --- /dev/null +++ b/spec/requests/api/graphql/timelogs_spec.rb @@ -0,0 +1,121 @@ +# frozen_string_literal: true + +require 'spec_helper' + +RSpec.describe 'Timelogs', feature_category: :team_planning do + include GraphqlHelpers + + let_it_be(:user) { create(:user) } + let_it_be(:group) { create(:group, reporters: user) } + let_it_be(:project) { create(:project, group: group) } + let_it_be(:user_project) { create(:project, reporters: user) } + + let_it_be(:user_issue) { create(:issue, project: user_project) } + let_it_be(:group_issue) { create(:issue, project: create(:project, group: group)) } + let_it_be(:project_issue) { create(:issue, project: project) } + + let_it_be(:user_timelog) { create(:timelog, user: user, issue: user_issue) } + let_it_be(:group_timelog) { create(:timelog, issue: group_issue) } + let_it_be(:project_timelog) { create(:timelog, issue: project_issue) } + + let(:params) { {} } + let(:group_id) { "gid://gitlab/Group/#{group.id}" } + let(:project_id) { "gid://gitlab/Project/#{project.id}" } + let(:current_user) { user } + + subject(:execute_query) { post_graphql(query, current_user: current_user) } + + shared_examples 'an OK response with no errors' do + it 'returns no error message' do + execute_query + + expect(response).to have_gitlab_http_status(:ok) + expect(graphql_errors).to be_nil + end + end + + shared_examples 'a response containing the correct timelogs' do + it 'returns the expected timelogs' do + execute_query + + expect(graphql_data_at(:timelogs, :nodes).pluck('id')).to match_array(expected_timelogs) + end + end + + context 'with no parameters' do + context 'when not an admin' do + it 'returns an error message' do + execute_query + + expect(response).to have_gitlab_http_status(:ok) + expect(graphql_errors).to contain_exactly( + a_hash_including('message' => 'Non-admin users must provide a group_id, project_id, or current username') + ) + end + end + + context 'when an admin' do + let!(:current_user) { create(:user, :admin) } + + it_behaves_like 'an OK response with no errors' + end + end + + context 'with group_id parameter' do + let(:params) { { group_id: group_id } } + let(:expected_timelogs) do + [ + "gid://gitlab/Timelog/#{project_timelog.id}", + "gid://gitlab/Timelog/#{group_timelog.id}" + ] + end + + it_behaves_like 'an OK response with no errors' + it_behaves_like 'a response containing the correct timelogs' + end + + context 'with project_id parameter' do + let(:params) { { project_id: project_id } } + let(:expected_timelogs) { ["gid://gitlab/Timelog/#{project_timelog.id}"] } + + it_behaves_like 'an OK response with no errors' + it_behaves_like 'a response containing the correct timelogs' + end + + context 'with username parameter' do + context 'when current user' do + let(:params) { { username: user.username } } + let(:expected_timelogs) { ["gid://gitlab/Timelog/#{user_timelog.id}"] } + + it_behaves_like 'an OK response with no errors' + it_behaves_like 'a response containing the correct timelogs' + end + + context 'when not current user' do + let(:params) { { username: 'username' } } + + it 'returns an error message' do + execute_query + + expect(response).to have_gitlab_http_status(:ok) + expect(graphql_errors).to contain_exactly( + a_hash_including('message' => 'Non-admin users must provide a group_id, project_id, or current username') + ) + end + end + end + + def query + timelog_nodes = <<~NODE + nodes { + id + } + NODE + + graphql_query_for( + :timelogs, + { **params }, + timelog_nodes + ) + end +end diff --git a/spec/services/import/reassign_placeholder_user_records_service_spec.rb b/spec/services/import/reassign_placeholder_user_records_service_spec.rb index cbe1c9ae3a7..cace45aab4f 100644 --- a/spec/services/import/reassign_placeholder_user_records_service_spec.rb +++ b/spec/services/import/reassign_placeholder_user_records_service_spec.rb @@ -276,6 +276,20 @@ RSpec.describe Import::ReassignPlaceholderUserRecordsService, feature_category: end end + context 'when user has existing same level INHERITED membership' do + before_all do + namespace.add_reporter(real_user) + end + + it 'still creates the project membership' do + expect { service.execute }.to change { project.reload.members.count }.to(1) + end + + it 'still creates the group membership' do + expect { service.execute }.to change { subgroup.reload.members.count }.to(1) + end + end + context 'when user has existing higher level INHERITED membership' do before_all do namespace.add_owner(real_user) @@ -293,7 +307,7 @@ RSpec.describe Import::ReassignPlaceholderUserRecordsService, feature_category: it 'does not create the project membership, and logs' do expect_skipped_membership_log( - 'Existing membership of same or higher access level found for user, skipping', + 'Existing membership of higher access level found for user, skipping', { 'project_id' => project.id }, existing_membership_logged_params ) @@ -302,7 +316,7 @@ RSpec.describe Import::ReassignPlaceholderUserRecordsService, feature_category: it 'does not create the group membership, and logs' do expect_skipped_membership_log( - 'Existing membership of same or higher access level found for user, skipping', + 'Existing membership of higher access level found for user, skipping', { 'group_id' => subgroup.id }, existing_membership_logged_params ) @@ -317,7 +331,7 @@ RSpec.describe Import::ReassignPlaceholderUserRecordsService, feature_category: it 'does not create a new membership, and logs' do expect_skipped_membership_log( - 'Existing direct membership of lower access level found for user, skipping', + 'Existing direct membership of lower or equal access level found for user, skipping', { 'project_id' => project.id }, @@ -334,6 +348,30 @@ RSpec.describe Import::ReassignPlaceholderUserRecordsService, feature_category: end end + context 'when user has existing same level DIRECT membership' do + before_all do + project.add_developer(real_user) + end + + it 'does not create a new membership, and logs' do + expect_skipped_membership_log( + 'Existing direct membership of lower or equal access level found for user, skipping', + { + 'project_id' => project.id + }, + { + 'id' => real_user.members.first.id, + 'access_level' => Gitlab::Access::DEVELOPER, + 'source_id' => project.id, + 'source_type' => 'Project', + 'user_id' => real_user.id + } + ) + + expect { service.execute }.not_to change { project.reload.members.count } + end + end + context 'when user has existing higher level DIRECT membership' do before_all do project.add_owner(real_user)