API documentation

[babelouest]

The wiki page mentioned in the community support paragraphs redirects to the project page: https://github.com/zmartzone/liboauth2

Is there any documentation available somewhere to describe the API for developers?

[zandbelt]

the code is MVP, the documentation is virtually non-existent and needs time and volunteers

[dawsonnnnnnnn]

If what needs documented is REST, I'd love to chip in!

[AnamikaTechProjects]

Hello. I have just started learning about REST API documentation and wanted to know if I can assist @GreatGhostsss in the documentation?

This might help the work get finished soon and I will also be able to learn more about REST APIs and their documentation process.

[mohsenomidi]

Dear contributors,
Is there any progress for documentation?

I am waiting long time to use this library but there is no single complete example to describe the usage and no any api references...

[zandbelt]

this library is primarily used as a utility in end-products developed and maintained by my organization; it is not yet ready for independent usage, exactly because of the lack of documentation and the not-yet-finalized state of the APIs

[zandbelt]

An API reference generated with Doxygen from the public headers is now published at https://openidc.github.io/liboauth2/ and can be generated locally with make doxygen.

The main entry points are documented at this point - oauth2.h (resource server token verification), openidc.h (the OpenID Connect RP flow), cfg.h, http.h, cache.h and session.h - and the remaining headers will follow. The README now carries a Documentation section describing this, plus a note on the API stability status and the reference consumers; the wiki FAQ is updated accordingly.

Help with documenting the remaining headers is appreciated.