Skip to content

Commit

Permalink
Added general description of the API
Browse files Browse the repository at this point in the history
  • Loading branch information
keul committed Sep 5, 2024
1 parent 5f23430 commit 292f07c
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion cads_catalogue_api_service/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
Expand Down

0 comments on commit 292f07c

Please sign in to comment.