Merge pull request eclipse-tractusx#137 from catenax-ng/docs/generate…

…_openapi_spec docs: generate OpenApi spec
paullatzelsperger · Mar 30, 2023 · 462a441 · 462a441
2 parents b7b037b + ad8416f
commit 462a441
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 0 deletions.
diff --git a/edc-extensions/control-plane-adapter/build.gradle.kts b/edc-extensions/control-plane-adapter/build.gradle.kts
@@ -2,6 +2,7 @@
 plugins {
     `java-library`
     `maven-publish`
+    id("io.swagger.core.v3.swagger-gradle-plugin")
 }
 
 dependencies {

diff --git a/...ntrol-plane-adapter/src/main/java/org/eclipse/tractusx/edc/cp/adapter/HttpController.java b/...ntrol-plane-adapter/src/main/java/org/eclipse/tractusx/edc/cp/adapter/HttpController.java
@@ -16,6 +16,7 @@
 
 import static java.util.Objects.isNull;
 
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.ws.rs.*;
 import jakarta.ws.rs.core.MediaType;
 import jakarta.ws.rs.core.Response;
@@ -35,6 +36,7 @@
 @Produces({MediaType.APPLICATION_JSON})
 @Path("/adapter/asset")
 @RequiredArgsConstructor
+@Tag(name = "Control Plane Adapter")
 public class HttpController {
   private final Monitor monitor;
   private final ResultService resultService;

diff --git a/resources/openapi/yaml/control-plane-adapter.yaml b/resources/openapi/yaml/control-plane-adapter.yaml
@@ -0,0 +1,40 @@
+openapi: 3.0.1
+paths:
+  /adapter/asset/sync/{assetId}:
+    get:
+      operationId: getAssetSynchronous
+      parameters:
+      - in: path
+        name: assetId
+        required: true
+        schema:
+          type: string
+          example: null
+      - in: query
+        name: providerUrl
+        schema:
+          type: string
+          example: null
+      - in: query
+        name: contractAgreementId
+        schema:
+          type: string
+          example: null
+      - in: query
+        name: contractAgreementReuse
+        schema:
+          type: boolean
+          default: true
+          example: null
+      - in: query
+        name: timeout
+        schema:
+          type: string
+          example: null
+      responses:
+        default:
+          content:
+            application/json: {}
+          description: default response
+      tags:
+      - Control Plane Adapter