[FEATURE REQUEST] API Documentation

[Barrow1990]

Checklist
Please make sure you have performed the following steps before submitting a new feature request, change [ ] to [x] to mark it as done

• I have read the Contributing Guidelines and Scope and Purpose
• I have searched through existing issues.

Description
Have better API Documentation. Maybe utilise something like swagger by utilising the openapi standard

[hargata]

I agree that the current documentation page for the API is not great, it was initially designed to only contain 5-6 GET endpoints but that's slowly been spiraling over time. I think eventually we will either utilize openapi or just move the docs out to a separate website, but that's just not a priority right now. For now, a good workaround will be the postman collection

[Barrow1990]

No problem. I may have a look into this myself as I build my integration

[tigattack]

+1 from me for OpenAPI, that would be amazing!

The Postman collection is quite useful, but I'd love to auto-generate a Python API client for use with lubelogger-fuelio-importer, which I cannot easily do without an OpenAPI spec.

[Barrow1990]

Currently working on this.
Bare with me though as I don't know C#
https://github.com/Barrow1990/lubelog/tree/add_swagger
Managed to get the swagger page loaded but need all the documentation added

[hargata]

Right, adding swagger is the easy part, the tedious part is writing documentation for the objects and schemas and that’s just something we don’t have any capacity to do currently.

We’re not really looking for a swagger page added to LubeLogger tho, an OpenAPI json or yaml file would’ve been ideal since anyone can plug that into an openapi viewer or roll a client library.

[Barrow1990]

since

Would you prefer it to just be a file or integrated within the code and autogenerated like it is in the repo I linked to?

[hargata]

Just a file is good enough.