diff --git a/scripts/jnk_grt_comment.py b/scripts/jnk_grt_comment.py index 021c187210fd39dea9920537c9bb9291d85b8dd3..1bb13d41ca03e587c4c17aba05ff8404178f9de9 100644 --- a/scripts/jnk_grt_comment.py +++ b/scripts/jnk_grt_comment.py @@ -46,6 +46,6 @@ def jenkins_gerrit_comment(change_num, patch_num, comment): send_gerrit_comment(change_num+","+patch_num, comment) def comment_openapis_artifacts(cn, pn, bu): - comment = mk_swg_ui_comment("**/*-API.yaml", bu) + comment = mk_swg_ui_comment("build/*-API.yaml", bu) # print "comment: "+comment jenkins_gerrit_comment(str(cn), str(pn), comment) \ No newline at end of file diff --git a/src/SOL002/VNFConfiguration/VNFConfiguration.yaml b/src/SOL002/VNFConfiguration/VNFConfiguration.yaml index 2fefa94303f9a3dadab6861128c21c15c111a9c9..7e9b8bf6e014dcfd8384976b5c55dbe69d0a65eb 100644 --- a/src/SOL002/VNFConfiguration/VNFConfiguration.yaml +++ b/src/SOL002/VNFConfiguration/VNFConfiguration.yaml @@ -41,6 +41,8 @@ paths: responses: 200: description: > + OK + Configuration information about a VNF instance was read successfully. The response body shall contain a representation of the configuration resource. schema: @@ -69,6 +71,8 @@ paths: responses: 200: description: > + OK + The request was accepted and completed. The response body shall contain the parameters of the configuration modification that was applied to the configuration resource. schema: diff --git a/src/SOL002/VNFConfiguration/responses/VNFConfiguration_resp.yaml b/src/SOL002/VNFConfiguration/responses/VNFConfiguration_resp.yaml index 305b84ef42e37c5397006d6ca7f35088602c236d..89938b310aa0a88113897523e91796ce760b402f 100644 --- a/src/SOL002/VNFConfiguration/responses/VNFConfiguration_resp.yaml +++ b/src/SOL002/VNFConfiguration/responses/VNFConfiguration_resp.yaml @@ -1,6 +1,8 @@ responses: 409: description: > + Conflict + Another request is in progress that prohibits the fulfilment of the current request, or the current resource state is inconsistent with the request. diff --git a/src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml b/src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml index 5c4ca7a7b7b88fec0588dd35dfae29c3eb278dbe..5a49feb39e736348e68ab0583f030278ac9499e3 100644 --- a/src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml +++ b/src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml @@ -66,6 +66,8 @@ paths: responses: 200: description: > + OK + The request has succeeded. The response body shall contain the list of related alarms. headers: @@ -145,6 +147,8 @@ paths: responses: 200: description: > + OK + Information about an individual alarm was read successfully. The response body shall contain a representation of the individual alarm. @@ -214,6 +218,8 @@ paths: responses: 200: description: > + OK + The request was accepted and completed. The response body shall contain attribute modifications for an ‘Individual alarm’ resource. @@ -292,6 +298,8 @@ paths: responses: 201: description: > + Created + The subscription was created successfully. The response body shall contain a representation of the created subscription resource. The HTTP response shall include a "Location:" HTTP header that @@ -363,6 +371,8 @@ paths: responses: 200: description: > + OK + The list of subscriptions was queried successfully. The response body shall contain the representations of all active subscriptions of the functional block that invokes the method. @@ -445,6 +455,8 @@ paths: responses: 200: description: > + OK + The operation has completed successfully. The response body shall contain a representation of the subscription resource. @@ -494,6 +506,8 @@ paths: responses: 204: description: > + No Content + The subscription resource was deleted successfully. The response body shall be empty. headers: diff --git a/src/SOL002/VNFFaultManagement/responses/VNFFaultManagement_resp.yaml b/src/SOL002/VNFFaultManagement/responses/VNFFaultManagement_resp.yaml index 3ef98f5007f13c428289745e553436aaed2b14b0..30c373f309c8b6873f7259132f3b0c60698220f3 100644 --- a/src/SOL002/VNFFaultManagement/responses/VNFFaultManagement_resp.yaml +++ b/src/SOL002/VNFFaultManagement/responses/VNFFaultManagement_resp.yaml @@ -4,6 +4,8 @@ responses: 409-alarm-state-conflict: description: > + Conflict + The operation cannot be executed currently, due to a conflict with the state of the "Individual alarm" resource. Typically, this is due to the fact that the alarm is already in the diff --git a/src/SOL002/VNFIndicator/VNFIndicator.yaml b/src/SOL002/VNFIndicator/VNFIndicator.yaml index 16493a301bf81e430df384e677eb0a9946ce838e..cb5a3c5bffb6f503d96ad832f146fd2f48799aca 100644 --- a/src/SOL002/VNFIndicator/VNFIndicator.yaml +++ b/src/SOL002/VNFIndicator/VNFIndicator.yaml @@ -102,6 +102,8 @@ paths: responses: 200: description: > + OK + The list of VNF indicators was queried successfully. The response body shall contain the representations of all VNF indicators that match the attribute-based filtering parameters. @@ -127,6 +129,8 @@ paths: - name: vnfInstanceId in: path description: > + Service Unavailable + Identifier of the VNF instance to which the VNF indicators applies. NOTE: This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body @@ -189,6 +193,8 @@ paths: responses: 200: description: > + OK + The list of VNF indicators was queried successfully. The response body shall contain the representations of all VNF indicators that match the attribute-based filtering parameters. @@ -214,6 +220,8 @@ paths: - name: vnfInstanceId in: path description: > + Service Unavailable + Identifier of the VNF instance to which the VNF indicators applies. NOTE: This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body @@ -237,6 +245,8 @@ paths: responses: 200: description: > + OK + The VNF indicator was read successfully. The response body shall contain the representation of the VNF indicator. schema: @@ -268,6 +278,8 @@ paths: responses: 201: description: > + Created + The subscription was created successfully. The response body shall contain a representation of the created subscription resource. schema: @@ -292,6 +304,8 @@ paths: get: summary: Query multiple subscriptions. description: > + Service Unavailable + The GET method queries the list of active subscriptions of the functional block that invokes the method. It can be used e.g. for resynchronization after error situations. # parameters: @@ -368,6 +382,8 @@ paths: responses: 200: description: > + OK + The list of subscriptions was queried successfully. The response body shall contain the representations of all active subscriptions of the functional block that invokes the method which match the attribute filter. @@ -392,6 +408,8 @@ paths: get: summary: Read an individual subscription. description: > + Service Unavailable + This resource represents an individual subscription. The client can use this resource to read and to terminate a subscription to notifications related to VNF indicator value changes. parameters: @@ -408,6 +426,8 @@ paths: responses: 200: description: > + OK + The subscriptions was queried successfully. The response body shall contain the representation of the requested subscription. schema: @@ -429,6 +449,8 @@ paths: parameters: - name: subscriptionId description: > + Service Unavailable + Identifier of this subscription. NOTE: This identifier can be retrieved from the resource referenced by the "Location" HTTP header @@ -440,6 +462,8 @@ paths: responses: 204: description: > + No Content + The subscription was deleted successfully. The response body shall be empty. 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } diff --git a/src/SOL002/VNFIndicator/responses/VNFIndicator_resp.yaml b/src/SOL002/VNFIndicator/responses/VNFIndicator_resp.yaml index 305b84ef42e37c5397006d6ca7f35088602c236d..89938b310aa0a88113897523e91796ce760b402f 100644 --- a/src/SOL002/VNFIndicator/responses/VNFIndicator_resp.yaml +++ b/src/SOL002/VNFIndicator/responses/VNFIndicator_resp.yaml @@ -1,6 +1,8 @@ responses: 409: description: > + Conflict + Another request is in progress that prohibits the fulfilment of the current request, or the current resource state is inconsistent with the request. diff --git a/src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml b/src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml index c9cb9ee7b6755b06ed5b4ec24d6bb75884291367..05d7affa42aa921d192fc5d779574d2916a85022 100644 --- a/src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml +++ b/src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml @@ -54,6 +54,8 @@ paths: responses: 204: description: > + No Content + The notification was delivered successfully. The response body shall be empty. 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } 401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' } @@ -69,11 +71,15 @@ paths: get: summary: Test notification endpoint. description: > + Service Unavailable + The GET method allows the server to test the notification endpoint that is provided by the client, e.g. during subscription. responses: 204: description: > + No Content + The notification endpoint was tested successfully. The response body shall be empty. 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } 401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' } diff --git a/src/SOL002/VNFIndicatorNotification/responses/VNFIndicatorNotification_resp.yaml b/src/SOL002/VNFIndicatorNotification/responses/VNFIndicatorNotification_resp.yaml index 305b84ef42e37c5397006d6ca7f35088602c236d..89938b310aa0a88113897523e91796ce760b402f 100644 --- a/src/SOL002/VNFIndicatorNotification/responses/VNFIndicatorNotification_resp.yaml +++ b/src/SOL002/VNFIndicatorNotification/responses/VNFIndicatorNotification_resp.yaml @@ -1,6 +1,8 @@ responses: 409: description: > + Conflict + Another request is in progress that prohibits the fulfilment of the current request, or the current resource state is inconsistent with the request. diff --git a/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml b/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml index 6d3504f66474ae7d9281091f1641d45b9ea9a9dc..79fa100bfc434bacdadac7a7f425411e4fc35221 100644 --- a/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml +++ b/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml @@ -84,6 +84,8 @@ paths: format: url WWW-Authenticate: description: > + Created + Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. @@ -135,6 +137,8 @@ paths: responses: 200: description: > + OK + Information about zero or more VNF instances was queried successfully. The response body shall contain representations of zero or more VNF instances. @@ -198,6 +202,8 @@ paths: responses: 200: description: > + OK + Information about zero or more VNF instances was queried successfully. The response body shall contain representations of zero or more VNF instances. @@ -283,6 +289,8 @@ paths: responses: 204: description: > + No Content + The VNF instance resource and the associated VNF identifier were deleted successfully. The response body shall be empty. @@ -345,6 +353,8 @@ paths: responses: 200: description: > + OK + Information about zero or more VNF instances was queried successfully. The response body shall contain representations of zero or more VNF instances. @@ -401,6 +411,8 @@ paths: responses: 200: description: > + OK + Information about zero or more VNF instances was queried successfully. The response body shall contain representations of zero or more VNF instances. @@ -507,6 +519,8 @@ paths: responses: 204: description: > + No Content + The VNF instance resource and the associated VNF identifier were deleted successfully. The response body shall be empty. @@ -887,6 +901,8 @@ paths: responses: 200: description: > + OK + Status information for zero or more VNF lifecycle management operation occurrences was queried successfully. The response body shall contain status information about zero or more VNF lifecycle @@ -951,6 +967,8 @@ paths: responses: 200: description: > + OK + Information about an individual VNF instance was queried successfully. The response body shall contain status information about a VNF lifecycle management operation @@ -1101,6 +1119,8 @@ paths: responses: 200: description: > + OK + The state of the VNF lifecycle management operation occurrence was changed successfully. The response shall include a representation of the VNF lifecycle operation occurrence resource. @@ -1178,6 +1198,8 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" 409: description: > + Conflict + The operation cannot be executed currently, due to a conflict with the state of the VNF LCM operation occurrence resource. Typically, this is due to the fact that the operation occurrence @@ -1224,6 +1246,8 @@ paths: responses: 201: description: > + Created + The subscription was created successfully. The response body shall contain a representation of the created subscription resource. The HTTP response shall include a "Location" HTTP header that @@ -1272,6 +1296,8 @@ paths: responses: 200: description: > + OK + The list of subscriptions was queried successfully. The response body shall contain the representations of all active subscriptions of the functional block that invokes the method. @@ -1293,6 +1319,8 @@ paths: $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription" 400: description: > + Bad Request + Invalid attribute-based filtering parameters. The response body shall contain a ProblemDetails structure, in which the "detail" attribute should convey more information about @@ -1350,6 +1378,8 @@ paths: responses: 200: description: > + OK + The operation has completed successfully. The response body shall contain a representation of the subscription resource. @@ -1391,6 +1421,8 @@ paths: responses: 204: description: > + No Content + The subscription resource was deleted successfully. The response body shall be empty. headers: diff --git a/src/SOL002/VNFLifecycleManagement/responses/VNFLifecycleManagement_resp.yaml b/src/SOL002/VNFLifecycleManagement/responses/VNFLifecycleManagement_resp.yaml index a4a6171da92ec7d3f8aa37c664554d22f798a909..92e8da02081ab26845bdbf5c377057381adfd79d 100644 --- a/src/SOL002/VNFLifecycleManagement/responses/VNFLifecycleManagement_resp.yaml +++ b/src/SOL002/VNFLifecycleManagement/responses/VNFLifecycleManagement_resp.yaml @@ -4,6 +4,8 @@ responses: 202-with-Location: description: > + Accepted + The request was accepted for processing, but the processing has not been completed. On success, the HTTP response shall include a "Location" HTTP header that contains the URI of the newly-created @@ -31,6 +33,8 @@ responses: $ref: "../definitions/VNFLifecycleManagement_def.yaml#/definitions/VnfInstance" 409-another-lcm-operation-ongoing: description: > + Conflict + The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource. Typically, this is due to the fact that another LCM operation is @@ -55,6 +59,8 @@ responses: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" 409-inconsistent-state: description: > + Conflict + Another request is in progress that prohibits the fulfilment of the current request, or the current resource state is inconsistent with the request. @@ -76,6 +82,8 @@ responses: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" 409-state-conflict-INSTANTIATED: description: > + Conflict + The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource. Typically, this is due to the fact that the VNF instance resource is in @@ -125,6 +133,8 @@ responses: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" 409-state-conflict-NOT-INSTANTIATED: description: > + Conflict + The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource. Typically, this is due to the fact that the VNF instance resource is in diff --git a/src/SOL002/VNFPerformanceManagement/VNFPerformanceManagement.yaml b/src/SOL002/VNFPerformanceManagement/VNFPerformanceManagement.yaml index 0844a4c55859bcf2bfd6df872a42b6ee62a595fa..67ff790cdd77223359cba385986167d811dd822c 100644 --- a/src/SOL002/VNFPerformanceManagement/VNFPerformanceManagement.yaml +++ b/src/SOL002/VNFPerformanceManagement/VNFPerformanceManagement.yaml @@ -71,6 +71,8 @@ paths: responses: 201: description: > + Created + The PM job was created successfully. The response body shall contain a representation of the created PM job resource. The HTTP response shall include a "Location" HTTP header that @@ -132,6 +134,8 @@ paths: responses: 200: description: > + OK + Information about zero or more PM jobs was queried successfully. The response body shall contain representations of zero or more PM jobs. @@ -199,6 +203,8 @@ paths: responses: 200: description: > + OK + Information about an individual PM job was queried successfully. The response body shall contain a representation of the PM job resource. @@ -241,6 +247,8 @@ paths: responses: 204: description: > + No Content + The PM job was deleted successfully. The response body shall be empty. headers: @@ -306,6 +314,8 @@ paths: responses: 200: description: > + OK + Information of an individual performance report was read successfully. The response body shall contain a representation of the @@ -375,6 +385,8 @@ paths: responses: 201: description: > + Created + A threshold was created successfully. The response body shall contain a representation of the created threshold resource. The HTTP response shall include a "Location" HTTP header that @@ -429,6 +441,8 @@ paths: responses: 200: description: > + OK + Information about zero or more thresholds was queried successfully. The response body shall contain representations of zero @@ -501,6 +515,8 @@ paths: responses: 200: description: > + OK + Information about an individual threshold was queried successfully. The response body shall contain a representation of the threshold. @@ -550,6 +566,8 @@ paths: responses: 204: description: > + No Content + The threshold was deleted successfully. The response body shall be empty. headers: @@ -615,6 +633,8 @@ paths: responses: 201: description: > + Created + The subscription was created successfully. A representation of the created subscription resource shall be returned in the response body. @@ -672,6 +692,8 @@ paths: responses: 200: description: > + OK + The list of subscriptions was queried successfully. The response body shall contain the representations of all active subscriptions of the functional block that invokes the method. @@ -746,6 +768,8 @@ paths: responses: 200: description: > + OK + The subscription was read successfully. The response body shall contain a representation of the subscription resource. headers: @@ -801,6 +825,8 @@ paths: responses: 204: description: > + No Content + The subscription resource was deleted successfully. The response body shall be empty. headers: diff --git a/src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml b/src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml index 909c1c5c17af434d1e423972273b30e9bfb16091..e78bb265877b3759f5d5f2af8fbd6bb23610c570 100644 --- a/src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml +++ b/src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml @@ -66,6 +66,8 @@ paths: responses: 200: description: > + OK + The request has succeeded. The response body shall contain the list of related alarms. headers: @@ -137,6 +139,8 @@ paths: responses: 200: description: > + OK + Information about an individual alarm was read successfully. The response body shall contain a representation of the individual alarm. @@ -200,6 +204,8 @@ paths: responses: 200: description: > + OK + The request was accepted and completed. The response body shall contain attribute modifications for an ‘Individual alarm’ resource. @@ -280,6 +286,8 @@ paths: responses: 201: description: > + Created + The subscription was created successfully. The response body shall contain a representation of the created subscription resource. The HTTP response shall include a "Location:" HTTP header that @@ -345,6 +353,8 @@ paths: responses: 200: description: > + OK + The list of subscriptions was queried successfully. The response body shall contain the representations of all active subscriptions of the functional block that invokes the method. @@ -419,6 +429,8 @@ paths: responses: 200: description: > + OK + The operation has completed successfully. The response body shall contain a representation of the subscription resource. @@ -460,6 +472,8 @@ paths: responses: 204: description: > + No Content + The subscription resource was deleted successfully. The response body shall be empty. headers: diff --git a/src/SOL003/VNFFaultManagement/responses/VNFFaultManagement_resp.yaml b/src/SOL003/VNFFaultManagement/responses/VNFFaultManagement_resp.yaml index 65c775a8a43b064f5d2353d8343854066054d7b4..6814a0f6c978cff5f3f92da48fe25b44fbabe94f 100644 --- a/src/SOL003/VNFFaultManagement/responses/VNFFaultManagement_resp.yaml +++ b/src/SOL003/VNFFaultManagement/responses/VNFFaultManagement_resp.yaml @@ -1,6 +1,8 @@ responses: 409-alarm-state-conflict: description: > + Conflict + The operation cannot be executed currently, due to a conflict with the state of the "Individual alarm" resource. Typically, this is due to the fact that the alarm is already in the diff --git a/src/SOL003/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml b/src/SOL003/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml index 63041b90145a4c0d71f67ee842333b0c0b60347b..5aa167dd986019dad0e9e65b0b54ebdda1ce4dcb 100644 --- a/src/SOL003/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml +++ b/src/SOL003/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml @@ -54,6 +54,8 @@ paths: responses: 204: description: > + No Content + The notification was delivered successfully. The response body shall be empty. 400: @@ -77,6 +79,8 @@ paths: responses: 204: description: > + No Content + The notification endpoint was tested successfully. The response body shall be empty. 400: @@ -113,6 +117,8 @@ paths: responses: 204: description: > + No Content + The notification was delivered successfully. The response body shall be empty. 400: @@ -136,6 +142,8 @@ paths: responses: 204: description: > + No Content + The notification endpoint was tested successfully. The response body shall be empty. 400: @@ -172,6 +180,8 @@ paths: responses: 204: description: > + No Content + The notification was delivered successfully. The response body shall be empty. 400: @@ -195,6 +205,8 @@ paths: responses: 204: description: > + No Content + The notification endpoint was tested successfully. The response body shall be empty. 400: diff --git a/src/SOL003/VNFIndicator/VNFIndicator.yaml b/src/SOL003/VNFIndicator/VNFIndicator.yaml index 463b6123ff872b66bb66ae31bc07336d0450f4e9..46d82b678a00bdf9f77826daf544674328ff3fcd 100644 --- a/src/SOL003/VNFIndicator/VNFIndicator.yaml +++ b/src/SOL003/VNFIndicator/VNFIndicator.yaml @@ -65,6 +65,8 @@ paths: responses: 200: description: > + OK + The list of VNF indicators was queried successfully. The response body shall contain the representations of all VNF indicators that match the attribute filter. @@ -139,6 +141,8 @@ paths: responses: 200: description: > + OK + The list of VNF indicators was queried successfully. The response body shall contain the representations of all VNF indicators that are related to the particular VNF instance and @@ -222,6 +226,8 @@ paths: responses: 200: description: > + OK + The VNF indicator was read successfully. The response body shall contain the representation of the VNF indicator. @@ -297,6 +303,8 @@ paths: responses: 201: description: > + Created + The subscription was created successfully. The response body shall contain a representation of the created subscription resource. @@ -364,6 +372,8 @@ paths: responses: 200: description: > + OK + The list of subscriptions was queried successfully. The response body shall contain the representations of all active subscriptions of the functional block that invokes the method @@ -442,6 +452,8 @@ paths: responses: 200: description: > + OK + The operation has completed successfully. The response body shall contain a representation of the subscription resource. @@ -483,6 +495,8 @@ paths: responses: 204: description: > + No Content + The subscription resource was deleted successfully. The response body shall be empty. 400: diff --git a/src/SOL003/VNFIndicatorNotification/VNFIndicatorNotification.yaml b/src/SOL003/VNFIndicatorNotification/VNFIndicatorNotification.yaml index f62a947fe7ccc5d1d68299ee78859ff2bb0f2f98..0b2ac5d08de09afa86b935ed74fa9cbe6b88cb88 100644 --- a/src/SOL003/VNFIndicatorNotification/VNFIndicatorNotification.yaml +++ b/src/SOL003/VNFIndicatorNotification/VNFIndicatorNotification.yaml @@ -54,6 +54,8 @@ paths: responses: 204: description: > + No Content + The notification was delivered successfully. The response body shall be empty. 400: @@ -77,6 +79,8 @@ paths: responses: 204: description: > + No Content + The notification endpoint was tested successfully. The response body shall be empty. 400: diff --git a/src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml b/src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml index 43df688145908c54dba9718e1d924f8c29c06654..9fea6742881ba94fd9e86d75c0d2dd1b8577df0d 100644 --- a/src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml +++ b/src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml @@ -129,6 +129,8 @@ paths: responses: 200: description: > + OK + Information about zero or more VNF instances was queried successfully. The response body shall contain representations of zero or more VNF instances. @@ -185,6 +187,8 @@ paths: responses: 200: description: > + OK + Information about zero or more VNF instances was queried successfully. The response body shall contain representations of zero or more VNF instances. @@ -271,6 +275,8 @@ paths: responses: 204: description: > + No Content + The VNF instance resource and the associated VNF identifier were deleted successfully. The response body shall be empty. @@ -324,6 +330,8 @@ paths: responses: 200: description: > + OK + Information about zero or more VNF instances was queried successfully. The response body shall contain representations of zero or more VNF instances. @@ -372,6 +380,8 @@ paths: responses: 200: description: > + OK + Information about zero or more VNF instances was queried successfully. The response body shall contain representations of zero or more VNF instances. @@ -470,6 +480,8 @@ paths: responses: 204: description: > + No Content + The VNF instance resource and the associated VNF identifier were deleted successfully. The response body shall be empty. @@ -841,6 +853,8 @@ paths: responses: 200: description: > + OK + Status information for zero or more VNF lifecycle management operation occurrences was queried successfully. The response body shall contain status information about zero or more VNF lifecycle @@ -897,6 +911,8 @@ paths: responses: 200: description: > + OK + Information about an individual VNF instance was queried successfully. The response body shall contain status information about a VNF lifecycle management operation @@ -1039,6 +1055,8 @@ paths: responses: 200: description: > + OK + The state of the VNF lifecycle management operation occurrence was changed successfully. The response shall include a representation of the VNF lifecycle operation occurrence resource. @@ -1108,6 +1126,8 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" 409: description: > + Conflict + The operation cannot be executed currently, due to a conflict with the state of the VNF LCM operation occurrence resource. Typically, this is due to the fact that the operation occurrence @@ -1156,6 +1176,8 @@ paths: responses: 201: description: > + Created + The subscription was created successfully. The response body shall contain a representation of the created subscription resource. The HTTP response shall include a "Location" HTTP header that @@ -1174,6 +1196,8 @@ paths: $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription" 303: description: > + See Other + A subscription with the same callbackURI and the same filter already exists and the policy of the VNFM is to not create redundant subscriptions. @@ -1209,6 +1233,8 @@ paths: responses: 200: description: > + OK + The list of subscriptions was queried successfully. The response body shall contain the representations of all active subscriptions of the functional block that invokes the method. @@ -1222,6 +1248,8 @@ paths: $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription" 400: description: > + Bad Request + Invalid attribute-based filtering parameters. The response body shall contain a ProblemDetails structure, in which the "detail" attribute should convey more information about @@ -1271,6 +1299,8 @@ paths: responses: 200: description: > + OK + The operation has completed successfully. The response body shall contain a representation of the subscription resource. @@ -1304,6 +1334,8 @@ paths: responses: 204: description: > + No Content + The subscription resource was deleted successfully. The response body shall be empty. 400: diff --git a/src/SOL003/VNFLifecycleManagement/responses/VNFLifecycleManagement_resp.yaml b/src/SOL003/VNFLifecycleManagement/responses/VNFLifecycleManagement_resp.yaml index 59b58ac1fc245a2ae38327fe4640ee05c608fb6a..6309128cb00ec8931b1c56b9d0fac1a655d1cfca 100644 --- a/src/SOL003/VNFLifecycleManagement/responses/VNFLifecycleManagement_resp.yaml +++ b/src/SOL003/VNFLifecycleManagement/responses/VNFLifecycleManagement_resp.yaml @@ -4,6 +4,8 @@ responses: 202-with-Location: description: > + Accepted + The request was accepted for processing, but the processing has not been completed. On success, the HTTP response shall include a "Location" HTTP header that contains the URI of the newly-created @@ -23,6 +25,8 @@ responses: $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance" 202-with-Location-empty: description: > + Accepted + The request was accepted for processing, but the processing has not been completed. On success, the HTTP response shall include a "Location" HTTP header that contains the URI of the newly-created @@ -36,6 +40,8 @@ responses: format: url 409-another-lcm-operation-ongoing: description: > + Conflict + The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource. Typically, this is due to the fact that another LCM operation is @@ -52,6 +58,8 @@ responses: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" 409-inconsistent-state: description: > + Conflict + Another request is in progress that prohibits the fulfilment of the current request, or the current resource state is inconsistent with the request. @@ -65,6 +73,8 @@ responses: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" 409-state-conflict-INSTANTIATED: description: > + Conflict + The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource. Typically, this is due to the fact that the VNF instance resource is in @@ -98,6 +108,8 @@ responses: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" 409-state-conflict-NOT-INSTANTIATED: description: > + Conflict + The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource. Typically, this is due to the fact that the VNF instance resource is in diff --git a/src/SOL003/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml b/src/SOL003/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml index d5efb041f9913a41a83c7bad2401f31cedf29e52..f661974c18e6890baf39fad3f0ba51a54ed2956e 100644 --- a/src/SOL003/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml +++ b/src/SOL003/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml @@ -51,6 +51,8 @@ paths: responses: 204: description: > + No Content + The notification was delivered successfully. 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" @@ -87,6 +89,8 @@ paths: responses: 204: description: > + No Content + The notification was delivered successfully. 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" @@ -123,6 +127,8 @@ paths: responses: 204: description: > + No Content + The notification was delivered successfully. 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" diff --git a/src/SOL003/VNFLifecycleOperationGranting/VNFLifecycleOperationGranting.yaml b/src/SOL003/VNFLifecycleOperationGranting/VNFLifecycleOperationGranting.yaml index ae29b8516abe4c87e34dc0e91af8925f51ad80cd..e83763c7cb7436368aece857252cc45e03e954ce 100644 --- a/src/SOL003/VNFLifecycleOperationGranting/VNFLifecycleOperationGranting.yaml +++ b/src/SOL003/VNFLifecycleOperationGranting/VNFLifecycleOperationGranting.yaml @@ -71,6 +71,8 @@ paths: responses: 201: description: > + Created + The grant was created successfully (synchronous mode). A representation of the created "Individual grant" resource shall be returned in the response body. @@ -91,6 +93,8 @@ paths: $ref: "definitions/VNFLifecycleOperationGranting_def.yaml#/definitions/Grant" 202: description: > + Accepted + The request was accepted for processing, but the processing has not been completed. It is expected to take some time to create the grant (asynchronous mode). @@ -110,6 +114,8 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" 403: description: > + Forbidden + The grant was rejected. A ProblemDetails structure shall be included in the response to provide more details about the rejection in the "details" @@ -160,6 +166,8 @@ paths: responses: 200: description: > + OK + The grant was read successfully. A representation of the "individual grant" resource shall be returned in the response body. @@ -174,6 +182,8 @@ paths: $ref: "definitions/VNFLifecycleOperationGranting_def.yaml#/definitions/Grant" 202: description: > + Accepted + The process of creating the grant is ongoing, no grant is available yet. The response body shall be empty. @@ -183,6 +193,8 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" 403: description: > + Forbidden + The grant was rejected. A ProblemDetails structure shall be included in the response to provide more details about the rejection in the "details" diff --git a/src/SOL003/VNFPackageManagement/VNFPackageManagement.yaml b/src/SOL003/VNFPackageManagement/VNFPackageManagement.yaml index a3cd2d796958e6c19039e15c8d15ca172148ab24..2980680b2fbbef882275ca7b5280ce30ac3617cb 100644 --- a/src/SOL003/VNFPackageManagement/VNFPackageManagement.yaml +++ b/src/SOL003/VNFPackageManagement/VNFPackageManagement.yaml @@ -61,6 +61,8 @@ paths: responses: 200: description: > + OK + Information of the selected VNF packages. headers: Content-Type: @@ -126,6 +128,8 @@ paths: responses: 200: description: > + OK + Information of the selected VNF packages. headers: Content-Type: @@ -216,6 +220,8 @@ paths: responses: 200: description: > + OK + On success, the content of the VNFD is returned. The payload body shall contain a copy of the file representing the VNFD or a ZIP file that contains the file or multiple files @@ -300,6 +306,8 @@ paths: responses: 200: description: > + OK + On success, a copy of the VNF package file is returned. The response body shall include a copy of the VNF package file. The "Content-Type HTTP" header shall be set according to the type @@ -313,6 +321,8 @@ paths: minimum: 1 206: description: > + Partial Content + On success, if the NFVO supports range requests, a single consecutive byte range from the content of the VNF package file is returned. @@ -407,6 +417,8 @@ paths: responses: 200: description: > + OK + On success, the content of the artifact is returned. The payload body shall contain a copy of the artifact file from the VNF package, as defined by ETSI GS NFV-SOL 004. @@ -427,6 +439,8 @@ paths: minimum: 1 206: description: > + Partial Content + On success, if the NFVO supports range requests, a single consecutive byte range from the content of the VNF package file is returned. @@ -517,6 +531,8 @@ paths: responses: 201: description: > + Created + Representation of the created subscription resource. The HTTP response shall include a "Location" HTTP header that points to the created subscription resource. @@ -577,6 +593,8 @@ paths: responses: 200: description: > + OK + Active subscriptions of the functional block that invokes the method. headers: @@ -644,6 +662,8 @@ paths: responses: 200: description: > + OK + Representation of the subscription resource. headers: Content-Type: @@ -685,6 +705,8 @@ paths: responses: 204: description: > + No Content + The subscription resource was deleted successfully. 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" diff --git a/src/SOL003/VNFPackageManagement/responses/VNFPackageManagement_resp.yaml b/src/SOL003/VNFPackageManagement/responses/VNFPackageManagement_resp.yaml index 18f576322f0a88f719c3f45639f1de7e4d44d87d..a3f5ffbddd741125b08dbe0599147513b27f8eeb 100644 --- a/src/SOL003/VNFPackageManagement/responses/VNFPackageManagement_resp.yaml +++ b/src/SOL003/VNFPackageManagement/responses/VNFPackageManagement_resp.yaml @@ -1,6 +1,8 @@ responses: 406: description: > + Not Acceptable + If the "Accept" header does not contain at least one name of a content type for which the NFVO can provide a representation of the VNFD, the NFVO shall respond with this response code. @@ -16,6 +18,8 @@ responses: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" 409: description: > + Conflict + Error: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact that "onboardingState" of the VNF @@ -32,6 +36,8 @@ responses: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" 416: description: > + Requested Range Not Satisfiable + The byte range passed in the "Range" header did not match any available byte range in the VNF package file (e.g. "access after end of file"). The response body may contain a ProblemDetails structure. diff --git a/src/SOL003/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml b/src/SOL003/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml index f4d81900dd0e38bf72a02dc3785efda62650e92d..54073f8eacb5fe19fb28a8bf5a6321560d665278 100644 --- a/src/SOL003/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml +++ b/src/SOL003/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml @@ -52,6 +52,8 @@ paths: responses: 204: description: > + No Content + The notification was delivered successfully. 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" @@ -74,6 +76,8 @@ paths: responses: 204: description: > + No Content + The notification endpoint was tested successfully. The response body shall be empty. 400: @@ -109,6 +113,8 @@ paths: responses: 204: description: > + No Content + The notification was delivered successfully. 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" @@ -131,6 +137,8 @@ paths: responses: 204: description: > + No Content + The notification endpoint was tested successfully. The response body shall be empty. 400: diff --git a/src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml b/src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml index e4a7c1882fbf5e801642172f42db9dea938b2e96..02305bbfdf46bd205298d0a80fc163d405bafdc8 100644 --- a/src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml +++ b/src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml @@ -71,6 +71,8 @@ paths: responses: 201: description: > + Created + The PM job was created successfully. The response body shall contain a representation of the created PM job resource. The HTTP response shall include a "Location" HTTP header that @@ -124,6 +126,8 @@ paths: responses: 200: description: > + OK + Information about zero or more PM jobs was queried successfully. The response body shall contain representations of zero or more PM jobs. @@ -190,6 +194,8 @@ paths: responses: 200: description: > + OK + Information about an individual PM job was queried successfully. The response body shall contain a representation of the PM job resource. @@ -231,6 +237,8 @@ paths: responses: 204: description: > + No Content + The PM job was deleted successfully. The response body shall be empty. 400: @@ -287,6 +295,8 @@ paths: responses: 200: description: > + OK + Information of an individual performance report was read successfully. The response body shall contain a representation of the @@ -355,6 +365,8 @@ paths: responses: 201: description: > + Created + A threshold was created successfully. The response body shall contain a representation of the created threshold resource. The HTTP response shall include a "Location" HTTP header that @@ -408,6 +420,8 @@ paths: responses: 200: description: > + OK + Information about zero or more thresholds was queried successfully. The response body shall contain representations of zero @@ -479,6 +493,8 @@ paths: responses: 200: description: > + OK + Information about an individual threshold was queried successfully. The response body shall contain a representation of the threshold. @@ -527,6 +543,8 @@ paths: responses: 204: description: > + No Content + The threshold was deleted successfully. The response body shall be empty. 400: @@ -593,6 +611,8 @@ paths: responses: 201: description: > + Created + The subscription was created successfully. A representation of the created subscription resource shall be returned in the response body. @@ -651,6 +671,8 @@ paths: responses: 200: description: > + OK + The list of subscriptions was queried successfully. The response body shall contain the representations of all active subscriptions of the functional block that invokes the method. @@ -717,6 +739,8 @@ paths: responses: 200: description: > + OK + The subscription was read successfully. The response body shall contain a representation of the subscription resource. headers: @@ -764,6 +788,8 @@ paths: responses: 204: description: > + No Content + The subscription resource was deleted successfully. The response body shall be empty. 400: diff --git a/src/SOL003/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml b/src/SOL003/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml index 1163be69d4fa905215428fb45569318ae3fdb4aa..a0bc337cc26defbc00a7025f07a842efd07ab44b 100644 --- a/src/SOL003/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml +++ b/src/SOL003/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml @@ -54,6 +54,8 @@ paths: responses: 204: description: > + No Content + The notification was delivered successfully. 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" @@ -76,6 +78,8 @@ paths: responses: 204: description: > + No Content + The notification endpoint was tested successfully. 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" @@ -111,6 +115,8 @@ paths: responses: 204: description: > + No Content + The notification was delivered successfully. 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" @@ -133,6 +139,8 @@ paths: responses: 204: description: > + No Content + The notification endpoint was tested successfully. 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" diff --git a/src/SOL003/VirtualisedResourcesQuotaAvailableNotification/VirtualisedResourcesQuotaAvailableNotification.yaml b/src/SOL003/VirtualisedResourcesQuotaAvailableNotification/VirtualisedResourcesQuotaAvailableNotification.yaml index 218face89a3f7559b436562e7e5bde33a9e95f7a..e3e7480404adacebf048d014d8d7754ffa874053 100644 --- a/src/SOL003/VirtualisedResourcesQuotaAvailableNotification/VirtualisedResourcesQuotaAvailableNotification.yaml +++ b/src/SOL003/VirtualisedResourcesQuotaAvailableNotification/VirtualisedResourcesQuotaAvailableNotification.yaml @@ -61,6 +61,8 @@ paths: responses: 201: description: > + Created + Representation of the created subscription resource. The HTTP response shall include a "Location" HTTP header that points to the created subscription resource. @@ -101,6 +103,8 @@ paths: responses: 204: description: > + No Content + The notification endpoint was tested successfully. The response body shall be empty. 400: diff --git a/src/SOL003/VirtualisedResourcesQuotaAvailableNotificationNotification/VirtualisedResourcesQuotaAvailableNotificationNotification.yaml b/src/SOL003/VirtualisedResourcesQuotaAvailableNotificationNotification/VirtualisedResourcesQuotaAvailableNotificationNotification.yaml index c0f083607cb9a4be9f73e8fee697c13a17ed1182..024048682317c84ce056f8852327841fc53f3ea5 100644 --- a/src/SOL003/VirtualisedResourcesQuotaAvailableNotificationNotification/VirtualisedResourcesQuotaAvailableNotificationNotification.yaml +++ b/src/SOL003/VirtualisedResourcesQuotaAvailableNotificationNotification/VirtualisedResourcesQuotaAvailableNotificationNotification.yaml @@ -51,6 +51,8 @@ paths: responses: 204: description: > + No Content + The notification was delivered successfully. 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" @@ -75,6 +77,8 @@ paths: responses: 204: description: > + No Content + The notification was delivered successfully. 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" diff --git a/src/responses/SOL002SOL003_resp.yaml b/src/responses/SOL002SOL003_resp.yaml index a0e4441f09b83429a0dc28c50b1cfa7fd3471dcc..cc35d0b9b19b5c263b6fb718be13adc8e852e0d0 100644 --- a/src/responses/SOL002SOL003_resp.yaml +++ b/src/responses/SOL002SOL003_resp.yaml @@ -1,6 +1,8 @@ responses: 202: description: > + Accepted + The request was accepted for processing, but processing has not been completed. The response shall have an empty payload body. headers: @@ -24,6 +26,8 @@ responses: minimum: 0 202-with-Location: description: > + Accepted + The request was accepted for processing, but the processing has not been completed. On success, the HTTP response shall include a "Location" HTTP header that contains the URI of the newly-created @@ -50,6 +54,8 @@ responses: minimum: 0 303: description: > + See Other + A subscription with the same callbackURI and the same filter already exists and the policy of the VNFM is to not create redundant subscriptions. @@ -58,6 +64,8 @@ responses: The response body shall be empty. 400: description: > + Bad Request + It fhe request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), the API producer shall respond with this @@ -93,6 +101,8 @@ responses: $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" 400-attr-based-filtering-error: description: > + Bad Request + Invalid attribute-based filtering parameters or Invalid attribute selector. It fhe request is malformed or syntactically incorrect (e.g. if the @@ -128,6 +138,8 @@ responses: $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" 400-attr-selector: description: > + Bad Request + It fhe request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), the API producer shall respond with this @@ -163,6 +175,8 @@ responses: $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" 401: description: > + Unauthorized + If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should @@ -188,6 +202,8 @@ responses: $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" 403: description: > + Forbidden + If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. @@ -203,6 +219,8 @@ responses: $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" 404: description: > + Not Found + If the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this @@ -220,6 +238,8 @@ responses: $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" 404-task-resource-not-exists: description: > + Not Found + Error: The API producer did not find a current representation for the target resource or is not willing to disclose that one exists. Specifically in case of this task resource, the response code 404 shall @@ -239,6 +259,8 @@ responses: $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" 404-task-resource-not-exists-VNF-LCM: description: > + Not Found + Error: The API producer did not find a current representation for the target resource or is not willing to disclose that one exists. Specifically in case of this task resource, the response code 404 shall @@ -258,6 +280,8 @@ responses: $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" 404-task-not-suported: description: > + Not Found + If the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this @@ -278,6 +302,8 @@ responses: $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" 404-task-not-suported-VNF-LCM: description: > + Not Found + If the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this @@ -299,6 +325,8 @@ responses: $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" 405: description: > + Method Not Allowed + If a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted in that case. @@ -312,6 +340,8 @@ responses: $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" 406: description: > + Not Acceptable + If the "Accept" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The @@ -326,6 +356,8 @@ responses: $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" 412: description: > + Precondition Failed + A precondition given in an HTTP request header is not fulfilled. Typically, this is due to an ETag mismatch, indicating that the resource was modified by another entity. The response body should @@ -341,6 +373,8 @@ responses: $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" 416: description: > + Requested Range Not Satisfiable + This code is returned if the requested byte range in the Range HTTP header is not present in the requested resource. headers: @@ -353,6 +387,8 @@ responses: $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" 422: description: > + Unprocessable Entity + If the payload body of a request contains syntactically correct data (e.g. well-formed JSON) but the data cannot be processed (e.g. because it fails validation against a schema), the API @@ -372,6 +408,8 @@ responses: $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" 500: description: > + Internal Server Error + If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond withthis @@ -388,6 +426,8 @@ responses: $ref: "/../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" 503: description: > + Service Unavailable + If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for