Add response cases for failed job target

eclipse · Dec 23, 2022 · b330249 · b330249
1 parent 11c4cc4
commit b330249
Show file tree

Hide file tree

Showing 2 changed files with 51 additions and 14 deletions.
diff --git a/...pi/resources/src/main/resources/openapi/jobTarget/job-scopeId-jobId-targets-targetId.yaml b/...pi/resources/src/main/resources/openapi/jobTarget/job-scopeId-jobId-targets-targetId.yaml
@@ -29,6 +29,11 @@ paths:
             application/json:
               schema:
                 $ref: './jobTarget.yaml#/components/schemas/jobTarget'
+              examples:
+                Successfully processed Job Target:
+                  $ref: './jobTarget.yaml#/components/examples/jobTargetSuccess'
+                Failed processed Job Target:
+                  $ref: './jobTarget.yaml#/components/examples/jobTargetFailed'
         401:
           $ref: '../openapi.yaml#/components/responses/unauthenticated'
         403:

diff --git a/rest-api/resources/src/main/resources/openapi/jobTarget/jobTarget.yaml b/rest-api/resources/src/main/resources/openapi/jobTarget/jobTarget.yaml
@@ -52,19 +52,6 @@ components:
               type: integer
             statusMessage:
               type: string
-      example:
-        type: jobTarget
-        id: Y-vYl9TKaf8
-        scopeId: AQ
-        createdOn: '2019-12-06T11:00:02.000Z'
-        createdBy: AQ
-        modifiedOn: '2019-12-06T11:01:00.000Z'
-        modifiedBy: AQ
-        optlock: 2
-        jobId: auSoU2ph1bY
-        jobTargetId: VBk_ZDZSOV0
-        status: PROCESS_OK
-        stepIndex: 0
     jobTargetListResult:
       allOf:
         - $ref: '../openapi.yaml#/components/schemas/kapuaListResult'
@@ -91,11 +78,56 @@ components:
                 jobTargetId: VBk_ZDZSOV0
                 status: PROCESS_OK
                 stepIndex: 0
+              - type: jobTarget
+                id: Y-vYl9TKaf8
+                scopeId: AQ
+                createdOn: '2019-12-06T11:00:02.000Z'
+                createdBy: AQ
+                modifiedOn: '2019-12-06T11:01:00.000Z'
+                modifiedBy: AQ
+                optlock: 2
+                jobId: baSSoU2ph1bY
+                jobTargetId: VRG42ZDZSOV
+                status: PROCESS_FAILED
+                statusMessage: Device not connected
+                stepIndex: 0
+
+
     jobTargetStatus:
       type: string
       enum:
         - PROCESS_OK
         - PROCESS_FAILED
         - PROCESS_AWAITING
         - AWAITING_COMPLETION
-        - NOTIFIED_COMPLETION
+        - NOTIFIED_COMPLETION
+  examples:
+    jobTargetSuccess:
+      value:
+        type: jobTarget
+        id: Y-vYl9TKaf8
+        scopeId: AQ
+        createdOn: '2019-12-06T11:00:02.000Z'
+        createdBy: AQ
+        modifiedOn: '2019-12-06T11:01:00.000Z'
+        modifiedBy: AQ
+        optlock: 2
+        jobId: auSoU2ph1bY
+        jobTargetId: VBk_ZDZSOV0
+        status: PROCESS_OK
+        stepIndex: 0
+    jobTargetFailed:
+      value:
+        type: jobTarget
+        id: Y-vYl9TKaf8
+        scopeId: AQ
+        createdOn: '2019-12-06T11:00:02.000Z'
+        createdBy: AQ
+        modifiedOn: '2019-12-06T11:01:00.000Z'
+        modifiedBy: AQ
+        optlock: 2
+        jobId: SaSaU2ph1bY
+        jobTargetId: VAR1ZDZSOV0
+        status: PROCESS_FAILED
+        statusMessage: Device not connected
+        stepIndex: 0