Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/source/plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
----------------------------------

Expand Down
30 changes: 30 additions & 0 deletions docs/source/publishing/ogcapi-edr.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <example-custom-pygeoapi-formatter>` for more
information on custom formatter plugins.

.. csv-table::
:header: Formatter, format parameter value
:align: left

:ref:`CSV <csv-formatter-edr>`,``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
--------------------

Expand Down
32 changes: 32 additions & 0 deletions docs/source/publishing/ogcapi-features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ Connection examples

Below are specific connection examples based on supported providers.

.. _csv:

CSV
^^^

Expand Down Expand Up @@ -845,6 +847,36 @@ To publish a TinyDB (`see website <https://tinydb.readthedocs.io>`_) 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 <example-custom-pygeoapi-formatter>` for more
information on custom formatter plugins.

.. csv-table::
:header: Formatter, format parameter value
:align: left

:ref:`CSV <csv-formatter-features>`,``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
--------------------------------

Expand Down
Loading