OpenIDC / liboauth2

OAuth 2.x and OpenID Connect C library
Apache License 2.0
101 stars 26 forks source link

API documentation #11

Open babelouest opened 4 years ago

babelouest commented 4 years ago

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 commented 4 years ago

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

GreatGhostsss commented 3 years ago

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

CuteCap commented 3 years ago

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 commented 3 years ago

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 commented 3 years ago

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