diff --git a/code/API_definitions/qod-api.yaml b/code/API_definitions/qod-api.yaml index 21e0e27e88..ea3c1d69e3 100644 --- a/code/API_definitions/qod-api.yaml +++ b/code/API_definitions/qod-api.yaml @@ -141,6 +141,15 @@ paths: $ref: "#/components/responses/Generic403" "404": $ref: "#/components/responses/SessionNotFound404" + "500": + description: Server error + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorInfo" + example: + code: INTERNAL + message: "Could not get session information" "503": $ref: "#/components/responses/Generic503" delete: @@ -164,6 +173,15 @@ paths: $ref: "#/components/responses/Generic403" "404": $ref: "#/components/responses/SessionNotFound404" + "500": + description: Server error + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorInfo" + example: + code: INTERNAL + message: "Session could not be deleted" "503": $ref: "#/components/responses/Generic503" /notifications: @@ -191,6 +209,15 @@ paths: $ref: "#/components/responses/Generic401" "403": $ref: "#/components/responses/Generic403" + "500": + description: Server error + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorInfo" + example: + code: INTERNAL + message: "Failed to handle notification" "503": $ref: "#/components/responses/Generic503" security: diff --git a/documentation/API_documentation/QoD_API.md b/documentation/API_documentation/QoD_API.md index b717817691..ec19dc6a3d 100644 --- a/documentation/API_documentation/QoD_API.md +++ b/documentation/API_documentation/QoD_API.md @@ -190,7 +190,7 @@ Following table defines API endpoints of exposed REST based for QoD management o 503: Service temporarily unavailable - + @@ -222,7 +222,7 @@ Following table defines API endpoints of exposed REST based for QoD management o No request body parameters are defined - Response + Response 200: Session information returned Response body:
@@ -247,6 +247,9 @@ Following table defines API endpoints of exposed REST based for QoD management o 404: Session not found + + 500: Server Error + 503: Service temporarily unavailable @@ -281,7 +284,7 @@ Following table defines API endpoints of exposed REST based for QoD management o No request body parameters are defined - Response + Response 204: Session deleted @@ -293,9 +296,12 @@ Following table defines API endpoints of exposed REST based for QoD management o 404: Session not found + + 500: Server Error + 503: Service temporarily unavailable - +