[keycloak-dev] REST API documentation

[Stan Silvert]

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 missing)
> * 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?
I suspect that there are hooks into the generator we could use?

As someone who is starting to use those REST API's, improved 
documentation would be a huge help!  Glad you are thinking about it.
> _______________________________________________
> keycloak-dev mailing list
> keycloak-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/keycloak-dev