Valetudo icon indicating copy to clipboard operation
Valetudo copied to clipboard

More/Better Swagger Examples

Open Hypfer opened this issue 4 years ago • 3 comments

The swagger docs could use some more examples for common things to do such as ordered Segment Cleaning as well as additional proof-reading.

The actual spec is built from many small json files spread all around the project in doc folders via the build_openapi_schema npm script to keep them readable. e.g. https://github.com/Hypfer/Valetudo/blob/master/backend/lib/webserver/capabilityRouters/doc/MapSegmentationCapabilityRouter.openapi.json

Hypfer avatar Jul 13 '21 19:07 Hypfer

Could you write a list of endpoints which could use additional examples?

kcindric avatar Jul 30 '21 13:07 kcindric

Actually basically all of them. Only the TimerRouter has some examples

The rest is just infered from the schema by the swagger ui

Hypfer avatar Jul 30 '21 13:07 Hypfer

Ok, I'll try to commit to this. What a better way to learn a project than go through each and every endpoint :)

kcindric avatar Jul 30 '21 14:07 kcindric