swagger: "2.0" info: version: "1.1.1" title: "SOL002 - VNF Indicator interface" description: > VNF Indicator interface of ETSI NFV SOL002. This API allows the EM/VNF to provide information on value changes of VNF related indicators. VNF related indicators are declared in the VNFD. 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/bugzilla/buglist.cgi?component=Nfv-Openapis license: name: "ETSI Forge copyright notice" url: https://forge.etsi.org/etsi-forge-copyright-notice.txt externalDocs: description: ETSI GS NFV-SOL 002 V2.4.1 url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.04.01_60/gs_NFV-SOL002v020401p.pdf basePath: /vnfind/v1 schemes: - http - https consumes: - application/json produces: - application/json paths: /indicators: get: summary: Query multiple indicators description: Get a list of indicators. Support of attribute based filtering via query parameters. # parameters: # - name: id.eq # in: query # description: Attribute based filtering for indicator identifer as specified in VNFD. # type: array # items: # type: string # - name: name.eq # in: query # description: Attribute based filtering for indicator name as specified in VNFD. # type: array # items: # type: string # - name: value.eq # in: query # description: Attribute based filtering for indicator value equality. # type: array # items: # type: string # - name: value.neq # in: query # description: Attribute based filtering for indicator value unequality. # type: array # items: # type: string # - name: value.gt # in: query # description: Attribute based filtering for indicator value greater than. # type: array # items: # type: string # - name: value.gte # in: query # description: Attribute based filtering for indicator value greater then or equal. # type: array # items: # type: string # - name: value.lt # in: query # description: Attribute based filtering for indicator value less than. # type: array # items: # type: string # - name: value.lte # in: query # description: Attribute based filtering for indicator value less than or equal. # type: array # items: # type: string # - name: vnfInstanceId.eq # in: query # description: Attribute based filtering for indicators belonging to specified VNF instance. # type: array # items: # type: string responses: 200: description: > OK 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 EM/VNF supports alternative 2 (paging) according to clause 4.7.2.1 for this resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3. schema: type: array items: $ref: 'definitions/VnfIndicator_def.yaml#/definitions/VnfIndicator' 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' } 409: { $ref: 'responses/VNFIndicator_resp.yaml#/responses/409' } 416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' } 422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } 500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } /indicators/{vnfInstanceId}: parameters: - 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. type: string required: true 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: # - name: id.eq # in: query # description: Attribute based filtering for indicator identifer as specified in VNFD. # type: array # items: # type: string # - name: name.eq # in: query # description: Attribute based filtering for indicator name as specified in VNFD. # type: array # items: # type: string # - name: value.eq # in: query # description: Attribute based filtering for indicator value equality. # type: array # items: # type: string # - name: value.neq # in: query # description: Attribute based filtering for indicator value unequality. # type: array # items: # type: string # - name: value.gt # in: query # description: Attribute based filtering for indicator value greater than. # type: array # items: # type: string # - name: value.gte # in: query # description: Attribute based filtering for indicator value greater then or equal. # type: array # items: # type: string # - name: value.lt # in: query # description: Attribute based filtering for indicator value less than. # type: array # items: # type: string # - name: value.lte # in: query # description: Attribute based filtering for indicator value less than or equal. # type: array # items: # type: string responses: 200: description: > OK 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 EM/VMF supports alternative 2 (paging) according to clause 4.7.2.1 for this resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3. schema: type: array items: $ref: 'definitions/VnfIndicator_def.yaml#/definitions/VnfIndicator' 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' } 409: { $ref: 'responses/VNFIndicator_resp.yaml#/responses/409' } 416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' } 422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } 500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } /indicators/{vnfInstanceId}/{indicatorId}: parameters: - 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. type: string required: true - name: indicatorId in: path description: > Identifier of the VNF indicator. # LEH NOTE from SOL002 is strange type: string required: true 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: description: > OK The VNF indicator was read successfully. The response body shall contain the representation of the VNF indicator. schema: $ref: 'definitions/VnfIndicator_def.yaml#/definitions/VnfIndicator' 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' } 409: { $ref: 'responses/VNFIndicator_resp.yaml#/responses/409' } 416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' } 422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } 500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } /subscriptions: post: summary: Create a new subscription to VNF indicator change notifications description: Create a new subscription parameters: - name: subscription in: body description: Subscription data. required: true schema: $ref: 'definitions/VnfIndicatorSubscriptionRequest_def.yaml#/definitions/VnfIndicatorSubscriptionRequest' responses: 201: description: > Created The subscription was created successfully. The response body shall contain a representation of the created subscription resource. schema: $ref: 'definitions/VnfIndicatorSubscription_def.yaml#/definitions/VnfIndicatorSubscription' headers: Location: description: > Pointer to the created subscription resource. type: string format: URI 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' } 409: { $ref: 'responses/VNFIndicator_resp.yaml#/responses/409' } 416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' } 422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } 500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } 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: # - name: id.eq # in: query # description: > # Attribute based filtering for subscription identifiers. # type: array # items: # type: string # - name: callbackUri.eq # in: query # description: > # Attribute based filtering for the subscription's call back URIs. # type: array # items: # type: string # - name: filter.indicatorIds.cont # in: query # description: > # Attribute based filtering for indicator identifiers. # type: array # items: # type: string # - name: filter.vnfInstanceSubscriptionFilter.vnfdIds.cont # in: query # description: > # Attribute based filtering for VNFD identifiers. # type: array # items: # type: string # - name: filter.vnfInstanceSubscriptionFilter.vnfProductsFromProviders.vnfProvider.eq # in: query # description: > # Attribute based filtering for VNF providers. # type: array # items: # type: string # - name: filter.vnfInstanceSubscriptionFilter.vnfProductsFromProviders.vnfProducts.vnfProductName.eq # in: query # description: > # Attribute based filtering for VNF product name. # type: array # items: # type: string # - name: filter.vnfInstanceSubscriptionFilter.vnfProductsFromProviders.vnfProducts.versions.vnfSoftwareVersion.cont # in: query # description: > # Attribute based filtering for VNF software versions. # type: array # items: # type: string # - name: filter.vnfInstanceSubscriptionFilter.vnfProductsFromProviders.vnfProducts.versions.vnfdVersion.cont # in: query # description: > # Attribute based filtering for VNFD versions. # type: array # items: # type: string # - name: filter.vnfInstanceSubscriptionFilter.vnfInstanceIds.cont # in: query # description: > # Attribute based filtering for VNF instance identifiers. # type: array # items: # type: string # - name: filter.vnfInstanceSubscriptionFilter.vnfInstanceNames.cont # in: query # description: > # Attribute based filtering for VNF instance names. # type: array # items: # type: string responses: 200: description: > OK 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 EM supports alternative 2 (paging) according to clause 4.7.2.1 for this resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3. schema: type: array items: $ref: 'definitions/VnfIndicatorSubscription_def.yaml#/definitions/VnfIndicatorSubscription' 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' } 409: { $ref: 'responses/VNFIndicator_resp.yaml#/responses/409' } 416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' } 422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } 500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } /subscriptions/{subscriptionId}: 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. parameters: - name: subscriptionId 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. in: path type: string required: true responses: 200: description: > OK The subscriptions was queried successfully. The response body shall contain the representation of the requested subscription. schema: $ref: 'definitions/VnfIndicatorSubscription_def.yaml#/definitions/VnfIndicatorSubscription' 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' } 409: { $ref: 'responses/VNFIndicator_resp.yaml#/responses/409' } 416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' } 422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } 500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } delete: summary: Delete a subscription description: Terminate an individual subscription. parameters: - name: subscriptionId description: > Service Unavailable 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. in: path type: string required: true responses: 204: description: > No Content The subscription was deleted successfully. The response body shall be empty. 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' } 409: { $ref: 'responses/VNFIndicator_resp.yaml#/responses/409' } 416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' } 422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } 500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }