From dba83652f440ad687db91fc38461af39aa161573 Mon Sep 17 00:00:00 2001 From: RoryPTB <47696929+RoryPTB@users.noreply.github.com> Date: Fri, 23 Aug 2024 13:17:28 +0200 Subject: [PATCH] docs: add CAP data pipeline plugin --- docker-compose.override.yml | 2 +- .../running/data-pipeline-plugins.rst | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/docker-compose.override.yml b/docker-compose.override.yml index aacfd598..f34bd412 100644 --- a/docker-compose.override.yml +++ b/docker-compose.override.yml @@ -17,4 +17,4 @@ services: mosquitto: ports: - 1883:1883 - - 8883:8884 \ No newline at end of file + - 8884:8884 \ No newline at end of file diff --git a/docs/source/reference/running/data-pipeline-plugins.rst b/docs/source/reference/running/data-pipeline-plugins.rst index a1c5234b..6c5c5e5b 100644 --- a/docs/source/reference/running/data-pipeline-plugins.rst +++ b/docs/source/reference/running/data-pipeline-plugins.rst @@ -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 `_ +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`` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^