BTW, the direct grant section of the doc needs to be updated.
ServiceUrlConstants.TOKEN_SERVICE_DIRECT_GRANT_PATH is not valid any
more. I'm new to that API, so I won't attempt to update the doc myself.
On 3/27/2015 8:51 AM, Bill Burke wrote:
I'm more concerned about the admin api. we can manually doc the
On 3/27/2015 8:21 AM, Stian Thorgersen wrote:
> I agree, generating is best, but we'd need to least figure out how to add missing
protocol endpoints, and also exclude internal endpoints.
> ----- Original Message -----
>> From: "Bill Burke" <bburke(a)redhat.com>
>> To: keycloak-dev(a)lists.jboss.org
>> Sent: Friday, 27 March, 2015 1:13:18 PM
>> Subject: Re: [keycloak-dev] REST API documentation
>> 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
>> first place.
>> 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,
>>> * 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
>> Bill Burke
>> JBoss, a division of Red Hat
>> keycloak-dev mailing list