diff --git a/src/SOL002/APIVersion/APIVersion.yaml b/src/SOL002/APIVersion/APIVersion.yaml index 00b5982fa898c23f9f1df77ce4cdd69fb0ab0ca4..a63037b852416352a16df097548dfd75372b196a 100644 --- a/src/SOL002/APIVersion/APIVersion.yaml +++ b/src/SOL002/APIVersion/APIVersion.yaml @@ -20,12 +20,12 @@ externalDocs: paths: /vnfconfig/api_versions: - $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' + $ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions /vnffm/api_versions: - $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' + $ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions /vnfind/api_versions: - $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' + $ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions /vnflcm/api_versions: - $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' + $ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions /vnfpm/api_versions: - $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' \ No newline at end of file + $ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions \ No newline at end of file diff --git a/src/SOL002/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml b/src/SOL002/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml index 9b067109c603b62c820a6a4e2c56870af5d6a88c..3cc4a16ba538bfc5d19d5e25887f35acf96eedfb 100644 --- a/src/SOL002/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml +++ b/src/SOL002/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml @@ -1,389 +1,258 @@ -swagger: "2.0" +openapi: 3.0.2 info: - version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL002 - VNF Fault Management Notification interface - description: > - SOL002 - VNF Fault Management Notification interface - IMPORTANT: Please note that this file might be not aligned to the current - version of the ETSI Group Specification it refers to and has not been - approved by the ETSI NFV ISG. In case of discrepancies the published ETSI - Group Specification takes precedence. - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis + description: | + SOL002 - VNF Fault Management Notification interface IMPORTANT: Please note that this file might be not aligned to + the current version of the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG. + In case of discrepancies the published ETSI Group Specification takes precedence. Please report bugs to + https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis + contact: + name: NFV-SOL WG license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - contact: - name: NFV-SOL WG + version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 002 V2.7.1 + description: ETSI GS NFV-SOL 002 V3.3.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf -basePath: /callback/v1 - -schemes: - - http - - https - -consumes: - - application/json - -produces: - - application/json +servers: + - url: http://127.0.0.1/callback/v1 + - url: https://127.0.0.1/callback/v1 paths: - ############################################################################### - # Notification endpoint AlarmNotification # - ############################################################################### - '/URI-is-provided-by-the-client-when-creating-the-subscription_AlarmNotification': + /URI-is-provided-by-the-client-when-creating-the-subscription_AlarmNotification: parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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: - description: > - Notify - - The POST method notifies a VNF alarm or that the alarm list has been - rebuilt. The API consumer shall have previously created an "Individual - subscription" resource with a matching filter. - parameters: - - name: AlarmNotification - description: > - Information of a VNF alarm. - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmNotification" - - name: Content-Type - description: > - The Content-Type header shall be set to - "application/merge-patch+json" according to - IETF RFC 7396. - in: header - required: true - type: string - responses: - 204: - description: > - 204 NO CONTENT - - Shall be returned when the notification has been delivered 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: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: - description: > - The GET method allows the server to test the notification endpoint - that is provided by the client, e.g. during subscription. + description: | + The GET method allows the server to test the notification endpoint that is provided by the client, + e.g. during subscription. responses: - 204: - description: > - 201 NO CONTENT + "204": + $ref: '#/components/responses/VNFFMNotification.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 - Shall be returned to indicate the notification endpoint has been - 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: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" - ############################################################################### - # Notification endpoint AlarmClearedNotification # - ############################################################################### - '/URI-is-provided-by-the-client-when-creating-the-subscription_AlarmClearedNotification': - parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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: - description: > + description: | Notify - - The POST method notifies a VNF alarm or that the alarm list has been - rebuilt. The API consumer shall have previously created an "Individual - subscription" resource with a matching filter. + The POST method notifies a VNF alarm or that the alarm list has been rebuilt. The API consumer shall have + previously created an "Individual subscription" resource with a matching filter. parameters: - - name: AlarmClearedNotification - description: > - Information of the clearance of a VNF alarm - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmClearedNotification" - - name: Content-Type - description: > - The Content-Type header shall be set to - "application/merge-patch+json" according to - IETF RFC 7396. - in: header - required: true - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/AlarmNotification' responses: - 204: - description: > - 204 NO CONTENT + "204": + $ref: '#/components/responses/VNFFMNotification.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 - Shall be returned when the notification has been delivered 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: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" - get: - description: > - The GET method allows the server to test the notification endpoint - that is provided by the client, e.g. during subscription. - responses: - 204: - description: > - 201 NO CONTENT + /URI-is-provided-by-the-client-when-creating-the-subscription_AlarmClearedNotification: + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + get: + description: | + The GET method allows the server to test the notification endpoint that is provided by the client, + e.g. during subscription. + responses: + "204": + $ref: '#/components/responses/VNFFMNotification.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + + post: + description: | + Notify + The POST method notifies a VNF alarm or that the alarm list has been rebuilt. The API consumer shall have + previously created an "Individual subscription" resource with a matching filter. + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/AlarmClearedNotification' + responses: + "204": + $ref: '#/components/responses/VNFFMNotification.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 - Shall be returned to indicate the notification endpoint has been - 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: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" - ############################################################################### - # Notification endpoint AlarmListRebuiltNotification # - ############################################################################### - '/URI-is-provided-by-the-client-when-creating-the-subscription_AlarmListRebuiltNotification': + /URI-is-provided-by-the-client-when-creating-the-subscription_AlarmListRebuiltNotification: parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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: - description: > - Notify + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + get: + description: | + The GET method allows the server to test the notification endpoint that is provided by the client, + e.g. during subscription. + responses: + "204": + $ref: '#/components/responses/VNFFMNotification.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 - The POST method notifies a VNF alarm or that the alarm list has been - rebuilt. The API consumer shall have previously created an "Individual - subscription" resource with a matching filter. - parameters: - - name: AlarmListRebuiltNotification - description: > - Information that the alarm list has been rebuilt by the VNFM - in: body - required: true + post: + description: | + Notify + The POST method notifies a VNF alarm or that the alarm list has been rebuilt. The API consumer shall have + previously created an "Individual subscription" resource with a matching filter. + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/AlarmListRebuiltNotification' + responses: + "204": + $ref: '#/components/responses/VNFFMNotification.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + +components: + requestBodies: + AlarmNotification: + description: | + Information of a VNF alarm. + content: + application/json: schema: - $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmListRebuiltNotification" - - name: Content-Type - description: > - The Content-Type header shall be set to - "application/merge-patch+json" according to - IETF RFC 7396. - in: header - required: true - type: string - responses: - 204: - description: > - 204 NO CONTENT + $ref: ../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmNotification + required: true - Shall be returned when the notification has been delivered 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: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" - get: - description: > - The GET method allows the server to test the notification endpoint - that is provided by the client, e.g. during subscription. - responses: - 204: - description: > - 204 NO CONTENT + AlarmClearedNotification: + description: | + Information of the clearance of a VNF alarm. + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmClearedNotification + required: true - Shall be returned to indicate the notification endpoint has been - 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: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" \ No newline at end of file + AlarmListRebuiltNotification: + description: | + Information that the alarm list has been rebuilt by the VNFM. + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmListRebuiltNotification + required: true + + responses: + VNFFMNotification.Get: + description: | + 201 NO CONTENT + Shall be returned to indicate the notification endpoint has been tested successfully. The response body + shall be empty. + headers: + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + content: {} + + VNFFMNotification.Post: + description: | + 204 NO CONTENT + Shall be returned when the notification has been delivered successfully. The response body shall be empty. + headers: + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + content: {} \ No newline at end of file diff --git a/src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml b/src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml index 43ee4aa3f2fb1553316553df83ff680977d61339..ac54093129a2a2e1021fa0fa7f7e8a1d1ce6a848 100644 --- a/src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml +++ b/src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml @@ -1,137 +1,138 @@ -swagger: "2.0" +openapi: 3.0.2 info: - version: "1.2.1-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL002 - VNF Indicator Notification Endpoint interface - description: > - SOL002 - VNF Indicator Notification Endpoint interface - IMPORTANT: Please note that this file might be not aligned to the current - version of the ETSI Group Specification it refers to and has not been - approved by the ETSI NFV ISG. In case of discrepancies the published ETSI - Group Specification takes precedence. - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis + description: | + SOL002 - VNF Indicator Notification Endpoint interface IMPORTANT: Please note that this file might be not aligned to + the current version of the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG. + In case of discrepancies the published ETSI Group Specification takes precedence. Please report bugs to + https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis + contact: + name: NFV-SOL WG license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - contact: - name: NFV-SOL WG + version: 1.2.1-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 002 V2.7.1 + description: ETSI GS NFV-SOL 002 V3.3.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf -schemes: - - http - - https - -consumes: - - application/json - -produces: - - application/json +servers: + - url: http://127.0.0.1/callback/v1 + - url: https://127.0.0.1/callback/v1 paths: - ############################################################################### - # Notification endpoint VnfIndicatorValueChangeNotification # - ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription_VnfIndicatorValueChangeNotification': parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + 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": + $ref: '#/components/responses/VNFInNotification.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + post: summary: Notification endpoint - description: > - The API producer can use this resource to send notifications related to VNF indicator - value changes to a subscribed API consumer, which has provided the URI of this resource - during the subscription process. - The POST method delivers a notification from API producer to an API consumer. The API - consumer shall have previously created an "Individual subscription" resource with a - matching filter. + description: | + The API producer can use this resource to send notifications related to VNF indicator value changes to a + subscribed API consumer, which has provided the URI of this resource during the subscription process. + The POST method delivers a notification from API producer to an API consumer. The API consumer shall have + previously created an "Individual subscription" resource with a matching filter. parameters: - - name: vnfIndicatorValueChangeNotification - in: body - description: > - A notification about VNF indicator value changes. - required: true - schema: - $ref: 'definitions/SOL002VNFIndicatorNotification_def.yaml#/definitions/VnfIndicatorValueChangeNotification' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/VnfIndicatorValueChangeNotification' responses: - 204: - description: > - 204 NO CONTENT + "204": + $ref: '#/components/responses/VNFInNotification.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 - Shall be returned when the notification has been delivered successfully. - The response body shall be empty. - headers: - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" - get: - summary: Test notification endpoint. - description: > - Service Unavailable +components: + requestBodies: + VnfIndicatorValueChangeNotification: + description: | + A notification about VNF indicator value changes. + content: + application/json: + schema: + $ref: ./definitions/SOL002VNFIndicatorNotification_def.yaml#/definitions/VnfIndicatorValueChangeNotification + required: true - The GET method allows the server to test the notification endpoint that is provided - by the client, e.g. during subscription. - responses: - 204: - description: > - 204 NO CONTENT + responses: + VNFInNotification.Get: + description: | + 201 NO CONTENT + Shall be returned to indicate the notification endpoint has been tested successfully. The response body + shall be empty. + headers: + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + content: {} - Shall be returned when the notification endpoint has been 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#/components/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" \ No newline at end of file + VNFInNotification.Post: + description: | + 204 NO CONTENT + Shall be returned when the notification has been delivered successfully. The response body shall be empty. + headers: + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + content: {} \ No newline at end of file diff --git a/src/SOL002/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml b/src/SOL002/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml index 35645cd1fd0d74866aae52e461ca6364017742c8..331f321142380c134ecc70109ab34bb9b2177de6 100644 --- a/src/SOL002/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml +++ b/src/SOL002/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml @@ -1,447 +1,259 @@ -swagger: "2.0" +openapi: 3.0.2 info: - version: "1.4.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL002 - VNF Lifecycle Management Notification interface - description: > + description: | SOL002 - VNF Lifecycle Management Notification interface - IMPORTANT: Please note that this file might be not aligned to the current - version of the ETSI Group Specification it refers to and has not been - approved by the ETSI NFV ISG. In case of discrepancies the published ETSI - Group Specification takes precedence. + IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification + it refers to and has not been approved by the ETSI NFV ISG. In case of discrepancies the published ETSI Group + Specification takes precedence. Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis + contact: + name: NFV-SOL WG license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - contact: - name: NFV-SOL WG + version: 1.4.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 002 V2.7.1 + description: ETSI GS NFV-SOL 002 V3.3.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf -basePath: /callback/v1 - -schemes: - - http - - https - -consumes: - - application/json - -produces: - - application/json +servers: + - url: http://127.0.0.1/callback/v1 + - url: https://127.0.0.1/callback/v1 paths: - ############################################################################### - # Notification endpoint VnfLcmOperationOccurrenceNotification # - ############################################################################### - '/URI-is-provided-by-the-client-when-creating-the-subscription_VnfLcmOperationOccurrenceNotification': + /URI-is-provided-by-the-client-when-creating-the-subscription_VnfLcmOperationOccurrenceNotification: parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + get: + description: | + The GET method allows the server to test the notification endpoint that is provided by the API consumer, + e.g. during subscription. + responses: + "204": + $ref: '#/components/responses/VNFLCMNotification.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + post: - description: > + description: | Notify - The POST method delivers a notification from the API producer to an API consumer. The API consumer shall have previously created an "Individual subscription" resource with a matching filter. parameters: - - name: VnfLcmOperationOccurrenceNotification - description: A notification about lifecycle changes triggered by a VNF LCM operation occurrence. - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOperationOccurrenceNotification" - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/VnfLcmOperationOccurrenceNotification' responses: - 204: - description: > - 204 NO CONTENT - - The notification has been delivered successfully. - 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: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" + "204": + $ref: '#/components/responses/VNFLCMNotification.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + /URI-is-provided-by-the-client-when-creating-the-subscription_VnfIdentifierCreationNotification: + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: - description: > - The GET method allows the server to test the notification endpoint - that is provided by the API consumer, e.g. during subscription. - 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 + description: | + The GET method allows the server to test the notification endpoint that is provided by the API consumer, + e.g. during subscription. responses: - 204: - description: > - 204 NO CONTENT + "204": + $ref: '#/components/responses/VNFLCMNotification.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 - The notification endpoint has been tested successfully. - 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: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" - ############################################################################### - # Notification endpoint VnfIdentifierCreationNotification # - ############################################################################### - '/URI-is-provided-by-the-client-when-creating-the-subscription_VnfIdentifierCreationNotification': - parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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: - description: > + description: | Notify - The POST method delivers a notification from the API producer to an API consumer. The API consumer shall have previously created an "Individual subscription" resource with a matching filter. parameters: - - name: VnfIdentifierCreationNotification - description: > - A notification about the creation of a VNF identifier and the - related "Individual VNF instance" resource. - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfIdentifierCreationNotification" - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/VnfIdentifierCreationNotification' responses: - 204: - description: > - 204 NO CONTENT - - The notification has been delivered successfully. - 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: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" + "204": + $ref: '#/components/responses/VNFLCMNotification.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + /URI-is-provided-by-the-client-when-creating-the-subscription_VnfIdentifierDeletionNotification: + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: - description: > - The GET method allows the server to test the notification endpoint - that is provided by the API consumer, e.g. during subscription. - 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 + description: | + The GET method allows the server to test the notification endpoint that is provided by the API consumer, + e.g. during subscription. responses: - 204: - description: > - 204 NO CONTENT + "204": + $ref: '#/components/responses/VNFLCMNotification.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 - The notification endpoint has been tested successfully. - 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: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" - ############################################################################### - # Notification endpoint VnfIdentifierDeletionNotification # - ############################################################################### - '/URI-is-provided-by-the-client-when-creating-the-subscription_VnfIdentifierDeletionNotification': - parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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: - description: > + description: | Notify - The POST method delivers a notification from the API producer to an API consumer. The API consumer shall have previously created an "Individual subscription" resource with a matching filter. parameters: - - name: VnfIdentifierDeletionNotification - description: > - A notification about the deletion of a VNF identifier and the - related "Individual VNF instance" resource. - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfIdentifierDeletionNotification" - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/VnfIdentifierDeletionNotification' responses: - 204: - description: > - 204 NO CONTENT + "204": + $ref: '#/components/responses/VNFLCMNotification.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 - The notification has been delivered successfully. - 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: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" +components: + requestBodies: + VnfLcmOperationOccurrenceNotification: + description: | + A notification about lifecycle changes triggered by a VNF LCM operation occurrence. + content: + application/json: + schema: + $ref: ./definitions/SOL002VNFLifecycleManagementNotification_def.yaml#/definitions/VnfLcmOperationOccurrenceNotification + required: true - get: - description: > - The GET method allows the server to test the notification endpoint - that is provided by the API consumer, e.g. during subscription. - 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 - responses: - 204: - description: > - No Content + VnfIdentifierCreationNotification: + description: | + A notification about lifecycle changes triggered by a VNF LCM operation occurrence. + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfIdentifierCreationNotification + required: true - The notification endpoint has been tested successfully. - 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: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" \ No newline at end of file + VnfIdentifierDeletionNotification: + description: | + A notification about the deletion of a VNF identifier and the related "Individual VNF instance" resource. + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfIdentifierDeletionNotification + required: true + + responses: + VNFLCMNotification.Get: + description: | + 201 NO CONTENT + Shall be returned to indicate the notification endpoint has been tested successfully. The response body + shall be empty. + headers: + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + content: {} + + VNFLCMNotification.Post: + description: | + 204 NO CONTENT + Shall be returned when the notification has been delivered successfully. The response body shall be empty. + headers: + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + content: {} \ No newline at end of file diff --git a/src/SOL002/VNFLifecycleManagementNotification/definitions/VNFLifecycleManagementNotification_def.yaml b/src/SOL002/VNFLifecycleManagementNotification/definitions/SOL002VNFLifecycleManagementNotification_def.yaml similarity index 99% rename from src/SOL002/VNFLifecycleManagementNotification/definitions/VNFLifecycleManagementNotification_def.yaml rename to src/SOL002/VNFLifecycleManagementNotification/definitions/SOL002VNFLifecycleManagementNotification_def.yaml index c425ca3b74a9e258355661e31397952c69c931d8..34df7c9db3c32f40e1d784006016ee335972ccf8 100644 --- a/src/SOL002/VNFLifecycleManagementNotification/definitions/VNFLifecycleManagementNotification_def.yaml +++ b/src/SOL002/VNFLifecycleManagementNotification/definitions/SOL002VNFLifecycleManagementNotification_def.yaml @@ -176,4 +176,4 @@ definitions: _links: description: > Links to resources related to this notification. - $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnLinks" + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnLinks" \ No newline at end of file diff --git a/src/SOL002/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml b/src/SOL002/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml index 6996ac0e70ab07fc428f784e31f2c7f1f0f7505c..9937499d5f245c559dc413d356d2b3a5683210fd 100644 --- a/src/SOL002/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml +++ b/src/SOL002/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml @@ -1,295 +1,198 @@ -swagger: "2.0" +openapi: 3.0.2 info: - version: "2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL002 - VNF Performance Management Notification interface - description: > + description: | SOL002 - VNF Performance Management Notification interface - IMPORTANT: Please note that this file might be not aligned to the current - version of the ETSI Group Specification it refers to and has not been - approved by the ETSI NFV ISG. In case of discrepancies the published ETSI - Group Specification takes precedence. - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis + IMPORTANT: Please note that this file might be not + aligned to the current version of the ETSI Group Specification it refers to and has not been approved by the + ETSI NFV ISG. In case of discrepancies the published ETSI Group Specification takes precedence. Please report + bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis + contact: + name: NFV-SOL WG license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - contact: - name: NFV-SOL WG + version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 002 V2.7.1 + description: ETSI GS NFV-SOL 002 V3.3.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf -basePath: /callback/v1 - -schemes: - - http - - https - -consumes: - - application/json - -produces: - - application/json +servers: + - url: http://127.0.0.1/callback/v1 + - url: https://127.0.0.1/callback/v1 paths: - ############################################################################### - # Notification endpoint PerformanceInformationAvailableNotification # - ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription_PerformanceInformationAvailableNotification': + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + get: + description: | + The GET method allows the server to test the notification endpoint that is provided by the client, + e.g. during subscription. + responses: + "204": + $ref: '#/components/responses/VNFPMNotification.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + post: - description: > + description: | Notify - - The POST method delivers a notification regarding a performance - management event from API producer to an API consumer. The API consumer - shall have previously created an "Individual subscription" resource with - a matching filter. + The POST method delivers a notification regarding a performance management event from API producer to an API + consumer. The API consumer shall have previously created an "Individual subscription" resource with a matching filter. parameters: - - name: PerformanceInformationAvailableNotification - description: > - Notification about performance information availability. - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PerformanceInformationAvailableNotification" - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - 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 - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/PerformanceInformationAvailableNotification' responses: - 204: - description: > - No Content + "204": + $ref: '#/components/responses/VNFPMNotification.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 - Shall be returned when the notification has been delivered successfully. - 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: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" + /URI-is-provided-by-the-client-when-creating-the-subscription_ThresholdCrossedNotification: + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: - description: > - The GET method allows the server to test the notification endpoint - that is provided by the client, e.g. during subscription. - 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 + description: | + 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 + "204": + $ref: '#/components/responses/VNFPMNotification.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 - Shall be returned to indicate that the notification endpoint has been - 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: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" - ############################################################################### - # Notification endpoint ThresholdCrossedNotification # - ############################################################################### - '/URI-is-provided-by-the-client-when-creating-the-subscription_ThresholdCrossedNotification': post: - description: > + description: | Notify - - The POST method delivers a notification regarding a performance - management event from API producer to an API consumer. The API consumer - shall have previously created an "Individual subscription" resource with - a matching filter. + The POST method delivers a notification regarding a performance management event from API producer to an API + consumer. The API consumer shall have previously created an "Individual subscription" resource with a matching + filter. parameters: - - name: ThresholdCrossedNotification - description: > - Notification about performance information availability. - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/ThresholdCrossedNotification" - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - 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 - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/ThresholdCrossedNotification' responses: - 204: - description: > - 204 NO CONTENT + "204": + $ref: '#/components/responses/VNFPMNotification.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 - Shall be returned when the notification has been delivered successfully. - 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: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" - get: - description: > - The GET method allows the server to test the notification endpoint - that is provided by the client, e.g. during subscription. - 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 - responses: - 204: - description: > - 204 NO CONTENT +components: + requestBodies: + PerformanceInformationAvailableNotification: + description: | + Notification about performance information availability. + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PerformanceInformationAvailableNotification + required: true - Shall be returned to indicate that the notification endpoint has been - 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: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" \ No newline at end of file + ThresholdCrossedNotification: + description: | + Notification about crossed threshold. + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/ThresholdCrossedNotification + required: true + + responses: + VNFPMNotification.Get: + description: | + 201 NO CONTENT + Shall be returned to indicate the notification endpoint has been tested successfully. The response body + shall be empty. + headers: + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + content: {} + + VNFPMNotification.Post: + description: | + 204 NO CONTENT + Shall be returned when the notification has been delivered successfully. The response body shall be empty. + headers: + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + content: {} \ No newline at end of file