:py:mod:`GeoHealthCheck.plugins.probe.ogcfeat`
==============================================

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


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

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



.. 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'

      

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

      

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

      

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

      

   .. py:attribute:: REQUEST_HEADERS

      

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

      

   .. 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: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'

      

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

      

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

      

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

      

   .. py:attribute:: 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'

      

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

      

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

      

   .. py:attribute:: 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.