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

Show API documentation at /api/ #2650

Merged
merged 3 commits into from
Oct 23, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add info about apidocs folder in README.md and include swaggerUI NOTICE
  • Loading branch information
mrkvon committed Oct 18, 2023
commit 2309a5cfd5b1fc06f840f02160f7e69daa0cae09
2 changes: 2 additions & 0 deletions apidocs/NOTICE
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
swagger-ui
Copyright 2020-2021 SmartBear Software Inc.
3 changes: 3 additions & 0 deletions apidocs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# API Documentation

In this folder, [openapi.json](./openapi.json) is generated with [swagger-autogen](https://www.npmjs.com/package/swagger-autogen), and the rest is copied from [Swagger-UI release 5.9.0](https://github.com/swagger-api/swagger-ui/releases/tag/v5.9.0) and displays documentation UI. The Swagger-UI is licensed under [Apache-2.0 license](./LICENSE)