Loading src/SOL003/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml +144 −181 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 Performance Management Notification interface description: > description: | SOL003 - VNF Performance Management Notification interface Loading @@ -20,32 +19,32 @@ 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 description: ETSI GS NFV-SOL 003 V3.3.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 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 PerformanceInformationAvailableNotification # ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription-PerformanceInformationAvailableNotification': /URI-is-provided-by-the-client-when-creating-the-subscription-PerformanceInformationAvailableNotification: #SOL003 location: 6.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 regarding a performance management event from the API producer to an API consumer. Loading @@ -53,54 +52,12 @@ paths: This method shall follow the provisions specified in the tables 6.4.9.3.1-1 and 6.4.9.3.1-2 for URI query parameters, request and response data structures, and response codes. 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: > 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/PerformanceInformationAvailableNotification.Post.204' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: Loading @@ -117,47 +74,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 the creation of the PM job or threshold resource. This method shall follow the provisions specified in the tables 6.4.9.3.2-1 and 6.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/PerformanceInformationAvailableNotification.Get.204' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: Loading @@ -176,10 +100,13 @@ paths: ############################################################################### # Notification endpoint ThresholdCrossedNotification # ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription-ThresholdCrossedNotification': /URI-is-provided-by-the-client-when-creating-the-subscription-ThresholdCrossedNotification: #SOL003 location: 6.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 regarding a performance management event from the API producer to an API consumer. Loading @@ -187,54 +114,12 @@ paths: This method shall follow the provisions specified in the tables 6.4.9.3.1-1 and 6.4.9.3.1-2 for URI query parameters, request and response data structures, and response codes. 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 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/ThresholdCrossedNotification.Post.204' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: Loading @@ -251,47 +136,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 6.4.9.3.2-1 and 6.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/ThresholdCrossedNotification.Get.204' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: Loading @@ -306,3 +158,114 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" components: requestBodies: PerformanceInformationAvailableNotification: description: | Notification about performance information availability. content: application/json: schema: $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PerformanceInformationAvailableNotification" required: true ThresholdCrossedNotification: description: | Notification about performance information availability. content: application/json: schema: $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/ThresholdCrossedNotification" required: true responses: PerformanceInformationAvailableNotification.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 PerformanceInformationAvailableNotification.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 ThresholdCrossedNotification.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 ThresholdCrossedNotification.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 No newline at end of file Loading
src/SOL003/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml +144 −181 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 Performance Management Notification interface description: > description: | SOL003 - VNF Performance Management Notification interface Loading @@ -20,32 +19,32 @@ 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 description: ETSI GS NFV-SOL 003 V3.3.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 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 PerformanceInformationAvailableNotification # ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription-PerformanceInformationAvailableNotification': /URI-is-provided-by-the-client-when-creating-the-subscription-PerformanceInformationAvailableNotification: #SOL003 location: 6.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 regarding a performance management event from the API producer to an API consumer. Loading @@ -53,54 +52,12 @@ paths: This method shall follow the provisions specified in the tables 6.4.9.3.1-1 and 6.4.9.3.1-2 for URI query parameters, request and response data structures, and response codes. 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: > 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/PerformanceInformationAvailableNotification.Post.204' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: Loading @@ -117,47 +74,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 the creation of the PM job or threshold resource. This method shall follow the provisions specified in the tables 6.4.9.3.2-1 and 6.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/PerformanceInformationAvailableNotification.Get.204' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: Loading @@ -176,10 +100,13 @@ paths: ############################################################################### # Notification endpoint ThresholdCrossedNotification # ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription-ThresholdCrossedNotification': /URI-is-provided-by-the-client-when-creating-the-subscription-ThresholdCrossedNotification: #SOL003 location: 6.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 regarding a performance management event from the API producer to an API consumer. Loading @@ -187,54 +114,12 @@ paths: This method shall follow the provisions specified in the tables 6.4.9.3.1-1 and 6.4.9.3.1-2 for URI query parameters, request and response data structures, and response codes. 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 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/ThresholdCrossedNotification.Post.204' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: Loading @@ -251,47 +136,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 6.4.9.3.2-1 and 6.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/ThresholdCrossedNotification.Get.204' 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: Loading @@ -306,3 +158,114 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" components: requestBodies: PerformanceInformationAvailableNotification: description: | Notification about performance information availability. content: application/json: schema: $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PerformanceInformationAvailableNotification" required: true ThresholdCrossedNotification: description: | Notification about performance information availability. content: application/json: schema: $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/ThresholdCrossedNotification" required: true responses: PerformanceInformationAvailableNotification.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 PerformanceInformationAvailableNotification.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 ThresholdCrossedNotification.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 ThresholdCrossedNotification.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 No newline at end of file
