Skip to content
Merged
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
44 changes: 22 additions & 22 deletions docs/api_rest.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,14 @@ The default mimetype (output format) can be set by adding `&f=json` or `&f=xml`

GET GetCapabilities Request URL:

.. code-block::
.. code-block:: json

http://localhost:5000/processes/?service=WPS
http://localhost:5000/wps/?request=GetCapabilities&service=WPS&f=json

GET GetCapabilities Response:

.. code-block::
.. code-block:: json

{
"pywps_version": "4.5.0",
Expand Down Expand Up @@ -113,14 +113,14 @@ GET GetCapabilities Response:

GET DescribeProcess Request URL:

.. code-block::
.. code-block:: json

http://localhost:5000/processes/say_hello?service=WPS
http://localhost:5000/wps/?request=DescribeProcess&service=WPS&identifier=say_hello&version=1.0.0&f=json

GET DescribeProcess Response:

.. code-block::
.. code-block:: json

{
"pywps_version": "4.5.0",
Expand Down Expand Up @@ -178,13 +178,13 @@ GET DescribeProcess Response:

GET Execute Request URL:

.. code-block::
.. code-block:: json

http://localhost:5000/wps?/service=wps&version=1.0.0&request=execute&Identifier=say_hello&storeExecuteResponse=true&DataInputs=name=Dude&f=json

GET Execute Response:

.. code-block::
.. code-block:: json

{
"status": {
Expand All @@ -200,13 +200,13 @@ GET Execute Response:

GET Execute Request URL (Raw output):

.. code-block::
.. code-block:: json

http://localhost:5000/wps?/service=wps&version=1.0.0&request=execute&Identifier=say_hello&storeExecuteResponse=true&DataInputs=name=Dude&RawDataOutput=output

GET Execute Response:

.. code-block::
.. code-block:: json

Hello Dude

Expand All @@ -224,13 +224,13 @@ Example of a `Say Hello` POST request:

POST Execute Request URL:

.. code-block::
.. code-block:: json

http://localhost:5000/jobs

POST Execute Request Body:

.. code-block::
.. code-block:: json

{
"identifier": "say_hello",
Expand All @@ -241,7 +241,7 @@ POST Execute Request Body:

POST Execute Response:

.. code-block::
.. code-block:: json

{
"status": {
Expand All @@ -260,7 +260,7 @@ Example of a `Say Hello` POST request with raw output:

POST Execute Request Body:

.. code-block::
.. code-block:: json

{
"identifier": "say_hello",
Expand All @@ -273,29 +273,29 @@ POST Execute Request Body:

POST Execute Response:

.. code-block::
.. code-block:: json

Hello Dude

Alternatively, the `identifier` and optionally the raw output name can be encoded in the Request URL:

POST Execute Request URL (with `identifier`):

.. code-block::
.. code-block:: json

http://localhost:5000/jobs/say_hello

POST Execute Request Body:

.. code-block::
.. code-block:: json

{
"name": "Dude"
}

POST Execute Response:

.. code-block::
.. code-block:: json

{
"status": {
Expand All @@ -311,28 +311,28 @@ POST Execute Response:

POST Execute Request URL (with `identifier` and output name):

.. code-block::
.. code-block:: json

http://localhost:5000/jobs/say_hello/output

POST Execute Request Body:

.. code-block::
.. code-block:: json

{
"name": "Dude"
}

POST Execute Response:

.. code-block::
.. code-block:: json

Hello Dude


Example for a reference input:

.. code-block::
.. code-block:: json

"raster": {
"type": "reference",
Expand All @@ -342,7 +342,7 @@ Example for a reference input:
Example for a BoundingBox input:
(bbox default axis order is yx (EPSG:4326), i.e. miny, minx, maxy, maxx)

.. code-block::
.. code-block:: json

"extent": {
"type": "bbox",
Expand All @@ -353,7 +353,7 @@ Example for a BoundingBox input:
Example for a ComplexInput input:
(the data is a standard GeoJSON)

.. code-block::
.. code-block:: json

"cutline": {
"type": "complex",
Expand Down