Document query parameters for /oauth2/auth

[Flaque]

It's frustrating to attempt to debug a faulty client or a poor usage of a client only to get an error like this:

And then to be linked to docs that purposely don't explain the request.

I'm all for encouraging users to use things correctly; but not documenting things makes it needlessly worse for users trying to debug.

[aeneasr]

It would be helpful if you filled out the form, like which version are you running and so on. But in general, docker logs <id> should help or optionally setting OAUTH2_SHARE_ERROR_DEBUG. I'm explicitly asking for the version because we improved error reporting at some point and it seems like you might not be using that version.

[Flaque]

^ Solid point. Sorry about that. Just going to close this and fade away.

[aeneasr]

Don't, I'm still interested what caused the issue. Reducing dev frustration is something I hold dear, so let's make this better than it is by understanding what went wrong :)

[Flaque]

Whoops sorry about that. I was having a stressful / generally bad day. Sorry for being not helpful around this; it's really not like me. 😕

The version I was running was v1.0.0-beta.9, but that error message came from a previous version (not sure which).

Though, I don't think that error message is particularly bad. My concern was as a new user reading through the docs, you're told that the entry point for the application is /oauth2/auth.

In the docs, it lists out the flow and then says:

The flow itself works as follows:

1. The OAuth 2.0 Client initiates an Authorize Code, Hybrid, or Implicit flow. The user's user agent is redirect to http://hydra/oauth2/auth?client_id=...&....

So that leads me as a newb to believe I need to create this URL, so I'll go to look at the REST docs for /oauth2/auth (https://www.ory.sh/docs/api/hydra/). But on that doc, it just says that it's not documented because we shouldn't build our own implementation. Instead we should use a client. And that's fine, that makes sense.

So I'll go type in oauth2 client javascript into google, and click on the first thing that pops up. But if that client library doesn't immediately work as expected, there's no solid recourse for debugging except greping through the code of hydra, the client library and the OAuth2 spec. And that kind of defeats the point of the docs. 😕

[aeneasr]

I see, that makes sense, thank you for elaborating. I've tracked this as ory/docs#59