Loading src/SOL003/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml +146 −182 Original line number Diff line number Diff line swagger: "2.0" openapi: 3.0.2 info: version: "2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL003 - VNF Package Management Notification interface description: > description: | SOL003 - VNF Package 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. In case of discrepancies the published ETSI Group Specification takes precedence. Loading @@ -20,85 +18,44 @@ info: design. Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution= contact: name: NFV-SOL WG license: name: "ETSI Forge copyright notice" name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: description: ETSI GS NFV-SOL 003 V2.7.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.07.01_60/gs_NFV-SOL003v020701p.pdf basePath: "/callback/v2" schemes: - https 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 consumes: - "application/json" produces: - "application/json" servers: - url: http://127.0.0.1/callback/v2 - url: https://127.0.0.1/callback/v2 paths: ############################################################################### # Notification endpoint VnfPackageOnboardingNotification # ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageOnboardingNotification': /URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageOnboardingNotification: #SOL003 location: 10.4.9 parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version 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. This method shall follow the provisions specified in the tables 10.4.9.3.1-1 and 10.4.9.3.1-2 for URI query parameters, request and response data structures, and response codes. parameters: - name: VnfPackageOnboardingNotification description: A notification about on-boarding of a VNF package. in: body required: true schema: $ref: "definitions/VNFPackageManagementNotification_def.yaml#/definitions/VnfPackageOnboardingNotification" - 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/VnfPackageOnboardingNotification' responses: 204: description: > 204 NO CONTENT 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 $ref: '#/components/responses/VnfPackageOnboardingNotification.Post.204' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: Loading @@ -115,47 +72,14 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" get: description: > description: | The GET method allows the API producer to test the notification endpoint that is provided by the API consumer e.g. during subscription. This method shall follow the provisions specified in the tables 10.4.9.3.2-1 and 10.4.9.3.2-2 for URI query parameters, request and response data structures, and response codes. 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 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 $ref: '#/components/responses/VnfPackageOnboardingNotification.Get.204' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: Loading @@ -174,64 +98,25 @@ paths: ############################################################################### # Notification endpoint VnfPackageChangeNotification # ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageChangeNotification': /URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageChangeNotification: #SOL003 location: 10.4.9 parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version 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. This method shall follow the provisions specified in the tables 10.4.9.3.1-1 and 10.4.9.3.1-2 for URI query parameters, request and response data structures, and response codes. parameters: - name: VnfPackageChangeNotification description: > A notification about changes of status in a VNF package. in: body required: true schema: $ref: "definitions/VNFPackageManagementNotification_def.yaml#/definitions/VnfPackageChangeNotification" - 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/VnfPackageChangeNotification' responses: 204: description: > 204 NO CONTENT 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 $ref: '#/components/responses/VnfPackageChangeNotification.Post.204' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: Loading @@ -248,47 +133,14 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" get: description: > description: | The GET method allows the API producer to test the notification endpoint that is provided by the API consumer e.g. during subscription. This method shall follow the provisions specified in the tables 10.4.9.3.2-1 and 10.4.9.3.2-2 for URI query parameters, request and response data structures, and response codes. 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 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 $ref: '#/components/responses/VnfPackageChangeNotification.Get.204' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: Loading @@ -303,3 +155,115 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" components: requestBodies: VnfPackageOnboardingNotification: description: A notification about on-boarding of a VNF package. content: application/json: schema: $ref: "definitions/VNFPackageManagementNotification_def.yaml#/definitions/VnfPackageOnboardingNotification" required: true VnfPackageChangeNotification: description: | A notification about changes of status in a VNF package.= content: application/json: schema: $ref: "definitions/VNFPackageManagementNotification_def.yaml#/definitions/VnfPackageChangeNotification" required: true responses: VnfPackageOnboardingNotification.Post.204: description: | 204 NO CONTENT 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. style: simple explode: false schema: type: string Version: description: | Version of the API used in the response. style: simple explode: false schema: type: string VnfPackageOnboardingNotification.Get.204: description: | 204 NO CONTENT 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. style: simple explode: false schema: type: string Version: description: | Version of the API used in the response. style: simple explode: false schema: type: string VnfPackageChangeNotification.Post.204: description: | 204 NO CONTENT 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. style: simple explode: false schema: type: string Version: description: | Version of the API used in the response. style: simple explode: false schema: type: string VnfPackageChangeNotification.Get.204: description: | 204 NO CONTENT 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. style: simple explode: false schema: type: string Version: description: | Version of the API used in the response. style: simple explode: false schema: type: string Loading
src/SOL003/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml +146 −182 Original line number Diff line number Diff line swagger: "2.0" openapi: 3.0.2 info: version: "2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL003 - VNF Package Management Notification interface description: > description: | SOL003 - VNF Package 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. In case of discrepancies the published ETSI Group Specification takes precedence. Loading @@ -20,85 +18,44 @@ info: design. Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution= contact: name: NFV-SOL WG license: name: "ETSI Forge copyright notice" name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: description: ETSI GS NFV-SOL 003 V2.7.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.07.01_60/gs_NFV-SOL003v020701p.pdf basePath: "/callback/v2" schemes: - https 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 consumes: - "application/json" produces: - "application/json" servers: - url: http://127.0.0.1/callback/v2 - url: https://127.0.0.1/callback/v2 paths: ############################################################################### # Notification endpoint VnfPackageOnboardingNotification # ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageOnboardingNotification': /URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageOnboardingNotification: #SOL003 location: 10.4.9 parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version 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. This method shall follow the provisions specified in the tables 10.4.9.3.1-1 and 10.4.9.3.1-2 for URI query parameters, request and response data structures, and response codes. parameters: - name: VnfPackageOnboardingNotification description: A notification about on-boarding of a VNF package. in: body required: true schema: $ref: "definitions/VNFPackageManagementNotification_def.yaml#/definitions/VnfPackageOnboardingNotification" - 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/VnfPackageOnboardingNotification' responses: 204: description: > 204 NO CONTENT 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 $ref: '#/components/responses/VnfPackageOnboardingNotification.Post.204' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: Loading @@ -115,47 +72,14 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" get: description: > description: | The GET method allows the API producer to test the notification endpoint that is provided by the API consumer e.g. during subscription. This method shall follow the provisions specified in the tables 10.4.9.3.2-1 and 10.4.9.3.2-2 for URI query parameters, request and response data structures, and response codes. 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 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 $ref: '#/components/responses/VnfPackageOnboardingNotification.Get.204' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: Loading @@ -174,64 +98,25 @@ paths: ############################################################################### # Notification endpoint VnfPackageChangeNotification # ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageChangeNotification': /URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageChangeNotification: #SOL003 location: 10.4.9 parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version 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. This method shall follow the provisions specified in the tables 10.4.9.3.1-1 and 10.4.9.3.1-2 for URI query parameters, request and response data structures, and response codes. parameters: - name: VnfPackageChangeNotification description: > A notification about changes of status in a VNF package. in: body required: true schema: $ref: "definitions/VNFPackageManagementNotification_def.yaml#/definitions/VnfPackageChangeNotification" - 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/VnfPackageChangeNotification' responses: 204: description: > 204 NO CONTENT 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 $ref: '#/components/responses/VnfPackageChangeNotification.Post.204' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: Loading @@ -248,47 +133,14 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" get: description: > description: | The GET method allows the API producer to test the notification endpoint that is provided by the API consumer e.g. during subscription. This method shall follow the provisions specified in the tables 10.4.9.3.2-1 and 10.4.9.3.2-2 for URI query parameters, request and response data structures, and response codes. 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 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 $ref: '#/components/responses/VnfPackageChangeNotification.Get.204' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: Loading @@ -303,3 +155,115 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" components: requestBodies: VnfPackageOnboardingNotification: description: A notification about on-boarding of a VNF package. content: application/json: schema: $ref: "definitions/VNFPackageManagementNotification_def.yaml#/definitions/VnfPackageOnboardingNotification" required: true VnfPackageChangeNotification: description: | A notification about changes of status in a VNF package.= content: application/json: schema: $ref: "definitions/VNFPackageManagementNotification_def.yaml#/definitions/VnfPackageChangeNotification" required: true responses: VnfPackageOnboardingNotification.Post.204: description: | 204 NO CONTENT 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. style: simple explode: false schema: type: string Version: description: | Version of the API used in the response. style: simple explode: false schema: type: string VnfPackageOnboardingNotification.Get.204: description: | 204 NO CONTENT 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. style: simple explode: false schema: type: string Version: description: | Version of the API used in the response. style: simple explode: false schema: type: string VnfPackageChangeNotification.Post.204: description: | 204 NO CONTENT 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. style: simple explode: false schema: type: string Version: description: | Version of the API used in the response. style: simple explode: false schema: type: string VnfPackageChangeNotification.Get.204: description: | 204 NO CONTENT 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. style: simple explode: false schema: type: string Version: description: | Version of the API used in the response. style: simple explode: false schema: type: string
