From 14c66f2f07e285e5bf035a2c90cec9d2231a6618 Mon Sep 17 00:00:00 2001 From: moscatelli Date: Wed, 8 May 2019 11:28:19 +0200 Subject: [PATCH] SOL002: VNF Indicator notification interface data types consolidation --- .../VNFIndicatorNotification.yaml | 75 ++++++++++++------- ...> SOL002VNFIndicatorNotification_def.yaml} | 6 +- .../VNFIndicatorNotification_resp.yaml | 21 ------ .../SOL002SOL003VNFIndicator_def.yaml | 2 +- 4 files changed, 54 insertions(+), 50 deletions(-) rename src/SOL002/VNFIndicatorNotification/definitions/{VnfIndicatorValueChangeNotification_def.yaml => SOL002VNFIndicatorNotification_def.yaml} (96%) delete mode 100644 src/SOL002/VNFIndicatorNotification/responses/VNFIndicatorNotification_resp.yaml diff --git a/src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml b/src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml index 5ab829db..8ffd5faa 100644 --- a/src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml +++ b/src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml @@ -31,7 +31,10 @@ produces: - application/json paths: - /notificationendpoint: + ############################################################################### + # Notification endpoint # + ############################################################################### + '/URI-is-provided-by-the-client-when-creating-the-subscription': parameters: - name: Version description: > @@ -39,6 +42,13 @@ paths: in: header required: true type: string + - name: Authorization + description: > + The authorization token for the request. + Reference: IETF RFC 7235 + in: header + required: false + type: string post: summary: Notification endpoint description: > @@ -53,7 +63,7 @@ paths: A notification about VNF indicator value changes. required: true schema: - $ref: 'definitions/VnfIndicatorValueChangeNotification_def.yaml#/definitions/VnfIndicatorValueChangeNotification' + $ref: 'definitions/SOL002VNFIndicatorNotification_def.yaml#/definitions/VnfIndicatorValueChangeNotification' responses: 204: description: > @@ -66,18 +76,20 @@ paths: type: string maximum: 1 minimum: 1 - - 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } - 401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' } - 403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' } - 404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' } - 405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' } - 406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' } - 409: { $ref: 'responses/VNFIndicatorNotification_resp.yaml#/responses/409' } - 416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' } - 422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } - 500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } - 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } + 400: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + 401: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + 403: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + 405: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + 406: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + 500: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + 503: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" get: summary: Test notification endpoint. description: > @@ -88,23 +100,34 @@ paths: responses: 204: description: > - No Content + 204 NO CONTENT The notification endpoint was tested successfully. The response body shall be empty. headers: + 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: The used API version. type: string maximum: 1 minimum: 1 - 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } - 401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' } - 403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' } - 404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' } - 405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' } - 406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' } - 409: { $ref: 'responses/VNFIndicatorNotification_resp.yaml#/responses/409' } - 416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' } - 422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } - 500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } - 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } \ No newline at end of file + 400: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + 401: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + 403: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + 405: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + 406: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + 500: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + 503: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" \ No newline at end of file diff --git a/src/SOL002/VNFIndicatorNotification/definitions/VnfIndicatorValueChangeNotification_def.yaml b/src/SOL002/VNFIndicatorNotification/definitions/SOL002VNFIndicatorNotification_def.yaml similarity index 96% rename from src/SOL002/VNFIndicatorNotification/definitions/VnfIndicatorValueChangeNotification_def.yaml rename to src/SOL002/VNFIndicatorNotification/definitions/SOL002VNFIndicatorNotification_def.yaml index 517979e3..bc0d72b6 100644 --- a/src/SOL002/VNFIndicatorNotification/definitions/VnfIndicatorValueChangeNotification_def.yaml +++ b/src/SOL002/VNFIndicatorNotification/definitions/SOL002VNFIndicatorNotification_def.yaml @@ -1,5 +1,7 @@ -definitions: +# Copyright (c) ETSI 2017. +# https://forge.etsi.org/etsi-forge-copyright-notice.txt +definitions: VnfIndicatorValueChangeNotification: description: > This type represents a VNF indicator value change notification. @@ -65,4 +67,4 @@ definitions: subscription: description: > Link to the related subscription. - $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/Link' + $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/Link' \ No newline at end of file diff --git a/src/SOL002/VNFIndicatorNotification/responses/VNFIndicatorNotification_resp.yaml b/src/SOL002/VNFIndicatorNotification/responses/VNFIndicatorNotification_resp.yaml deleted file mode 100644 index 5f625c85..00000000 --- a/src/SOL002/VNFIndicatorNotification/responses/VNFIndicatorNotification_resp.yaml +++ /dev/null @@ -1,21 +0,0 @@ -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. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - schema: - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" diff --git a/src/definitions/SOL002SOL003VNFIndicator_def.yaml b/src/definitions/SOL002SOL003VNFIndicator_def.yaml index 7cf746de..fc9615ef 100644 --- a/src/definitions/SOL002SOL003VNFIndicator_def.yaml +++ b/src/definitions/SOL002SOL003VNFIndicator_def.yaml @@ -208,4 +208,4 @@ definitions: subscription: description: > Link to the related subscription. - $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink" + $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink" \ No newline at end of file -- GitLab