Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create openAPI schema for parts of the REST API using Swagger #5693

Merged
merged 12 commits into from Sep 2, 2021
Merged

Conversation

fm3
Copy link
Member

@fm3 fm3 commented Aug 30, 2021

URL of deployed dev instance (used for testing):

  • https://___.webknossos.xyz

Routes to document

  • GET /api/datasets/:organizationName/:dataSetName
  • GET /api/annotations/:typ/:id/info
  • GET /api/annotations/:typ/:id/download
  • POST /api/annotations/upload
  • GET /api/datastores
  • POST /data/datasets (uploadChunk)
  • POST /data/datasets/finishUpload
  • GET /data/datasets/:organizationName/:dataSetName/layers/:dataLayerName/data

Steps to test:

  • visit /swagger.json - should list routes

Known issues

  • return value schema is not included
  • multipart/form or json body schema is not included (I describe it in the description instead)
  • prefix /api is missing (anything that does not start with /data really starts with /api

Issues:


@fm3 fm3 changed the title [WIP] Create openAPI schema for parts of the REST API using Swagger Create openAPI schema for parts of the REST API using Swagger Sep 1, 2021
@fm3 fm3 marked this pull request as ready for review September 1, 2021 12:53
@fm3 fm3 requested a review from jstriebel September 1, 2021 12:53
Copy link
Contributor

@jstriebel jstriebel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks ❤️

@fm3 fm3 merged commit 1ec60f8 into master Sep 2, 2021
@fm3 fm3 deleted the swagger branch September 2, 2021 12:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Generate OpenAPI schema for REST API
2 participants