Merge pull request #105 from it-at-m/feat/eai-client-internal-update-spec

chore(ticketing-eai/api-client-internal): update spec add attachment endpoint

Author: simonhir

ticketing-eai/api-client-internal/src/main/java/de/muenchen/oss/dbs/ticketing/eai/client/ApiClientAutoConfiguration.java

@@ -1,6 +1,7 @@
 package de.muenchen.oss.dbs.ticketing.eai.client;
 
 import de.muenchen.oss.dbs.ticketing.eai.client.api.ArticlesApi;
+import de.muenchen.oss.dbs.ticketing.eai.client.api.AttachmentsApi;
 import de.muenchen.oss.dbs.ticketing.eai.client.api.OrganizationsApi;
 import de.muenchen.oss.dbs.ticketing.eai.client.api.TicketsApi;
 import de.muenchen.oss.dbs.ticketing.eai.client.api.UsersApi;
@@ -46,6 +47,12 @@ public ArticlesApi articlesApi(final ApiClient apiClient) {
         return new ArticlesApi(apiClient);
     }
 
+    @Bean
+    @ConditionalOnMissingBean
+    public AttachmentsApi attachmentsApi(final ApiClient apiClient) {
+        return new AttachmentsApi(apiClient);
+    }
+
     @Bean
     @ConditionalOnMissingBean
     public OrganizationsApi organizationsApi(final ApiClient apiClient) {

ticketing-eai/api-client-internal/src/main/resources/api-spec-internal-without-security.json

@@ -7,11 +7,15 @@
   },
   "servers": [
     {
-      "url": "https://dbs-ticketing-eai-test-dbs-ticketing-eai.apps.capk.muenchen.de",
+      "url": "https://dbs-ticketing-eai-integration-dbs-ticketing-eai.apps.capk.muenchen.de",
       "description": "Generated server url"
     }
   ],
   "tags": [
+    {
+      "name": "Attachments",
+      "description": "Endpoints to receive Attachment-Data for downloading."
+    },
     {
       "name": "Articles",
       "description": "Reading and Creating Articles in Zammad."
@@ -1098,6 +1102,55 @@
         }
       }
     },
+    "/attachments/{ticketID}/{articleID}/{attachmentID}": {
+      "get": {
+        "tags": [
+          "Attachments"
+        ],
+        "summary": "Get Attachment of given article id from given ticket id by given attachment id.",
+        "description": "Receives the attachment with the ID attachmentID of the article articleID from the ticket ticketID and forwards it as a binary data stream.",
+        "operationId": "getAttachment",
+        "parameters": [
+          {
+            "name": "ticketID",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "articleID",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "attachmentID",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "default": {
+            "description": "Attachment as binary data.",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "type": "string",
+                  "format": "octet-stream"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/actuator": {
       "get": {
         "tags": [
@@ -2201,7 +2254,7 @@
         "in": "header",
         "scheme": "bearer",
         "bearerFormat": "JWT",
-        "openIdConnectUrl": "https://ssotest.muenchen.de/auth/realms/intrap/.well-known/openid-configuration"
+        "openIdConnectUrl": "https://ssodev.muenchen.de/auth/realms/KM81/.well-known/openid-configuration"
       }
     }
   }

ticketing-eai/api-client-internal/src/main/resources/api-spec-internal.json

@@ -7,11 +7,15 @@
   },
   "servers": [
     {
-      "url": "https://dbs-ticketing-eai-test-dbs-ticketing-eai.apps.capk.muenchen.de",
+      "url": "https://dbs-ticketing-eai-integration-dbs-ticketing-eai.apps.capk.muenchen.de",
       "description": "Generated server url"
     }
   ],
   "tags": [
+    {
+      "name": "Attachments",
+      "description": "Endpoints to receive Attachment-Data for downloading."
+    },
     {
       "name": "Articles",
       "description": "Reading and Creating Articles in Zammad."
@@ -1203,6 +1207,60 @@
         ]
       }
     },
+    "/attachments/{ticketID}/{articleID}/{attachmentID}": {
+      "get": {
+        "tags": [
+          "Attachments"
+        ],
+        "summary": "Get Attachment of given article id from given ticket id by given attachment id.",
+        "description": "Receives the attachment with the ID attachmentID of the article articleID from the ticket ticketID and forwards it as a binary data stream.",
+        "operationId": "getAttachment",
+        "parameters": [
+          {
+            "name": "ticketID",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "articleID",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "attachmentID",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "default": {
+            "description": "Attachment as binary data.",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "type": "string",
+                  "format": "octet-stream"
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "dbs-ticketing-eai-secscheme": []
+          }
+        ]
+      }
+    },
     "/actuator": {
       "get": {
         "tags": [
@@ -2306,7 +2364,7 @@
         "in": "header",
         "scheme": "bearer",
         "bearerFormat": "JWT",
-        "openIdConnectUrl": "https://ssotest.muenchen.de/auth/realms/intrap/.well-known/openid-configuration"
+        "openIdConnectUrl": "https://ssodev.muenchen.de/auth/realms/KM81/.well-known/openid-configuration"
       }
     }
   }