More control over /rest-doc/ content - Mendix Forum

More control over /rest-doc/ content

8

As a developer I want to be able to exclude some rest endpoints from this list. And to add some 'general description'

 

In our case we have some internal REST API's that are only relevant for internal developers that I don't want to expose to our clients. And I have at least 2 endpoints that are added because we've added modules from the Marketplace which includes endpoints - but in our case we don't need them.

 

So I would like to suggest that on the published rest document we could determine if a endpoint should be added to the /rest-doc/ documentation.

 

Or have a general information somewhere in the projects settings where all the published rest endpoints are shown where we can toggle them on/off for displaying on the rest-doc page.

 

asked
1 answers

Would an authentication requirement for the /rest-doc/ content fit this?

 

The rest documentation response would then only contain the details for which the authenticated user's role has access to.  An anonymous / unauthenticated user would ony see details for endpoints with "Requires authentication" set to "no",  a developer would need to authenticate as a user in the "app-developer" role in order to see the development end-points etc.

Created