Docs need to be updated

By: Steve Sobol user 23 Jul 2016 at 11:06 a.m. CDT

8 Responses
Steve Sobol gravatar
So now that I have oxD working, there are two more issues. - The Javadocs at *oxd.gluu.org* are out of date. The example shows the use of CommandClient, but that class is not documented in the Javadocs, nor is FlowResponse which is also used in the example. The C# docs look pretty complete and it looks like the class names are the same as the class names in the Java library, so I'm going to use the C# docs for now and I should be ok, but this is something that needs attention - and you'll want to update [https://oxd.gluu.org/docs/libraries/java/](https://oxd.gluu.org/docs/libraries/java/). - Also, I need a little guidance, and I might be missing something obvious here :) but at this moment, using the ImplicitFlowResponse, I can get an idToken, but I need to redirect the user to the login page if necessary, and that isn't happening; and I want to be able to log the user out later. Using the Gluu server by itself, I was able to redirect the user and then get the id_token, but when I went to log the user out and passed the token, the server couldn't find the session corresponding to that token. I'm going to try using the C# docs at [https://oxd.gluu.org/docs/libraries/csharp/](https://oxd.gluu.org/docs/libraries/csharp/) and see how far I get. Thanks
U1404
closed

Answers

By Yuriy Zabrovarnyy staff 23 Jul 2016 at 4:35 p.m. CDT

Copy
Yuriy Zabrovarnyy gravatar
You can find different samples of oxD usages at oxD client tests: `https://github.com/GluuFederation/oxd/tree/version_2.4.4/oxd-client/src/test/java/org/xdi/oxd/client` Source code of oxD is here : `https://github.com/GluuFederation/oxd/tree/version_2.4.4` There you can find any class you wish, including `https://github.com/GluuFederation/oxd/blob/version_2.4.4/oxd-client/src/main/java/org/xdi/oxd/client/CommandClient.java` Sorry about javadocs, it seems someone messed it on host server. I will update it at Monday. Thanks, Yuriy Z

By Steve Sobol user 24 Jul 2016 at 11:43 a.m. CDT

Copy
Steve Sobol gravatar
I was really hoping for something that would give me an overview of the entire process. I don't see a test for implicit flow, which is ok, I don't have to use it, but.... I'm going to go check the OpenID specs again, I'm probably missing something, but it's difficult to figure things out when you're new to Gluu/oxD *and* OpenID Connect.

By Steve Sobol user 24 Jul 2016 at 11:47 a.m. CDT

Copy
Steve Sobol gravatar
I'm still not sure where, in the oxD process, I redirect the use to the Gluu login page. Is it ``` 1. get authorization URL 2. get authorization code (Authorization Code flow) and id token, or just id_token (Implicit flow) 3. redirect user? ``` (Edit: Registering the site and getting the authorization URL seems to work. I don't need the ID token. But then I send the browser to the authorization URL and it keeps on requesting permission for the same thing over and over again.) (Edit 2: Never mind that. Figured out why. I wasn't passing my client ID and password and oxD was dynamically registering a new client each time)

By Steve Sobol user 24 Jul 2016 at 2:14 p.m. CDT

Copy
Steve Sobol gravatar
In lieu of a Gluu support contract, which I would like to purchase but can't afford right now, is it possible for me to contribute some documentation to the project? I think I'm getting the hang of this, and you and the team have been very responsive. I will definitely purchase an oxD license, and will purchase support as soon as I can, but I'll probably need to wait a while to purchase the support.

By Yuriy Zabrovarnyy staff 25 Jul 2016 at 1:49 a.m. CDT

Copy
Yuriy Zabrovarnyy gravatar
I've updated javadocs for both 2.4.3 and 2.4.4 versions. ``` https://oxd.gluu.org/api-docs/oxd-java/2.4.3/ https://oxd.gluu.org/api-docs/oxd-java/2.4.4/ ``` Note that our public documentation sticks to 2.4.4 version at https://oxd.gluu.org/docs/. Documentation team work on having landing page and then navigate to particular version documentation. Feel free to contribute into our documentation: ``` master - https://github.com/GluuFederation/docs-oxd 2.4.3 - https://github.com/GluuFederation/docs-oxd/tree/2.4.3 ``` It is based on http://www.mkdocs.org/

By Yuriy Zabrovarnyy staff 25 Jul 2016 at 1:53 a.m. CDT

Copy
Yuriy Zabrovarnyy gravatar
Understanding of OpenID Connect is the key of course but you are right we need entire process description in user-friendly manner. I will try to put something right now, your feedback is welcome.

By Yuriy Zabrovarnyy staff 25 Jul 2016 at 2:49 a.m. CDT

Copy
Yuriy Zabrovarnyy gravatar
I've added Connect overview for Authorization Code Grant to both main oxd protocol page and oxd-java: ``` https://oxd.gluu.org/docs/oxdserver/ https://oxd.gluu.org/docs/libraries/java/ ``` Your feedback is welcome. You can contribute by opening pull request on github. Thanks in advance, Yuriy Z

By Steve Sobol user 25 Jul 2016 at 11:23 p.m. CDT

Copy
Steve Sobol gravatar
Thanks. I think I've gotten the hang of things. The changes to the documentation have helped. I have one more issue to resolve and then I think I'm good to go. I'll go ahead and close this ticket.

Post an answer