Merge pull request #630 from catenax-ng/docs/api/json-format

Docs(Api): add OpenAPI descriptions for BPDM applications in JSON format
eclipse-tractusx · Nov 17, 2023 · 9b01965 · 9b01965
2 parents 44fcec5 + 0886f0b
commit 9b01965
Show file tree

Hide file tree

Showing 4 changed files with 11,644 additions and 0 deletions.
diff --git a/docs/api/bridge-dummy.json b/docs/api/bridge-dummy.json
@@ -0,0 +1,31 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "Business Partner Data Management Bridge Dummy",
+    "description": "Bridge between Gate and Pool as a simple replacement for a dedicated sharing service",
+    "version": "4.1.0"
+  },
+  "servers": [
+    {
+      "url": "http://localhost:8083",
+      "description": "Generated server url"
+    }
+  ],
+  "paths": {
+    "/api/bridge/sync": {
+      "post": {
+        "tags": [
+          "bridge-controller"
+        ],
+        "summary": "Start sync between Gate and Pool",
+        "operationId": "triggerSync",
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
+    }
+  },
+  "components": {}
+}