openapi: 3.0.2 info: title: SOL002 - VNF Indicator interface description: | SOL002 - VNF Indicator 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/bugzilla/buglist.cgi?component=Nfv-Openapis contact: name: NFV-SOL WG license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt version: 1.2.1-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/02.07.01_60/gs_nfv-sol002v020701p.pdf servers: - url: http://127.0.0.1/vnfind/v1 - url: https://127.0.0.1/vnfind/v1 paths: /api_versions: $ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions /indicators: parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: summary: Query multiple indicators description: Get a list of indicators. Support of attribute based filtering via query parameters. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker responses: "200": $ref: '#/components/responses/Indicators.Get' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400 "401": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401 "403": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403 "404": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404 "405": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416 "422": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422 "429": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429 "500": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500 "503": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503 "504": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504 /indicators/{vnfInstanceId}: parameters: - $ref: '#/components/parameters/VnfInstanceId' - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: summary: Query multiple indicators related to a VNF instance. description: | Get a list of indicators related to a specific VNF instance. Support of attribute based filtering via query parameters. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker responses: "200": $ref: '#/components/responses/VnfIndicators.Get' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400 "401": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401 "403": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403 "404": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404 "405": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416 "422": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422 "429": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429 "500": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500 "503": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503 "504": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504 /indicators/{vnfInstanceId}/{indicatorId}: parameters: - $ref: '#/components/parameters/VnfInstanceId' - $ref: '#/components/parameters/IndicatorId' - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: summary: Read an inidividual VNF indicator related to a VNF instance. description: | Read an individual VNF indicator related to a specific VNF instance. NOTE: This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response. responses: "200": $ref: '#/components/responses/VnfIndividualIndicator.Get' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400 "401": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401 "403": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403 "404": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404 "405": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416 "422": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422 "429": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429 "500": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500 "503": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503 "504": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504 /subscriptions: parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: summary: Query multiple subscriptions. description: | Service Unavailable The GET method queries the list of active subscriptions of the functional block that invokes the method. It can be used e.g. for resynchronization after error situations. parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker responses: "200": $ref: '#/components/responses/VnfIndicatorSubscriptions.Get' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400 "401": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401 "403": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403 "404": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404 "405": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416 "422": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422 "429": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429 "500": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500 "503": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503 "504": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504 post: summary: Create a new subscription to VNF indicator change notifications description: | This method creates a new subscription. As the result of successfully executing this method, a new "Individual subscription" resource as defined in clause 8.4.6 shall have been created. This method shall not trigger any notification. Creation of two "Individual subscription" resources with the same callbackURI and the same filter can result in performance degradation and will provide duplicates of notifications to the VNFM, and might make sense only in very rare use cases. Consequently, the API producer may either allow creating a new "Individual subscription" resource if another "Individual subscription" resource with the same filter and callbackUri already exists (in which case it shall return the "201 Created" response code), or may decide to not create a duplicate "Individual subscription" resource (in which case it shall return a "303 See Other" response code referencing the existing "Individual subscription" resource with the same filter and callbackUri). This method shall follow the provisions specified in the tables 8.4.5.3.1-1 and 8.4.5.3.1-2 for URI query parameters, request and response data structures, and response codes parameters: - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType requestBody: $ref: '#/components/requestBodies/VnfIndicatorSubscriptionRequest' responses: "201": $ref: '#/components/responses/VnfIndicatorSubscription.Post' "303": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/303 "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400 "401": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401 "403": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403 "404": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404 "405": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416 "422": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422 "429": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429 "500": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500 "503": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503 "504": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504 /subscriptions/{subscriptionId}: parameters: - $ref: '#/components/parameters/SubscriptionId' - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: summary: Read an individual subscription. description: | Service Unavailable This resource represents an individual subscription. The client can use this resource to read and to terminate a subscription to notifications related to VNF indicator value changes. responses: "200": $ref: '#/components/responses/VnfIndicatorSubscription.Get' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400 "401": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401 "403": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403 "404": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404 "405": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416 "422": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422 "429": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429 "500": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500 "503": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503 "504": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504 delete: summary: Delete a subscription description: | This method terminates an individual subscription. As the result of successfully executing this method, the "Individual subscription" resource shall not exist any longer. This means that no notifications for that subscription shall be sent to the formerly-subscribed API consumer. NOTE:\tDue to race conditions, some notifications might still be received by the formerly-subscribed API consumer for a certain time period after the deletion. responses: "204": $ref: '#/components/responses/VnfIndicatorSubscription.Delete' "400": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400 "401": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401 "403": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403 "404": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404 "405": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405 "406": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406 "416": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/416 "422": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422 "429": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429 "500": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500 "503": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503 "504": $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504 components: parameters: VnfInstanceId: name: vnfInstanceId in: path description: | Service Unavailable. Identifier of the VNF instance to which the VNF indicators applies. NOTE: This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response. required: true style: simple explode: false schema: type: string IndicatorId: name: indicatorId in: path description: | Identifier of the VNF indicator. required: true style: simple explode: false schema: type: string SubscriptionId: name: subscriptionId in: path description: | Identifier of this subscription. NOTE: This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from the "id" attribute in the payload body of that response. required: true style: simple explode: false schema: type: string requestBodies: VnfIndicatorSubscriptionRequest: description: Details of the subscription to be created. content: application/json: schema: $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscriptionRequest required: true responses: Indicators.Get: description: | 200 OK Shall be returned when information about zero or more VNF indicators was queried successfully. The response body shall contain in an array the representations of all VNF indicators that match the attribute-based filtering parameters, i.e. zero or more representations of VNF indicators as defined in clause 8.5.2.2. If the "filter" URI parameter was supplied in the request, the data in the response body shall have been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. If the EM/VNF supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013for this resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. headers: Version: description: The used API version. style: simple explode: false schema: type: string Link: description: | Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. style: simple explode: false schema: type: string Content-Type: description: The MIME type of the body of the response. style: simple explode: false schema: type: string content: application/json: schema: type: array items: $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator VnfIndicators.Get: description: | 200 OK Shall be returned when information about zero or more VNF indicators was queried successfully. The response body shall contain in an array the representations of all VNF indicators that are related to the particular VNF instance and that match the attribute filter., i.e. zero or more representations of VNF indicators as defined in clause 8.5.2.2. If the "filter" URI parameter was supplied in the request, the data in the response body shall have been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. If the EM/VMF supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. headers: Version: description: The used API version. style: simple explode: false schema: type: string Link: description: | Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. style: simple explode: false schema: type: string Content-Type: description: The MIME type of the body of the response. style: simple explode: false schema: type: string content: application/json: schema: type: array items: $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator VnfIndividualIndicator.Get: description: | 200 OK Shall be returned when the VNF indicator has been read successfully. The response body shall contain the representation of the VNF indicator. headers: Version: description: The used API version. style: simple explode: false schema: type: string Content-Type: description: The MIME type of the body of the response. style: simple explode: false schema: type: string content: application/json: schema: $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator VnfIndicatorSubscriptions.Get: description: | 200 OK Shall be returned when the list of subscriptions was queried successfully. The response body shall contain in an array the representations of all active subscriptions of the functional block that invokes the method which match the attribute filter, i.e. zero or more representations of VNF indicators subscriptions as defined in clause 8.5.2.4. If the "filter" URI parameter was supplied in the request, the data in the response body shall have been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV SOL 013. If the EM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. headers: Version: description: The used API version. style: simple explode: false schema: type: string Link: description: | Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. style: simple explode: false schema: type: string Content-Type: description: The MIME type of the body of the response. style: simple explode: false schema: type: string content: application/json: schema: type: array items: $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription VnfIndicatorSubscription.Post: description: | 201 CREATED Shall be returned when the subscription has been created successfully. The response body shall contain a representation of the created "Individual subscription" resource. headers: Version: description: The used API version. 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 Location: description: | Pointer to the created subscription resource. style: simple explode: false schema: type: string format: URI Content-Type: description: The MIME type of the body of the response. style: simple explode: false schema: type: string content: application/json: schema: type: array items: $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription VnfIndicatorSubscription.Get: description: | 200 OK Shall be returned when information about an individual subscription has been read successfully. The response body shall contain the representation of the "Individual subscription" resource. headers: Version: description: The used API version. style: simple explode: false schema: type: string Content-Type: description: The MIME type of the body of the response. style: simple explode: false schema: type: string content: application/json: schema: $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription VnfIndicatorSubscription.Delete: description: | 204 NO CONTENT Shall be returned when the subscription has been deleted successfully. The response body shall be empty. headers: Version: description: The used API version. style: simple explode: false schema: type: string content: {}