Add query params

Author: quietsy

root/app/api.py

@@ -2,6 +2,7 @@
 from fastapi.responses import JSONResponse
 from keyvaluestore import KeyValueStore
 from models import ImagesResponse
+from pydantic import ValidationError
 import json
 import traceback
 
@@ -11,12 +12,25 @@
 async def health():
     return "Success"
 
-@api.get("/api/v1/images", response_model=ImagesResponse, summary="Get a list of images")
-async def images():
+async def get_images():
+    with KeyValueStore() as kv:
+        return kv["images"]
+
+@api.get("/api/v1/images", response_model=ImagesResponse, summary="Get a list of images", response_model_exclude_none=True)
+async def images(include_config: bool = False, include_deprecated: bool = False):
     try:
-        with KeyValueStore() as kv:
-            content = json.loads(kv["images"])
-            return JSONResponse(content=content)
+        response = await get_images()
+        image_response = ImagesResponse.model_validate_json(response)
+        if not include_deprecated:
+            image_response.exclude_deprecated()
+        if not include_config:
+            image_response.exclude_config()
+        return image_response
+    except ValidationError:
+        print(traceback.format_exc())
+        response = await get_images()
+        content = json.loads(response)
+        return JSONResponse(content=content)
     except Exception:
         print(traceback.format_exc())
         raise HTTPException(status_code=404, detail="Not found")

root/app/keyvaluestore.py

@@ -41,9 +41,5 @@ def __getitem__(self, key):
     def set_value(self, key, value, schema_version):
         self.conn.execute("REPLACE INTO kv (key, value, updated_at, schema_version) VALUES (?, ?, DATETIME('now', 'utc'), ?)", (key, value, schema_version))
         self.conn.commit()
-    def update_schema(self, key, schema_version):
-        is_updated = self.conn.execute(f"SELECT 1 FROM kv WHERE key = '{key}' AND schema_version = {schema_version}").fetchone() is not None
-        if not is_updated:
-            self.conn.execute(f"UPDATE kv SET schema_version = {schema_version} WHERE key = '{key}'")
-            self.conn.commit()
-        return is_updated
+    def is_current_schema(self, key, schema_version):
+        return self.conn.execute(f"SELECT 1 FROM kv WHERE key = '{key}' AND schema_version = {schema_version}").fetchone() is not None

root/app/models.py

@@ -74,26 +74,26 @@ class MacAddress(BaseModel):
     optional: bool
 
 class Config(BaseModel):
-    application_setup: str
-    readonly_supported: bool | None
-    nonroot_supported: bool | None
-    privileged: bool | None
-    networking: str | None
-    hostname: Hostname | None
-    mac_address: MacAddress | None
-    env_vars: list[EnvVar] | None
-    volumes: list[Volume] | None
-    ports: list[Port] | None
-    custom: list[Custom] | None
-    security_opt: list[SecurityOpt] | None
-    devices: list[Device] | None
-    caps: list[Cap] | None
+    application_setup: str | None = None
+    readonly_supported: bool | None = None
+    nonroot_supported: bool | None = None
+    privileged: bool | None = None
+    networking: str | None = None
+    hostname: Hostname | None = None
+    mac_address: MacAddress | None = None
+    env_vars: list[EnvVar] | None = None
+    volumes: list[Volume] | None = None
+    ports: list[Port] | None = None
+    custom: list[Custom] | None = None
+    security_opt: list[SecurityOpt] | None = None
+    devices: list[Device] | None = None
+    caps: list[Cap] | None = None
 
 class Image(BaseModel):
     name: str
     github_url: str
-    project_url: str | None
-    project_logo: str | None
+    project_url: str | None = None
+    project_logo: str | None = None
     description: str
     version: str
     version_timestamp: str
@@ -103,8 +103,8 @@ class Image(BaseModel):
     stars: int
     tags: list[Tag]
     architectures: list[Architecture]
-    changelog: list[Changelog] | None
-    config: Config
+    changelog: list[Changelog] | None = None
+    config: Config | None  = None
 
 class Repository(BaseModel):
     linuxserver: list[Image]
@@ -116,3 +116,11 @@ class ImagesResponse(BaseModel):
     status: str
     last_updated: str
     data: ImagesData
+
+    def exclude_config(self):
+        for image in self.data.repositories.linuxserver:
+            image.config = None
+
+    def exclude_deprecated(self):
+        images = self.data.repositories.linuxserver
+        self.data.repositories.linuxserver = list(filter(lambda image: not image.deprecated, images))

root/app/updater.py

@@ -154,8 +154,11 @@ def get_image(repo):
     tags, stable = get_tags(readme_vars)
     deprecated = readme_vars.get("project_deprecation_status", False)
     version, version_timestamp = gh.get_last_stable_release(repo)
+    application_setup = None
+    if readme_vars.get("app_setup_block_enabled", False):
+        application_setup = f"{repo.html_url}?tab=readme-ov-file#application-setup"
     config = Config(
-        application_setup=f"{repo.html_url}?tab=readme-ov-file#application-setup",
+        application_setup=application_setup,
         readonly_supported=readme_vars.get("readonly_supported", None),
         nonroot_supported=readme_vars.get("nonroot_supported", None),
         privileged=readme_vars.get("privileged", None),
@@ -190,8 +193,8 @@ def get_image(repo):
 
 def update_images():
     with KeyValueStore(invalidate_hours=INVALIDATE_HOURS, readonly=False) as kv:
-        is_updated = kv.update_schema("images", IMAGES_SCHEMA_VERSION)
-        if ("images" in kv and is_updated) or CI == "1":
+        is_current_schema = kv.is_current_schema("images", IMAGES_SCHEMA_VERSION)
+        if ("images" in kv and is_current_schema) or CI == "1":
             print(f"{datetime.datetime.now()} - skipped - already updated")
             return
         print(f"{datetime.datetime.now()} - updating images")
@@ -202,6 +205,7 @@ def update_images():
             if not image:
                 continue
             images.append(image)
+        
         data = ImagesData(repositories=Repository(linuxserver=images))
         last_updated = datetime.datetime.now(datetime.timezone.utc).isoformat(' ', 'seconds')
         response = ImagesResponse(status="OK", last_updated=last_updated, data=data)