webknossos
webknossos copied to clipboard
Find a way to include response schemas in swagger/openAPI
The REST-API response schemas are not present in the current swagger.json – the client auto-generates them from recorded responses, which is very fragile and cannot infer which fields are optional or varying. We should find a way to include that in the swagger/openAPI schema. May mean re-implementing some of it, or writing some version of it manually.
If we write the schema manually, we could think about automatic testing against it using one of
- https://github.com/schemathesis/schemathesis
- https://github.com/meqaio/swagger_meqa
- https://openapi.tools/#testing
No longer relevant as we are moving away from Swagger.