Wiki API: problems on update (parameters and 500 error)
Summary
When trying to update a wiki page both title
and content
are required, although the docs state otherwise: https://docs.gitlab.com/ce/api/wikis.html#edit-an-existing-wiki-page (1 of title
or content
is enough).
The behavior described in the documentation seems to be the correct one.
(Probably another issue: if both title
and content
are provided the server returns a 500 error.)
Steps to reproduce
Use the API to update a wiki page:
curl -H "PRIVATE-TOKEN: REDACTED" -H "Content-type: application/json" http://gitlab.local/api/v4/projects/6/wikis/MyFirstWikiPage --data '{"content": "New content"}'
The server returns 400: {"error":"title is missing"}
What is the current bug behavior?
Currently the page is not updated if title
is not provided
What is the expected correct behavior?
The wiki page content should be updated.
Results of GitLab environment info
Expand for output related to GitLab environment info
System information System: Ubuntu 16.04 Current User: git Using RVM: no Ruby Version: 2.3.5p376 Gem Version: 2.6.13 Bundler Version:1.13.7 Rake Version: 12.1.0 Redis Version: 3.2.5 Git Version: 2.13.5 Sidekiq Version:5.0.4 Go Version: unknownGitLab information Version: 10.1.0 Revision: 5a695c4 Directory: /opt/gitlab/embedded/service/gitlab-rails DB Adapter: postgresql URL: http://gitlab.lxd HTTP Clone URL: http://gitlab.lxd/some-group/some-project.git SSH Clone URL: git@gitlab.lxd:some-group/some-project.git Using LDAP: no Using Omniauth: no
GitLab Shell Version: 5.9.3 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
Expand for output related to the GitLab application check
Checking GitLab Shell ...GitLab Shell version >= 5.9.3 ? ... OK (5.9.3) Repo base directory exists? default... yes Repo storage directories are symlinks? default... no Repo paths owned by git:root, or git:git? default... yes Repo paths access is drwxrws---? default... yes hooks directories in repos are links: ... 1/1 ... ok 1/2 ... ok 1/3 ... repository is empty 1/4 ... repository is empty 3/5 ... repository is empty 4/6 ... ok Running /opt/gitlab/embedded/service/gitlab-shell/bin/check Check GitLab API access: OK Redis available via internal API: OK
Access to /var/opt/gitlab/.ssh/authorized_keys: OK gitlab-shell self-check successful
Checking GitLab Shell ... Finished
Checking Sidekiq ...
Running? ... yes Number of Sidekiq processes ... 1
Checking Sidekiq ... Finished
Reply by email is disabled in config/gitlab.yml Checking LDAP ...
LDAP is disabled in config/gitlab.yml
Checking LDAP ... Finished
Checking GitLab ...
Git configured correctly? ... yes Database config exists? ... yes All migrations up? ... yes Database contains orphaned GroupMembers? ... no GitLab config exists? ... yes GitLab config up to date? ... yes Log directory writable? ... yes Tmp directory writable? ... yes Uploads directory exists? ... yes Uploads directory has correct permissions? ... yes Uploads directory tmp has correct permissions? ... yes 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/1 ... yes 1/2 ... yes 1/3 ... yes 1/4 ... yes 3/5 ... yes 4/6 ... yes Redis version >= 2.8.0? ... yes Ruby version >= 2.3.3 ? ... yes (2.3.5) Git version >= 2.7.3 ? ... yes (2.13.5) Git user has default SSH configuration? ... yes Active users: ... 2
Checking GitLab ... Finished
Possible fixes
In lib/api/wikis.rb
the put
(update) method uses the same parameters definition as the post
(create) method. Update parameters should be defined to reflect the documentation (only one of title
or content
should be defined).