Merge pull request #1100 from eclipse-tractusx/docs/api/gate-6.2.0-sn…

…apshot docs(api): update gate open-api docs to current 6.2.0-SNAPSHOT version
eclipse-tractusx · Oct 31, 2024 · 23f82ed · 23f82ed
2 parents e230e99 + dfd4a78
commit 23f82ed
Show file tree

Hide file tree

Showing 2 changed files with 354 additions and 8 deletions.
diff --git a/docs/api/gate.json b/docs/api/gate.json
@@ -3,7 +3,7 @@
   "info": {
     "title": "Business Partner Data Management Gate",
     "description": "A gate for a member to share business partner data with CatenaX",
-    "version": "6.1.0-SNAPSHOT"
+    "version": "6.2.0-SNAPSHOT"
   },
   "servers": [
     {
@@ -211,6 +211,67 @@
         }
       }
     },
+    "/v6/input/partner-upload-process": {
+      "post": {
+        "tags": [
+          "partner-upload-controller"
+        ],
+        "summary": "Create or update business partners from uploaded CSV file",
+        "description": "Create or update generic business partners. Updates instead of creating a new business partner if an already existing external ID is used. The same external ID may not occur more than once in a requested file. ",
+        "operationId": "uploadPartnerCsvFile",
+        "requestBody": {
+          "content": {
+            "multipart/form-data": {
+              "schema": {
+                "required": [
+                  "file"
+                ],
+                "type": "object",
+                "properties": {
+                  "file": {
+                    "type": "string",
+                    "format": "binary"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Business partners were successfully updated or created",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/BusinessPartnerInputDto"
+                  }
+                }
+              },
+              "multipart/form-data": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/BusinessPartnerInputDto"
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "On malformed Business partner upload request",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PartnerUploadErrorResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/v6/input/changelog/search": {
       "post": {
         "tags": [
@@ -484,6 +545,35 @@
           }
         }
       }
+    },
+    "/v6/input/partner-upload-template": {
+      "get": {
+        "tags": [
+          "partner-upload-controller"
+        ],
+        "summary": "Get CSV template with headers in file",
+        "description": "Create empty CSV file template including headers.Generated CSV file can later be used for uploading business partner data.",
+        "operationId": "getPartnerCsvTemplate",
+        "responses": {
+          "200": {
+            "description": "CSV file template generated successfully",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "string",
+                  "format": "binary"
+                }
+              },
+              "multipart/form-data": {
+                "schema": {
+                  "type": "string",
+                  "format": "binary"
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "components": {
@@ -1278,17 +1368,17 @@
           "longitude": {
             "type": "number",
             "description": "Longitude coordinate",
-            "format": "float"
+            "format": "double"
           },
           "latitude": {
             "type": "number",
             "description": "Latitude coordinate",
-            "format": "float"
+            "format": "double"
           },
           "altitude": {
             "type": "number",
             "description": "Altitude, if applicable",
-            "format": "float"
+            "format": "double"
           }
         },
         "description": "The exact location of the physical postal address in latitude, longitude, and altitude."
@@ -1535,6 +1625,110 @@
         },
         "description": "Paginated collection of results"
       },
+      "PartnerUploadErrorResponse": {
+        "required": [
+          "error",
+          "path",
+          "status",
+          "timestamp"
+        ],
+        "type": "object",
+        "properties": {
+          "timestamp": {
+            "type": "string",
+            "description": "Timestamp of the error occurrence",
+            "format": "date-time"
+          },
+          "status": {
+            "type": "string",
+            "description": "HTTP status of the error response",
+            "enum": [
+              "100 CONTINUE",
+              "101 SWITCHING_PROTOCOLS",
+              "102 PROCESSING",
+              "103 EARLY_HINTS",
+              "103 CHECKPOINT",
+              "200 OK",
+              "201 CREATED",
+              "202 ACCEPTED",
+              "203 NON_AUTHORITATIVE_INFORMATION",
+              "204 NO_CONTENT",
+              "205 RESET_CONTENT",
+              "206 PARTIAL_CONTENT",
+              "207 MULTI_STATUS",
+              "208 ALREADY_REPORTED",
+              "226 IM_USED",
+              "300 MULTIPLE_CHOICES",
+              "301 MOVED_PERMANENTLY",
+              "302 FOUND",
+              "302 MOVED_TEMPORARILY",
+              "303 SEE_OTHER",
+              "304 NOT_MODIFIED",
+              "305 USE_PROXY",
+              "307 TEMPORARY_REDIRECT",
+              "308 PERMANENT_REDIRECT",
+              "400 BAD_REQUEST",
+              "401 UNAUTHORIZED",
+              "402 PAYMENT_REQUIRED",
+              "403 FORBIDDEN",
+              "404 NOT_FOUND",
+              "405 METHOD_NOT_ALLOWED",
+              "406 NOT_ACCEPTABLE",
+              "407 PROXY_AUTHENTICATION_REQUIRED",
+              "408 REQUEST_TIMEOUT",
+              "409 CONFLICT",
+              "410 GONE",
+              "411 LENGTH_REQUIRED",
+              "412 PRECONDITION_FAILED",
+              "413 PAYLOAD_TOO_LARGE",
+              "413 REQUEST_ENTITY_TOO_LARGE",
+              "414 URI_TOO_LONG",
+              "414 REQUEST_URI_TOO_LONG",
+              "415 UNSUPPORTED_MEDIA_TYPE",
+              "416 REQUESTED_RANGE_NOT_SATISFIABLE",
+              "417 EXPECTATION_FAILED",
+              "418 I_AM_A_TEAPOT",
+              "419 INSUFFICIENT_SPACE_ON_RESOURCE",
+              "420 METHOD_FAILURE",
+              "421 DESTINATION_LOCKED",
+              "422 UNPROCESSABLE_ENTITY",
+              "423 LOCKED",
+              "424 FAILED_DEPENDENCY",
+              "425 TOO_EARLY",
+              "426 UPGRADE_REQUIRED",
+              "428 PRECONDITION_REQUIRED",
+              "429 TOO_MANY_REQUESTS",
+              "431 REQUEST_HEADER_FIELDS_TOO_LARGE",
+              "451 UNAVAILABLE_FOR_LEGAL_REASONS",
+              "500 INTERNAL_SERVER_ERROR",
+              "501 NOT_IMPLEMENTED",
+              "502 BAD_GATEWAY",
+              "503 SERVICE_UNAVAILABLE",
+              "504 GATEWAY_TIMEOUT",
+              "505 HTTP_VERSION_NOT_SUPPORTED",
+              "506 VARIANT_ALSO_NEGOTIATES",
+              "507 INSUFFICIENT_STORAGE",
+              "508 LOOP_DETECTED",
+              "509 BANDWIDTH_LIMIT_EXCEEDED",
+              "510 NOT_EXTENDED",
+              "511 NETWORK_AUTHENTICATION_REQUIRED"
+            ]
+          },
+          "error": {
+            "type": "array",
+            "description": "List of error messages",
+            "items": {
+              "type": "string",
+              "description": "List of error messages"
+            }
+          },
+          "path": {
+            "type": "string",
+            "description": "Request path where the error occurred"
+          }
+        },
+        "description": "Error response for invalid partner upload"
+      },
       "PhysicalPostalAddressDto": {
         "type": "object",
         "properties": {