Make parent_id field integer/null value instead of string
See the general Documentation guidelines http://docs.gitlab.com/ce/development/doc_styleguide.html
What does this MR do?
Updates namespaces API documentation.
Currently the parent_id
field in API response is presented as string. This is wrong, because the value itself is stored in database as integer/NULL, so Grape is serializing it to a proper JSON integer/null representation. And because of that current documentation may confuse API users.
For languages like Ruby, which are not strictly typed, this is not a problem. But for languages like, for example, go - it is. Please look on https://github.com/xanzy/go-gitlab/pull/325 for a reference.
Requires gitlab-org/gitlab-ee!4502 to be merged in GitLab EE for compatibility.
Moving docs to a new location?
See the guidelines: http://docs.gitlab.com/ce/development/doc_styleguide.html#changing-document-location
-
Make sure the old link is not removed and has its contents replaced with a link to the new location. -
Make sure internal links pointing to the document in question are not broken. -
Search and replace any links referring to old docs in GitLab Rails app, specifically under the app/views/
directory. -
Make sure to add redirect_from
to the new document if there are any Disqus comments on the old document thread. -
If working on CE, submit an MR to EE with the changes as well. -
Ping one of the technical writers for review.