openapi: 3.0.2 info: title: SOL005 - VNF Package Management Notification interface description: | SOL005 - 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. Please report bugs to https://forge.etsi.org/rep/nfv/SOL005/issues license: 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 005 V3.3.1 url: https://docbox.etsi.org/ISG/NFV/Open/Drafts/SOL005ed331_Os-Ma-nfvo_APIs_-_spec/NFV-SOL005ed331v304.zip servers: - url: http://127.0.0.1/callback/v1 - url: https://127.0.0.1/callback/v1 paths: '/URI_is_provided_by_the_client_when_creating_the_subscription-VnfPackageOnboardingNotification': parameters: - $ref: ../components/SOL005_params.yaml#/components/parameters/Version - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization get: summary: Notify about VNF package onboarding or change description: | 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: - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept responses: "204": $ref: '#/components/responses/VnfPackageOnboardingNotification.Get' "400": $ref: ../responses/SOL005_resp.yaml#/components/responses/400 "401": $ref: ../responses/SOL005_resp.yaml#/components/responses/401 "403": $ref: ../responses/SOL005_resp.yaml#/components/responses/403 "405": $ref: ../responses/SOL005_resp.yaml#/components/responses/405 "406": $ref: ../responses/SOL005_resp.yaml#/components/responses/406 "500": $ref: ../responses/SOL005_resp.yaml#/components/responses/500 "503": $ref: ../responses/SOL005_resp.yaml#/components/responses/503 post: summary: Notify about VNF package onboarding or change description: | 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: - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType requestBody: $ref: '#/components/requestBodies/VnfPackageOnboardingNotificationRequest' responses: "204": $ref: '#/components/responses/VnfPackageOnboardingNotification.Post' "400": $ref: ../responses/SOL005_resp.yaml#/components/responses/400 "401": $ref: ../responses/SOL005_resp.yaml#/components/responses/401 "403": $ref: ../responses/SOL005_resp.yaml#/components/responses/403 "405": $ref: ../responses/SOL005_resp.yaml#/components/responses/405 "406": $ref: ../responses/SOL005_resp.yaml#/components/responses/406 "500": $ref: ../responses/SOL005_resp.yaml#/components/responses/500 "503": $ref: ../responses/SOL005_resp.yaml#/components/responses/503 /URI_is_provided_by_the_client_when_creating_the_subscription-VnfPackageChangeNotification: parameters: - $ref: ../components/SOL005_params.yaml#/components/parameters/Version - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization get: summary: Test the notification endpoint description: | The GET method allows the API producer to test the notification endpoint that is provided by the API consumer, e.g. during subscription. parameters: - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept responses: "204": $ref: '#/components/responses/VnfPackageChangeNotification.Get' "400": $ref: ../responses/SOL005_resp.yaml#/components/responses/400 "401": $ref: ../responses/SOL005_resp.yaml#/components/responses/401 "403": $ref: ../responses/SOL005_resp.yaml#/components/responses/403 "405": $ref: ../responses/SOL005_resp.yaml#/components/responses/405 "406": $ref: ../responses/SOL005_resp.yaml#/components/responses/406 "500": $ref: ../responses/SOL005_resp.yaml#/components/responses/500 "503": $ref: ../responses/SOL005_resp.yaml#/components/responses/503 post: summary: Notify about VNF package onboarding or change description: | The POST method delivers a notification from the server to the client. This method shall follow the provisions specified in the Tables 9.4.10.3.1-1 and 9.4.10.3.1-2 for URI query parameters, request and response data structures, and response codes. parameters: - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType requestBody: $ref: '#/components/requestBodies/VnfPackageChangeNotificationRequest' responses: "204": $ref: '#/components/responses/VnfPackageChangeNotification.Post' "400": $ref: ../responses/SOL005_resp.yaml#/components/responses/400 "401": $ref: ../responses/SOL005_resp.yaml#/components/responses/401 "403": $ref: ../responses/SOL005_resp.yaml#/components/responses/403 "405": $ref: ../responses/SOL005_resp.yaml#/components/responses/405 "406": $ref: ../responses/SOL005_resp.yaml#/components/responses/406 "500": $ref: ../responses/SOL005_resp.yaml#/components/responses/500 "503": $ref: ../responses/SOL005_resp.yaml#/components/responses/503 components: requestBodies: VnfPackageOnboardingNotificationRequest: description: | A notification about on-boarding of a VNF package. content: application/json: schema: $ref: ./definitions/SOL005VNFPackageManagementNotification_def.yaml#/definitions/VnfPackageOnboardingNotification required: true VnfPackageChangeNotificationRequest: description: | A notification about changes of status in a VNF package. content: application/json: schema: $ref: ./definitions/SOL005VNFPackageManagementNotification_def.yaml#/definitions/VnfPackageChangeNotification required: true responses: VnfPackageOnboardingNotification.Get: description: | 204 No Content Shall be returned to indicate that 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: {} VnfPackageOnboardingNotification.Post: description: | 204 No Content Shall be returned when the notification has been delivered successfully. 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: {} VnfPackageChangeNotification.Get: description: | 204 No Content Shall be returned to indicate that 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: {} VnfPackageChangeNotification.Post: description: | 204 No Content Shall be returned when the notification has been delivered successfully. 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: {}