Update projects API example to lowercase matched name/path to avoid confusion
What does this MR do?
Documentation update. As requested by customer:
When looking at the API documentation's example results for getting projects via the API it appears that the "path" field always contains the lower-cased expression of the project's "name" field (examples from the docs are "name":"Diaspora Client" and "path":"diaspora-client" or "name":"Puppet" and "path":"puppet".
I now faced a project which did have the same value in "name" and "path". Though I cannot guarantee that a user did not change the path manually (as you can do that in the Advanced Settings for a project) I would EITHER assume that the new value for path get's automatically lower-cased by Gitlab OR the documentation for the API would state that the value could also be upper-cased.
From the given examples I can only deduce that the "path" field is meant to provide a lower-cased (maybe DNS-1123 compliant?) variant of the "name" field. A bit more explanation would be nice here.
Are there points in the code the reviewer needs to double check?
Please confirm that the example is coherent from a user perspective.
Why was this MR needed?
To clarify that the path value isn't returned as a lower case parsed name value.
Screenshots (if relevant)
Does this MR meet the acceptance criteria?
-
Changelog entry added, if necessary -
Documentation created/updated -
API support added -
Tests added for this feature/bug - Review
-
Has been reviewed by UX -
Has been reviewed by Frontend -
Has been reviewed by Backend -
Has been reviewed by Database
-
-
Conform by the merge request performance guides -
Conform by the style guides -
Squashed related commits together -
Internationalization required/considered
What are the relevant issue numbers?
Zendesk: https://gitlab.zendesk.com/agent/tickets/85064 (Internal Only)