diff --git a/docs/source/plugins.rst b/docs/source/plugins.rst index 0badbf4f6..29977991c 100644 --- a/docs/source/plugins.rst +++ b/docs/source/plugins.rst @@ -466,6 +466,8 @@ Below is a sample process definition as a Python dictionary: Additional processing plugins can also be found in ``pygeoapi/process``. +.. _example-custom-pygeoapi-formatter: + Example: custom pygeoapi formatter ---------------------------------- diff --git a/docs/source/publishing/ogcapi-edr.rst b/docs/source/publishing/ogcapi-edr.rst index 246a70b76..ed80c384c 100644 --- a/docs/source/publishing/ogcapi-edr.rst +++ b/docs/source/publishing/ogcapi-edr.rst @@ -123,6 +123,36 @@ relies on using the ObservedProperty Entity to create the `parameter-name` set. EDR query type. +Formatters +---------- + +CoverageJSON is the default format provided by edr providers. Additional formats can +be added to configuration using one of the pygeoapi core formatters or by building a +custom formatter plugin. + +.. note:: + See the :ref:`plugin documentation ` for more + information on custom formatter plugins. + +.. csv-table:: + :header: Formatter, format parameter value + :align: left + + :ref:`CSV `,``f=csv`` + +.. _csv-formatter-edr: + +CSV +^^^ + +.. code-block:: yaml + + formatters: + - name: CSV # propagated by .../items?f=csv + geom: False # whether to include geometry (default=False) + attachment: True # whether to provide as an attachment (default=False) + + Data access examples -------------------- diff --git a/docs/source/publishing/ogcapi-features.rst b/docs/source/publishing/ogcapi-features.rst index 8a38e0b98..1acb51c16 100644 --- a/docs/source/publishing/ogcapi-features.rst +++ b/docs/source/publishing/ogcapi-features.rst @@ -45,6 +45,8 @@ Connection examples Below are specific connection examples based on supported providers. +.. _csv: + CSV ^^^ @@ -845,6 +847,36 @@ To publish a TinyDB (`see website `_) index, the .. _including-extra-query-parameters: +Formatters +---------- + +GeoJSON is the default format provided by feature providers. Additional formats can +be added to configuration using one of the pygeoapi core formatters or by building a +custom formatter plugin. + +.. note:: + See the :ref:`plugin documentation ` for more + information on custom formatter plugins. + +.. csv-table:: + :header: Formatter, format parameter value + :align: left + + :ref:`CSV `,``f=csv`` + +.. _csv-formatter-features: + +CSV +^^^ + +.. code-block:: yaml + + formatters: + - name: CSV # propagated by .../items?f=csv + geom: False # whether to include geometry (default=False) + attachment: True # whether to provide as an attachment (default=False) + + Including extra query parameters --------------------------------