Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
Dec 7, 2021
+29 −0
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f40871f
docs: Add 503 response code to core-command API document
jinlinGuan Dec 6, 2021
dbd721e
Merge branch 'main' into issue-3838
cloudxxx8 Dec 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions openapi/v2/core-command.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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'
Expand Down