Skip to content
Snippets Groups Projects
Commit e452604a authored by Andreas Huber's avatar Andreas Huber
Browse files

#13 API Specification: Method of Acknowledge Application endpoint of... 

#13 API Specification: Method of Acknowledge Application endpoint of Subscriber API should be PUT instead of POST
parent 9cbd0d77
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
reference/sender.json
+ 84
− 104
View file @ e452604a
...@@ -20,110 +20,6 @@ ...@@ -20,110 +20,6 @@
} }
], ],
"paths": { "paths": {
"/destinations/{destinationId}/applications/{applicationId}": {
"parameters": [
{
"schema": {
"type": "string"
},
"name": "destinationId",
"in": "path",
"required": true
},
{
"schema": {
"type": "string"
},
"name": "applicationId",
"in": "path",
"required": true
}
],
"post": {
"summary": "Send Application",
"operationId": "commit-application",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "../models/status-overview.json"
},
"examples": {
"example-1": {
"value": {
"code": "queued",
"timestamp": "2020-05-20T08:31:01.135842+02:00",
"number": 2
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "../models/error-body.json"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "../models/error-body.json"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "../models/error-body.json"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "../models/error-body.json"
}
}
}
}
},
"description": "Übertragung abschließen, Antrag absenden",
"parameters": [],
"requestBody": {
"content": {
"application/json": {}
},
"description": ""
},
"tags": [
"Application Transfer"
],
"security": [
{
"OAuth20": [
"{senderId}:application:apply",
"{senderId}:sender:manage"
]
}
]
}
},
"/destinations/{destinationId}": { "/destinations/{destinationId}": {
"parameters": [ "parameters": [
{ {
...@@ -631,6 +527,90 @@ ...@@ -631,6 +527,90 @@
] ]
} }
] ]
},
"put": {
"summary": "Send Application",
"operationId": "commit-application",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "../models/status-overview.json"
},
"examples": {
"example-1": {
"value": {
"code": "queued",
"timestamp": "2020-05-20T08:31:01.135842+02:00",
"number": 2
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "../models/error-body.json"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "../models/error-body.json"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "../models/error-body.json"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "../models/error-body.json"
}
}
}
}
},
"description": "Übertragung abschließen, Antrag absenden",
"parameters": [],
"requestBody": {
"content": {
"application/json": {}
},
"description": ""
},
"tags": [
"Application Transfer"
],
"security": [
{
"OAuth20": [
"{senderId}:application:apply",
"{senderId}:sender:manage"
]
}
]
} }
}, },
"/destinations/{destinationId}/applications/{applicationId}/upload-status": { "/destinations/{destinationId}/applications/{applicationId}/upload-status": {
......
reference/subscriber.json
+ 114
− 94
View file @ e452604a
...@@ -769,100 +769,6 @@ ...@@ -769,100 +769,6 @@
] ]
} }
] ]
},
"post": {
"summary": "Acknowledge Application",
"operationId": "ack-application",
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "../models/error-body.json"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "../models/error-body.json"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "../models/error-body.json"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "../models/error-body.json"
}
}
}
}
},
"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.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"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."
}
},
"required": [
"finalDelivery"
]
},
"examples": {
"example-1": {
"value": {
"finalDelivery": false
}
},
"example-2": {
"value": {
"finalDelivery": true
}
}
}
}
},
"description": "Details der Quittung"
},
"tags": [
"Application Retrieval"
],
"security": [
{
"OAuth20": [
"{subscriberId}:manage",
"{subscriberId}:application:receive",
"{subscriberId}:destination:{destinationId}:application:receive"
]
}
]
} }
}, },
"/destinations/{destinationId}/applications": { "/destinations/{destinationId}/applications": {
...@@ -1432,6 +1338,120 @@ ...@@ -1432,6 +1338,120 @@
} }
] ]
} }
},
"/destinations/{destinationId}/applications/{applicationId}/status": {
"parameters": [
{
"schema": {
"type": "string"
},
"name": "destinationId",
"in": "path",
"required": true
},
{
"schema": {
"type": "string"
},
"name": "applicationId",
"in": "path",
"required": true
}
],
"put": {
"summary": "Acknowledge Application",
"operationId": "ack-application",
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "../models/error-body.json"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "../models/error-body.json"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "../models/error-body.json"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "../models/error-body.json"
}
}
}
}
},
"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.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"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."
}
},
"required": [
"finalDelivery"
]
},
"examples": {
"example-1": {
"value": {
"finalDelivery": false
}
},
"example-2": {
"value": {
"finalDelivery": true
}
}
}
}
},
"description": "Details der Quittung"
},
"tags": [
"Application Retrieval"
],
"security": [
{
"OAuth20": [
"{subscriberId}:manage",
"{subscriberId}:application:receive",
"{subscriberId}:destination:{destinationId}:application:receive"
]
}
]
}
} }
}, },
"tags": [ "tags": [
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment