Skip to content

Feature/edr conformance #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
scranford1 merged 3 commits into from
Feb 18, 2026
Merged

Feature/edr conformance #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3bec726
Add optional resolution parameters
scranford1 Feb 16, 2026
0277dfb
Supporting EDR version 1.1.0 and custom api documentation
scranford1 Feb 17, 2026
3ab9b8c
Reduce duplication for Sonarqube
scranford1 Feb 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
331 changes: 329 additions & 2 deletions ogc/edr/edr_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,15 @@
class EdrAPI:
"""Used to modify the default responses before returning data to the user."""

CONFORMANCE_CLASSES = sorted(
{
"https://www.opengis.net/spec/ogcapi-common-1/1.0/conf/core",
Comment thread
scranford1 marked this conversation as resolved.
"https://www.opengis.net/spec/ogcapi-common-2/1.0/conf/collections",
"https://www.opengis.net/spec/ogcapi-edr-1/1.1/conf/core",
}
)
SCHEMA_CLASS = "https://schemas.opengis.net/ogcapi/edr/1.1/openapi"

@jsonldify
@staticmethod
def landing_page(api: API, request: APIRequest) -> Tuple[dict, int, str]:
Expand Down Expand Up @@ -51,7 +60,24 @@ def openapi_(api: API, request: APIRequest) -> Tuple[dict, int, str]:
Tuple[dict, int, str]
Headers, HTTP Status, and Content returned as a tuple.
"""
return pygeoapi.api.openapi_(api, request)
html_path = "openapi/redoc.html" if request._args.get("ui") == "redoc" else "openapi/swagger.html"
headers = request.get_response_headers(**api.api_headers)

if request.format == pygeoapi.api.F_HTML:
data = {"openapi-document-path": f"{api.base_url}/openapi"}
content = pygeoapi.api.render_j2_template(
api.tpl_config, api.config["server"]["templates"], html_path, data, request.locale
)

return headers, HTTPStatus.OK, content

headers["Content-Type"] = "application/vnd.oai.openapi+json;version=3.0"

if isinstance(api.openapi, dict):
openapi = EdrAPI._openapi_update(api.openapi)
return headers, HTTPStatus.OK, to_json(openapi, api.pretty_print)
else:
return headers, HTTPStatus.OK, api.openapi

@staticmethod
def conformance(api: API, request: APIRequest) -> Tuple[dict, int, str]:
Expand All @@ -69,7 +95,18 @@ def conformance(api: API, request: APIRequest) -> Tuple[dict, int, str]:
Tuple[dict, int, str]
Headers, HTTP Status, and Content returned as a tuple.
"""
return pygeoapi.api.conformance(api, request)
html_path = "conformance.html"
conformance = {"conformsTo": list(EdrAPI.CONFORMANCE_CLASSES)}

headers = request.get_response_headers(**api.api_headers)
if request.format == pygeoapi.api.F_HTML:
content = pygeoapi.api.render_j2_template(
api.tpl_config, api.config["server"]["templates"], html_path, conformance, request.locale
)

return headers, HTTPStatus.OK, content

return headers, HTTPStatus.OK, to_json(conformance, api.pretty_print)

@jsonldify
@staticmethod
Expand Down Expand Up @@ -336,3 +373,293 @@ def _instance_parameters(
},
}
return instance_parameters

@staticmethod
def _openapi_update(api: Dict[str, Any]) -> Dict[str, Any]:
"""Update the default OpenAPI definition to a custom format.

Parameters
----------
api : Dict[str, Any]
The OpenAPI definition to be updated.

Returns
-------
Dict[str, Any]
The customized OpenAPI definition.
"""
server_tag = "Server"
collection_tag = "Collection Information"
instance_tag = "Instance Information"
query_tag = "Query"

resource_not_found_error = {"description": "Resource not found."}
internal_application_error = {
"description": "Internal application error",
"content": {
"application/xml": {
"schema": {
"type": "object",
"format": "xml",
"xml": {"name": "ExceptionReport"},
},
"example": (
'<?xml version="1.0"?>'
"<ExceptionReport>"
'<Exception exceptionCode="NoApplicableCode">'
"<ExceptionText>Internal application error</ExceptionText>"
"</Exception>"
"</ExceptionReport>"
),
}
},
}

query_base_parameters = [
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/core/crs.yaml"},
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/core/datetime.yaml"},
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/core/f.yaml"},
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/core/parameter-name.yaml"},
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/core/z.yaml"},
]
query_responses = {
"200": {
"$ref": f"{EdrAPI.SCHEMA_CLASS}/responses/queries/200.yaml",
},
"400": {
"$ref": f"{EdrAPI.SCHEMA_CLASS}/responses/queries/400.yaml",
},
"404": resource_not_found_error,
"default": internal_application_error,
}

openapi = {}
openapi["openapi"] = api.get("openapi")
openapi["info"] = api.get("info")
openapi["servers"] = api.get("servers")
openapi["tags"] = [server_tag, collection_tag, instance_tag, query_tag]
openapi["paths"] = {
"/": {
"get": {
"summary": "Landing Page",
"description": "Landing page of the API.",
"tags": [server_tag],
"operationId": "getLandingPage",
"parameters": [
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/core/f.yaml"},
],
"responses": {
"200": {
"$ref": f"{EdrAPI.SCHEMA_CLASS}/responses/core/landingPage.yaml",
},
"default": internal_application_error,
},
},
},
"/api": {
"get": {
"summary": "Capabilities of the API.",
"description": "API",
"tags": [server_tag],
"operationId": "getApi",
"parameters": [
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/core/f.yaml"},
],
"responses": {
"200": {
"description": "API capabilities",
},
"default": internal_application_error,
},
},
},
"/conformance": {
"get": {
"summary": "Conformance classes defining standard compliance of the API.",
"description": "Conformance Classes",
"tags": [server_tag],
"operationId": "getConformance",
"parameters": [
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/core/f.yaml"},
],
"responses": {
"200": {
"$ref": f"{EdrAPI.SCHEMA_CLASS}/responses/core/conformance.yaml",
},
"default": internal_application_error,
},
},
},
"/collections": {
"get": {
"summary": "Collection information for all available collections.",
"description": "Collections",
"tags": [collection_tag],
"operationId": "getCollections",
"parameters": [
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/core/f.yaml"},
],
"responses": {
"200": {
"$ref": f"{EdrAPI.SCHEMA_CLASS}/responses/collections/collections.yaml",
},
"default": internal_application_error,
},
},
},
"/collections/{collectionId}": {
"get": {
"summary": "Collection information for a single collection.",
"description": "Collection",
"tags": [collection_tag],
"operationId": "getCollection",
"parameters": [
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/collections/collectionId.yaml"},
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/core/f.yaml"},
],
"responses": {
"200": {
"$ref": f"{EdrAPI.SCHEMA_CLASS}/responses/collections/collection.yaml",
},
"404": resource_not_found_error,
"default": internal_application_error,
},
},
},
"/collections/{collectionId}/area": {
"get": {
"summary": "Query a collection for an area.",
"description": "Collection Area Query",
"tags": [query_tag],
"operationId": "getCollectionArea",
"parameters": [
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/core/areaCoords.yaml"},
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/collections/collectionId.yaml"},
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/core/resolution-x.yaml"},
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/core/resolution-y.yaml"},
*query_base_parameters,
],
"responses": query_responses,
},
},
"/collections/{collectionId}/cube": {
"get": {
"summary": "Query a collection for a cube.",
"description": "Collection Cube Query",
"tags": [query_tag],
"operationId": "getCollectionCube",
"parameters": [
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/core/bbox.yaml"},
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/collections/collectionId.yaml"},
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/core/resolution-x.yaml"},
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/core/resolution-y.yaml"},
*query_base_parameters,
],
"responses": query_responses,
},
},
"/collections/{collectionId}/position": {
"get": {
"summary": "Query a collection for a position.",
"description": "Collection Position Query",
"tags": [query_tag],
"operationId": "getCollectionPosition",
"parameters": [
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/core/positionCoords.yaml"},
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/collections/collectionId.yaml"},
*query_base_parameters,
],
"responses": query_responses,
},
},
"/collections/{collectionId}/instances/": {
"get": {
"summary": "Instance information for all available instances in a collection.",
"description": "Collection Instances",
"tags": [instance_tag],
"operationId": "getCollectionInstances",
"parameters": [
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/core/f.yaml"},
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/collections/collectionId.yaml"},
],
"responses": {
"200": {
"$ref": f"{EdrAPI.SCHEMA_CLASS}/responses/queries/instances.yaml",
},
"404": resource_not_found_error,
"default": internal_application_error,
},
},
},
"/collections/{collectionId}/instances/{instanceId}": {
"get": {
"summary": "Instance information for a single instance in a collection.",
"description": "Collection Instance",
"tags": [instance_tag],
"operationId": "getCollectionInstance",
"parameters": [
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/core/f.yaml"},
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/collections/collectionId.yaml"},
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/queries/instanceId.yaml"},
],
"responses": {
"200": {
"$ref": f"{EdrAPI.SCHEMA_CLASS}/responses/queries/instances.yaml",
},
"404": resource_not_found_error,
"default": internal_application_error,
},
},
},
"/collections/{collectionId}/instances/{instanceId}/area": {
"get": {
"summary": "Query a collection instance for an area.",
"description": "Instance Area Query",
"tags": [query_tag],
"operationId": "getCollectionInstanceArea",
"parameters": [
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/core/areaCoords.yaml"},
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/collections/collectionId.yaml"},
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/queries/instanceId.yaml"},
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/core/resolution-x.yaml"},
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/core/resolution-y.yaml"},
*query_base_parameters,
],
"responses": query_responses,
},
},
"/collections/{collectionId}/instances/{instanceId}/cube": {
"get": {
"summary": "Query a collection instance for a cube.",
"description": "Instance Cube Query",
"tags": [query_tag],
"operationId": "getCollectionInstanceCube",
"parameters": [
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/core/bbox.yaml"},
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/collections/collectionId.yaml"},
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/queries/instanceId.yaml"},
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/core/resolution-x.yaml"},
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/core/resolution-y.yaml"},
*query_base_parameters,
],
"responses": query_responses,
},
},
"/collections/{collectionId}/instances/{instanceId}/position": {
"get": {
"summary": "Query a collection instance for a position.",
"description": "Instance Position Query",
"tags": [query_tag],
"operationId": "getCollectionInstancePosition",
"parameters": [
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/core/positionCoords.yaml"},
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/collections/collectionId.yaml"},
{"$ref": f"{EdrAPI.SCHEMA_CLASS}/parameters/queries/instanceId.yaml"},
*query_base_parameters,
],
"responses": query_responses,
},
},
}

return openapi
Loading