docs: Add 503 response code to core-command API document (#3839)

Fix #3838 Signed-off-by: Ginny Guan <[email protected]> Co-authored-by: Cloud Tsai <[email protected]>
edgexfoundry · Dec 7, 2021 · f0bf127 · f0bf127
1 parent 4264632
commit f0bf127
Showing 1 changed file with 29 additions and 0 deletions.
diff --git a/openapi/v2/core-command.yaml b/openapi/v2/core-command.yaml
@@ -458,6 +458,11 @@ components:
         apiVersion: "v2"
         statusCode: 500
         message: "Internal Server Error"
+    503Example:
+      value:
+        apiVersion: "v2"
+        statusCode: 503
+        message: "HTTP request timeout"
     DeviceCoreCommandExample:
       value:
         apiVersion: "v2"
@@ -608,6 +613,18 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+        '503':
+          description: "Service Unavailable"
+          headers:
+            X-Correlation-ID:
+              $ref: '#/components/headers/correlatedResponseHeader'
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+              examples:
+                503Example:
+                  $ref: '#/components/examples/503Example'
     put:
       summary: "Issue the specified write command referenced by the command name to the device/sensor that is also referenced by name."
       requestBody:
@@ -662,6 +679,18 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+        '503':
+          description: "Service Unavailable"
+          headers:
+            X-Correlation-ID:
+              $ref: '#/components/headers/correlatedResponseHeader'
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+              examples:
+                503Example:
+                  $ref: '#/components/examples/503Example'
   /device/name/{name}:
     parameters:
       - $ref: '#/components/parameters/correlatedRequestHeader'