openapi.yaml: delete, deprecate, or redirect?
Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.
Capturing @andrewn's question from !181582 (merged): Should we even be keeping the https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/api/openapi/openapi.yaml file? Would it not just add confusion, considering how out-of-date it is? It might be better to delete it or at least deprecate it (with a warning at the top of the file)
Response from @m_frankiewicz: https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/api/openapi/openapi.yaml is for OpenAPI v3 and incomplete. I think we should check if it's not linked from anywhere else in code and if not remove or deprecate it, I agree
Extra info from @aqualls: Creating a redirect to another page is also a possibility.
Of interest to @Andyschoenen.
Related
- Related to OpenAPI page: minor updates, and change YAML fi... (!181582 - merged) where the question came up
- Related to Regenerate API file, document how it was done (!179892 - merged) which is how Amy learned of this file's existence in the first place
- Related to Document the REST API in OpenAPI V2 (&8926) (overarching epic)