some progress

Author: toro-berlin

pystapi-schema-generator/pyproject.toml

@@ -5,6 +5,7 @@ description = "Schema Generator for the Satellite Tasking API (STAPI) Specificat
 readme = "README.md"
 authors = [
     { name = "Tobias Rohnstock", email = "tobias.rohnstock@live-eo.com" },
+    { name = "Justin Trautmann", email = "justin@live-eo.com" },
 ]
 requires-python = ">=3.10"
 dependencies = [

pystapi-schema-generator/src/pystapi_schema_generator/application.py

@@ -1,10 +1,9 @@
 from fastapi import FastAPI
-from stapi_fastapi.conformance import CORE, OPPORTUNITIES
 from stapi_pydantic import Product
 
 from pystapi_schema_generator.router import RootRouter
 
-router = RootRouter(conformances=[CORE, OPPORTUNITIES])
+router = RootRouter()
 router.add_product(
     Product(
         id="{productId}",

pystapi-schema-generator/src/pystapi_schema_generator/router.py

@@ -1,7 +1,6 @@
 from typing import Any
 
-from fastapi import APIRouter, Path, Request
-from stapi_fastapi.conformance import CORE
+from fastapi import APIRouter, Path
 from stapi_fastapi.responses import GeoJSONResponse
 from stapi_pydantic import (
     Conformance,
@@ -18,27 +17,8 @@
 
 
 class RootRouter(APIRouter):
-    def __init__(
-        self,
-        conformances: list[str] = [CORE],
-        name: str = "root",
-        openapi_endpoint_name: str = "openapi",
-        docs_endpoint_name: str = "swagger_ui_html",
-        *args: Any,
-        **kwargs: Any,
-    ) -> None:
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
         super().__init__(*args, **kwargs)
-
-        self.conformances = conformances
-        self.name = name
-        self.openapi_endpoint_name = openapi_endpoint_name
-        self.docs_endpoint_name = docs_endpoint_name
-        self.product_ids: list[str] = []
-
-        # A dict is used to track the product routers so we can ensure
-        # idempotentcy in case a product is added multiple times, and also to
-        # manage clobbering if multiple products with the same product_id are
-        # added.
         self.product_routers: dict[str, ProductRouter] = {}
 
         # Core endpoints
@@ -47,17 +27,29 @@ def __init__(
             self.get_root,
             methods=["GET"],
             tags=["Core"],
-            summary="landing page",
-            description="...",
+            summary="STAPI root endpoint for API discovery and metadata",
+            description=(
+                "This endpoint serves as the entry point for API discovery and navigation. "
+                "Returns the STAPI root endpoint response containing the API's metadata: "
+                "a unique identifier, descriptive text, implemented conformance classes, "
+                "and hypermedia links to available resources and documentation."
+            ),
         )
 
         self.add_api_route(
             "/conformance",
             self.get_conformance,
             methods=["GET"],
             tags=["Core"],
-            summary="information about specifications that this API conforms to",
-            description="A list of all conformance classes specified in a standard that the server conforms to.",
+            summary="List of implemented STAPI and OGC conformance classes",
+            description=(
+                "Returns a list of conformance classes implemented by this API, following "
+                "the OGC API Features conformance structure. While the core STAPI "
+                "conformance classes are already communicated in the root endpoint, "
+                "OGC API requires this duplicate conformance information at this "
+                "/conformance endpoint. Includes both STAPI-specific conformance classes "
+                "(e.g., core, order statuses, searches) and relevant OGC conformance classes."
+            ),
         )
 
         # Orders endpoints - w/o specific {productId}/orders endpoints
@@ -105,32 +97,23 @@ def add_product(self, product: Product, *args: Any, **kwargs: Any) -> None:
         product_router = ProductRouter(product, self, *args, **kwargs)
         self.include_router(product_router, prefix=f"/products/{product.id}")
         self.product_routers[product.id] = product_router
-        self.product_ids = [*self.product_routers.keys()]
 
-    def get_root(self, request: Request) -> RootResponse:
+    def get_root(self) -> RootResponse:
         return None  # type: ignore
 
     def get_conformance(self) -> Conformance:
         return None  # type: ignore
 
-    def get_products(self, request: Request) -> ProductsCollection:
+    def get_products(self) -> ProductsCollection:
         return None  # type: ignore
 
-    def get_orders(self, request: Request) -> OrderCollection[OrderStatus]:
+    def get_orders(self) -> OrderCollection[OrderStatus]:
         return None  # type: ignore
 
     def get_order(
-        self,
-        request: Request,
-        order_id: str = Path(alias="orderId", description="local identifier of an order"),
+        self, order_id: str = Path(alias="orderId", description="local identifier of an order")
     ) -> Order[OrderStatus]:
         return None  # type: ignore
 
-    def get_order_statuses(
-        self,
-        order_id: str,
-        request: Request,
-        next: str | None = None,
-        limit: int = 10,
-    ) -> OrderStatuses:  # type: ignore
+    def get_order_statuses(self, order_id: str, next: str | None = None, limit: int = 10) -> OrderStatuses:  # type: ignore
         return None  # type: ignore

stapi-pydantic/src/stapi_pydantic/conformance.py

@@ -2,4 +2,4 @@
 
 
 class Conformance(BaseModel):
-    conforms_to: list[str] = Field(serialization_alias="conformsTo")
+    conforms_to: list[str] = Field(default_factory=list, serialization_alias="conformsTo")

stapi-pydantic/src/stapi_pydantic/root.py

@@ -1,12 +1,11 @@
 from pydantic import BaseModel, Field
-from pydantic.json_schema import SkipJsonSchema
 
 from .shared import Link
 
 
 class RootResponse(BaseModel):
-    conforms_to: list[str] = Field(serialization_alias="conformsTo")
     id: str
-    title: str | SkipJsonSchema[None] = None
-    description: str
-    links: list[Link]
+    conformsTo: list[str] = Field(default_factory=list)
+    title: str = ""
+    description: str = ""
+    links: list[Link] = Field(default_factory=list)