Conformance route

[fmigneault]

Conformance route should be implemented to link standards that the application conforms to and/or supports.

GET /conformance

see example:
https://github.com/opengeospatial/oapi_common/blob/master/standard/examples/conformance_response_JSON_1.adoc

Also update docs reference links to return (old pdf ref seem to be missing) :

• https://github.com/opengeospatial/wps-rest-binding
• https://opengeospatial.github.io/architecture-dwg/api-processes/index.html

Following is done for now:

weaver/weaver/wps_restapi/api.py

Lines 54 to 153 in 0b67d70

	def api_frontpage_body(settings):
	# type: (SettingsType) -> JSON
	"""Generates the JSON body describing the Weaver API and documentation references."""
	# import here to avoid circular import errors
	from weaver.config import get_weaver_configuration
	from weaver.wps import get_wps_url
	weaver_url = get_weaver_url(settings)
	weaver_config = get_weaver_configuration(settings)
	weaver_api = asbool(settings.get("weaver.wps_restapi"))
	weaver_api_url = get_wps_restapi_base_url(settings) if weaver_api else None
	weaver_api_def = weaver_api_url + sd.api_swagger_ui_service.path if weaver_api else None
	weaver_api_spec = weaver_api_url + sd.api_swagger_json_service.path if weaver_api else None
	weaver_wps = asbool(settings.get("weaver.wps"))
	weaver_wps_url = get_wps_url(settings) if weaver_wps else None
	weaver_conform_url = weaver_url + sd.api_conformance_service.path
	weaver_process_url = weaver_url + sd.processes_service.path
	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."},
	]
	if weaver_api:
	weaver_links.extend([
	{"href": weaver_api_url,
	"rel": "service", "type": CONTENT_TYPE_APP_JSON,
	"title": "WPS REST API endpoint of this service."},
	{"href": weaver_api_def,
	"rel": "swagger", "type": CONTENT_TYPE_TEXT_HTML,
	"title": "WPS REST API definition of this service."},
	{"href": weaver_api_spec,
	"rel": "OpenAPI", "type": CONTENT_TYPE_APP_JSON,
	"title": "WPS REST API specification of this service."},
	{"href": "https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/develop/docs/18-062.pdf",
	"rel": "documentation", "type": CONTENT_TYPE_APP_PDF,
	"title": "API documentation about this service."},
	{"href": "https://app.swaggerhub.com/apis/geoprocessing/WPS/",
	"rel": "wps-rest-swagger", "type": CONTENT_TYPE_TEXT_HTML,
	"title": "API reference specification of this service."},
	{"href": weaver_process_url,
	"rel": "processes", "type": CONTENT_TYPE_APP_JSON,
	"title": "Processes offered by this service."}
	])
	if weaver_wps:
	weaver_links.extend([
	{"href": weaver_wps,
	"rel": "wps", "type": CONTENT_TYPE_APP_XML,
	"title": "WPS 1.0.0/2.0 XML endpoint of this service."},
	{"href": "http://docs.opengeospatial.org/is/14-065/14-065.html",
	"rel": "wps-xml-specification", "type": CONTENT_TYPE_TEXT_HTML,
	"title": "WPS 1.0.0/2.0 definition of this service."},
	{"href": "http://schemas.opengis.net/wps/",
	"rel": "wps-xml-schema", "type": CONTENT_TYPE_APP_XML,
	"title": "WPS 1.0.0/2.0 XML validation schemas."}
	])
	return {
	"message": "Weaver Information",
	"configuration": weaver_config,
	"parameters": [
	{"name": "api", "enabled": weaver_api,
	"url": weaver_api_url,
	"api": weaver_api_def},
	{"name": "wps", "enabled": weaver_wps,
	"url": weaver_wps_url},
	],
	"links": weaver_links,
	}
	@sd.api_versions_service.get(tags=[sd.TAG_API], renderer=OUTPUT_FORMAT_JSON,
	schema=sd.VersionsEndpoint(), response_schemas=sd.get_api_versions_responses)
	def api_versions(request): # noqa: F811
	# type: (Request) -> HTTPException
	"""Weaver versions information."""
	weaver_info = {"name": "weaver", "version": __meta__.__version__, "type": "api"}
	return HTTPOk(json={"versions": [weaver_info]})
	@sd.api_conformance_service.get(tags=[sd.TAG_API], renderer=OUTPUT_FORMAT_JSON,
	schema=sd.ConformanceEndpoint(), response_schemas=sd.get_api_conformance_responses)
	def api_conformance(request): # noqa: F811
	# type: (Request) -> HTTPException
	"""Weaver specification conformance information."""
	# TODO: follow updates with https://github.com/geopython/pygeoapi/issues/198
	conformance = {"conformsTo": [
	# "http://www.opengis.net/spec/wfs-1/3.0/req/core",
	# "http://www.opengis.net/spec/wfs-1/3.0/req/oas30",
	# "http://www.opengis.net/spec/wfs-1/3.0/req/html",
	# "http://www.opengis.net/spec/wfs-1/3.0/req/geojson",
	"http://schemas.opengis.net/wps/1.0.0/",
	"http://schemas.opengis.net/wps/2.0/",
	"http://www.opengis.net/spec/WPS/2.0/req/service/binding/rest-json/core",
	# "http://www.opengis.net/spec/WPS/2.0/req/service/binding/rest-json/oas30",
	# "http://www.opengis.net/spec/WPS/2.0/req/service/binding/rest-json/html"
	"https://github.com/opengeospatial/wps-rest-binding",
	]}
	return HTTPOk(json=conformance)

Following still must be added :

• CWL specifications:
  • https://www.commonwl.org/#Specification (in both conformsTo and frontpage links)
  • https://www.commonwl.org/v1.0/CommandLineTool.html (only conformsTo)
  • https://www.commonwl.org/v1.0/Workflow.html (only conformsTo)
  • https://www.commonwl.org/v1.1/CommandLineTool.html (only conformsTo)
  • https://www.commonwl.org/v1.1/Workflow.html (only conformsTo)
  • Employ actual requirements from best-practices instead:
    Apply EOAPs best-practice requirements/conformance classes #399
• WPS-REST
  • http://www.opengis.net/spec/ogcapi-processes/ (under frontpage links)
  • http://www.opengis.net/spec/ogcapi-processes/1.0/req/core (under conformsTo)
  • http://www.opengis.net/spec/ogcapi-processes/1.0/conf/core (under conformsTo)
  • other items under above ogcapi-processes namespace?
    (identified from: https://github.com/opengeospatial/wps-rest-binding/search?q=rc_core&unscoped_q=rc_core)
• see also: How to correctly document conformance? opengeospatial/ogcapi-processes#71

Slightly more official/recent conformance definitions:
https://htmlpreview.github.io/?https://github.com/opengeospatial/ogcapi-processes/blob/master/docs/18-062.html#_conformance

• Core: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/core
• Processes: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/ogc-process-description
• JSON: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/json
• HTML: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/html (implementation needed [Feature] HTML format #210)
  • include conformance requirements in https://github.com/opengeospatial/ogcapi-processes/tree/master/core/requirements/html
• OAS3: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/oas30
• Job List: Update Job list conformance requiremnets #606
• Callback: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/callback (implementation needed [Feature] Support and validate Job notification callback URL #230)
• Dismiss: http://www.opengis.net/spec/ogcapi-processes-1/1.0/conf/dismiss (implementation needed [Feature] Support job dismiss operation #228)
• KVP execution Update Job list conformance requiremnets #606, conformance for KVP execution #607