From c179afeedb8c8e850a784768a063549cad81b4ff Mon Sep 17 00:00:00 2001
From: Andreas Huber <andreas.huber@fjd.de>
Date: Mon, 24 Aug 2020 17:06:53 +0200
Subject: [PATCH] #13 API Specification: Method of Acknowledge Application
 endpoint of Subscriber API should be PUT instead of POST

---
 reference/sender.json     | 299 ++++++++++++++++++++++++--------------
 reference/subscriber.json |  25 +++-
 2 files changed, 215 insertions(+), 109 deletions(-)

diff --git a/reference/sender.json b/reference/sender.json
index bd12c26f..9f320a3e 100644
--- a/reference/sender.json
+++ b/reference/sender.json
@@ -527,112 +527,6 @@
             ]
           }
         ]
-      },
-      "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": {
-              "schema": {
-                "type": "object",
-                "properties": {
-                  "code": {
-                    "type": "string",
-                    "enum": [
-                      "queued"
-                    ]
-                  }
-                },
-                "required": [
-                  "code"
-                ]
-              },
-              "examples": {
-                "example-1": {
-                  "value": {
-                    "code": "queued"
-                  }
-                }
-              }
-            }
-          },
-          "description": ""
-        },
-        "tags": [
-          "Application Transfer"
-        ],
-        "security": [
-          {
-            "OAuth20": [
-              "{senderId}:application:apply",
-              "{senderId}:sender:manage"
-            ]
-          }
-        ]
       }
     },
     "/destinations/{destinationId}/applications/{applicationId}/upload-status": {
@@ -999,6 +893,199 @@
           }
         ]
       }
+    },
+    "/destinations/{destinationId}/applications/{applicationId}/status/current": {
+      "parameters": [
+        {
+          "schema": {
+            "type": "string"
+          },
+          "name": "destinationId",
+          "in": "path",
+          "required": true
+        },
+        {
+          "schema": {
+            "type": "string"
+          },
+          "name": "applicationId",
+          "in": "path",
+          "required": true
+        }
+      ],
+      "get": {
+        "summary": "Get Status",
+        "tags": [
+          "status"
+        ],
+        "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+02:00",
+                      "number": 2
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "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"
+                }
+              }
+            }
+          }
+        },
+        "operationId": "get-application-status",
+        "description": "Ruft den aktuellen Status der Ãœbermittlung ab.",
+        "security": [
+          {
+            "OAuth20": [
+              "{senderId}:status:read",
+              "{senderId}:sender:manage"
+            ]
+          }
+        ]
+      },
+      "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": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "code": {
+                    "type": "string",
+                    "enum": [
+                      "queued"
+                    ]
+                  }
+                },
+                "required": [
+                  "code"
+                ]
+              },
+              "examples": {
+                "example-1": {
+                  "value": {
+                    "code": "queued"
+                  }
+                }
+              }
+            }
+          },
+          "description": ""
+        },
+        "tags": [
+          "Application Transfer"
+        ],
+        "security": [
+          {
+            "OAuth20": [
+              "{senderId}:application:apply",
+              "{senderId}:sender:manage"
+            ]
+          }
+        ]
+      }
     }
   },
   "tags": [
diff --git a/reference/subscriber.json b/reference/subscriber.json
index 70361caa..02406dec 100644
--- a/reference/subscriber.json
+++ b/reference/subscriber.json
@@ -1339,7 +1339,7 @@
         ]
       }
     },
-    "/destinations/{destinationId}/applications/{applicationId}/status": {
+    "/destinations/{destinationId}/applications/{applicationId}/status/current": {
       "parameters": [
         {
           "schema": {
@@ -1363,7 +1363,26 @@
         "operationId": "ack-application",
         "responses": {
           "200": {
-            "description": "OK"
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "additionalProperties": false,
+                  "properties": {
+                    "result": {
+                      "type": "string",
+                      "enum": [
+                        "success"
+                      ]
+                    }
+                  },
+                  "required": [
+                    "result"
+                  ]
+                }
+              }
+            }
           },
           "400": {
             "description": "Bad Request",
@@ -1416,7 +1435,7 @@
                 "properties": {
                   "code": {
                     "type": "string",
-                    "description": "Zeigt an, ob die Zustellung zum nächsten Hop (`false`) oder bis zum Endpunkt (`true`) erfolgt ist.",
+                    "description": "Zeigt an, ob die Zustellung zum nächsten Hop (`forwarded`) oder bis zum Endpunkt (`delivered`) erfolgt ist.",
                     "enum": [
                       "forwarded",
                       "delivered"
-- 
GitLab