Documentation for Jobs API is incorrect
Summary
The documentation for List project jobs talks of a scope parameter, and lists it's possible values. These values are incorrect.
Steps to reproduce
- Create a pipeline with an action "when: manual"
- Call /api/v4/projects/ID/jobs?scope[]=skipped, as the documentation suggests, see empty output
What is the current bug behavior?
The documentation does not list the "manual" value for the scope parameter. In addition, the listed "skipped" values does not behave as suggested.
What is the expected correct behavior?
Docs should list correct values for parameters
Relevant logs and/or screenshots
Output of checks
N/A
Results of GitLab environment info
System information System: Proxy: no Current User: git Using RVM: no Ruby Version: 2.3.3p222 Gem Version: 2.6.6 Bundler Version:1.13.7 Rake Version: 10.5.0 Redis Version: 3.2.5 Git Version: 2.11.1 Sidekiq Version:4.2.7GitLab information Version: 9.1.3-ee Revision: e28218c Directory: /opt/gitlab/embedded/service/gitlab-rails DB Adapter: postgresql DB Version: 9.6.1 URL: https:// HTTP Clone URL: https:///some-group/some-project.git SSH Clone URL: git@:some-group/some-project.git Elasticsearch: no Geo: no Using LDAP: no Using Omniauth: yes Omniauth Providers: saml, github
GitLab Shell Version: 5.0.2 Repository storage paths:
- default: /var/opt/gitlab/git-data/repositories Hooks: /opt/gitlab/embedded/service/gitlab-shell/hooks Git: /opt/gitlab/embedded/bin/git
Results of GitLab application Check
Checking GitLab Shell ...GitLab Shell version >= 5.0.2 ? ... OK (5.0.2) Repo base directory exists? default... yes Repo storage directories are symlinks? default... no Repo paths owned by git:git? default... yes Repo paths access is drwxrws---? default... yes hooks directories in repos are links: ... 1/3 ... repository is empty 1/4 ... ok 1/5 ... repository is empty 3/6 ... ok 8/11 ... ok 11/12 ... ok 3/13 ... ok 12/14 ... ok 3/16 ... ok 89/18 ... ok 89/19 ... ok 89/20 ... ok 89/21 ... ok 7/22 ... ok 85/23 ... ok 7/24 ... ok 89/25 ... ok 89/26 ... ok 5/27 ... ok 7/28 ... ok 87/29 ... ok 85/30 ... ok 87/31 ... ok 87/32 ... ok 87/33 ... ok 87/34 ... ok 85/35 ... ok 87/36 ... ok 87/37 ... ok 87/38 ... ok 87/39 ... ok 87/40 ... ok 87/41 ... ok 89/42 ... ok 7/43 ... ok 90/44 ... ok 7/45 ... ok 90/46 ... ok 89/47 ... ok 84/48 ... ok 90/49 ... ok 89/51 ... ok 12/52 ... ok 12/54 ... ok 89/55 ... ok 7/56 ... ok 89/57 ... ok 90/58 ... ok 7/59 ... ok 7/60 ... ok 86/61 ... ok 86/62 ... ok 86/63 ... ok 7/64 ... ok 86/65 ... ok 86/66 ... ok 85/69 ... ok 95/70 ... ok 85/71 ... ok 85/72 ... ok 7/73 ... ok 33/74 ... ok 12/76 ... ok 9/77 ... ok 5/78 ... ok 8/79 ... ok 5/81 ... ok 5/83 ... ok 5/84 ... ok 5/85 ... ok 19/86 ... ok 19/87 ... ok 5/88 ... ok 9/89 ... ok 9/90 ... ok 22/91 ... ok 5/92 ... ok 4/93 ... ok 2/95 ... ok 40/96 ... ok 22/97 ... ok 43/98 ... ok 43/99 ... ok 26/100 ... ok 43/101 ... ok 44/102 ... ok 94/104 ... ok 43/105 ... ok 44/106 ... ok 30/107 ... ok 30/109 ... ok 20/110 ... ok 30/112 ... ok 43/113 ... ok 22/114 ... ok 5/115 ... ok 9/117 ... ok 5/119 ... ok 12/120 ... ok 30/122 ... ok 14/125 ... ok 9/126 ... ok 52/127 ... ok 54/129 ... ok 17/131 ... ok 53/132 ... ok 52/134 ... ok 54/135 ... ok 52/136 ... ok 3/137 ... ok 22/138 ... ok 12/139 ... ok 56/141 ... ok 9/142 ... ok 54/143 ... ok 57/144 ... ok 28/145 ... ok 30/146 ... ok 28/147 ... ok 24/148 ... ok 12/149 ... ok 5/150 ... ok 9/151 ... ok 59/152 ... repository is empty 5/153 ... ok 60/154 ... ok 5/155 ... ok 58/156 ... ok 54/157 ... ok 46/159 ... ok 27/161 ... ok 27/162 ... ok 13/163 ... ok 5/164 ... ok 5/165 ... ok 5/166 ... ok 30/167 ... ok 5/168 ... ok 54/169 ... ok 9/170 ... ok 60/171 ... ok 14/172 ... ok 4/173 ... ok 37/174 ... ok 56/175 ... ok 9/176 ... ok 5/178 ... ok 5/179 ... repository is empty 52/180 ... ok 5/181 ... ok 57/182 ... ok 5/185 ... ok 20/186 ... ok 43/187 ... ok 57/188 ... ok 57/189 ... ok 9/190 ... ok 43/191 ... ok 20/192 ... ok 12/193 ... ok 12/194 ... ok 67/195 ... ok 67/196 ... ok 68/197 ... ok 68/198 ... ok 65/199 ... ok 57/200 ... ok 28/201 ... ok 16/202 ... ok 44/203 ... ok 30/204 ... ok 60/206 ... ok 33/207 ... ok 7/208 ... ok 24/209 ... ok 20/210 ... ok 94/211 ... ok 9/212 ... ok 94/213 ... ok 12/215 ... ok 20/216 ... ok 57/217 ... ok 30/218 ... ok 72/219 ... ok 9/220 ... ok 12/222 ... ok 75/223 ... repository is empty 75/224 ... repository is empty 76/225 ... ok 75/226 ... ok 18/227 ... ok 18/228 ... ok 59/229 ... ok 67/230 ... ok 68/231 ... ok 78/232 ... ok 20/233 ... ok 20/234 ... ok 32/235 ... ok 32/236 ... ok 54/237 ... ok 9/238 ... ok 74/239 ... ok 74/240 ... ok 75/241 ... ok 52/243 ... ok 54/244 ... ok 9/245 ... ok 9/246 ... ok 25/247 ... ok 76/248 ... ok 22/249 ... ok 7/250 ... ok 14/251 ... ok 81/252 ... ok 54/253 ... ok 54/254 ... ok 54/255 ... ok 54/256 ... ok 57/257 ... ok 5/258 ... ok 81/259 ... ok 84/260 ... ok 54/262 ... ok 54/263 ... ok 88/264 ... ok 88/265 ... ok 43/266 ... ok 54/267 ... ok 11/268 ... ok 82/269 ... ok 82/270 ... ok 46/271 ... ok 43/272 ... ok 54/273 ... ok 27/274 ... ok 95/275 ... ok 95/276 ... ok 95/277 ... ok 95/278 ... ok 95/279 ... ok 14/280 ... ok 74/281 ... ok 92/282 ... repository is empty 23/283 ... ok 23/284 ... ok 27/285 ... ok 26/287 ... ok 9/288 ... ok 74/289 ... ok 75/290 ... ok 75/291 ... ok 85/292 ... ok 44/293 ... ok 81/294 ... ok 7/295 ... ok 4/296 ... ok 4/297 ... ok 29/299 ... repository is empty 75/300 ... repository is empty 46/301 ... ok 95/302 ... ok 54/303 ... ok 2/306 ... ok Running /opt/gitlab/embedded/service/gitlab-shell/bin/check Check GitLab API access: OK Access to /var/opt/gitlab/.ssh/authorized_keys: OK Send ping to redis server: OK gitlab-shell self-check successful
Checking GitLab Shell ... Finished
Checking Sidekiq ...
Running? ... yes Number of Sidekiq processes ... 1
Checking Sidekiq ... Finished
Checking Reply by email ...
Reply by email is disabled in config/gitlab.yml
Checking Reply by email ... Finished
Checking LDAP ...
LDAP is disabled in config/gitlab.yml
Checking LDAP ... Finished
Checking GitLab ...
Git configured with autocrlf=input? ... yes Database config exists? ... yes All migrations up? ... yes Database contains orphaned GroupMembers? ... no GitLab config exists? ... yes GitLab config outdated? ... no Log directory writable? ... yes Tmp directory writable? ... yes Uploads directory setup correctly? ... no Try fixing it: sudo chown -R git /var/opt/gitlab/gitlab-rails/uploads sudo find /var/opt/gitlab/gitlab-rails/uploads -type f -exec chmod 0644 {} ; sudo find /var/opt/gitlab/gitlab-rails/uploads -type d -not -path /var/opt/gitlab/gitlab-rails/uploads -exec chmod 0700 {} ; For more information see: doc/install/installation.md in section "GitLab" Please fix the error above and rerun the checks. Init script exists? ... skipped (omnibus-gitlab has no init script) Init script up-to-date? ... skipped (omnibus-gitlab has no init script) projects have namespace: ... 1/3 ... yes 1/4 ... yes 1/5 ... yes 3/6 ... yes 8/11 ... yes 11/12 ... yes 3/13 ... yes 12/14 ... yes 3/16 ... yes 89/18 ... yes 89/19 ... yes 89/20 ... yes 89/21 ... yes 7/22 ... yes 85/23 ... yes 7/24 ... yes 89/25 ... yes 89/26 ... yes 5/27 ... yes 7/28 ... yes 87/29 ... yes 85/30 ... yes 87/31 ... yes 87/32 ... yes 87/33 ... yes 87/34 ... yes 85/35 ... yes 87/36 ... yes 87/37 ... yes 87/38 ... yes 87/39 ... yes 87/40 ... yes 87/41 ... yes 89/42 ... yes 7/43 ... yes 90/44 ... yes 7/45 ... yes 90/46 ... yes 89/47 ... yes 84/48 ... yes 90/49 ... yes 89/51 ... yes 12/52 ... yes 12/54 ... yes 89/55 ... yes 7/56 ... yes 89/57 ... yes 90/58 ... yes 7/59 ... yes 7/60 ... yes 86/61 ... yes 86/62 ... yes 86/63 ... yes 7/64 ... yes 86/65 ... yes 86/66 ... yes 85/69 ... yes 95/70 ... yes 85/71 ... yes 85/72 ... yes 7/73 ... yes 33/74 ... yes 12/76 ... yes 9/77 ... yes 5/78 ... yes 8/79 ... yes 5/81 ... yes 5/83 ... yes 5/84 ... yes 5/85 ... yes 19/86 ... yes 19/87 ... yes 5/88 ... yes 9/89 ... yes 9/90 ... yes 22/91 ... yes 5/92 ... yes 4/93 ... yes 2/95 ... yes 40/96 ... yes 22/97 ... yes 43/98 ... yes 43/99 ... yes 26/100 ... yes 43/101 ... yes 44/102 ... yes 94/104 ... yes 43/105 ... yes 44/106 ... yes 30/107 ... yes 30/109 ... yes 20/110 ... yes 30/112 ... yes 43/113 ... yes 22/114 ... yes 5/115 ... yes 9/117 ... yes 5/119 ... yes 12/120 ... yes 30/122 ... yes 14/125 ... yes 9/126 ... yes 52/127 ... yes 54/129 ... yes 17/131 ... yes 53/132 ... yes 52/134 ... yes 54/135 ... yes 52/136 ... yes 3/137 ... yes 22/138 ... yes 12/139 ... yes 56/141 ... yes 9/142 ... yes 54/143 ... yes 57/144 ... yes 28/145 ... yes 30/146 ... yes 28/147 ... yes 24/148 ... yes 12/149 ... yes 5/150 ... yes 9/151 ... yes 59/152 ... yes 5/153 ... yes 60/154 ... yes 5/155 ... yes 58/156 ... yes 54/157 ... yes 46/159 ... yes 27/161 ... yes 27/162 ... yes 13/163 ... yes 5/164 ... yes 5/165 ... yes 5/166 ... yes 30/167 ... yes 5/168 ... yes 54/169 ... yes 9/170 ... yes 60/171 ... yes 14/172 ... yes 4/173 ... yes 37/174 ... yes 56/175 ... yes 9/176 ... yes 5/178 ... yes 5/179 ... yes 52/180 ... yes 5/181 ... yes 57/182 ... yes 5/185 ... yes 20/186 ... yes 43/187 ... yes 57/188 ... yes 57/189 ... yes 9/190 ... yes 43/191 ... yes 20/192 ... yes 12/193 ... yes 12/194 ... yes 67/195 ... yes 67/196 ... yes 68/197 ... yes 68/198 ... yes 65/199 ... yes 57/200 ... yes 28/201 ... yes 16/202 ... yes 44/203 ... yes 30/204 ... yes 60/206 ... yes 33/207 ... yes 7/208 ... yes 24/209 ... yes 20/210 ... yes 94/211 ... yes 9/212 ... yes 94/213 ... yes 12/215 ... yes 20/216 ... yes 57/217 ... yes 30/218 ... yes 72/219 ... yes 9/220 ... yes 12/222 ... yes 75/223 ... yes 75/224 ... yes 76/225 ... yes 75/226 ... yes 18/227 ... yes 18/228 ... yes 59/229 ... yes 67/230 ... yes 68/231 ... yes 78/232 ... yes 20/233 ... yes 20/234 ... yes 32/235 ... yes 32/236 ... yes 54/237 ... yes 9/238 ... yes 74/239 ... yes 74/240 ... yes 75/241 ... yes 52/243 ... yes 54/244 ... yes 9/245 ... yes 9/246 ... yes 25/247 ... yes 76/248 ... yes 22/249 ... yes 7/250 ... yes 14/251 ... yes 81/252 ... yes 54/253 ... yes 54/254 ... yes 54/255 ... yes 54/256 ... yes 57/257 ... yes 5/258 ... yes 81/259 ... yes 84/260 ... yes 54/262 ... yes 54/263 ... yes 88/264 ... yes 88/265 ... yes 43/266 ... yes 54/267 ... yes 11/268 ... yes 82/269 ... yes 82/270 ... yes 46/271 ... yes 43/272 ... yes 54/273 ... yes 27/274 ... yes 95/275 ... yes 95/276 ... yes 95/277 ... yes 95/278 ... yes 95/279 ... yes 14/280 ... yes 74/281 ... yes 92/282 ... yes 23/283 ... yes 23/284 ... yes 27/285 ... yes 26/287 ... yes 9/288 ... yes 74/289 ... yes 75/290 ... yes 75/291 ... yes 85/292 ... yes 44/293 ... yes 81/294 ... yes 7/295 ... yes 4/296 ... yes 4/297 ... yes 29/299 ... yes 75/300 ... yes 46/301 ... yes 95/302 ... yes 54/303 ... yes 2/306 ... yes Redis version >= 2.8.0? ... yes Ruby version >= 2.1.0 ? ... yes (2.3.3) Your git bin path is "/opt/gitlab/embedded/bin/git" Git version >= 2.7.3 ? ... yes (2.11.1) Active users: 46
Checking GitLab ... Finished
Possible fixes
Documentation needs update