webknossos icon indicating copy to clipboard operation
webknossos copied to clipboard

Find a way to include response schemas in swagger/openAPI

Open fm3 opened this issue 3 years ago • 1 comments

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.

fm3 avatar Feb 03 '22 08:02 fm3

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

jstriebel avatar Aug 10 '22 13:08 jstriebel

No longer relevant as we are moving away from Swagger.

hotzenklotz avatar Nov 08 '23 17:11 hotzenklotz