From 292f07cc1542688301a846607df7279986fcd7fe Mon Sep 17 00:00:00 2001 From: Luca Fabbri Date: Thu, 5 Sep 2024 11:54:48 +0200 Subject: [PATCH] Added general description of the API --- cads_catalogue_api_service/main.py | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/cads_catalogue_api_service/main.py b/cads_catalogue_api_service/main.py index 5c00a3e..2fd89d1 100644 --- a/cads_catalogue_api_service/main.py +++ b/cads_catalogue_api_service/main.py @@ -90,7 +90,15 @@ async def lifespan(application: fastapi.FastAPI): def catalogue_openapi() -> dict[str, Any]: """OpenAPI, but with not implemented paths removed.""" openapi_schema = fastapi.openapi.utils.get_openapi( - title="CADS STAC Catalogue", version=api.api_version, routes=api.app.routes + title="CADS STAC Catalogue", + version=api.api_version, + routes=api.app.routes, + description=( + "The CADS catalogue API is a STAC compliant API to access the CADS catalogues.\n\n" + "The implementation is based on [Standalone Collections]" + "(https://github.com/radiantearth/stac-spec/blob/master/collection-spec/collection-spec.md#standalone-collections) " # noqa: E501 + "while a custom extension is present to provide datasets search capabilities." + ), ) del openapi_schema["paths"]["/collections/{collection_id}/items"]