From 54f276565e2d9b090c28c1fb535cd5b84eec9631 Mon Sep 17 00:00:00 2001
From: Andreas Huber <andreas.huber@fjd.de>
Date: Fri, 21 Aug 2020 12:39:58 +0200
Subject: [PATCH] #13 API Specification: Method of Acknowledge Application
endpoint of Subscriber API should be PUT instead of POST
---
reference/sender.json | 24 +++++++++++++++++++++++-
reference/subscriber.json | 18 +++++++++++-------
2 files changed, 34 insertions(+), 8 deletions(-)
diff --git a/reference/sender.json b/reference/sender.json
index 7820ba3b..bd12c26f 100644
--- a/reference/sender.json
+++ b/reference/sender.json
@@ -596,7 +596,29 @@
"parameters": [],
"requestBody": {
"content": {
- "application/json": {}
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string",
+ "enum": [
+ "queued"
+ ]
+ }
+ },
+ "required": [
+ "code"
+ ]
+ },
+ "examples": {
+ "example-1": {
+ "value": {
+ "code": "queued"
+ }
+ }
+ }
+ }
},
"description": ""
},
diff --git a/reference/subscriber.json b/reference/subscriber.json
index d48f6767..70361caa 100644
--- a/reference/subscriber.json
+++ b/reference/subscriber.json
@@ -1406,7 +1406,7 @@
}
}
},
- "description": "Bestätigt die Abholung der Application. Über den Parameter `finalDelivery` im Body wird gesteuert, wie der Folgestatus aussieht:\n\n| final-delivery | status |\n| -------------- | ----------- |\n| `false` | \"forwarded\" |\n| `true` | \"delivered\" |\n\nDer Parameter `finalDelivery` zeigt an, ob der Antrag noch weitergesendet wird (`false`) oder das finale Ziel erreicht hat (`true`).\n\nSofern der Wert `false` übergeben wurde, muss zu einem späteren Zeitpunkt, wenn der Antrag final zugestellt wurde, ein weiterer Aufruf mit dem Wert `true` erfolgen.",
+ "description": "Bestätigt die Abholung der Application.\n\nDer Parameter `code` zeigt an, ob der Antrag noch weitergesendet wurde (`forwarded`) oder das finale Ziel erreicht hat (`delivered`).\n\nSofern der Wert `forwarded` übergeben wurde, muss zu einem späteren Zeitpunkt, wenn der Antrag final zugestellt wurde, ein weiterer Aufruf mit dem Wert `delivered` erfolgen.",
"requestBody": {
"content": {
"application/json": {
@@ -1414,24 +1414,28 @@
"type": "object",
"additionalProperties": false,
"properties": {
- "finalDelivery": {
- "type": "boolean",
- "description": "Zeigt an, ob die Zustellung zum nächsten Hop (`false`) oder bis zum Endpunkt (`true`) erfolgt ist."
+ "code": {
+ "type": "string",
+ "description": "Zeigt an, ob die Zustellung zum nächsten Hop (`false`) oder bis zum Endpunkt (`true`) erfolgt ist.",
+ "enum": [
+ "forwarded",
+ "delivered"
+ ]
}
},
"required": [
- "finalDelivery"
+ "code"
]
},
"examples": {
"example-1": {
"value": {
- "finalDelivery": false
+ "code": "forwarded"
}
},
"example-2": {
"value": {
- "finalDelivery": true
+ "code": "delivered"
}
}
}
--
GitLab