Document the errors returned by the server and validation stacks

[kevinchalet]

OpenIddict 3.0 returns error_uris containing a link to this repository. We should progressively document all the errors returned by the server and validation stacks.

Example of a link: https://documentation.openiddict.com/errors/ID2093

[jacojvv-dev]

Hi @kevinchalet

I would be happy to contribute to this section of the documentation.

I suppose we'd need to agree to a format. I am thinking a general outline of the problem with a remedy if applicable?

Potentially even a link to the source of the problem in the openiddict core repository so that advanced members can try and debug their issue by referencing the source?

[kfsass]

Hey, @kevinchalet! I'm also interested in helping out; it seems this hasn't seen much attention in the 4 years since you asked for help, and I imagine the average person browsing doesn't have enough information to contribute effectively.

Where could we find the source code for the various errors to help document? Would you like to provide an example/template, or would you like contributors to do their own thing and receive feedback?

I understand this is a big lift, but right now, it's difficult to debug issues with OpenIddict because the errors are opaque and provide broken links. If there will be no documentation at the provided URLs for another 4 years, would it be prudent to remove the Error URI property? Then you won't have the same issue being opened every few months.

Thank you for your hard work on OpenIddict; please let us know how we can support you with this!

[bunsen32]

I just came on here about to raise an issue, because I thought that the links must have been originally working and become broken!

Is it possible to at least put placeholder pages for each of the errors, with the text from the source code? The file OpenIddictResources.resx contains some basic text. For https://documentation.openiddict.com/errors/ID2093 :

  <data name="ID2093" xml:space="preserve">
    <value>The specified token doesn't contain any audience.</value>
  </data>

Some messages contain placeholders, but that’s better than nothing:

  <data name="ID2072" xml:space="preserve">
    <value>The specified '{0}' parameter doesn't match the client redirection URI the authorization code was initially sent to.</value>
  </data>

Even that text on the page, with a message to say that ‘the documentation is in progress, and will be updated when resources allow,’ would be useful.

(We are using and benefitting from OpenIddict, and potentially I could work on this, but I would need some pointers about how to go about it.)