openapi: 3.0.2 info: title: SOL002 - VNF Indicator Notification interface description: | SOL002 - VNF Indicator 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/rep/nfv/SOL002-SOL003/issues contact: name: NFV-SOL WG license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: description: ETSI GS NFV-SOL 002 V3.3.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.03.01_60/gs_NFV-SOL002v030301p.pdf 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_VnfIndicatorValueChangeNotification': parameters: - $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. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType requestBody: $ref: '#/components/requestBodies/VnfIndicatorValueChangeNotification' responses: "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 '/URI-is-provided-by-the-client-when-creating-the-subscription_SupportedIndicatorsChangeNotification': parameters: - $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. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType requestBody: $ref: '#/components/requestBodies/SupportedIndicatorsChangeNotification' responses: "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 components: requestBodies: VnfIndicatorValueChangeNotification: description: | A notification about VNF indicator value changes. content: application/json: schema: $ref: ./definitions/SOL002VNFIndicatorNotification_def.yaml#/definitions/VnfIndicatorValueChangeNotification required: true SupportedIndicatorsChangeNotification: description: | A notification about changes of the set of supported indicators. content: application/json: schema: $ref: ./definitions/SOL002VNFIndicatorNotification_def.yaml#/definitions/SupportedIndicatorsChangeNotification required: true 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: {} 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: {}