summaryrefslogtreecommitdiff
path: root/plugins/jobs/doc/response_protocol.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/jobs/doc/response_protocol.md')
-rw-r--r--plugins/jobs/doc/response_protocol.md54
1 files changed, 0 insertions, 54 deletions
diff --git a/plugins/jobs/doc/response_protocol.md b/plugins/jobs/doc/response_protocol.md
deleted file mode 100644
index e195c407..00000000
--- a/plugins/jobs/doc/response_protocol.md
+++ /dev/null
@@ -1,54 +0,0 @@
-Response protocol used to communicate between worker and RR. When a worker completes its job, it should send a typed
-response. The response should contain:
-
-1. `type` field with the message type. Can be treated as enums.
-2. `data` field with the dynamic response related to the type.
-
-Types are:
-
-```
-0 - NO_ERROR
-1 - ERROR
-2 - ...
-```
-
-- `NO_ERROR`: contains only `type` and empty `data`.
-- `ERROR` : contains `type`: 1, and `data` field with: `message` describing the error, `requeue` flag to requeue the
- job,
- `delay_seconds`: to delay a queue for a provided amount of seconds, `headers` - job's headers represented as hashmap
- with string key and array of strings as a value.
-
-For example:
-
-`NO_ERROR`:
-For example:
-
-```json
-{
- "type": 0,
- "data": {}
-}
-
-```
-
-`ERROR`:
-
-```json
-{
- "type": 1,
- "data": {
- "message": "internal worker error",
- "requeue": true,
- "headers": [
- {
- "test": [
- "1",
- "2",
- "3"
- ]
- }
- ],
- "delay_seconds": 10
- }
-}
-```