Switch to fastapi for docs

Author: quietsy

Dockerfile

@@ -24,5 +24,5 @@ RUN \
 
 COPY root/ /
 
-EXPOSE 5000
+EXPOSE 8000
 VOLUME /config

Jenkinsfile

@@ -30,7 +30,7 @@ pipeline {
     MULTIARCH='true'
     CI='true'
     CI_WEB='false'
-    CI_PORT='5000'
+    CI_PORT='8000'
     CI_SSL='false'
     CI_DELAY='30'
     CI_DOCKERENV='CI=1'

README.md

@@ -35,7 +35,7 @@ docker run -d \
 -e DB_FILE=/config/api.db `#optional` \
 -e INVALIDATE_HOURS=24 `#optional` \
 -e PAT=token `#optional` \
--p 5000:5000 \
+-p 8000:8000 \
 -v /path/to/lsio-api/config:/config \
 --restart unless-stopped \
 lscr.io/linuxserver/lsio-api:latest

jenkins-vars.yml

@@ -18,7 +18,7 @@ repo_vars:
   - MULTIARCH='true'
   - CI='true'
   - CI_WEB='false'
-  - CI_PORT='5000'
+  - CI_PORT='8000'
   - CI_SSL='false'
   - CI_DELAY='30'
   - CI_DOCKERENV='CI=1'

readme-vars.yml

@@ -40,7 +40,7 @@ full_custom_readme: |
   -e DB_FILE=/config/api.db `#optional` \
   -e INVALIDATE_HOURS=24 `#optional` \
   -e PAT=token `#optional` \
-  -p 5000:5000 \
+  -p 8000:8000 \
   -v /path/to/lsio-api/config:/config \
   --restart unless-stopped \
   lscr.io/linuxserver/lsio-api:latest

root/app/api.py

@@ -1,22 +1,17 @@
-from flask import Flask
-from flask import jsonify
+from fastapi import FastAPI
 from keyvaluestore import KeyValueStore
+from models import ImagesResponse, ImagesData
 
-api = Flask(__name__)
+api = FastAPI(docs_url="/")
 
+@api.get("/health", summary="Get the health status")
+async def health():
+    return "Success"
 
-@api.route("/health")
-def health():
-    return jsonify("Success")
-
-@api.route("/api/v1/images")
-def images():
+@api.get("/api/v1/images", response_model=ImagesResponse, summary="Get a list of images")
+async def images():
     with KeyValueStore() as kv:
-        return api.response_class(
-            response=kv["images"],
-            status=200,
-            mimetype="application/json"
-        )
+        return ImagesResponse(status="OK", data=ImagesData.model_validate_json(kv["images"]))
 
 if __name__ == "__main__":
     api.run()

root/app/models.py

@@ -0,0 +1,19 @@
+from pydantic import BaseModel
+
+
+class Image(BaseModel):
+    name: str
+    version: str
+    category: str
+    stable: bool
+    deprecated: bool
+
+class Repository(BaseModel):
+    linuxserver: list[Image]
+
+class ImagesData(BaseModel):
+    repositories: Repository
+
+class ImagesResponse(BaseModel):
+    status: str
+    data: ImagesData

root/app/requirements.txt

@@ -1,4 +1,3 @@
-Flask==3.1.0
-gunicorn==23.0.0
+fastapi[standard]==0.115.8
 PyGithub==2.5.0
 PyYAML==6.0.2

root/app/updater.py

@@ -1,9 +1,9 @@
 from github import Auth
 from github import Github
 from keyvaluestore import KeyValueStore
+from models import Image, Repository, ImagesData
 
 import datetime
-import json
 import os
 import threading
 import time
@@ -41,23 +41,22 @@ def get_state():
         if "Internal" in categories:
             continue
         version = "latest" if "development_versions_items" not in readme_vars else readme_vars["development_versions_items"][0]["tag"]
-        images.append({
-                    "name": repo.full_name.replace("linuxserver/docker-", ""),
-                    "version": version,
-                    "category": categories,
-                    "stable": version == "latest",
-                    "deprecated": False
-                })
-    return {"status": "OK", "data": {"repositories": {"linuxserver": images}}}
+        images.append(Image(
+                name=repo.full_name.replace("linuxserver/docker-", ""),
+                version=version,
+                category=categories,
+                stable=version == "latest",
+                deprecated=False
+            ))
+    return ImagesData(repositories=Repository(linuxserver=images)).model_dump_json()
 
 def update_images():
     with KeyValueStore(invalidate_hours=INVALIDATE_HOURS, readonly=False) as kv:
         if "images" in kv or CI == "1":
             print(f"{datetime.datetime.now()} - skipped - already updated")
             return
         print(f"{datetime.datetime.now()} - updating images")
-        current_state = get_state()
-        kv["images"] = json.dumps(current_state)
+        kv["images"] = get_state()
         print(f"{datetime.datetime.now()} - updated images")
 
 class UpdateImages(threading.Thread):

root/etc/s6-overlay/s6-rc.d/svc-api/run

@@ -1,5 +1,5 @@
 #!/usr/bin/with-contenv bash
 # shellcheck shell=bash
 
-exec s6-notifyoncheck -d -n 300 -w 1000 -c "nc -z localhost 5000" \
-    cd /app s6-setuidgid abc gunicorn api:api -b 0.0.0.0:5000 -w 4 --timeout 15 --log-level warning
+exec s6-notifyoncheck -d -n 300 -w 1000 -c "nc -z localhost 8000" \
+    cd /app s6-setuidgid abc fastapi run --workers 4 api.py