From acc0e9c09626cbe5f9e8ddcc240292679b7b9b4c Mon Sep 17 00:00:00 2001 From: Francis Charette Migneault Date: Tue, 25 May 2021 17:23:38 -0400 Subject: [PATCH] update metadata doc links (relates to #231) --- CHANGES.rst | 5 ++++- docs/source/references.rst | 2 +- weaver/wps_restapi/api.py | 20 ++++++++++++++++++-- 3 files changed, 23 insertions(+), 4 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index b50cf8557..4e30a124e 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -10,7 +10,9 @@ Changes Changes: -------- -- No change. +- Add reference link to ReadTheDocs URL of `Weaver` in API landing page. +- Add references to `OGC-API Processes` requirements and recommendations for eventual conformance listing + (relates to `#231 `_). Fixes: ------ @@ -21,6 +23,7 @@ Fixes: (see issue `#526 `_). - Fix default execution mode specification in process job control options (fixes `#182 `_). +- Fix old OGC-API WPS REST bindings link in landing page for the more recent `OGC-API Processes` specification. `3.1.0 `_ (2021-04-23) ======================================================================== diff --git a/docs/source/references.rst b/docs/source/references.rst index b0f1ccdc3..e29401d76 100644 --- a/docs/source/references.rst +++ b/docs/source/references.rst @@ -47,7 +47,7 @@ .. |ogc-home| replace:: |ogc| Homepage .. _ogc-home: `ogc`_ .. |ogc-proc-api| replace:: OGC API - Processes -.. _ogc-proc-api: https://github.com/opengeospatial/wps-rest-binding +.. _ogc-proc-api: https://github.com/opengeospatial/ogcapi-processes .. |pywps| replace:: PyWPS .. _pywps: https://github.com/geopython/pywps/ .. |pywps-status| replace:: Progress and Status Report diff --git a/weaver/wps_restapi/api.py b/weaver/wps_restapi/api.py index a0361c6a2..40010fc67 100644 --- a/weaver/wps_restapi/api.py +++ b/weaver/wps_restapi/api.py @@ -77,7 +77,7 @@ def api_frontpage_body(settings): weaver_links = [ {"href": weaver_url, "rel": "self", "type": CONTENT_TYPE_APP_JSON, "title": "This document"}, {"href": weaver_conform_url, "rel": "conformance", "type": CONTENT_TYPE_APP_JSON, - "title": "WPS conformance classes implemented by this service."}, + "title": "Conformance classes implemented by this service."}, ] if weaver_api: weaver_links.extend([ @@ -130,6 +130,10 @@ def api_frontpage_body(settings): doc_type = CONTENT_TYPE_TEXT_PLAIN # default most basic type weaver_links.append({"href": weaver_api_doc, "rel": "documentation", "type": doc_type, "title": "API reference documentation about this service."}) + else: + weaver_links.append({"href": __meta__.__documentation_url__, "rel": "documentation", + "type": CONTENT_TYPE_TEXT_HTML, + "title": "API reference documentation about this service."}) if weaver_wps: weaver_links.extend([ {"href": weaver_wps_url, @@ -177,7 +181,16 @@ def api_versions(request): # noqa: F811 def api_conformance(request): # noqa: F811 # type: (Request) -> HTTPException """Weaver specification conformance information.""" - # TODO: follow updates with https://github.com/geopython/pygeoapi/issues/198 + # see references: + # - https://github.com/opengeospatial/ogcapi-common/tree/Working/collections/requirements + # - https://github.com/opengeospatial/ogcapi-common/tree/Working/collections/recommendations + # - https://github.com/opengeospatial/ogcapi-processes/tree/master/core/requirements + # - https://github.com/opengeospatial/ogcapi-processes/tree/master/core/recommendations + # - https://github.com/opengeospatial/ogcapi-processes/tree/master/extensions/transactions/standard/requirements + # - https://github.com/opengeospatial/ogcapi-processes/tree/master/extensions/transactions/standard/recommendations + # - https://github.com/opengeospatial/ogcapi-processes/tree/master/extensions/workflows/standard/requirements + # - https://github.com/opengeospatial/ogcapi-processes/tree/master/extensions/workflows/standard/recommendations + conformance = {"conformsTo": [ # "http://www.opengis.net/spec/wfs-1/3.0/req/core", # "http://www.opengis.net/spec/wfs-1/3.0/req/oas30", @@ -205,6 +218,9 @@ def api_conformance(request): # noqa: F811 # "http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/callback", # FIXME: https://github.com/crim-ca/weaver/issues/228 # "http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/dismiss", + # FIXME: https://github.com/crim-ca/weaver/issues/231 + # List all supported requirements, recommendations and abstract tests + "http://www.opengis.net/spec/ogcapi-processes-1/1.0/req/core/process", ]} return HTTPOk(json=conformance)