Add openapi API documentation (#294)

* Initial version

- Add OpenAPI documentation generator
- Update README.md to remove endpoint documentations

* Adds new endpoints

- Fixes build with swag
- Adds new endpoints

* Adds more endpoints documentation

- Also removes swag from Dockerfile and build script

* Finally adds all endpoints documentation

* Initial version

- Add OpenAPI documentation generator
- Update README.md to remove endpoint documentations

* Adds new endpoints

- Fixes build with swag
- Adds new endpoints

* Adds more endpoints documentation

- Also removes swag from Dockerfile and build script

* Finally adds all endpoints documentation

* Update README (#1)

* Update README

I completely redid the `README.md`. Now it's much easier to read and understand.

---------

Co-authored-by: cocool97 <34218602+cocool97@users.noreply.github.com>

* Improves documentation

* Delete server/config.db

* Update README.md

* Update README.md

* fix download in api docs

* add api docs to web

---------

Co-authored-by: Shadeov <144587546+shadeov@users.noreply.github.com>
Co-authored-by: nikk gitanes <tsynik@gmail.com>
This commit is contained in:
cocool97
2023-11-13 07:59:23 +01:00
committed by GitHub
parent aa061fd24c
commit b72c66d433
32 changed files with 5375 additions and 2024 deletions

View File

@@ -21,6 +21,7 @@
},
"AddFromLink": "Add Torrent",
"AddNewTorrent": "Add new torrent",
"ApiDocs": "API Docs",
"B": "B",
"bps": "bps",
"Buffer": "Preload Buffer / Cache",
@@ -66,6 +67,7 @@
"MB": "MB",
"Mbps": "Mbps",
"Name": "Name",
"NasReleases": "NAS Releases",
"NoTorrentsAdded": "No torrents added",
"Offline": "Offline",
"OK": "OK",
@@ -76,7 +78,6 @@
"Playlist": "Playlist",
"Preload": "Preload",
"ProjectSource": "Project GitHub",
"NasReleases": "NAS Releases GitHub",
"PWAGuide": {
"Header": "Install application",
"Description": "Install the app on your device to easily access it anytime. No app store. No download.",