diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-01-08 03:07:43 +0300 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-01-08 03:07:43 +0300 |
| commit | 2b3bfe8fc59ed4cdc385955cdb38cbd481b45426 (patch) | |
| tree | 6b570a8d134fb2beeacf11bbcc79ff22123156ec /doc | |
| parent | d203316c80aa27cf747aa29df9f7c2d374965b5f (diff) | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/administration/geo/replication/troubleshooting.md | 34 | ||||
| -rw-r--r-- | doc/api/graphql/reference/gitlab_schema.graphql | 177 | ||||
| -rw-r--r-- | doc/api/graphql/reference/gitlab_schema.json | 186 | ||||
| -rw-r--r-- | doc/api/graphql/reference/index.md | 173 | ||||
| -rw-r--r-- | doc/api/projects.md | 15 | ||||
| -rw-r--r-- | doc/development/api_graphql_styleguide.md | 2 | ||||
| -rw-r--r-- | doc/development/testing_guide/best_practices.md | 1 | ||||
| -rw-r--r-- | doc/user/project/issues/img/disable_issue_auto_close.png | bin | 0 -> 48055 bytes | |||
| -rw-r--r-- | doc/user/project/issues/managing_issues.md | 13 |
9 files changed, 342 insertions, 259 deletions
diff --git a/doc/administration/geo/replication/troubleshooting.md b/doc/administration/geo/replication/troubleshooting.md index 0a2602261d1..e60a70d57c9 100644 --- a/doc/administration/geo/replication/troubleshooting.md +++ b/doc/administration/geo/replication/troubleshooting.md @@ -318,6 +318,40 @@ Slots where `active` is `f` are not active. SELECT pg_drop_replication_slot('<name_of_extra_slot>'); ``` +### Message: "ERROR: canceling statement due to conflict with recovery" + +This error may rarely occur under normal usage, and the system is resilient +enough to recover. + +However, under certain conditions, some database queries on secondaries may run +excessively long, which increases the frequency of this error. At some point, +some of these queries will never be able to complete due to being canceled +every time. + +These long-running queries are +[planned to be removed in the future](https://gitlab.com/gitlab-org/gitlab/issues/34269), +but as a workaround, we recommend enabling +[hot_standby_feedback](https://www.postgresql.org/docs/10/hot-standby.html#HOT-STANDBY-CONFLICT). +This increases the likelihood of bloat on the **primary** node as it prevents +`VACUUM` from removing recently-dead rows. However, it has been used +successfully in production on GitLab.com. + +To enable `hot_standby_feedback`, add the following to `/etc/gitlab/gitlab.rb` +on the **secondary** node: + +```ruby +postgresql['hot_standby_feedback'] = 'on' +``` + +Then reconfigure GitLab: + +```sh +sudo gitlab-ctl reconfigure +``` + +To help us resolve this problem, consider commenting on +[the issue](https://gitlab.com/gitlab-org/gitlab/issues/4489). + ### Very large repositories never successfully synchronize on the **secondary** node GitLab places a timeout on all repository clones, including project imports diff --git a/doc/api/graphql/reference/gitlab_schema.graphql b/doc/api/graphql/reference/gitlab_schema.graphql index 731d6dc05cd..5c6dd93a676 100644 --- a/doc/api/graphql/reference/gitlab_schema.graphql +++ b/doc/api/graphql/reference/gitlab_schema.graphql @@ -1668,7 +1668,7 @@ type Epic implements Noteable { state: EpicState! """ - Boolean flag for whether the currently logged in user is subscribed to this epic + Indicates the currently logged in user is subscribed to the epic """ subscribed: Boolean! @@ -1984,7 +1984,7 @@ type EpicIssue implements Noteable { state: IssueState! """ - Boolean flag for whether the currently logged in user is subscribed to this issue + Indicates the currently logged in user is subscribed to the issue """ subscribed: Boolean! @@ -2089,42 +2089,42 @@ Check permissions for the current user on an epic """ type EpicPermissions { """ - Whether or not a user can perform `admin_epic` on this resource + Indicates the user can perform `admin_epic` on this resource """ adminEpic: Boolean! """ - Whether or not a user can perform `award_emoji` on this resource + Indicates the user can perform `award_emoji` on this resource """ awardEmoji: Boolean! """ - Whether or not a user can perform `create_epic` on this resource + Indicates the user can perform `create_epic` on this resource """ createEpic: Boolean! """ - Whether or not a user can perform `create_note` on this resource + Indicates the user can perform `create_note` on this resource """ createNote: Boolean! """ - Whether or not a user can perform `destroy_epic` on this resource + Indicates the user can perform `destroy_epic` on this resource """ destroyEpic: Boolean! """ - Whether or not a user can perform `read_epic` on this resource + Indicates the user can perform `read_epic` on this resource """ readEpic: Boolean! """ - Whether or not a user can perform `read_epic_iid` on this resource + Indicates the user can perform `read_epic_iid` on this resource """ readEpicIid: Boolean! """ - Whether or not a user can perform `update_epic` on this resource + Indicates the user can perform `update_epic` on this resource """ updateEpic: Boolean! } @@ -2585,7 +2585,7 @@ type Group { type GroupPermissions { """ - Whether or not a user can perform `read_group` on this resource + Indicates the user can perform `read_group` on this resource """ readGroup: Boolean! } @@ -2816,7 +2816,7 @@ type Issue implements Noteable { state: IssueState! """ - Boolean flag for whether the currently logged in user is subscribed to this issue + Indicates the currently logged in user is subscribed to the issue """ subscribed: Boolean! @@ -2921,42 +2921,42 @@ Check permissions for the current user on a issue """ type IssuePermissions { """ - Whether or not a user can perform `admin_issue` on this resource + Indicates the user can perform `admin_issue` on this resource """ adminIssue: Boolean! """ - Whether or not a user can perform `create_design` on this resource + Indicates the user can perform `create_design` on this resource """ createDesign: Boolean! """ - Whether or not a user can perform `create_note` on this resource + Indicates the user can perform `create_note` on this resource """ createNote: Boolean! """ - Whether or not a user can perform `destroy_design` on this resource + Indicates the user can perform `destroy_design` on this resource """ destroyDesign: Boolean! """ - Whether or not a user can perform `read_design` on this resource + Indicates the user can perform `read_design` on this resource """ readDesign: Boolean! """ - Whether or not a user can perform `read_issue` on this resource + Indicates the user can perform `read_issue` on this resource """ readIssue: Boolean! """ - Whether or not a user can perform `reopen_issue` on this resource + Indicates the user can perform `reopen_issue` on this resource """ reopenIssue: Boolean! """ - Whether or not a user can perform `update_issue` on this resource + Indicates the user can perform `update_issue` on this resource """ updateIssue: Boolean! } @@ -3714,42 +3714,42 @@ Check permissions for the current user on a merge request """ type MergeRequestPermissions { """ - Whether or not a user can perform `admin_merge_request` on this resource + Indicates the user can perform `admin_merge_request` on this resource """ adminMergeRequest: Boolean! """ - Whether or not a user can perform `cherry_pick_on_current_merge_request` on this resource + Indicates the user can perform `cherry_pick_on_current_merge_request` on this resource """ cherryPickOnCurrentMergeRequest: Boolean! """ - Whether or not a user can perform `create_note` on this resource + Indicates the user can perform `create_note` on this resource """ createNote: Boolean! """ - Whether or not a user can perform `push_to_source_branch` on this resource + Indicates the user can perform `push_to_source_branch` on this resource """ pushToSourceBranch: Boolean! """ - Whether or not a user can perform `read_merge_request` on this resource + Indicates the user can perform `read_merge_request` on this resource """ readMergeRequest: Boolean! """ - Whether or not a user can perform `remove_source_branch` on this resource + Indicates the user can perform `remove_source_branch` on this resource """ removeSourceBranch: Boolean! """ - Whether or not a user can perform `revert_on_current_merge_request` on this resource + Indicates the user can perform `revert_on_current_merge_request` on this resource """ revertOnCurrentMergeRequest: Boolean! """ - Whether or not a user can perform `update_merge_request` on this resource + Indicates the user can perform `update_merge_request` on this resource """ updateMergeRequest: Boolean! } @@ -4362,27 +4362,27 @@ type NoteEdge { type NotePermissions { """ - Whether or not a user can perform `admin_note` on this resource + Indicates the user can perform `admin_note` on this resource """ adminNote: Boolean! """ - Whether or not a user can perform `award_emoji` on this resource + Indicates the user can perform `award_emoji` on this resource """ awardEmoji: Boolean! """ - Whether or not a user can perform `create_note` on this resource + Indicates the user can perform `create_note` on this resource """ createNote: Boolean! """ - Whether or not a user can perform `read_note` on this resource + Indicates the user can perform `read_note` on this resource """ readNote: Boolean! """ - Whether or not a user can perform `resolve_note` on this resource + Indicates the user can perform `resolve_note` on this resource """ resolveNote: Boolean! } @@ -4574,17 +4574,17 @@ type PipelineEdge { type PipelinePermissions { """ - Whether or not a user can perform `admin_pipeline` on this resource + Indicates the user can perform `admin_pipeline` on this resource """ adminPipeline: Boolean! """ - Whether or not a user can perform `destroy_pipeline` on this resource + Indicates the user can perform `destroy_pipeline` on this resource """ destroyPipeline: Boolean! """ - Whether or not a user can perform `update_pipeline` on this resource + Indicates the user can perform `update_pipeline` on this resource """ updatePipeline: Boolean! } @@ -4605,11 +4605,16 @@ enum PipelineStatusEnum { type Project { """ - Archived status of the project + Indicates the archived status of the project """ archived: Boolean """ + Indicates if issues referenced by merge requests and commits within the default branch are closed automatically + """ + autocloseReferencedIssues: Boolean + + """ URL to avatar image file of the project """ avatarUrl: String @@ -5145,207 +5150,207 @@ type ProjectEdge { type ProjectPermissions { """ - Whether or not a user can perform `admin_operations` on this resource + Indicates the user can perform `admin_operations` on this resource """ adminOperations: Boolean! """ - Whether or not a user can perform `admin_project` on this resource + Indicates the user can perform `admin_project` on this resource """ adminProject: Boolean! """ - Whether or not a user can perform `admin_remote_mirror` on this resource + Indicates the user can perform `admin_remote_mirror` on this resource """ adminRemoteMirror: Boolean! """ - Whether or not a user can perform `admin_wiki` on this resource + Indicates the user can perform `admin_wiki` on this resource """ adminWiki: Boolean! """ - Whether or not a user can perform `archive_project` on this resource + Indicates the user can perform `archive_project` on this resource """ archiveProject: Boolean! """ - Whether or not a user can perform `change_namespace` on this resource + Indicates the user can perform `change_namespace` on this resource """ changeNamespace: Boolean! """ - Whether or not a user can perform `change_visibility_level` on this resource + Indicates the user can perform `change_visibility_level` on this resource """ changeVisibilityLevel: Boolean! """ - Whether or not a user can perform `create_deployment` on this resource + Indicates the user can perform `create_deployment` on this resource """ createDeployment: Boolean! """ - Whether or not a user can perform `create_design` on this resource + Indicates the user can perform `create_design` on this resource """ createDesign: Boolean! """ - Whether or not a user can perform `create_issue` on this resource + Indicates the user can perform `create_issue` on this resource """ createIssue: Boolean! """ - Whether or not a user can perform `create_label` on this resource + Indicates the user can perform `create_label` on this resource """ createLabel: Boolean! """ - Whether or not a user can perform `create_merge_request_from` on this resource + Indicates the user can perform `create_merge_request_from` on this resource """ createMergeRequestFrom: Boolean! """ - Whether or not a user can perform `create_merge_request_in` on this resource + Indicates the user can perform `create_merge_request_in` on this resource """ createMergeRequestIn: Boolean! """ - Whether or not a user can perform `create_pages` on this resource + Indicates the user can perform `create_pages` on this resource """ createPages: Boolean! """ - Whether or not a user can perform `create_pipeline` on this resource + Indicates the user can perform `create_pipeline` on this resource """ createPipeline: Boolean! """ - Whether or not a user can perform `create_pipeline_schedule` on this resource + Indicates the user can perform `create_pipeline_schedule` on this resource """ createPipelineSchedule: Boolean! """ - Whether or not a user can perform `create_snippet` on this resource + Indicates the user can perform `create_snippet` on this resource """ createSnippet: Boolean! """ - Whether or not a user can perform `create_wiki` on this resource + Indicates the user can perform `create_wiki` on this resource """ createWiki: Boolean! """ - Whether or not a user can perform `destroy_design` on this resource + Indicates the user can perform `destroy_design` on this resource """ destroyDesign: Boolean! """ - Whether or not a user can perform `destroy_pages` on this resource + Indicates the user can perform `destroy_pages` on this resource """ destroyPages: Boolean! """ - Whether or not a user can perform `destroy_wiki` on this resource + Indicates the user can perform `destroy_wiki` on this resource """ destroyWiki: Boolean! """ - Whether or not a user can perform `download_code` on this resource + Indicates the user can perform `download_code` on this resource """ downloadCode: Boolean! """ - Whether or not a user can perform `download_wiki_code` on this resource + Indicates the user can perform `download_wiki_code` on this resource """ downloadWikiCode: Boolean! """ - Whether or not a user can perform `fork_project` on this resource + Indicates the user can perform `fork_project` on this resource """ forkProject: Boolean! """ - Whether or not a user can perform `push_code` on this resource + Indicates the user can perform `push_code` on this resource """ pushCode: Boolean! """ - Whether or not a user can perform `push_to_delete_protected_branch` on this resource + Indicates the user can perform `push_to_delete_protected_branch` on this resource """ pushToDeleteProtectedBranch: Boolean! """ - Whether or not a user can perform `read_commit_status` on this resource + Indicates the user can perform `read_commit_status` on this resource """ readCommitStatus: Boolean! """ - Whether or not a user can perform `read_cycle_analytics` on this resource + Indicates the user can perform `read_cycle_analytics` on this resource """ readCycleAnalytics: Boolean! """ - Whether or not a user can perform `read_design` on this resource + Indicates the user can perform `read_design` on this resource """ readDesign: Boolean! """ - Whether or not a user can perform `read_pages_content` on this resource + Indicates the user can perform `read_pages_content` on this resource """ readPagesContent: Boolean! """ - Whether or not a user can perform `read_project` on this resource + Indicates the user can perform `read_project` on this resource """ readProject: Boolean! """ - Whether or not a user can perform `read_project_member` on this resource + Indicates the user can perform `read_project_member` on this resource """ readProjectMember: Boolean! """ - Whether or not a user can perform `read_wiki` on this resource + Indicates the user can perform `read_wiki` on this resource """ readWiki: Boolean! """ - Whether or not a user can perform `remove_fork_project` on this resource + Indicates the user can perform `remove_fork_project` on this resource """ removeForkProject: Boolean! """ - Whether or not a user can perform `remove_pages` on this resource + Indicates the user can perform `remove_pages` on this resource """ removePages: Boolean! """ - Whether or not a user can perform `remove_project` on this resource + Indicates the user can perform `remove_project` on this resource """ removeProject: Boolean! """ - Whether or not a user can perform `rename_project` on this resource + Indicates the user can perform `rename_project` on this resource """ renameProject: Boolean! """ - Whether or not a user can perform `request_access` on this resource + Indicates the user can perform `request_access` on this resource """ requestAccess: Boolean! """ - Whether or not a user can perform `update_pages` on this resource + Indicates the user can perform `update_pages` on this resource """ updatePages: Boolean! """ - Whether or not a user can perform `update_wiki` on this resource + Indicates the user can perform `update_wiki` on this resource """ updateWiki: Boolean! """ - Whether or not a user can perform `upload_file` on this resource + Indicates the user can perform `upload_file` on this resource """ uploadFile: Boolean! } @@ -5909,32 +5914,32 @@ type SnippetEdge { type SnippetPermissions { """ - Whether or not a user can perform `admin_snippet` on this resource + Indicates the user can perform `admin_snippet` on this resource """ adminSnippet: Boolean! """ - Whether or not a user can perform `award_emoji` on this resource + Indicates the user can perform `award_emoji` on this resource """ awardEmoji: Boolean! """ - Whether or not a user can perform `create_note` on this resource + Indicates the user can perform `create_note` on this resource """ createNote: Boolean! """ - Whether or not a user can perform `read_snippet` on this resource + Indicates the user can perform `read_snippet` on this resource """ readSnippet: Boolean! """ - Whether or not a user can perform `report_snippet` on this resource + Indicates the user can perform `report_snippet` on this resource """ reportSnippet: Boolean! """ - Whether or not a user can perform `update_snippet` on this resource + Indicates the user can perform `update_snippet` on this resource """ updateSnippet: Boolean! } @@ -6360,7 +6365,7 @@ type ToggleAwardEmojiPayload { errors: [String!]! """ - True when the emoji was awarded, false when it was removed + Indicates the status of the emoji. True if the toggle awarded the emoji, and false if the toggle removed the emoji. """ toggledOn: Boolean! } @@ -6873,7 +6878,7 @@ type UserEdge { type UserPermissions { """ - Whether or not a user can perform `create_snippet` on this resource + Indicates the user can perform `create_snippet` on this resource """ createSnippet: Boolean! } diff --git a/doc/api/graphql/reference/gitlab_schema.json b/doc/api/graphql/reference/gitlab_schema.json index a68fe0e0e52..1357cab54fe 100644 --- a/doc/api/graphql/reference/gitlab_schema.json +++ b/doc/api/graphql/reference/gitlab_schema.json @@ -310,7 +310,21 @@ "fields": [ { "name": "archived", - "description": "Archived status of the project", + "description": "Indicates the archived status of the project", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "autocloseReferencedIssues", + "description": "Indicates if issues referenced by merge requests and commits within the default branch are closed automatically", "args": [ ], @@ -1600,7 +1614,7 @@ "fields": [ { "name": "adminOperations", - "description": "Whether or not a user can perform `admin_operations` on this resource", + "description": "Indicates the user can perform `admin_operations` on this resource", "args": [ ], @@ -1618,7 +1632,7 @@ }, { "name": "adminProject", - "description": "Whether or not a user can perform `admin_project` on this resource", + "description": "Indicates the user can perform `admin_project` on this resource", "args": [ ], @@ -1636,7 +1650,7 @@ }, { "name": "adminRemoteMirror", - "description": "Whether or not a user can perform `admin_remote_mirror` on this resource", + "description": "Indicates the user can perform `admin_remote_mirror` on this resource", "args": [ ], @@ -1654,7 +1668,7 @@ }, { "name": "adminWiki", - "description": "Whether or not a user can perform `admin_wiki` on this resource", + "description": "Indicates the user can perform `admin_wiki` on this resource", "args": [ ], @@ -1672,7 +1686,7 @@ }, { "name": "archiveProject", - "description": "Whether or not a user can perform `archive_project` on this resource", + "description": "Indicates the user can perform `archive_project` on this resource", "args": [ ], @@ -1690,7 +1704,7 @@ }, { "name": "changeNamespace", - "description": "Whether or not a user can perform `change_namespace` on this resource", + "description": "Indicates the user can perform `change_namespace` on this resource", "args": [ ], @@ -1708,7 +1722,7 @@ }, { "name": "changeVisibilityLevel", - "description": "Whether or not a user can perform `change_visibility_level` on this resource", + "description": "Indicates the user can perform `change_visibility_level` on this resource", "args": [ ], @@ -1726,7 +1740,7 @@ }, { "name": "createDeployment", - "description": "Whether or not a user can perform `create_deployment` on this resource", + "description": "Indicates the user can perform `create_deployment` on this resource", "args": [ ], @@ -1744,7 +1758,7 @@ }, { "name": "createDesign", - "description": "Whether or not a user can perform `create_design` on this resource", + "description": "Indicates the user can perform `create_design` on this resource", "args": [ ], @@ -1762,7 +1776,7 @@ }, { "name": "createIssue", - "description": "Whether or not a user can perform `create_issue` on this resource", + "description": "Indicates the user can perform `create_issue` on this resource", "args": [ ], @@ -1780,7 +1794,7 @@ }, { "name": "createLabel", - "description": "Whether or not a user can perform `create_label` on this resource", + "description": "Indicates the user can perform `create_label` on this resource", "args": [ ], @@ -1798,7 +1812,7 @@ }, { "name": "createMergeRequestFrom", - "description": "Whether or not a user can perform `create_merge_request_from` on this resource", + "description": "Indicates the user can perform `create_merge_request_from` on this resource", "args": [ ], @@ -1816,7 +1830,7 @@ }, { "name": "createMergeRequestIn", - "description": "Whether or not a user can perform `create_merge_request_in` on this resource", + "description": "Indicates the user can perform `create_merge_request_in` on this resource", "args": [ ], @@ -1834,7 +1848,7 @@ }, { "name": "createPages", - "description": "Whether or not a user can perform `create_pages` on this resource", + "description": "Indicates the user can perform `create_pages` on this resource", "args": [ ], @@ -1852,7 +1866,7 @@ }, { "name": "createPipeline", - "description": "Whether or not a user can perform `create_pipeline` on this resource", + "description": "Indicates the user can perform `create_pipeline` on this resource", "args": [ ], @@ -1870,7 +1884,7 @@ }, { "name": "createPipelineSchedule", - "description": "Whether or not a user can perform `create_pipeline_schedule` on this resource", + "description": "Indicates the user can perform `create_pipeline_schedule` on this resource", "args": [ ], @@ -1888,7 +1902,7 @@ }, { "name": "createSnippet", - "description": "Whether or not a user can perform `create_snippet` on this resource", + "description": "Indicates the user can perform `create_snippet` on this resource", "args": [ ], @@ -1906,7 +1920,7 @@ }, { "name": "createWiki", - "description": "Whether or not a user can perform `create_wiki` on this resource", + "description": "Indicates the user can perform `create_wiki` on this resource", "args": [ ], @@ -1924,7 +1938,7 @@ }, { "name": "destroyDesign", - "description": "Whether or not a user can perform `destroy_design` on this resource", + "description": "Indicates the user can perform `destroy_design` on this resource", "args": [ ], @@ -1942,7 +1956,7 @@ }, { "name": "destroyPages", - "description": "Whether or not a user can perform `destroy_pages` on this resource", + "description": "Indicates the user can perform `destroy_pages` on this resource", "args": [ ], @@ -1960,7 +1974,7 @@ }, { "name": "destroyWiki", - "description": "Whether or not a user can perform `destroy_wiki` on this resource", + "description": "Indicates the user can perform `destroy_wiki` on this resource", "args": [ ], @@ -1978,7 +1992,7 @@ }, { "name": "downloadCode", - "description": "Whether or not a user can perform `download_code` on this resource", + "description": "Indicates the user can perform `download_code` on this resource", "args": [ ], @@ -1996,7 +2010,7 @@ }, { "name": "downloadWikiCode", - "description": "Whether or not a user can perform `download_wiki_code` on this resource", + "description": "Indicates the user can perform `download_wiki_code` on this resource", "args": [ ], @@ -2014,7 +2028,7 @@ }, { "name": "forkProject", - "description": "Whether or not a user can perform `fork_project` on this resource", + "description": "Indicates the user can perform `fork_project` on this resource", "args": [ ], @@ -2032,7 +2046,7 @@ }, { "name": "pushCode", - "description": "Whether or not a user can perform `push_code` on this resource", + "description": "Indicates the user can perform `push_code` on this resource", "args": [ ], @@ -2050,7 +2064,7 @@ }, { "name": "pushToDeleteProtectedBranch", - "description": "Whether or not a user can perform `push_to_delete_protected_branch` on this resource", + "description": "Indicates the user can perform `push_to_delete_protected_branch` on this resource", "args": [ ], @@ -2068,7 +2082,7 @@ }, { "name": "readCommitStatus", - "description": "Whether or not a user can perform `read_commit_status` on this resource", + "description": "Indicates the user can perform `read_commit_status` on this resource", "args": [ ], @@ -2086,7 +2100,7 @@ }, { "name": "readCycleAnalytics", - "description": "Whether or not a user can perform `read_cycle_analytics` on this resource", + "description": "Indicates the user can perform `read_cycle_analytics` on this resource", "args": [ ], @@ -2104,7 +2118,7 @@ }, { "name": "readDesign", - "description": "Whether or not a user can perform `read_design` on this resource", + "description": "Indicates the user can perform `read_design` on this resource", "args": [ ], @@ -2122,7 +2136,7 @@ }, { "name": "readPagesContent", - "description": "Whether or not a user can perform `read_pages_content` on this resource", + "description": "Indicates the user can perform `read_pages_content` on this resource", "args": [ ], @@ -2140,7 +2154,7 @@ }, { "name": "readProject", - "description": "Whether or not a user can perform `read_project` on this resource", + "description": "Indicates the user can perform `read_project` on this resource", "args": [ ], @@ -2158,7 +2172,7 @@ }, { "name": "readProjectMember", - "description": "Whether or not a user can perform `read_project_member` on this resource", + "description": "Indicates the user can perform `read_project_member` on this resource", "args": [ ], @@ -2176,7 +2190,7 @@ }, { "name": "readWiki", - "description": "Whether or not a user can perform `read_wiki` on this resource", + "description": "Indicates the user can perform `read_wiki` on this resource", "args": [ ], @@ -2194,7 +2208,7 @@ }, { "name": "removeForkProject", - "description": "Whether or not a user can perform `remove_fork_project` on this resource", + "description": "Indicates the user can perform `remove_fork_project` on this resource", "args": [ ], @@ -2212,7 +2226,7 @@ }, { "name": "removePages", - "description": "Whether or not a user can perform `remove_pages` on this resource", + "description": "Indicates the user can perform `remove_pages` on this resource", "args": [ ], @@ -2230,7 +2244,7 @@ }, { "name": "removeProject", - "description": "Whether or not a user can perform `remove_project` on this resource", + "description": "Indicates the user can perform `remove_project` on this resource", "args": [ ], @@ -2248,7 +2262,7 @@ }, { "name": "renameProject", - "description": "Whether or not a user can perform `rename_project` on this resource", + "description": "Indicates the user can perform `rename_project` on this resource", "args": [ ], @@ -2266,7 +2280,7 @@ }, { "name": "requestAccess", - "description": "Whether or not a user can perform `request_access` on this resource", + "description": "Indicates the user can perform `request_access` on this resource", "args": [ ], @@ -2284,7 +2298,7 @@ }, { "name": "updatePages", - "description": "Whether or not a user can perform `update_pages` on this resource", + "description": "Indicates the user can perform `update_pages` on this resource", "args": [ ], @@ -2302,7 +2316,7 @@ }, { "name": "updateWiki", - "description": "Whether or not a user can perform `update_wiki` on this resource", + "description": "Indicates the user can perform `update_wiki` on this resource", "args": [ ], @@ -2320,7 +2334,7 @@ }, { "name": "uploadFile", - "description": "Whether or not a user can perform `upload_file` on this resource", + "description": "Indicates the user can perform `upload_file` on this resource", "args": [ ], @@ -3654,7 +3668,7 @@ "fields": [ { "name": "readGroup", - "description": "Whether or not a user can perform `read_group` on this resource", + "description": "Indicates the user can perform `read_group` on this resource", "args": [ ], @@ -4498,7 +4512,7 @@ }, { "name": "subscribed", - "description": "Boolean flag for whether the currently logged in user is subscribed to this epic", + "description": "Indicates the currently logged in user is subscribed to the epic", "args": [ ], @@ -5142,7 +5156,7 @@ "fields": [ { "name": "adminNote", - "description": "Whether or not a user can perform `admin_note` on this resource", + "description": "Indicates the user can perform `admin_note` on this resource", "args": [ ], @@ -5160,7 +5174,7 @@ }, { "name": "awardEmoji", - "description": "Whether or not a user can perform `award_emoji` on this resource", + "description": "Indicates the user can perform `award_emoji` on this resource", "args": [ ], @@ -5178,7 +5192,7 @@ }, { "name": "createNote", - "description": "Whether or not a user can perform `create_note` on this resource", + "description": "Indicates the user can perform `create_note` on this resource", "args": [ ], @@ -5196,7 +5210,7 @@ }, { "name": "readNote", - "description": "Whether or not a user can perform `read_note` on this resource", + "description": "Indicates the user can perform `read_note` on this resource", "args": [ ], @@ -5214,7 +5228,7 @@ }, { "name": "resolveNote", - "description": "Whether or not a user can perform `resolve_note` on this resource", + "description": "Indicates the user can perform `resolve_note` on this resource", "args": [ ], @@ -5604,7 +5618,7 @@ "fields": [ { "name": "createSnippet", - "description": "Whether or not a user can perform `create_snippet` on this resource", + "description": "Indicates the user can perform `create_snippet` on this resource", "args": [ ], @@ -6746,7 +6760,7 @@ "fields": [ { "name": "adminSnippet", - "description": "Whether or not a user can perform `admin_snippet` on this resource", + "description": "Indicates the user can perform `admin_snippet` on this resource", "args": [ ], @@ -6764,7 +6778,7 @@ }, { "name": "awardEmoji", - "description": "Whether or not a user can perform `award_emoji` on this resource", + "description": "Indicates the user can perform `award_emoji` on this resource", "args": [ ], @@ -6782,7 +6796,7 @@ }, { "name": "createNote", - "description": "Whether or not a user can perform `create_note` on this resource", + "description": "Indicates the user can perform `create_note` on this resource", "args": [ ], @@ -6800,7 +6814,7 @@ }, { "name": "readSnippet", - "description": "Whether or not a user can perform `read_snippet` on this resource", + "description": "Indicates the user can perform `read_snippet` on this resource", "args": [ ], @@ -6818,7 +6832,7 @@ }, { "name": "reportSnippet", - "description": "Whether or not a user can perform `report_snippet` on this resource", + "description": "Indicates the user can perform `report_snippet` on this resource", "args": [ ], @@ -6836,7 +6850,7 @@ }, { "name": "updateSnippet", - "description": "Whether or not a user can perform `update_snippet` on this resource", + "description": "Indicates the user can perform `update_snippet` on this resource", "args": [ ], @@ -7217,7 +7231,7 @@ "fields": [ { "name": "adminEpic", - "description": "Whether or not a user can perform `admin_epic` on this resource", + "description": "Indicates the user can perform `admin_epic` on this resource", "args": [ ], @@ -7235,7 +7249,7 @@ }, { "name": "awardEmoji", - "description": "Whether or not a user can perform `award_emoji` on this resource", + "description": "Indicates the user can perform `award_emoji` on this resource", "args": [ ], @@ -7253,7 +7267,7 @@ }, { "name": "createEpic", - "description": "Whether or not a user can perform `create_epic` on this resource", + "description": "Indicates the user can perform `create_epic` on this resource", "args": [ ], @@ -7271,7 +7285,7 @@ }, { "name": "createNote", - "description": "Whether or not a user can perform `create_note` on this resource", + "description": "Indicates the user can perform `create_note` on this resource", "args": [ ], @@ -7289,7 +7303,7 @@ }, { "name": "destroyEpic", - "description": "Whether or not a user can perform `destroy_epic` on this resource", + "description": "Indicates the user can perform `destroy_epic` on this resource", "args": [ ], @@ -7307,7 +7321,7 @@ }, { "name": "readEpic", - "description": "Whether or not a user can perform `read_epic` on this resource", + "description": "Indicates the user can perform `read_epic` on this resource", "args": [ ], @@ -7325,7 +7339,7 @@ }, { "name": "readEpicIid", - "description": "Whether or not a user can perform `read_epic_iid` on this resource", + "description": "Indicates the user can perform `read_epic_iid` on this resource", "args": [ ], @@ -7343,7 +7357,7 @@ }, { "name": "updateEpic", - "description": "Whether or not a user can perform `update_epic` on this resource", + "description": "Indicates the user can perform `update_epic` on this resource", "args": [ ], @@ -8597,7 +8611,7 @@ }, { "name": "subscribed", - "description": "Boolean flag for whether the currently logged in user is subscribed to this issue", + "description": "Indicates the currently logged in user is subscribed to the issue", "args": [ ], @@ -8840,7 +8854,7 @@ "fields": [ { "name": "adminIssue", - "description": "Whether or not a user can perform `admin_issue` on this resource", + "description": "Indicates the user can perform `admin_issue` on this resource", "args": [ ], @@ -8858,7 +8872,7 @@ }, { "name": "createDesign", - "description": "Whether or not a user can perform `create_design` on this resource", + "description": "Indicates the user can perform `create_design` on this resource", "args": [ ], @@ -8876,7 +8890,7 @@ }, { "name": "createNote", - "description": "Whether or not a user can perform `create_note` on this resource", + "description": "Indicates the user can perform `create_note` on this resource", "args": [ ], @@ -8894,7 +8908,7 @@ }, { "name": "destroyDesign", - "description": "Whether or not a user can perform `destroy_design` on this resource", + "description": "Indicates the user can perform `destroy_design` on this resource", "args": [ ], @@ -8912,7 +8926,7 @@ }, { "name": "readDesign", - "description": "Whether or not a user can perform `read_design` on this resource", + "description": "Indicates the user can perform `read_design` on this resource", "args": [ ], @@ -8930,7 +8944,7 @@ }, { "name": "readIssue", - "description": "Whether or not a user can perform `read_issue` on this resource", + "description": "Indicates the user can perform `read_issue` on this resource", "args": [ ], @@ -8948,7 +8962,7 @@ }, { "name": "reopenIssue", - "description": "Whether or not a user can perform `reopen_issue` on this resource", + "description": "Indicates the user can perform `reopen_issue` on this resource", "args": [ ], @@ -8966,7 +8980,7 @@ }, { "name": "updateIssue", - "description": "Whether or not a user can perform `update_issue` on this resource", + "description": "Indicates the user can perform `update_issue` on this resource", "args": [ ], @@ -9981,7 +9995,7 @@ }, { "name": "subscribed", - "description": "Boolean flag for whether the currently logged in user is subscribed to this issue", + "description": "Indicates the currently logged in user is subscribed to the issue", "args": [ ], @@ -12284,7 +12298,7 @@ "fields": [ { "name": "adminPipeline", - "description": "Whether or not a user can perform `admin_pipeline` on this resource", + "description": "Indicates the user can perform `admin_pipeline` on this resource", "args": [ ], @@ -12302,7 +12316,7 @@ }, { "name": "destroyPipeline", - "description": "Whether or not a user can perform `destroy_pipeline` on this resource", + "description": "Indicates the user can perform `destroy_pipeline` on this resource", "args": [ ], @@ -12320,7 +12334,7 @@ }, { "name": "updatePipeline", - "description": "Whether or not a user can perform `update_pipeline` on this resource", + "description": "Indicates the user can perform `update_pipeline` on this resource", "args": [ ], @@ -14828,7 +14842,7 @@ "fields": [ { "name": "adminMergeRequest", - "description": "Whether or not a user can perform `admin_merge_request` on this resource", + "description": "Indicates the user can perform `admin_merge_request` on this resource", "args": [ ], @@ -14846,7 +14860,7 @@ }, { "name": "cherryPickOnCurrentMergeRequest", - "description": "Whether or not a user can perform `cherry_pick_on_current_merge_request` on this resource", + "description": "Indicates the user can perform `cherry_pick_on_current_merge_request` on this resource", "args": [ ], @@ -14864,7 +14878,7 @@ }, { "name": "createNote", - "description": "Whether or not a user can perform `create_note` on this resource", + "description": "Indicates the user can perform `create_note` on this resource", "args": [ ], @@ -14882,7 +14896,7 @@ }, { "name": "pushToSourceBranch", - "description": "Whether or not a user can perform `push_to_source_branch` on this resource", + "description": "Indicates the user can perform `push_to_source_branch` on this resource", "args": [ ], @@ -14900,7 +14914,7 @@ }, { "name": "readMergeRequest", - "description": "Whether or not a user can perform `read_merge_request` on this resource", + "description": "Indicates the user can perform `read_merge_request` on this resource", "args": [ ], @@ -14918,7 +14932,7 @@ }, { "name": "removeSourceBranch", - "description": "Whether or not a user can perform `remove_source_branch` on this resource", + "description": "Indicates the user can perform `remove_source_branch` on this resource", "args": [ ], @@ -14936,7 +14950,7 @@ }, { "name": "revertOnCurrentMergeRequest", - "description": "Whether or not a user can perform `revert_on_current_merge_request` on this resource", + "description": "Indicates the user can perform `revert_on_current_merge_request` on this resource", "args": [ ], @@ -14954,7 +14968,7 @@ }, { "name": "updateMergeRequest", - "description": "Whether or not a user can perform `update_merge_request` on this resource", + "description": "Indicates the user can perform `update_merge_request` on this resource", "args": [ ], @@ -17089,7 +17103,7 @@ }, { "name": "toggledOn", - "description": "True when the emoji was awarded, false when it was removed", + "description": "Indicates the status of the emoji. True if the toggle awarded the emoji, and false if the toggle removed the emoji.", "args": [ ], diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index dbff0b1759b..8ca17d4107d 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -239,7 +239,7 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph | `relativePosition` | Int | The relative position of the epic in the epic tree | | `relationPath` | String | | | `reference` | String! | | -| `subscribed` | Boolean! | Boolean flag for whether the currently logged in user is subscribed to this epic | +| `subscribed` | Boolean! | Indicates the currently logged in user is subscribed to the epic | | `descendantCounts` | EpicDescendantCount | Number of open and closed descendant epics and issues | ### EpicDescendantCount @@ -274,7 +274,7 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph | `webPath` | String! | Web path of the issue | | `webUrl` | String! | Web URL of the issue | | `relativePosition` | Int | Relative position of the issue (used for positioning in epic tree and issue boards) | -| `subscribed` | Boolean! | Boolean flag for whether the currently logged in user is subscribed to this issue | +| `subscribed` | Boolean! | Indicates the currently logged in user is subscribed to the issue | | `timeEstimate` | Int! | Time estimate of the issue | | `totalTimeSpent` | Int! | Total time reported as spent on the issue | | `closedAt` | Time | Timestamp of when the issue was closed | @@ -293,14 +293,14 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph | Name | Type | Description | | --- | ---- | ---------- | -| `readEpic` | Boolean! | Whether or not a user can perform `read_epic` on this resource | -| `readEpicIid` | Boolean! | Whether or not a user can perform `read_epic_iid` on this resource | -| `updateEpic` | Boolean! | Whether or not a user can perform `update_epic` on this resource | -| `destroyEpic` | Boolean! | Whether or not a user can perform `destroy_epic` on this resource | -| `adminEpic` | Boolean! | Whether or not a user can perform `admin_epic` on this resource | -| `createEpic` | Boolean! | Whether or not a user can perform `create_epic` on this resource | -| `createNote` | Boolean! | Whether or not a user can perform `create_note` on this resource | -| `awardEmoji` | Boolean! | Whether or not a user can perform `award_emoji` on this resource | +| `readEpic` | Boolean! | Indicates the user can perform `read_epic` on this resource | +| `readEpicIid` | Boolean! | Indicates the user can perform `read_epic_iid` on this resource | +| `updateEpic` | Boolean! | Indicates the user can perform `update_epic` on this resource | +| `destroyEpic` | Boolean! | Indicates the user can perform `destroy_epic` on this resource | +| `adminEpic` | Boolean! | Indicates the user can perform `admin_epic` on this resource | +| `createEpic` | Boolean! | Indicates the user can perform `create_epic` on this resource | +| `createNote` | Boolean! | Indicates the user can perform `create_note` on this resource | +| `awardEmoji` | Boolean! | Indicates the user can perform `award_emoji` on this resource | ### EpicSetSubscriptionPayload @@ -355,7 +355,7 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph | Name | Type | Description | | --- | ---- | ---------- | -| `readGroup` | Boolean! | Whether or not a user can perform `read_group` on this resource | +| `readGroup` | Boolean! | Indicates the user can perform `read_group` on this resource | ### Issue @@ -380,7 +380,7 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph | `webPath` | String! | Web path of the issue | | `webUrl` | String! | Web URL of the issue | | `relativePosition` | Int | Relative position of the issue (used for positioning in epic tree and issue boards) | -| `subscribed` | Boolean! | Boolean flag for whether the currently logged in user is subscribed to this issue | +| `subscribed` | Boolean! | Indicates the currently logged in user is subscribed to the issue | | `timeEstimate` | Int! | Time estimate of the issue | | `totalTimeSpent` | Int! | Total time reported as spent on the issue | | `closedAt` | Time | Timestamp of when the issue was closed | @@ -396,14 +396,14 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph | Name | Type | Description | | --- | ---- | ---------- | -| `readIssue` | Boolean! | Whether or not a user can perform `read_issue` on this resource | -| `adminIssue` | Boolean! | Whether or not a user can perform `admin_issue` on this resource | -| `updateIssue` | Boolean! | Whether or not a user can perform `update_issue` on this resource | -| `createNote` | Boolean! | Whether or not a user can perform `create_note` on this resource | -| `reopenIssue` | Boolean! | Whether or not a user can perform `reopen_issue` on this resource | -| `readDesign` | Boolean! | Whether or not a user can perform `read_design` on this resource | -| `createDesign` | Boolean! | Whether or not a user can perform `create_design` on this resource | -| `destroyDesign` | Boolean! | Whether or not a user can perform `destroy_design` on this resource | +| `readIssue` | Boolean! | Indicates the user can perform `read_issue` on this resource | +| `adminIssue` | Boolean! | Indicates the user can perform `admin_issue` on this resource | +| `updateIssue` | Boolean! | Indicates the user can perform `update_issue` on this resource | +| `createNote` | Boolean! | Indicates the user can perform `create_note` on this resource | +| `reopenIssue` | Boolean! | Indicates the user can perform `reopen_issue` on this resource | +| `readDesign` | Boolean! | Indicates the user can perform `read_design` on this resource | +| `createDesign` | Boolean! | Indicates the user can perform `create_design` on this resource | +| `destroyDesign` | Boolean! | Indicates the user can perform `destroy_design` on this resource | ### IssueSetConfidentialPayload @@ -506,14 +506,14 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph | Name | Type | Description | | --- | ---- | ---------- | -| `readMergeRequest` | Boolean! | Whether or not a user can perform `read_merge_request` on this resource | -| `adminMergeRequest` | Boolean! | Whether or not a user can perform `admin_merge_request` on this resource | -| `updateMergeRequest` | Boolean! | Whether or not a user can perform `update_merge_request` on this resource | -| `createNote` | Boolean! | Whether or not a user can perform `create_note` on this resource | -| `pushToSourceBranch` | Boolean! | Whether or not a user can perform `push_to_source_branch` on this resource | -| `removeSourceBranch` | Boolean! | Whether or not a user can perform `remove_source_branch` on this resource | -| `cherryPickOnCurrentMergeRequest` | Boolean! | Whether or not a user can perform `cherry_pick_on_current_merge_request` on this resource | -| `revertOnCurrentMergeRequest` | Boolean! | Whether or not a user can perform `revert_on_current_merge_request` on this resource | +| `readMergeRequest` | Boolean! | Indicates the user can perform `read_merge_request` on this resource | +| `adminMergeRequest` | Boolean! | Indicates the user can perform `admin_merge_request` on this resource | +| `updateMergeRequest` | Boolean! | Indicates the user can perform `update_merge_request` on this resource | +| `createNote` | Boolean! | Indicates the user can perform `create_note` on this resource | +| `pushToSourceBranch` | Boolean! | Indicates the user can perform `push_to_source_branch` on this resource | +| `removeSourceBranch` | Boolean! | Indicates the user can perform `remove_source_branch` on this resource | +| `cherryPickOnCurrentMergeRequest` | Boolean! | Indicates the user can perform `cherry_pick_on_current_merge_request` on this resource | +| `revertOnCurrentMergeRequest` | Boolean! | Indicates the user can perform `revert_on_current_merge_request` on this resource | ### MergeRequestSetAssigneesPayload @@ -622,11 +622,11 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph | Name | Type | Description | | --- | ---- | ---------- | -| `readNote` | Boolean! | Whether or not a user can perform `read_note` on this resource | -| `createNote` | Boolean! | Whether or not a user can perform `create_note` on this resource | -| `adminNote` | Boolean! | Whether or not a user can perform `admin_note` on this resource | -| `resolveNote` | Boolean! | Whether or not a user can perform `resolve_note` on this resource | -| `awardEmoji` | Boolean! | Whether or not a user can perform `award_emoji` on this resource | +| `readNote` | Boolean! | Indicates the user can perform `read_note` on this resource | +| `createNote` | Boolean! | Indicates the user can perform `create_note` on this resource | +| `adminNote` | Boolean! | Indicates the user can perform `admin_note` on this resource | +| `resolveNote` | Boolean! | Indicates the user can perform `resolve_note` on this resource | +| `awardEmoji` | Boolean! | Indicates the user can perform `award_emoji` on this resource | ### PageInfo @@ -660,9 +660,9 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph | Name | Type | Description | | --- | ---- | ---------- | -| `updatePipeline` | Boolean! | Whether or not a user can perform `update_pipeline` on this resource | -| `adminPipeline` | Boolean! | Whether or not a user can perform `admin_pipeline` on this resource | -| `destroyPipeline` | Boolean! | Whether or not a user can perform `destroy_pipeline` on this resource | +| `updatePipeline` | Boolean! | Indicates the user can perform `update_pipeline` on this resource | +| `adminPipeline` | Boolean! | Indicates the user can perform `admin_pipeline` on this resource | +| `destroyPipeline` | Boolean! | Indicates the user can perform `destroy_pipeline` on this resource | ### Project @@ -684,7 +684,7 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph | `forksCount` | Int! | Number of times the project has been forked | | `createdAt` | Time | Timestamp of the project creation | | `lastActivityAt` | Time | Timestamp of the project last activity | -| `archived` | Boolean | Archived status of the project | +| `archived` | Boolean | Indicates the archived status of the project | | `visibility` | String | Visibility of the project | | `containerRegistryEnabled` | Boolean | Indicates if the project stores Docker container images in a container registry | | `sharedRunnersEnabled` | Boolean | Indicates if shared runners are enabled on the project | @@ -704,6 +704,7 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph | `onlyAllowMergeIfAllDiscussionsAreResolved` | Boolean | Indicates if merge requests of the project can only be merged when all the discussions are resolved | | `printingMergeRequestLinkEnabled` | Boolean | Indicates if a link to create or view a merge request should display after a push to Git repositories of the project from the command line | | `removeSourceBranchAfterMerge` | Boolean | Indicates if `Delete source branch` option should be enabled by default for all new merge requests of the project | +| `autocloseReferencedIssues` | Boolean | Indicates if issues referenced by merge requests and commits within the default branch are closed automatically | | `namespace` | Namespace | Namespace of the project | | `group` | Group | Group of the project | | `statistics` | ProjectStatistics | Statistics of the project | @@ -719,47 +720,47 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph | Name | Type | Description | | --- | ---- | ---------- | -| `changeNamespace` | Boolean! | Whether or not a user can perform `change_namespace` on this resource | -| `changeVisibilityLevel` | Boolean! | Whether or not a user can perform `change_visibility_level` on this resource | -| `renameProject` | Boolean! | Whether or not a user can perform `rename_project` on this resource | -| `removeProject` | Boolean! | Whether or not a user can perform `remove_project` on this resource | -| `archiveProject` | Boolean! | Whether or not a user can perform `archive_project` on this resource | -| `removeForkProject` | Boolean! | Whether or not a user can perform `remove_fork_project` on this resource | -| `removePages` | Boolean! | Whether or not a user can perform `remove_pages` on this resource | -| `readProject` | Boolean! | Whether or not a user can perform `read_project` on this resource | -| `createMergeRequestIn` | Boolean! | Whether or not a user can perform `create_merge_request_in` on this resource | -| `readWiki` | Boolean! | Whether or not a user can perform `read_wiki` on this resource | -| `readProjectMember` | Boolean! | Whether or not a user can perform `read_project_member` on this resource | -| `createIssue` | Boolean! | Whether or not a user can perform `create_issue` on this resource | -| `uploadFile` | Boolean! | Whether or not a user can perform `upload_file` on this resource | -| `readCycleAnalytics` | Boolean! | Whether or not a user can perform `read_cycle_analytics` on this resource | -| `downloadCode` | Boolean! | Whether or not a user can perform `download_code` on this resource | -| `downloadWikiCode` | Boolean! | Whether or not a user can perform `download_wiki_code` on this resource | -| `forkProject` | Boolean! | Whether or not a user can perform `fork_project` on this resource | -| `readCommitStatus` | Boolean! | Whether or not a user can perform `read_commit_status` on this resource | -| `requestAccess` | Boolean! | Whether or not a user can perform `request_access` on this resource | -| `createPipeline` | Boolean! | Whether or not a user can perform `create_pipeline` on this resource | -| `createPipelineSchedule` | Boolean! | Whether or not a user can perform `create_pipeline_schedule` on this resource | -| `createMergeRequestFrom` | Boolean! | Whether or not a user can perform `create_merge_request_from` on this resource | -| `createWiki` | Boolean! | Whether or not a user can perform `create_wiki` on this resource | -| `pushCode` | Boolean! | Whether or not a user can perform `push_code` on this resource | -| `createDeployment` | Boolean! | Whether or not a user can perform `create_deployment` on this resource | -| `pushToDeleteProtectedBranch` | Boolean! | Whether or not a user can perform `push_to_delete_protected_branch` on this resource | -| `adminWiki` | Boolean! | Whether or not a user can perform `admin_wiki` on this resource | -| `adminProject` | Boolean! | Whether or not a user can perform `admin_project` on this resource | -| `updatePages` | Boolean! | Whether or not a user can perform `update_pages` on this resource | -| `adminRemoteMirror` | Boolean! | Whether or not a user can perform `admin_remote_mirror` on this resource | -| `createLabel` | Boolean! | Whether or not a user can perform `create_label` on this resource | -| `updateWiki` | Boolean! | Whether or not a user can perform `update_wiki` on this resource | -| `destroyWiki` | Boolean! | Whether or not a user can perform `destroy_wiki` on this resource | -| `createPages` | Boolean! | Whether or not a user can perform `create_pages` on this resource | -| `destroyPages` | Boolean! | Whether or not a user can perform `destroy_pages` on this resource | -| `readPagesContent` | Boolean! | Whether or not a user can perform `read_pages_content` on this resource | -| `adminOperations` | Boolean! | Whether or not a user can perform `admin_operations` on this resource | -| `createSnippet` | Boolean! | Whether or not a user can perform `create_snippet` on this resource | -| `readDesign` | Boolean! | Whether or not a user can perform `read_design` on this resource | -| `createDesign` | Boolean! | Whether or not a user can perform `create_design` on this resource | -| `destroyDesign` | Boolean! | Whether or not a user can perform `destroy_design` on this resource | +| `changeNamespace` | Boolean! | Indicates the user can perform `change_namespace` on this resource | +| `changeVisibilityLevel` | Boolean! | Indicates the user can perform `change_visibility_level` on this resource | +| `renameProject` | Boolean! | Indicates the user can perform `rename_project` on this resource | +| `removeProject` | Boolean! | Indicates the user can perform `remove_project` on this resource | +| `archiveProject` | Boolean! | Indicates the user can perform `archive_project` on this resource | +| `removeForkProject` | Boolean! | Indicates the user can perform `remove_fork_project` on this resource | +| `removePages` | Boolean! | Indicates the user can perform `remove_pages` on this resource | +| `readProject` | Boolean! | Indicates the user can perform `read_project` on this resource | +| `createMergeRequestIn` | Boolean! | Indicates the user can perform `create_merge_request_in` on this resource | +| `readWiki` | Boolean! | Indicates the user can perform `read_wiki` on this resource | +| `readProjectMember` | Boolean! | Indicates the user can perform `read_project_member` on this resource | +| `createIssue` | Boolean! | Indicates the user can perform `create_issue` on this resource | +| `uploadFile` | Boolean! | Indicates the user can perform `upload_file` on this resource | +| `readCycleAnalytics` | Boolean! | Indicates the user can perform `read_cycle_analytics` on this resource | +| `downloadCode` | Boolean! | Indicates the user can perform `download_code` on this resource | +| `downloadWikiCode` | Boolean! | Indicates the user can perform `download_wiki_code` on this resource | +| `forkProject` | Boolean! | Indicates the user can perform `fork_project` on this resource | +| `readCommitStatus` | Boolean! | Indicates the user can perform `read_commit_status` on this resource | +| `requestAccess` | Boolean! | Indicates the user can perform `request_access` on this resource | +| `createPipeline` | Boolean! | Indicates the user can perform `create_pipeline` on this resource | +| `createPipelineSchedule` | Boolean! | Indicates the user can perform `create_pipeline_schedule` on this resource | +| `createMergeRequestFrom` | Boolean! | Indicates the user can perform `create_merge_request_from` on this resource | +| `createWiki` | Boolean! | Indicates the user can perform `create_wiki` on this resource | +| `pushCode` | Boolean! | Indicates the user can perform `push_code` on this resource | +| `createDeployment` | Boolean! | Indicates the user can perform `create_deployment` on this resource | +| `pushToDeleteProtectedBranch` | Boolean! | Indicates the user can perform `push_to_delete_protected_branch` on this resource | +| `adminWiki` | Boolean! | Indicates the user can perform `admin_wiki` on this resource | +| `adminProject` | Boolean! | Indicates the user can perform `admin_project` on this resource | +| `updatePages` | Boolean! | Indicates the user can perform `update_pages` on this resource | +| `adminRemoteMirror` | Boolean! | Indicates the user can perform `admin_remote_mirror` on this resource | +| `createLabel` | Boolean! | Indicates the user can perform `create_label` on this resource | +| `updateWiki` | Boolean! | Indicates the user can perform `update_wiki` on this resource | +| `destroyWiki` | Boolean! | Indicates the user can perform `destroy_wiki` on this resource | +| `createPages` | Boolean! | Indicates the user can perform `create_pages` on this resource | +| `destroyPages` | Boolean! | Indicates the user can perform `destroy_pages` on this resource | +| `readPagesContent` | Boolean! | Indicates the user can perform `read_pages_content` on this resource | +| `adminOperations` | Boolean! | Indicates the user can perform `admin_operations` on this resource | +| `createSnippet` | Boolean! | Indicates the user can perform `create_snippet` on this resource | +| `readDesign` | Boolean! | Indicates the user can perform `read_design` on this resource | +| `createDesign` | Boolean! | Indicates the user can perform `create_design` on this resource | +| `destroyDesign` | Boolean! | Indicates the user can perform `destroy_design` on this resource | ### ProjectStatistics @@ -857,12 +858,12 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph | Name | Type | Description | | --- | ---- | ---------- | -| `createNote` | Boolean! | Whether or not a user can perform `create_note` on this resource | -| `awardEmoji` | Boolean! | Whether or not a user can perform `award_emoji` on this resource | -| `readSnippet` | Boolean! | Whether or not a user can perform `read_snippet` on this resource | -| `updateSnippet` | Boolean! | Whether or not a user can perform `update_snippet` on this resource | -| `adminSnippet` | Boolean! | Whether or not a user can perform `admin_snippet` on this resource | -| `reportSnippet` | Boolean! | Whether or not a user can perform `report_snippet` on this resource | +| `createNote` | Boolean! | Indicates the user can perform `create_note` on this resource | +| `awardEmoji` | Boolean! | Indicates the user can perform `award_emoji` on this resource | +| `readSnippet` | Boolean! | Indicates the user can perform `read_snippet` on this resource | +| `updateSnippet` | Boolean! | Indicates the user can perform `update_snippet` on this resource | +| `adminSnippet` | Boolean! | Indicates the user can perform `admin_snippet` on this resource | +| `reportSnippet` | Boolean! | Indicates the user can perform `report_snippet` on this resource | ### Submodule @@ -938,7 +939,7 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Reasons why the mutation failed. | | `awardEmoji` | AwardEmoji | The award emoji after mutation | -| `toggledOn` | Boolean! | True when the emoji was awarded, false when it was removed | +| `toggledOn` | Boolean! | Indicates the status of the emoji. True if the toggle awarded the emoji, and false if the toggle removed the emoji. | ### Tree @@ -996,4 +997,4 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph | Name | Type | Description | | --- | ---- | ---------- | -| `createSnippet` | Boolean! | Whether or not a user can perform `create_snippet` on this resource | +| `createSnippet` | Boolean! | Indicates the user can perform `create_snippet` on this resource | diff --git a/doc/api/projects.md b/doc/api/projects.md index 209d41d62cd..33308ff8905 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -156,6 +156,7 @@ When the user is authenticated and `simple` is not set this returns something li "remove_source_branch_after_merge": false, "request_access_enabled": false, "merge_method": "merge", + "autoclose_referenced_issues": true, "statistics": { "commit_count": 37, "storage_size": 1038090, @@ -254,6 +255,7 @@ When the user is authenticated and `simple` is not set this returns something li "packages_enabled": true, "service_desk_enabled": false, "service_desk_address": null, + "autoclose_referenced_issues": true, "statistics": { "commit_count": 12, "storage_size": 2066080, @@ -385,6 +387,7 @@ This endpoint supports [keyset pagination](README.md#keyset-based-pagination) fo "remove_source_branch_after_merge": false, "request_access_enabled": false, "merge_method": "merge", + "autoclose_referenced_issues": true, "statistics": { "commit_count": 37, "storage_size": 1038090, @@ -483,6 +486,7 @@ This endpoint supports [keyset pagination](README.md#keyset-based-pagination) fo "packages_enabled": true, "service_desk_enabled": false, "service_desk_address": null, + "autoclose_referenced_issues": true, "statistics": { "commit_count": 12, "storage_size": 2066080, @@ -593,6 +597,7 @@ Example response: "remove_source_branch_after_merge": false, "request_access_enabled": false, "merge_method": "merge", + "autoclose_referenced_issues": true, "statistics": { "commit_count": 37, "storage_size": 1038090, @@ -688,6 +693,7 @@ Example response: "packages_enabled": true, "service_desk_enabled": false, "service_desk_address": null, + "autoclose_referenced_issues": true, "statistics": { "commit_count": 12, "storage_size": 2066080, @@ -829,6 +835,7 @@ GET /projects/:id "packages_enabled": true, "service_desk_enabled": false, "service_desk_address": null, + "autoclose_referenced_issues": true, "statistics": { "commit_count": 37, "storage_size": 1038090, @@ -986,6 +993,7 @@ POST /projects | `only_allow_merge_if_pipeline_succeeds` | boolean | no | Set whether merge requests can only be merged with successful jobs | | `only_allow_merge_if_all_discussions_are_resolved` | boolean | no | Set whether merge requests can only be merged when all the discussions are resolved | | `merge_method` | string | no | Set the [merge method](#project-merge-method) used | +| `autoclose_referenced_issues` | boolean | no | Set whether auto-closing referenced issues on default branch | | `remove_source_branch_after_merge` | boolean | no | Enable `Delete source branch` option by default for all new merge requests | | `lfs_enabled` | boolean | no | Enable LFS | | `request_access_enabled` | boolean | no | Allow users to request member access | @@ -1050,6 +1058,7 @@ POST /projects/user/:user_id | `only_allow_merge_if_pipeline_succeeds` | boolean | no | Set whether merge requests can only be merged with successful jobs | | `only_allow_merge_if_all_discussions_are_resolved` | boolean | no | Set whether merge requests can only be merged when all the discussions are resolved | | `merge_method` | string | no | Set the [merge method](#project-merge-method) used | +| `autoclose_referenced_issues` | boolean | no | Set whether auto-closing referenced issues on default branch | | `remove_source_branch_after_merge` | boolean | no | Enable `Delete source branch` option by default for all new merge requests | | `lfs_enabled` | boolean | no | Enable LFS | | `request_access_enabled` | boolean | no | Allow users to request member access | @@ -1113,6 +1122,7 @@ PUT /projects/:id | `only_allow_merge_if_pipeline_succeeds` | boolean | no | Set whether merge requests can only be merged with successful jobs | | `only_allow_merge_if_all_discussions_are_resolved` | boolean | no | Set whether merge requests can only be merged when all the discussions are resolved | | `merge_method` | string | no | Set the [merge method](#project-merge-method) used | +| `autoclose_referenced_issues` | boolean | no | Set whether auto-closing referenced issues on default branch | | `remove_source_branch_after_merge` | boolean | no | Enable `Delete source branch` option by default for all new merge requests | | `lfs_enabled` | boolean | no | Enable LFS | | `request_access_enabled` | boolean | no | Allow users to request member access | @@ -1244,6 +1254,7 @@ Example responses: "remove_source_branch_after_merge": false, "request_access_enabled": false, "merge_method": "merge", + "autoclose_referenced_issues": true, "_links": { "self": "http://example.com/api/v4/projects", "issues": "http://example.com/api/v4/projects/1/issues", @@ -1332,6 +1343,7 @@ Example response: "remove_source_branch_after_merge": false, "request_access_enabled": false, "merge_method": "merge", + "autoclose_referenced_issues": true, "_links": { "self": "http://example.com/api/v4/projects", "issues": "http://example.com/api/v4/projects/1/issues", @@ -1419,6 +1431,7 @@ Example response: "remove_source_branch_after_merge": false, "request_access_enabled": false, "merge_method": "merge", + "autoclose_referenced_issues": true, "_links": { "self": "http://example.com/api/v4/projects", "issues": "http://example.com/api/v4/projects/1/issues", @@ -1593,6 +1606,7 @@ Example response: "remove_source_branch_after_merge": false, "request_access_enabled": false, "merge_method": "merge", + "autoclose_referenced_issues": true, "_links": { "self": "http://example.com/api/v4/projects", "issues": "http://example.com/api/v4/projects/1/issues", @@ -1699,6 +1713,7 @@ Example response: "remove_source_branch_after_merge": false, "request_access_enabled": false, "merge_method": "merge", + "autoclose_referenced_issues": true, "_links": { "self": "http://example.com/api/v4/projects", "issues": "http://example.com/api/v4/projects/1/issues", diff --git a/doc/development/api_graphql_styleguide.md b/doc/development/api_graphql_styleguide.md index 1ef0b928820..053eb55420e 100644 --- a/doc/development/api_graphql_styleguide.md +++ b/doc/development/api_graphql_styleguide.md @@ -210,7 +210,7 @@ class MergeRequestPermissionsType < BasePermissionType abilities :admin_merge_request, :update_merge_request, :create_note ability_field :resolve_note, - description: 'Whether or not the user can resolve disussions on the merge request' + description: 'Indicates the user can resolve discussions on the merge request' permission_field :push_to_source_branch, method: :can_push_to_source_branch? end ``` diff --git a/doc/development/testing_guide/best_practices.md b/doc/development/testing_guide/best_practices.md index 356e3f7a227..8dd5e2b1265 100644 --- a/doc/development/testing_guide/best_practices.md +++ b/doc/development/testing_guide/best_practices.md @@ -70,6 +70,7 @@ When using spring and guard together, use `SPRING=1 bundle exec guard` instead t use a Capyabara matcher beforehand (e.g. `find('.js-foo')`) to ensure the element actually exists. - Use `focus: true` to isolate parts of the specs you want to run. - Use [`:aggregate_failures`](https://relishapp.com/rspec/rspec-core/docs/expectation-framework-integration/aggregating-failures) when there is more than one expectation in a test. +- For [empty test description blocks](https://github.com/rubocop-hq/rspec-style-guide#it-and-specify), use `specify` rather than `it do` if the test is self-explanatory. ### System / Feature tests diff --git a/doc/user/project/issues/img/disable_issue_auto_close.png b/doc/user/project/issues/img/disable_issue_auto_close.png Binary files differnew file mode 100644 index 00000000000..2cf48a92331 --- /dev/null +++ b/doc/user/project/issues/img/disable_issue_auto_close.png diff --git a/doc/user/project/issues/managing_issues.md b/doc/user/project/issues/managing_issues.md index 38649b05593..c660c920ecb 100644 --- a/doc/user/project/issues/managing_issues.md +++ b/doc/user/project/issues/managing_issues.md @@ -211,6 +211,19 @@ as well as `#22` and `#23` in group/otherproject. `#17` won't be closed as it do not match the pattern. It works with multi-line commit messages as well as one-liners when used from the command line with `git commit -m`. +#### Disabling automatic issue closing + +The automatic issue closing feature can be disabled on a per-project basis +within the [project's repository settings](../settings/index.md). Referenced +issues will still be displayed as such but won't be closed automatically. + + + +This only applies to issues affected by new merge requests or commits. Already +closed issues remain as-is. Disabling automatic issue closing only affects merge +requests *within* the project and won't prevent other projects from closing it +via cross-project issues. + #### Customizing the issue closing pattern **(CORE ONLY)** In order to change the default issue closing pattern, GitLab administrators must edit the |
