Finish documentation for all endpoints

+ fix #193 (settings https redirect)
+ fix open api docs on binary
+ fix git error on binary
+ remove flask-restful

hopefully, I didn't break something 😩

app/api/plugins/__init__.py

@@ -1,37 +1,60 @@
 from flask import Blueprint, request
 
+from flask_openapi3 import Tag
+from flask_openapi3 import APIBlueprint
+from pydantic import BaseModel, Field
 from app.db.sqlite.plugins import PluginsMethods
 
-
-api = Blueprint("plugins", __name__, url_prefix="/plugins")
+bp_tag = Tag(name="Plugins", description="Manage plugins")
+api = APIBlueprint("plugins", __name__, url_prefix="/plugins", abp_tags=[bp_tag])
 
 
-@api.route("/", methods=["GET"])
+@api.get("/")
 def get_all_plugins():
+    """
+    List all plugins
+    """
     plugins = PluginsMethods.get_all_plugins()
 
     return {"plugins": plugins}
 
 
-@api.route("/setactive", methods=["GET"])
-def activate_deactivate_plugin():
-    name = request.args.get("plugin", None)
-    state = request.args.get("state", None)
+class PluginBody(BaseModel):
+    plugin: str = Field(description="The plugin name", example="lyrics")
 
-    if not name or not state:
-        return {"error": "Missing plugin or state"}, 400
 
-    PluginsMethods.plugin_set_active(name, int(state))
+class PluginActivateBody(PluginBody):
+    active: bool = Field(
+        description="New plugin active state", example=False, default=False
+    )
+
+
+@api.post("/setactive")
+def activate_deactivate_plugin(body: PluginActivateBody):
+    """
+    Activate/Deactivate plugin
+    """
+    name = body.plugin
+    active = 1 if body.active else 0
+
+    PluginsMethods.plugin_set_active(name, active)
 
     return {"message": "OK"}, 200
 
 
-@api.route("/settings", methods=["POST"])
-def update_plugin_settings():
-    data = request.get_json()
+class PluginSettingsBody(PluginBody):
+    settings: dict = Field(
+        description="The new plugin settings", example={"key": "value"}
+    )
 
-    plugin = data.get("plugin", None)
-    settings = data.get("settings", None)
+
+@api.post("/settings")
+def update_plugin_settings(body: PluginSettingsBody):
+    """
+    Update plugin settings
+    """
+    plugin = body.plugin
+    settings = body.settings
 
     if not plugin or not settings:
         return {"error": "Missing plugin or settings"}, 400

app/api/plugins/lyrics.py

@@ -1,24 +1,41 @@
-from flask import Blueprint, request
+from flask_openapi3 import Tag
+from flask_openapi3 import APIBlueprint
+from pydantic import Field
+from app.api.apischemas import TrackHashSchema
 from app.lib.lyrics import format_synced_lyrics
 
 from app.plugins.lyrics import Lyrics
+from app.settings import Defaults
 from app.utils.hashing import create_hash
 
-api = Blueprint("lyricsplugin", __name__, url_prefix="/plugins/lyrics")
+bp_tag = Tag(name="Lyrics Plugin", description="Musixmatch lyrics plugin")
+api = APIBlueprint(
+    "lyricsplugin", __name__, url_prefix="/plugins/lyrics", abp_tags=[bp_tag]
+)
 
 
-@api.route("/search", methods=["POST"])
-def search_lyrics():
-    data = request.get_json()
+class LyricsSearchBody(TrackHashSchema):
+    title: str = Field(description="The track title ", example=Defaults.API_TRACKNAME)
+    artist: str = Field(description="The track artist ", example=Defaults.API_ARTISTNAME)
+    album: str = Field(description="The track track album ", example=Defaults.API_ALBUMNAME)
+    filepath: str = Field(
+        description="Track filepath to save the lyrics file relative to",
+        example="/home/cwilvx/temp/crazy song.mp3",
+    )
 
-    trackhash = data.get("trackhash", "")
-    title = data.get("title", "")
-    artist = data.get("artist", "")
-    album = data.get("album", "")
-    filepath = data.get("filepath", None)
+
+@api.post("/search")
+def search_lyrics(body: LyricsSearchBody):
+    """
+    Search for lyrics by title and artist
+    """
+    title = body.title
+    artist = body.artist
+    album = body.album
+    filepath = body.filepath
+    trackhash = body.trackhash
 
     finder = Lyrics()
-
     data = finder.search_lyrics_by_title_and_artist(title, artist)
 
     if not data: