Skip to content

Commit

Permalink
update docs wording
Browse files Browse the repository at this point in the history
  • Loading branch information
tomkralidis committed Jul 24, 2024
1 parent 1aa3c46 commit 9a50d71
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions docs/source/data-publishing/ogcapi-processes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,32 +19,30 @@ The below configuration is an example of a process defined within the pygeoapi i
.. code-block:: yaml
processes:
# enabled by default
# enabled by default
hello-world:
processor:
name: HelloWorld
The below configuration is an example of a process defined as part of cusotm Python process:
The below configuration is an example of a process defined as part of a custom Python process:

.. code-block:: yaml
processes:
# enabled by default
# enabled by default
hello-world:
processor:
# refer to a process in the standard PYTHONPATH
# e.g. my_package/my_module/my_file.py (class MyProcess)
# the MyProcess class must subclass from pygeoapi.process.base.BaseProcessor
name: my_package.my_module.my_file.MyProcess
See :ref:`example-custom-pygeoapi-processing-plugin` for processing plugin examples
See :ref:`example-custom-pygeoapi-processing-plugin` for processing plugin examples.

Processing and response handling
--------------------------------

pygeoapi processing plugins are required to return a tuple of media type and native outputs. Multipart
pygeoapi processing plugins must return a tuple of media type and native outputs. Multipart
responses are not supported at this time, and it is up to the process plugin implementor to return a single
payload defining multiple artifacts (or references to them).

Expand All @@ -53,8 +51,8 @@ processing responses in their native encoding and media type, as defined by a gi
plugin (which needs to set the response content type and payload accordingly).

pygeoapi also supports a JSON-based response type (via the OGC API - Processes ``response: document``
execution parameter). When this mode is requested, the response will always be a JSON encoding embedding
the resulting payload (which may be base64 encoded for binary data, for example).
execution parameter). When this mode is requested, the response will always be a JSON encoding, embedding
the resulting payload (part of which may be Base64 encoded for binary data, for example).


Asynchronous support
Expand Down

0 comments on commit 9a50d71

Please sign in to comment.