Repository navigation
RFE: Figure out a way to parse the Gitlab API docs so it can be used to validate we support everything #1446
Description
Putting this here so I don't forget.
Would be nice if we could parse the API documentation (which is in Gitlab Markdown format) and extract the API data so that we could use that to figure out if we are missing anything in our implementation.
A possibility is something like Pandoc https://pandoc.org/ or just write some code to try to do it.
Reacted by Nejc Habjan
Metadata
Metadata
Assignees
Labels
No labels
Activity
[-]RFE: Figure out a way to parse the Gitlab API docs to use to validate we support everything[/-][+]RFE: Figure out a way to parse the Gitlab API docs so it can be used to validate we support everything[/+]max-wittig commentedon May 4, 2021
Not sure if that makes sense. We could do it once an
openapi.yamlfor GitLab is available. They are still in the early stages:nejch commentedon May 4, 2021
Or use that approach to help draft/convert the existing GitLab docs to openapi.yml for more endpoints 🤔
It's pretty quiet in there yeah:
https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/openapi/v4
At least some very basic stuff could be pre-filled into yaml for endpoints that follow the standard API doc guideline:
https://docs.gitlab.com/ee/development/documentation/restful_api_styleguide.html#api-topic-template
Just thinking out loud also, since gitlab themselves haven't done much, almost all the openAPI stuff has been community-contributed, and it's painful maintaining those list filters/create attrs/update attrs 😁
JohnVillalovos commentedon May 4, 2021
My main idea on this is to parse it so we can come up with a list of things we are missing. It would be run periodically to assist us. Not something that runs in the CI,.
But yeah it would be great if Gitlab did get the OpenAPI spec working, but it seems like they aren't assigning resources to work on it.
nejch commentedon May 4, 2021
That's true, there are a lot of endpoints that often get added silently without any mention in the release posts and we miss them.
JohnVillalovos commentedon Jul 9, 2025
I'm going to close this as I think it is quite a major task.