Skip to content
This repository was archived by the owner on Jan 25, 2023. It is now read-only.

Conversation

@JakobMiksch
Copy link
Contributor

@JakobMiksch JakobMiksch commented Sep 9, 2022

  • Add the route /docs with a Swagger UI for API development, see screenshot below
  • /docs does not need Basic Auth, the API routes still need it
  • the UI also supports login with Basic Auth and the UI can therefore be used to access the API with the Browser
  • references API docs #23
  • builds on Instantly use env vars on "npm run watch" #29

TODO (After merge)

  • the swagger.yaml is currently redundant with our JSON schema schema-geotiff-upload.json - we should find a way to either link the JSON schema to the Swagger config or use the swagger config to validate the input of the API --> could be moved to follow up issue
  • after merge: add config file to 'klips-sdi'

image

@JakobMiksch JakobMiksch changed the title Minimal swagger UI API documentation with Swagger Sep 9, 2022
@JakobMiksch JakobMiksch marked this pull request as ready for review September 9, 2022 11:32
@JakobMiksch
Copy link
Contributor Author

JakobMiksch commented Sep 9, 2022

@hwbllmnn @hblitza this is sitll kind of WIP, maybe you could have a look what you think (especially regarding the TODOs) , then I can make adaptations if needed

README.md Outdated
@@ -11,16 +11,6 @@ with local Node.js:
npm i

# define environment variables and run
Copy link
Contributor

@hblitza hblitza Sep 14, 2022

Choose a reason for hiding this comment

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

comment define environment variables still needed? since below all are deleted

Copy link
Contributor

@hblitza hblitza left a comment

Choose a reason for hiding this comment

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

LGTM, just minor.

@JakobMiksch JakobMiksch merged commit 400e85e into klips-project:main Sep 14, 2022
@JakobMiksch JakobMiksch deleted the swagger-api-2022-09-09 branch September 14, 2022 09:05
This was referenced Sep 14, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants