IMO< continue doing it this way for a few more months. Docs will get
out of sync fast with REST api. Which is why it is automated in the
On 3/27/2015 6:58 AM, Stian Thorgersen wrote:
Currently we're generating the REST API documentation
automatically. There's a few issues with that approach:
* Dynamic endpoints are not included (for example openid-connect and saml endpoints are
* No categories - we should split docs into admin, openid-connect, saml, etc.
* Includes private endpoints - for example required actions and account management are
included even though they are not intended for public use
* JSON objects not defined - a lot of REST APIs include examples on how to use, including
details on the JSON consumed/produced
Is there a way to solve this with the current approach or would it be better to manually
create the documentations?
keycloak-dev mailing list
JBoss, a division of Red Hat