From 3ee8f80d047b1a062e346208cc031dddc4744344 Mon Sep 17 00:00:00 2001 From: moscatelli Date: Thu, 9 May 2019 12:40:14 +0200 Subject: [PATCH] SOL005: fix in OpenAPI versions --- src/SOL005/NSDManagement/NSDManagement.yaml | 2 +- .../SOL005NSDescriptorManagement_def.yaml | 1 + .../NSDManagementNotification.yaml | 906 +----------------- .../NSFaultManagement/NSFaultManagement.yaml | 2 +- .../NSFaultManagementNotification.yaml | 2 +- .../NSLifecycleManagement.yaml | 2 +- .../NSLifecycleManagementNotification.yaml | 2 +- .../NSPerformanceManagement.yaml | 10 +- .../SOL005NSPerformanceManagement_def.yaml | 1 + .../NSPerformanceManagementNotification.yaml | 143 +-- .../VNFPackageManagement.yaml | 2 +- .../VNFPackageManagementNotification.yaml | 2 +- src/SOL005/responses/SOL005_resp.yaml | 296 +----- 13 files changed, 73 insertions(+), 1298 deletions(-) diff --git a/src/SOL005/NSDManagement/NSDManagement.yaml b/src/SOL005/NSDManagement/NSDManagement.yaml index ff4ce63..23df6ee 100644 --- a/src/SOL005/NSDManagement/NSDManagement.yaml +++ b/src/SOL005/NSDManagement/NSDManagement.yaml @@ -1,7 +1,7 @@ swagger: "2.0" info: - version: "1.1.0" + version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: "SOL005 - NSD Management Interface" description: > SOL005 - NSD Management Interface diff --git a/src/SOL005/NSDManagement/definitions/SOL005NSDescriptorManagement_def.yaml b/src/SOL005/NSDManagement/definitions/SOL005NSDescriptorManagement_def.yaml index ecd44fb..336caac 100644 --- a/src/SOL005/NSDManagement/definitions/SOL005NSDescriptorManagement_def.yaml +++ b/src/SOL005/NSDManagement/definitions/SOL005NSDescriptorManagement_def.yaml @@ -1,5 +1,6 @@ # Copyright (c) ETSI 2017. # https://forge.etsi.org/etsi-forge-copyright-notice.txt + definitions: NsdInfoModifications: type: object diff --git a/src/SOL005/NSDManagementNotification/NSDManagementNotification.yaml b/src/SOL005/NSDManagementNotification/NSDManagementNotification.yaml index ec968cd..15a736e 100644 --- a/src/SOL005/NSDManagementNotification/NSDManagementNotification.yaml +++ b/src/SOL005/NSDManagementNotification/NSDManagementNotification.yaml @@ -1,7 +1,7 @@ swagger: "2.0" info: - version: "1.1.0" + version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL005 - NSD Management Notification interface description: > SOL005 - NSD Management Notification interface @@ -30,9 +30,9 @@ produces: paths: ############################################################################### - # Notification endpoint NSDManagement # + # Notification endpoint # ############################################################################### - '/URI_is_provided_by_the_client_when_creating_the_subscription-NsdOnBoardingNotification': + '/URI_is_provided_by_the_client_when_creating_the_subscription': parameters: - name: Authorization description: > @@ -64,883 +64,49 @@ paths: description: > A notification about the successful on-boarding of an NSD. in: body - required: true - schema: - $ref: "definitions/SOL005NSDescriptorManagementNotification_def.yaml#/definitions/NsdOnBoardingNotification" - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231. - in: header - required: true - type: string - - name: Content-Type - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231. - in: header - required: true - type: string - responses: - 204: - description: > - 204 NO CONTENT - - The notification was delivered successfully. - headers: - WWW-Authenticate: - type: string - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP request - has provided an invalid authorization token. - maximum: 1 - minimum: 0 - Version: - description: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../responses/SOL005_resp.yaml#/responses/400" - 401: - $ref: "../responses/SOL005_resp.yaml#/responses/401" - 403: - $ref: "../responses/SOL005_resp.yaml#/responses/403" - 404: - $ref: "../responses/SOL005_resp.yaml#/responses/404" - 405: - $ref: "../responses/SOL005_resp.yaml#/responses/405" - 406: - $ref: "../responses/SOL005_resp.yaml#/responses/406" - 500: - $ref: "../responses/SOL005_resp.yaml#/responses/500" - 503: - $ref: "../responses/SOL005_resp.yaml#/responses/503" - - get: - summary: Test the notification endpoint - description: > - This resource represents a notification endpoint. The server can use - this resource to send notifications to a subscribed - client, which has provided the URI of this resource during the subscription process. - - The GET method allows the server to test the notification endpoint - that is provided by the client, e.g. during subscription. - This method shall follow the provisions specified in the Table 5.4.10.3.2-2 for URI query parameters, - request and response data structures, and response codes. - parameters: - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231. - in: header - required: true - type: string - responses: - 204: - description: > - 204 NO CONTENT - - The notification endpoint was tested successfully. - The response body shall be empty. - headers: - WWW-Authenticate: - type: string - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP request - has provided an invalid authorization token. - maximum: 1 - minimum: 0 - Version: - description: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../responses/SOL005_resp.yaml#/responses/400" - 401: - $ref: "../responses/SOL005_resp.yaml#/responses/401" - 403: - $ref: "../responses/SOL005_resp.yaml#/responses/403" - 404: - $ref: "../responses/SOL005_resp.yaml#/responses/404" - 405: - $ref: "../responses/SOL005_resp.yaml#/responses/405" - 406: - $ref: "../responses/SOL005_resp.yaml#/responses/406" - 500: - $ref: "../responses/SOL005_resp.yaml#/responses/500" - 503: - $ref: "../responses/SOL005_resp.yaml#/responses/503" - - '/URI_is_provided_by_the_client_when_creating_the_subscription-NsdOnBoardingFailureNotification': - #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10 - parameters: - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235. - in: header - required: false - type: string - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string - - post: - summary: Notify about NSD and PNFD changes - description: > - This resource represents a notification endpoint. The server can use - this resource to send notifications to a subscribed - client, which has provided the URI of this resource during the subscription process. - - The POST method delivers a notification from the server to the client. - This method shall support the URI query parameters, request and - response data structures, and response codes, as - specified in the Table 5.4.10.3.1-2. - parameters: - - name: NsdOnBoardingFailureNotification - description: > - A notification about the failure of on-boarding an NSD. - in: body - required: true - schema: - $ref: "definitions/SOL005NSDescriptorManagementNotification_def.yaml#/definitions/NsdOnBoardingFailureNotification" - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231. - in: header - required: true - type: string - - name: Content-Type - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231. - in: header - required: true - type: string - responses: - 204: - description: > - 204 NO CONTENT - - The notification was delivered successfully. - headers: - WWW-Authenticate: - type: string - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP request - has provided an invalid authorization token. - maximum: 1 - minimum: 0 - Version: - description: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../responses/SOL005_resp.yaml#/responses/400" - 401: - $ref: "../responses/SOL005_resp.yaml#/responses/401" - 403: - $ref: "../responses/SOL005_resp.yaml#/responses/403" - 404: - $ref: "../responses/SOL005_resp.yaml#/responses/404" - 405: - $ref: "../responses/SOL005_resp.yaml#/responses/405" - 406: - $ref: "../responses/SOL005_resp.yaml#/responses/406" - 500: - $ref: "../responses/SOL005_resp.yaml#/responses/500" - 503: - $ref: "../responses/SOL005_resp.yaml#/responses/503" - - get: - summary: Test the notification endpoint - description: > - This resource represents a notification endpoint. The server can use - this resource to send notifications to a subscribed - client, which has provided the URI of this resource during the subscription process. - - The GET method allows the server to test the notification endpoint - that is provided by the client, e.g. during subscription. - This method shall follow the provisions specified in the Table 5.4.10.3.2-2 for URI query parameters, - request and response data structures, and response codes. - parameters: - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231. - in: header - required: true - type: string - responses: - 204: - description: > - 204 NO CONTENT - - The notification endpoint was tested successfully. - The response body shall be empty. - headers: - WWW-Authenticate: - type: string - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP request - has provided an invalid authorization token. - maximum: 1 - minimum: 0 - Version: - description: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../responses/SOL005_resp.yaml#/responses/400" - 401: - $ref: "../responses/SOL005_resp.yaml#/responses/401" - 403: - $ref: "../responses/SOL005_resp.yaml#/responses/403" - 404: - $ref: "../responses/SOL005_resp.yaml#/responses/404" - 405: - $ref: "../responses/SOL005_resp.yaml#/responses/405" - 406: - $ref: "../responses/SOL005_resp.yaml#/responses/406" - 500: - $ref: "../responses/SOL005_resp.yaml#/responses/500" - 503: - $ref: "../responses/SOL005_resp.yaml#/responses/503" - - '/URI_is_provided_by_the_client_when_creating_the_subscription-NsdChangeNotification': - #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10 - parameters: - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235. - in: header - required: false - type: string - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string - - post: - summary: Notify about NSD and PNFD changes - description: > - This resource represents a notification endpoint. The server can use - this resource to send notifications to a subscribed - client, which has provided the URI of this resource during the subscription process. - - The POST method delivers a notification from the server to the client. - This method shall support the URI query parameters, request and - response data structures, and response codes, as - specified in the Table 5.4.10.3.1-2. - parameters: - - name: NsdChangeNotification - description: > - A notification about the state change of an on-boarded NSD. - in: body - required: true - schema: - $ref: "definitions/SOL005NSDescriptorManagementNotification_def.yaml#/definitions/NsdChangeNotification" - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231. - in: header - required: true - type: string - - name: Content-Type - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231. - in: header - required: true - type: string - responses: - 204: - description: > - 204 NO CONTENT - - The notification was delivered successfully. - headers: - WWW-Authenticate: - type: string - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP request - has provided an invalid authorization token. - maximum: 1 - minimum: 0 - Version: - description: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../responses/SOL005_resp.yaml#/responses/400" - 401: - $ref: "../responses/SOL005_resp.yaml#/responses/401" - 403: - $ref: "../responses/SOL005_resp.yaml#/responses/403" - 404: - $ref: "../responses/SOL005_resp.yaml#/responses/404" - 405: - $ref: "../responses/SOL005_resp.yaml#/responses/405" - 406: - $ref: "../responses/SOL005_resp.yaml#/responses/406" - 500: - $ref: "../responses/SOL005_resp.yaml#/responses/500" - 503: - $ref: "../responses/SOL005_resp.yaml#/responses/503" - - get: - summary: Test the notification endpoint - description: > - This resource represents a notification endpoint. The server can use - this resource to send notifications to a subscribed - client, which has provided the URI of this resource during the subscription process. - - The GET method allows the server to test the notification endpoint - that is provided by the client, e.g. during subscription. - This method shall follow the provisions specified in the Table 5.4.10.3.2-2 for URI query parameters, - request and response data structures, and response codes. - parameters: - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231. - in: header - required: true - type: string - responses: - 204: - description: > - 204 NO CONTENT - - The notification endpoint was tested successfully. - The response body shall be empty. - headers: - WWW-Authenticate: - type: string - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP request - has provided an invalid authorization token. - maximum: 1 - minimum: 0 - Version: - description: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../responses/SOL005_resp.yaml#/responses/400" - 401: - $ref: "../responses/SOL005_resp.yaml#/responses/401" - 403: - $ref: "../responses/SOL005_resp.yaml#/responses/403" - 404: - $ref: "../responses/SOL005_resp.yaml#/responses/404" - 405: - $ref: "../responses/SOL005_resp.yaml#/responses/405" - 406: - $ref: "../responses/SOL005_resp.yaml#/responses/406" - 500: - $ref: "../responses/SOL005_resp.yaml#/responses/500" - 503: - $ref: "../responses/SOL005_resp.yaml#/responses/503" - - '/URI_is_provided_by_the_client_when_creating_the_subscription-NsdDeletionNotification': - #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10 - parameters: - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235. - in: header - required: false - type: string - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string - - post: - summary: Notify about NSD and PNFD changes - description: > - This resource represents a notification endpoint. The server can use - this resource to send notifications to a subscribed - client, which has provided the URI of this resource during the subscription process. - - The POST method delivers a notification from the server to the client. - This method shall support the URI query parameters, request and - response data structures, and response codes, as - specified in the Table 5.4.10.3.1-2. - parameters: - - name: NsdDeletionNotification - description: > - A notification about the deletion of an on-boarded NSD. - in: body - required: true - schema: - $ref: "definitions/SOL005NSDescriptorManagementNotification_def.yaml#/definitions/NsdDeletionNotification" - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231. - in: header - required: true - type: string - - name: Content-Type - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231. - in: header - required: true - type: string - responses: - 204: - description: > - 204 NO CONTENT - - The notification was delivered successfully. - headers: - WWW-Authenticate: - type: string - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP request - has provided an invalid authorization token. - maximum: 1 - minimum: 0 - Version: - description: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../responses/SOL005_resp.yaml#/responses/400" - 401: - $ref: "../responses/SOL005_resp.yaml#/responses/401" - 403: - $ref: "../responses/SOL005_resp.yaml#/responses/403" - 404: - $ref: "../responses/SOL005_resp.yaml#/responses/404" - 405: - $ref: "../responses/SOL005_resp.yaml#/responses/405" - 406: - $ref: "../responses/SOL005_resp.yaml#/responses/406" - 500: - $ref: "../responses/SOL005_resp.yaml#/responses/500" - 503: - $ref: "../responses/SOL005_resp.yaml#/responses/503" - - get: - summary: Test the notification endpoint - description: > - This resource represents a notification endpoint. The server can use - this resource to send notifications to a subscribed - client, which has provided the URI of this resource during the subscription process. - - The GET method allows the server to test the notification endpoint - that is provided by the client, e.g. during subscription. - This method shall follow the provisions specified in the Table 5.4.10.3.2-2 for URI query parameters, - request and response data structures, and response codes. - parameters: - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231. - in: header - required: true - type: string - responses: - 204: - description: > - 204 NO CONTENT - - The notification endpoint was tested successfully. - The response body shall be empty. - headers: - WWW-Authenticate: - type: string - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP request - has provided an invalid authorization token. - maximum: 1 - minimum: 0 - Version: - description: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../responses/SOL005_resp.yaml#/responses/400" - 401: - $ref: "../responses/SOL005_resp.yaml#/responses/401" - 403: - $ref: "../responses/SOL005_resp.yaml#/responses/403" - 404: - $ref: "../responses/SOL005_resp.yaml#/responses/404" - 405: - $ref: "../responses/SOL005_resp.yaml#/responses/405" - 406: - $ref: "../responses/SOL005_resp.yaml#/responses/406" - 500: - $ref: "../responses/SOL005_resp.yaml#/responses/500" - 503: - $ref: "../responses/SOL005_resp.yaml#/responses/503" - - '/URI_is_provided_by_the_client_when_creating_the_subscription-PnfdOnBoardingNotification': - #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10 - parameters: - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235. - in: header - required: false - type: string - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string - - post: - summary: Notify about NSD and PNFD changes - description: > - This resource represents a notification endpoint. The server can use - this resource to send notifications to a subscribed - client, which has provided the URI of this resource during the subscription process. - - The POST method delivers a notification from the server to the client. - This method shall support the URI query parameters, request and - response data structures, and response codes, as - specified in the Table 5.4.10.3.1-2. - parameters: - - name: PnfdOnBoardingNotification - description: > - A notification about the successful on-boarding of a PNFD. - in: body - required: true - schema: - $ref: "definitions/SOL005NSDescriptorManagementNotification_def.yaml#/definitions/PnfdOnBoardingNotification" - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231. - in: header - required: true - type: string - - name: Content-Type - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231. - in: header - required: true - type: string - responses: - 204: - description: > - 204 No Content - - The notification was delivered successfully. - headers: - WWW-Authenticate: - type: string - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP request - has provided an invalid authorization token. - maximum: 1 - minimum: 0 - Version: - description: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../responses/SOL005_resp.yaml#/responses/400" - 401: - $ref: "../responses/SOL005_resp.yaml#/responses/401" - 403: - $ref: "../responses/SOL005_resp.yaml#/responses/403" - 404: - $ref: "../responses/SOL005_resp.yaml#/responses/404" - 405: - $ref: "../responses/SOL005_resp.yaml#/responses/405" - 406: - $ref: "../responses/SOL005_resp.yaml#/responses/406" - 500: - $ref: "../responses/SOL005_resp.yaml#/responses/500" - 503: - $ref: "../responses/SOL005_resp.yaml#/responses/503" - - get: - summary: Test the notification endpoint - description: > - This resource represents a notification endpoint. The server can use - this resource to send notifications to a subscribed - client, which has provided the URI of this resource during the subscription process. - - The GET method allows the server to test the notification endpoint - that is provided by the client, e.g. during subscription. - This method shall follow the provisions specified in the Table 5.4.10.3.2-2 for URI query parameters, - request and response data structures, and response codes. - parameters: - - name: Accept + required: false + schema: + $ref: "definitions/SOL005NSDescriptorManagementNotification_def.yaml#/definitions/NsdOnBoardingNotification" + - name: NsdOnBoardingFailureNotification description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231. - in: header - required: true - type: string - responses: - 204: + A notification about the failure of on-boarding an NSD. + in: body + required: false + schema: + $ref: "definitions/SOL005NSDescriptorManagementNotification_def.yaml#/definitions/NsdOnBoardingFailureNotification" + - name: NsdChangeNotification description: > - 204 NO CONTENT - - The notification endpoint was tested successfully. - The response body shall be empty. - headers: - WWW-Authenticate: - type: string - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP request - has provided an invalid authorization token. - maximum: 1 - minimum: 0 - Version: - description: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../responses/SOL005_resp.yaml#/responses/400" - 401: - $ref: "../responses/SOL005_resp.yaml#/responses/401" - 403: - $ref: "../responses/SOL005_resp.yaml#/responses/403" - 404: - $ref: "../responses/SOL005_resp.yaml#/responses/404" - 405: - $ref: "../responses/SOL005_resp.yaml#/responses/405" - 406: - $ref: "../responses/SOL005_resp.yaml#/responses/406" - 500: - $ref: "../responses/SOL005_resp.yaml#/responses/500" - 503: - $ref: "../responses/SOL005_resp.yaml#/responses/503" - - '/URI_is_provided_by_the_client_when_creating_the_subscription-PnfdOnBoardingFailureNotification': - #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10 - parameters: - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235. - in: header - required: false - type: string - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string - - post: - summary: Notify about NSD and PNFD changes - description: > - This resource represents a notification endpoint. The server can use - this resource to send notifications to a subscribed - client, which has provided the URI of this resource during the subscription process. - - The POST method delivers a notification from the server to the client. - This method shall support the URI query parameters, request and - response data structures, and response codes, as - specified in the Table 5.4.10.3.1-2. - parameters: + A notification about the state change of an on-boarded NSD. + in: body + required: false + schema: + $ref: "definitions/SOL005NSDescriptorManagementNotification_def.yaml#/definitions/NsdChangeNotification" + - name: NsdDeletionNotification + description: > + A notification about the deletion of an on-boarded NSD. + in: body + required: false + schema: + $ref: "definitions/SOL005NSDescriptorManagementNotification_def.yaml#/definitions/NsdDeletionNotification" + - name: PnfdOnBoardingNotification + description: > + A notification about the successful on-boarding of a PNFD. + in: body + required: false + schema: + $ref: "definitions/SOL005NSDescriptorManagementNotification_def.yaml#/definitions/PnfdOnBoardingNotification" - name: PnfdOnBoardingFailureNotification description: > A notification about the failure of on-boarding a PNFD. in: body - required: true + required: false schema: $ref: "definitions/SOL005NSDescriptorManagementNotification_def.yaml#/definitions/PnfdOnBoardingFailureNotification" - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231. - in: header - required: true - type: string - - name: Content-Type - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231. - in: header - required: true - type: string - responses: - 204: - description: > - 204 NO CONTENT - - The notification was delivered successfully. - headers: - WWW-Authenticate: - type: string - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP request - has provided an invalid authorization token. - maximum: 1 - minimum: 0 - Version: - description: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../responses/SOL005_resp.yaml#/responses/400" - 401: - $ref: "../responses/SOL005_resp.yaml#/responses/401" - 403: - $ref: "../responses/SOL005_resp.yaml#/responses/403" - 404: - $ref: "../responses/SOL005_resp.yaml#/responses/404" - 405: - $ref: "../responses/SOL005_resp.yaml#/responses/405" - 406: - $ref: "../responses/SOL005_resp.yaml#/responses/406" - 500: - $ref: "../responses/SOL005_resp.yaml#/responses/500" - 503: - $ref: "../responses/SOL005_resp.yaml#/responses/503" - - get: - summary: Test the notification endpoint - description: > - This resource represents a notification endpoint. The server can use - this resource to send notifications to a subscribed - client, which has provided the URI of this resource during the subscription process. - - The GET method allows the server to test the notification endpoint - that is provided by the client, e.g. during subscription. - This method shall follow the provisions specified in the Table 5.4.10.3.2-2 for URI query parameters, - request and response data structures, and response codes. - parameters: - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231. - in: header - required: true - type: string - responses: - 204: - description: > - 204 NO CONTENT - - The notification endpoint was tested successfully. - The response body shall be empty. - headers: - WWW-Authenticate: - type: string - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP request - has provided an invalid authorization token. - maximum: 1 - minimum: 0 - Version: - description: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../responses/SOL005_resp.yaml#/responses/400" - 401: - $ref: "../responses/SOL005_resp.yaml#/responses/401" - 403: - $ref: "../responses/SOL005_resp.yaml#/responses/403" - 404: - $ref: "../responses/SOL005_resp.yaml#/responses/404" - 405: - $ref: "../responses/SOL005_resp.yaml#/responses/405" - 406: - $ref: "../responses/SOL005_resp.yaml#/responses/406" - 500: - $ref: "../responses/SOL005_resp.yaml#/responses/500" - 503: - $ref: "../responses/SOL005_resp.yaml#/responses/503" - - '/URI_is_provided_by_the_client_when_creating_the_subscription-PnfdDeletionNotification': - #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10 - parameters: - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235. - in: header - required: false - type: string - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string - - post: - summary: Notify about NSD and PNFD changes - description: > - This resource represents a notification endpoint. The server can use - this resource to send notifications to a subscribed - client, which has provided the URI of this resource during the subscription process. - - The POST method delivers a notification from the server to the client. - This method shall support the URI query parameters, request and - response data structures, and response codes, as - specified in the Table 5.4.10.3.1-2. - parameters: - name: PnfdDeletionNotification description: > A notification about the deletion of an on-boarded PNFD. in: body - required: true + required: false schema: $ref: "definitions/SOL005NSDescriptorManagementNotification_def.yaml#/definitions/PnfdDeletionNotification" - name: Accept @@ -960,7 +126,7 @@ paths: responses: 204: description: > - 204 No Content + 204 NO CONTENT The notification was delivered successfully. headers: @@ -1051,4 +217,4 @@ paths: 500: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: - $ref: "../responses/SOL005_resp.yaml#/responses/503" + $ref: "../responses/SOL005_resp.yaml#/responses/503" \ No newline at end of file diff --git a/src/SOL005/NSFaultManagement/NSFaultManagement.yaml b/src/SOL005/NSFaultManagement/NSFaultManagement.yaml index 9da8d3b..c835424 100644 --- a/src/SOL005/NSFaultManagement/NSFaultManagement.yaml +++ b/src/SOL005/NSFaultManagement/NSFaultManagement.yaml @@ -1,7 +1,7 @@ swagger: "2.0" info: - version: "1.1.0" + version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: "SOL005 - NS Fault Management Interface" description: > SOL005 - NS Fault Management Interface diff --git a/src/SOL005/NSFaultManagementNotification/NSFaultManagementNotification.yaml b/src/SOL005/NSFaultManagementNotification/NSFaultManagementNotification.yaml index a1c5495..a5732c7 100644 --- a/src/SOL005/NSFaultManagementNotification/NSFaultManagementNotification.yaml +++ b/src/SOL005/NSFaultManagementNotification/NSFaultManagementNotification.yaml @@ -1,7 +1,7 @@ swagger: "2.0" info: - version: "1.1.0" + version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: "SOL005 - NS Fault Management Notification interface" description: > SOL005 - NS Fault Management Notification interface diff --git a/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml b/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml index 22f637a..4bf0b06 100644 --- a/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml +++ b/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml @@ -1,6 +1,6 @@ swagger: "2.0" info: - version: "1.1.0" + version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: "SOL005 - NS Lifecycle Management Interface" description: > SOL005 - NS Lifecycle Management Interface diff --git a/src/SOL005/NSLifecycleManagementNotification/NSLifecycleManagementNotification.yaml b/src/SOL005/NSLifecycleManagementNotification/NSLifecycleManagementNotification.yaml index 036a27e..25f98f7 100644 --- a/src/SOL005/NSLifecycleManagementNotification/NSLifecycleManagementNotification.yaml +++ b/src/SOL005/NSLifecycleManagementNotification/NSLifecycleManagementNotification.yaml @@ -1,7 +1,7 @@ swagger: "2.0" info: - version: "1.1.0" + version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: "SOL005 - NS Lifecycle Management Notification interface" description: > SOL005 - NS Lifecycle Management Notification interface diff --git a/src/SOL005/NSPerformanceManagement/NSPerformanceManagement.yaml b/src/SOL005/NSPerformanceManagement/NSPerformanceManagement.yaml index c01b86b..9dbdae3 100644 --- a/src/SOL005/NSPerformanceManagement/NSPerformanceManagement.yaml +++ b/src/SOL005/NSPerformanceManagement/NSPerformanceManagement.yaml @@ -1,7 +1,7 @@ swagger: "2.0" info: - version: "1.1.0" + version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: "SOL005 - NS Performance Management Interface" description: > SOL005 - NS Performance Management Interface @@ -15,17 +15,23 @@ info: url: https://forge.etsi.org/etsi-forge-copyright-notice.txt contact: name: "NFV-SOL WG" + externalDocs: description: ETSI GS NFV-SOL 005 V2.5.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf + basePath: /nspm/v1 + schemes: - http - https + consumes: - application/json + produces: - application/json + paths: ############################################################################### # API Versions # @@ -771,7 +777,7 @@ paths: responses: 204: description: > - 204 No Content + 204 NO CONTENT The threshold was deleted successfully. The response body shall be empty. diff --git a/src/SOL005/NSPerformanceManagement/definitions/SOL005NSPerformanceManagement_def.yaml b/src/SOL005/NSPerformanceManagement/definitions/SOL005NSPerformanceManagement_def.yaml index cbf41d0..6035136 100644 --- a/src/SOL005/NSPerformanceManagement/definitions/SOL005NSPerformanceManagement_def.yaml +++ b/src/SOL005/NSPerformanceManagement/definitions/SOL005NSPerformanceManagement_def.yaml @@ -1,5 +1,6 @@ # Copyright (c) ETSI 2017. # https://forge.etsi.org/etsi-forge-copyright-notice.txt + definitions: PmSubscriptionRequest: description: > diff --git a/src/SOL005/NSPerformanceManagementNotification/NSPerformanceManagementNotification.yaml b/src/SOL005/NSPerformanceManagementNotification/NSPerformanceManagementNotification.yaml index 0cb0476..069d11e 100644 --- a/src/SOL005/NSPerformanceManagementNotification/NSPerformanceManagementNotification.yaml +++ b/src/SOL005/NSPerformanceManagementNotification/NSPerformanceManagementNotification.yaml @@ -1,7 +1,7 @@ swagger: "2.0" info: - version: "1.1.0" + version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: "SOL005 - NS Performance Management Notification interface" description: > SOL005 - NS Performance Management Notification interface @@ -25,8 +25,10 @@ schemes: consumes: - application/json + produces: - application/json + paths: ################################################################################## # Notification endpoint NS Performance Management # @@ -59,145 +61,14 @@ paths: description: > Notification about performance information availability. in: body - required: true + required: false schema: $ref: "definitions/SOL005NSPerformanceManagementNotification_def.yaml#/definitions/PerformanceInformationAvailableNotification" - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231 - in: header - required: true - type: string - - name: Content-Type - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 - in: header - required: true - type: string - responses: - 204: - description: > - 204 NO CONTENT - - The notification was delivered successfully. - headers: - WWW-Authenticate: - type: string - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP request - has provided an invalid authorization token. - maximum: 1 - minimum: 0 - Version: - description: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../responses/SOL005_resp.yaml#/responses/400" - 401: - $ref: "../responses/SOL005_resp.yaml#/responses/401" - 403: - $ref: "../responses/SOL005_resp.yaml#/responses/403" - 404: - $ref: "../responses/SOL005_resp.yaml#/responses/404" - 405: - $ref: "../responses/SOL005_resp.yaml#/responses/405" - 406: - $ref: "../responses/SOL005_resp.yaml#/responses/406" - 500: - $ref: "../responses/SOL005_resp.yaml#/responses/500" - 503: - $ref: "../responses/SOL005_resp.yaml#/responses/503" - - get: - summary: Test the notification endpoint - description: > - The GET method allows the server to test the notification endpoint that is provided by the client, e.g. during - subscription. - This method shall follow the provisions specified in the - Tables 7.4.9.3.2-1 and 7.4.9.3.2-2 for URI query parameters, - request and response data structures, and response codes. - parameters: - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231. - in: header - required: true - type: string - responses: - 204: - description: > - 204 No Content - - The notification endpoint was tested successfully. - The response body shall be empty. - headers: - WWW-Authenticate: - type: string - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP request - has provided an invalid authorization token. - maximum: 1 - minimum: 0 - Version: - description: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../responses/SOL005_resp.yaml#/responses/400" - 401: - $ref: "../responses/SOL005_resp.yaml#/responses/401" - 403: - $ref: "../responses/SOL005_resp.yaml#/responses/403" - 404: - $ref: "../responses/SOL005_resp.yaml#/responses/404" - 405: - $ref: "../responses/SOL005_resp.yaml#/responses/405" - 406: - $ref: "../responses/SOL005_resp.yaml#/responses/406" - 500: - $ref: "../responses/SOL005_resp.yaml#/responses/500" - 503: - $ref: "../responses/SOL005_resp.yaml#/responses/503" - - '/URI_is_provided_by_the_client_when_creating_the_subscription-ThresholdCrossedNotification': - parameters: - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235. - in: header - required: false - type: string - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string - - post: - summary: Notify about PM related events - description: > - The POST method delivers a notification regarding a performance management event from the server to the client. - This method shall follow the provisions specified in the - Tables 7.4.9.3.1-1 and 7.4.9.3.1-2 for URI query parameters, - - parameters: - name: ThresholdCrossedNotification description: > Notification about threshold crossing. in: body - required: true + required: false schema: $ref: "definitions/SOL005NSPerformanceManagementNotification_def.yaml#/definitions/ThresholdCrossedNotification" - name: Accept @@ -210,7 +81,7 @@ paths: - name: Content-Type description: > The MIME type of the body of the request. - Reference: IETF RFC 7231. + Reference: IETF RFC 7231 in: header required: true type: string @@ -271,7 +142,7 @@ paths: responses: 204: description: > - 204 No Content + 204 NO CONTENT The notification endpoint was tested successfully. The response body shall be empty. diff --git a/src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml b/src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml index 71c0da2..e4659a0 100644 --- a/src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml +++ b/src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml @@ -1,7 +1,7 @@ swagger: "2.0" info: - version: "1.1.0" + version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL005 - VNF Package Management Interface description: > SOL005 - VNF Package Management Interface diff --git a/src/SOL005/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml b/src/SOL005/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml index c53a7f4..898bc35 100644 --- a/src/SOL005/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml +++ b/src/SOL005/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml @@ -1,6 +1,6 @@ swagger: "2.0" info: - version: "1.1.0" + version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: "SOL005 - VNF Package Management Notification interface" description: > SOL005 - VNF Package Management Notification interface diff --git a/src/SOL005/responses/SOL005_resp.yaml b/src/SOL005/responses/SOL005_resp.yaml index 81871d3..bee1324 100644 --- a/src/SOL005/responses/SOL005_resp.yaml +++ b/src/SOL005/responses/SOL005_resp.yaml @@ -39,6 +39,7 @@ responses: minimum: 1 schema: $ref: "../NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance" + 202-with-Location-empty: description: > 202 ACCEPTED @@ -70,8 +71,6 @@ responses: minimum: 1 206: - description: > - 206 PARTIAL CONTENT headers: Content-Type: description: > @@ -103,8 +102,6 @@ responses: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 303: - description: > - 303 SEE OTHER headers: Content-Type: description: The MIME type of the body of the response. @@ -180,6 +177,7 @@ responses: 401: description: > 401 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 respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 @@ -210,6 +208,7 @@ responses: 403: description: > 403 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. It should include in the "detail" attribute information about the source of the problem, @@ -240,6 +239,7 @@ responses: 404: description: > 404 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 response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about @@ -275,6 +275,7 @@ responses: 405: description: > 405 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. headers: @@ -303,6 +304,7 @@ responses: 406: description: > 406 NOT ACCEPTABLE + If the "Accept" 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 "ProblemDetails" structure may be omitted. @@ -329,284 +331,7 @@ responses: schema: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" - 406-state-conflict: - description: > - 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 package has a value - different from "ONBOARDED". - The response body shall contain a ProblemDetails - structure, in which the "detail" attribute shall convey - more information about the error. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - schema: - $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" - 409: - description: > - 409 CONFLICT - - Error: The operation cannot be executed - currently, due to a conflict with the state of - the resource. - Typically, this is due to any of the following - scenarios: - - Disable a VNF package resource of - hich the operational state is not - ENABLED - - Enable a VNF package resource of - which the operational state is not - DISABLED - The response body shall contain a - ProblemDetails structure, in which the - "detail" attribute shall convey more - information about the error. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - schema: - $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" - - 409-another-nsd-operation-ongoing: - description: > - 409 CONFLICT - - The operation cannot be executed currently, due to a conflict with the - state of the NS instance resource. - Typically, this is due to the fact that another Descriptor operation is - ongoing. - The response body shall contain a ProblemDetails structure, in which the - "detail" attribute should convey more information about the error. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - schema: - $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" - 409-inconsistent-state: - description: > - 409 CONFLICT - - Another request is in progress that prohibits the fulfilment of - the current request, or the current resource state is inconsistent - with the request. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - schema: - $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" - 409-state-conflict-INSTANTIATED: - description: > - 409 CONFLICT - - The operation cannot be executed currently, due to a conflict with the - state of the NS instance resource. - Typically, this is due to the fact that the NS instance resource is in - INSTANTIATED state. - The response body shall contain a ProblemDetails structure, in which the - "detail" attribute should convey more information about the error. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - schema: - $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" - 409-state-conflict-not-FAILED_TEMP: - description: > - 409 CONFLICT - - The operation cannot be executed currently, due to a conflict with the - state of the NS instance resource. - Typically, this is due to the fact that the NS instance resource is - not in FAILED_TEMP state, or another error handling action is starting, - such as rollback or fail. - The response body shall contain a ProblemDetails structure, in which the - "detail" attribute should convey more information about the error. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - schema: - $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" - 409-state-conflict-NOT-INSTANTIATED: - description: > - 409 CONFLICT - - The operation cannot be executed currently, due to a conflict with the - state of the NS instance resource. - Typically, this is due to the fact that the NS instance resource is in - NOT-INSTANTIATED state, or that another lifecycle management operation - is ongoing. - The response body shall contain a ProblemDetails structure, in which the - "detail" attribute should convey more information about the error. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - schema: - $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" - 409-state-conflict-ONBOARDING: - description: > - 409 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 package has a value different from "ONBOARDED". - The response body shall contain a ProblemDetails - structure, in which the "detail" attribute shall convey - more information about the error. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - schema: - $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" - 409-state-conflict-ONBOARDING-NOT-CREATED: - description: > - 409 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 the on boarding - state of the VNF package resource is not CREATED . - The response body shall contain a ProblemDetails - structure, in which the "detail" attribute shall convey - more information about the error. headers: Content-Type: description: The MIME type of the body of the response. @@ -664,6 +389,7 @@ responses: 413: description: > 413 PAYLOAD TOO LARGE + If the payload body of a request is larger than the amount of data the API producer is willing or able to process, it shall respond with this response code, following the provisions in IETF RFC 7231 for the use of the "Retry-After" HTTP header and for closing the connection. The "ProblemDetails" structure may be omitted. @@ -693,6 +419,7 @@ responses: 414: description: > 414 URI TOO LONG + If the request URI of a request is longer than the API producer is willing or able to process, it shall respond with this response code. This condition can e.g. be caused by passing long queries in the request URI of a GET request. The "ProblemDetails" structure may be omitted. @@ -720,8 +447,6 @@ responses: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 416: - description: > - 416 RANGE NOT SATISFIABLE headers: Content-Type: description: The MIME type of the body of the response. @@ -748,6 +473,7 @@ responses: 422: description: > 422 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 producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" @@ -780,6 +506,7 @@ responses: 429: description: > 429 TOO MANY REQUESTS + If the API consumer has sent too many requests in a defined period of time and the API producer is able to detect that condition ("rate limiting"), the API producer shall respond with this response code, following the provisions in IETF RFC 6585 [17] for the use of the "Retry-After" HTTP header. @@ -814,6 +541,7 @@ responses: 500: description: > 500 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 with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information @@ -844,6 +572,7 @@ responses: 503: description: > 503 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 for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" @@ -874,6 +603,7 @@ responses: 504: description: > 504 GATEWAY TIMEOUT + If the API producer encounters a timeout while waiting for a response from an upstream server (i.e. a server that the API producer communicates with when fulfilling a request), it should respond with this response code. -- GitLab