docs: added openapi specification for the new api

TheTipo01 · Oct 22, 2023 · 5cb9a7e · 5cb9a7e
1 parent f123955
commit 5cb9a7e
Show file tree

Hide file tree

Showing 5 changed files with 630 additions and 4 deletions.
diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml
@@ -21,5 +21,5 @@ jobs:
           path: .cache
           restore-keys: |
             mkdocs-material-
-      - run: pip install mkdocs-material
+      - run: pip install mkdocs-material mkdocs-render-swagger-plugin
       - run: mkdocs gh-deploy --force
diff --git a/docs/api.md b/docs/api.md
@@ -0,0 +1,2 @@
+# API Reference
+!!swagger openapi.json!!
diff --git a/docs/index.md b/docs/index.md
@@ -8,7 +8,7 @@ Yet Another Discord Music Bot - A music bot written in go
 
 - Supports what [yt-dlp](https://github.com/yt-dlp/yt-dlp) supports, plus spotify playlists (if you configure the
   required tokens!)
-- Uses slash commands (see [Commands](commands) for a list of commands)
+- Uses slash commands (see [Commands](commands.md) for a list of commands)
 - Save your favorite songs and playlists with custom commands
 - Automatically skips sponsors or moments when there's no music, thanks to
   the [SponsorBlock API](https://sponsor.ajay.app/)