9.3.1.13.1.2.1.6. GeoHealthCheck.plugins.probe.ogcfeat

9.3.1.13.1.2.1.6.1. Classes

OGCFeatCaps

Probe for OGC API - Features endpoint url

OGCFeatDrilldown

Probe for OGC API Features (OAFeat) endpoint "drilldown" or

OGCFeatOpenAPIValidator

Probe for OGC API Features (OAFeat) OpenAPI Document Validation.

9.3.1.13.1.2.1.6.2. Functions

type_for_link(links, rel)

set_accept_header(oa_feat, content_type)

supports_feature_items(collection)

9.3.1.13.1.2.1.6.3. Module Contents

class GeoHealthCheck.plugins.probe.ogcfeat.OGCFeatCaps

Bases: GeoHealthCheck.probe.Probe

Probe for OGC API - Features endpoint url

NAME = 'OGC API Features (OAFeat) Capabilities'

Short name of Plugin. TODO: i18n e.g. NAME_nl_NL ?

DESCRIPTION = 'Validate OGC API Features (OAFeat) endpoint landing page'

Longer description of Plugin. TODO: optional i18n e.g. DESCRIPTION_de_DE ?

RESOURCE_TYPE = 'OGCFeat'

Type of GHC Resource e.g. ‘OGC:WMS’, default not applicable.

REQUEST_METHOD = 'GET'

HTTP request method capitalized, GET (default) or POST.

REQUEST_HEADERS

dict of optional HTTP request headers.

REQUEST_TEMPLATE = ''

Template in standard Python str.format(*args). The variables like {service} and {version} within a template are filled from actual values for parameters defined in PARAM_DEFS and substituted from values or constant values specified by user in GUI and stored in DB.

CHECKS_AVAIL

Validate OGC API Features (OAFeat) endpoint landing page

GeoHealthCheck.plugins.probe.ogcfeat.set_accept_header(oa_feat, content_type)
GeoHealthCheck.plugins.probe.ogcfeat.supports_feature_items(collection)
class GeoHealthCheck.plugins.probe.ogcfeat.OGCFeatDrilldown

Bases: GeoHealthCheck.probe.Probe

Probe for OGC API Features (OAFeat) endpoint “drilldown” or “crawl”: starting with top endpoint: get Collections and fetch Features on them etc. Uses the OWSLib owslib.ogcapi package.

NAME = 'OGC API Features (OAFeat) Drilldown'

Short name of Plugin. TODO: i18n e.g. NAME_nl_NL ?

DESCRIPTION = 'Traverses an OGC API Features (OAFeat) API endpoint by drilling down'

Longer description of Plugin. TODO: optional i18n e.g. DESCRIPTION_de_DE ?

RESOURCE_TYPE = 'OGCFeat'

Type of GHC Resource e.g. ‘OGC:WMS’, default not applicable.

REQUEST_METHOD = 'GET'

HTTP request method capitalized, GET (default) or POST.

REQUEST_HEADERS

dict of optional HTTP request headers.

PARAM_DEFS

Param defs

perform_request()

Perform the drilldown. See https://github.com/geopython/OWSLib/blob/ master/tests/doctests/wfs3_GeoServerCapabilities.txt

class GeoHealthCheck.plugins.probe.ogcfeat.OGCFeatOpenAPIValidator

Bases: GeoHealthCheck.probe.Probe

Probe for OGC API Features (OAFeat) OpenAPI Document Validation. Uses https://pypi.org/project/openapi-spec-validator/.

NAME = 'OGC API Features (OAFeat) OpenAPI Validator'

Short name of Plugin. TODO: i18n e.g. NAME_nl_NL ?

DESCRIPTION = 'Validates OGC API Features (OAFeat) api endpoint for OpenAPI compliance'

Longer description of Plugin. TODO: optional i18n e.g. DESCRIPTION_de_DE ?

RESOURCE_TYPE = 'OGCFeat'

Type of GHC Resource e.g. ‘OGC:WMS’, default not applicable.

REQUEST_HEADERS

dict of optional HTTP request headers.

REQUEST_METHOD = 'GET'

Param defs

perform_request()

Perform the validation. Uses https://github.com/p1c2u/openapi-spec-validator on the specfile (dict) returned from the OpenAPI endpoint.