Invalid examples of "id vs iid" in the API doc
Hi,
I believe I found a misleading information in the API documentation.
The section:
https://gitlab.com/gitlab-org/gitlab-ee/blob/1cb9fe25/doc/api/README.md#id-vs-iid
explains the difference between id
s and iid
s. Then there are examples of HTTP requests.
The doc says one is API call the other one is the link, but they are actually the same call:
/projects/42/issues/:id
vs /projects/42/issues/:iid
, the same endpoint is used so the value has really one meaning.
Other issue with this doc fragment is that it says "if you want to get an issue via the API you should use the id
" - but it's not true, the behavior of this endpoint is that the number is interpreted as iid
.
Btw detailed document https://docs.gitlab.com/ee/api/issues.html#single-issue says it correctly. So it's the toplevel README.md which is incorrect/obsolete.