.. _ogcapi-processes:

Publishing processes via OGC API - Processes
============================================

`OGC API - Processes`_ provides geospatial data processing functionality in a standards-based
fashion (inputs, outputs).

pygeoapi implements OGC API - Processes functionality by providing a plugin architecture, thereby
allowing developers to implement custom processing workflows in Python.

A `sample`_ ``hello-world`` process is provided with the pygeoapi default configuration.

Configuration
-------------

.. code-block:: yaml

   processes:
       hello-world:
           processor:
               name: HelloWorld


Processing examples
-------------------

- list all processes
  - http://localhost:5000/processes
- describe the ``hello-world`` process
  - http://localhost:5000/processes/hello-world
- show all jobs for the ``hello-world`` process
  - http://localhost:5000/processes/hello-world/jobs
- execute a job for the ``hello-world`` process
  - ``curl -X POST "http://localhost:5000/processes/hello-world/jobs" -H "Content-Type: application/json" -d "{\"inputs\":[{\"id\":\"name\",\"type\":\"text/plain\",\"value\":\"hi there2\"}]}"``
- execute a job for the ``hello-world`` process with a raw response
  - ``curl -X POST "http://localhost:5000/processes/hello-world/jobs?response=raw" -H "Content-Type: application/json" -d "{\"inputs\":[{\"id\":\"name\",\"type\":\"text/plain\",\"value\":\"hi there2\"}]}"``


.. todo:: add more examples once OAProc implementation is complete

.. _`OGC API - Processes`: https://github.com/opengeospatial/wps-rest-binding
.. _`sample`: https://github.com/geopython/pygeoapi/blob/master/pygeoapi/process/hello_world.py