GeoHealthCheck.plugins.probe.ogcfeat
====================================

.. py:module:: GeoHealthCheck.plugins.probe.ogcfeat


Classes
-------

.. autoapisummary::

   GeoHealthCheck.plugins.probe.ogcfeat.OGCFeatCaps
   GeoHealthCheck.plugins.probe.ogcfeat.OGCFeatDrilldown
   GeoHealthCheck.plugins.probe.ogcfeat.OGCFeatOpenAPIValidator


Functions
---------

.. autoapisummary::

   GeoHealthCheck.plugins.probe.ogcfeat.type_for_link
   GeoHealthCheck.plugins.probe.ogcfeat.set_accept_header
   GeoHealthCheck.plugins.probe.ogcfeat.supports_feature_items


Module Contents
---------------

.. py:class:: OGCFeatCaps

   Bases: :py:obj:`GeoHealthCheck.probe.Probe`


   Probe for OGC API - Features endpoint url


   .. py:attribute:: NAME
      :value: 'OGC API Features (OAFeat) Capabilities'


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



   .. py:attribute:: DESCRIPTION
      :value: 'Validate OGC API Features (OAFeat) endpoint landing page'


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



   .. py:attribute:: RESOURCE_TYPE
      :value: 'OGCFeat'


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



   .. py:attribute:: REQUEST_METHOD
      :value: 'GET'


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



   .. py:attribute:: REQUEST_HEADERS

      `dict` of optional HTTP request headers.



   .. py:attribute:: REQUEST_TEMPLATE
      :value: ''


      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.



   .. py:attribute:: CHECKS_AVAIL

      Validate OGC API Features (OAFeat) endpoint landing page



.. py:function:: type_for_link(links, rel)

.. py:function:: set_accept_header(oa_feat, content_type)

.. py:function:: supports_feature_items(collection)

.. py:class:: OGCFeatDrilldown

   Bases: :py:obj:`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.


   .. py:attribute:: NAME
      :value: 'OGC API Features (OAFeat) Drilldown'


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



   .. py:attribute:: DESCRIPTION
      :value: 'Traverses an OGC API Features (OAFeat) API endpoint by drilling down'


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



   .. py:attribute:: RESOURCE_TYPE
      :value: 'OGCFeat'


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



   .. py:attribute:: REQUEST_METHOD
      :value: 'GET'


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



   .. py:attribute:: REQUEST_HEADERS

      `dict` of optional HTTP request headers.



   .. py:attribute:: PARAM_DEFS

      Param defs



   .. py:method:: perform_request()

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



.. py:class:: OGCFeatOpenAPIValidator

   Bases: :py:obj:`GeoHealthCheck.probe.Probe`


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



   .. py:attribute:: NAME
      :value: 'OGC API Features (OAFeat) OpenAPI Validator'


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



   .. py:attribute:: DESCRIPTION
      :value: 'Validates OGC API Features (OAFeat) api endpoint for OpenAPI compliance'


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



   .. py:attribute:: RESOURCE_TYPE
      :value: 'OGCFeat'


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



   .. py:attribute:: REQUEST_HEADERS

      `dict` of optional HTTP request headers.



   .. py:attribute:: REQUEST_METHOD
      :value: 'GET'


      Param defs



   .. py:method:: perform_request()

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