Skip to content

Commit

Permalink
docs: add CAP data pipeline plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
RoryPTB committed Aug 23, 2024
1 parent c07b766 commit dba8365
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docker-compose.override.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ services:
mosquitto:
ports:
- 1883:1883
- 8883:8884
- 8884:8884
18 changes: 18 additions & 0 deletions docs/source/reference/running/data-pipeline-plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,24 @@ A typical BUFR4 plugin workflow definition would be defined as follows:
notify: true # trigger GeoJSON publishing for API and UI
file-pattern: '^.*\.bin$'
``wis2box.data.cap_message.CAPMessageData``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This plugin takes the incoming XML file, then validates it against the
`CAP v1.2 schema <https://docs.oasis-open.org/emergency/cap/v1.2/CAP-v1.2-os.html>`_
and verifies the digital signature before publishing.

A typical CAP message plugin workflow definition would be defined as follows:

.. code-block:: yaml
xml:
- plugin: wis2box.data.cap_message.CAPMessageData
notify: true
buckets:
- ${WIS2BOX_STORAGE_INCOMING}
file-pattern: '^.*\.xml$'
``wis2box.data.universal.UniversalData``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down

0 comments on commit dba8365

Please sign in to comment.