swagger: "2.0" info: version: "2.3.0" title: SOL003 - VNF Lifecycle Management Notification interface license: name: "ETSI Forge copyright notice" url: https://forge.etsi.org/etsi-forge-copyright-notice.txt contact: name: "NFV-SOL WG" basePath: "/callback/v1" schemes: - https consumes: - "application/json" produces: - "application/json" paths: ############################################################################### # Notification endpoint AlarmNotification # ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmNotification': #SOL003 location: 7.4.6 post: description: > The POST method notifies a VNF alarm or that the alarm list has been rebuilt. parameters: - name: AlarmNotification description: > Information of a VNF alarm. in: body required: true schema: $ref: "../definitions/SOL003_def.yaml#/definitions/AlarmNotification" responses: 204: description: > The notification was 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 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" 401: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" 405: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" get: 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: > The notification endpoint was tested successfully. The response body shall be empty. headers: WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. type: string maximum: 1 minimum: 0 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" 401: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" 405: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" ############################################################################### # Notification endpoint AlarmClearedNotification # ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmClearedNotification': #SOL003 location: 7.4.6 post: description: > The POST method notifies a VNF alarm or that the alarm list has been rebuilt. parameters: - name: AlarmClearedNotification description: > Information of the clearance of a VNF alarm in: body required: true schema: $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmClearedNotification" responses: 204: description: > The notification was 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 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" 401: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" 405: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" get: 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: > The notification endpoint was tested successfully. The response body shall be empty. headers: WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. type: string maximum: 1 minimum: 0 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" 401: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" 405: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" ############################################################################### # Notification endpoint AlarmListRebuiltNotification # ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmListRebuiltNotification': #SOL003 location: 7.4.6 post: description: > The POST method notifies a VNF alarm or that the alarm list has been rebuilt. parameters: - name: AlarmListRebuiltNotification description: > Information that the alarm list has been rebuilt by the VNFM in: body required: true schema: $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmListRebuiltNotification" responses: 204: description: > The notification was 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 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" 401: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" 405: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" get: 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: > The notification endpoint was tested successfully. The response body shall be empty. headers: WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. type: string maximum: 1 minimum: 0 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" 401: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" 405: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"