application.py

from fastapi import FastAPI
from stapi_pydantic import Product, Provider

from pystapi_schema_generator import STAPI_BASE_URL, STAPI_VERSION
from pystapi_schema_generator.root_router import RootRouter


def create_app() -> FastAPI:
    """Create and configure the FastAPI application for OpenAPI spec generation."""
    app = FastAPI(
        title="STAPI API",
        description=(
            "The Sensor Tasking API (STAPI) defines a JSON-based web API to query for "
            "spatio-temporal analytic and data products derived from remote sensing "
            "(satellite or airborne) providers. The specification supports both products "
            "derived from new tasking and products from provider archives."
        ),
        version=STAPI_VERSION,
        openapi_tags=[
            {
                "name": "Core",
                "description": "Core endpoints for API discovery and metadata.",
                "externalDocs": {
                    "description": "STAPI Core Specification",
                    "url": "https://github.com/stapi-spec/stapi-spec/blob/main/core/README.md",
                },
            },
            {
                "name": "Products",
                "description": "Endpoints for discovering and accessing remote sensing data products.",
                "externalDocs": {
                    "description": "STAPI Product Specification",
                    "url": "https://github.com/stapi-spec/stapi-spec/blob/main/product/README.md",
                },
            },
            {
                "name": "Orders",
                "description": "Endpoints for creating and managing remote sensing data orders.",
                "externalDocs": {
                    "description": "STAPI Order Specification",
                    "url": "https://github.com/stapi-spec/stapi-spec/blob/main/order/README.md",
                },
            },
            {
                "name": "Opportunities",
                "description": "Endpoints for searching remote sensing acquisition opportunities.",
                "externalDocs": {
                    "description": "STAPI Opportunity Specification",
                    "url": "https://github.com/stapi-spec/stapi-spec/blob/main/opportunity/README.md",
                },
            },
        ],
        docs_url="/docs",
        redoc_url="/redoc",
        openapi_url="/openapi.json",
        # Enhanced OpenAPI configuration
        openapi_extra={
            "info": {
                "contact": {
                    "name": "STAPI Specification Organization",
                    "url": "https://github.com/stapi-spec",
                }
            },
            "externalDocs": {
                "description": "STAPI Specification Documentation",
                "url": "https://github.com/stapi-spec/stapi-spec",
            },
        },
        # Swagger UI customization
        swagger_ui_parameters={
            "deepLinking": True,
            "docExpansion": "list",  # list endpoints but details are collapsed
            "defaultModelsExpandDepth": 0,  # Show schemas at the bottom but collapsed
            "supportedSubmitMethods": [],  # Disable all submit methods to prevent "Try it out"
        },
        # ReDoc customization
        redoc_ui_parameters={
            # TODO: Add Redoc customization parameters here if needed
        },
    )

    router = RootRouter()
    router.add_product(
        Product(
            id="{productId}",
            title="Example Product",
            description=(
                "This is an example product that demonstrates the STAPI specification. "
                "Implementers should replace this with their actual product definitions, "
                "including specific metadata, queryable properties, and order parameters."
            ),
            license="proprietary",
            providers=[
                Provider(
                    name="Example Provider",
                    roles=["producer"],
                    url="https://example.com/provider",
                    description="Example provider for demonstration purposes",
                )
            ],
            links=[],
            stapi_type="Product",
            stapi_version=STAPI_VERSION,
            conformsTo=[
                f"{STAPI_BASE_URL}/{STAPI_VERSION}/core",
                "https://geojson.org/schema/Polygon.json",
            ],
        )
    )

    app.include_router(router, prefix="")

    return app


# Create the FastAPI application instance
app = create_app()


def main() -> None:
    """Generate OpenAPI schema for STAPI."""
    import argparse

    import yaml

    parser = argparse.ArgumentParser(description="Generate OpenAPI schema for STAPI")
    parser.add_argument(
        "--output",
        "-o",
        default="openapi.yml",
        help="Output file path for the OpenAPI schema (default: openapi.yml)",
    )
    args = parser.parse_args()

    with open(args.output, "w") as f:
        yaml.dump(app.openapi(), f)

    print(f"OpenAPI schema saved to '{args.output}'.")


if __name__ == "__main__":
    main()