Enhanced the api documentation

eclipse-tractusx · Oct 21, 2024 · 6a2711c · 6a2711c
1 parent 22c671e
commit 6a2711c
Showing 1 changed file with 8 additions and 8 deletions.
diff --git a/docs/api/issuer-service.yaml b/docs/api/issuer-service.yaml
@@ -8,12 +8,12 @@ paths:
       tags:
         - 'Org.Eclipse.TractusX.SsiCredentialIssuer.Service, Version=1.2.0.0, Culture=neutral, PublicKeyToken=null'
       summary: Gets all use case frameworks and the participation status of the acting company
-      description: 'Example: GET: api/issuer/useCaseParticipation'
+      description: 'Example: GET: api/issuer/useCaseParticipation<br><h3>Available values:</h3> All, Active, Expired'
       parameters:
         - name: status
           in: query
           schema:
-            $ref: '#/components/schemas/StatusType'
+            type: string
       responses:
         '200':
           description: OK
@@ -35,6 +35,12 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
         '409':
           description: Conflict
           content:
@@ -851,12 +857,6 @@ components:
         - RETRIGGER_TRIGGER_NOTIFICATION
         - RETRIGGER_TRIGGER_MAIL
       type: string
-    StatusType:
-      enum:
-        - Active
-        - Expired
-        - All
-      type: string
     TechnicalUserDetails:
       type: object
       properties: