Skip to content

Draft: Enable EE endpoints to be included in OpenAPI

Andy Schoenen requested to merge andysoiron/enable-ee-endpoints-to-be-mounted-in-openapi into master

What does this MR do and why?

This enables EE endpoints to be included in the OpenAPI documentation.

We are using the grape-swagger gem to generate the documentation. To allow building the documentation in an iterative way, I added a namespace where endpoints can be mounted to be included in the documentation.

Unfortunately, this means we can't include EE endpoints into this namespace.

This MR attempts to fix this my introducing a new API class that mounts the endpoints, but is not mounted in routes.

Once all endpoints are included in OpenAPI, we can move the add_swagger_documentation call to the global namespace and remove the extra class.

Related issue: #378652

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other merge requests.

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Edited by Andy Schoenen

Merge request reports