Commit e2d60eec authored by Michele Carignani's avatar Michele Carignani
Browse files

Fixing usage of query and read operations for Indicator API

Change-Id: Iaa071137ca386dfd0812c3bb23ddf31c667bef4e
parent 75951eda
swagger: "2.0"
info:
version: "2.3.1"
version: "1.1.1"
title: "DRAFT VNF Indicator interface"
description: >
DRAFT VNF Indicator interface of ETSI NFV SOL002
DRAFT 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 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&list_id=61&product=NFV&resolution=---
Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
termsOfService: "http://etsi.org"
contact:
name: "NFV-SOL WG"
license:
name: "ETSI Forge copyright notice"
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
externalDocs:
description: ETSI GS NFV-SOL 002 V2.3.3
url: https://docbox.etsi.org/ISG/NFV/Open/Drafts/SOL002ed241_Ve-Vnfm_RESTful_protocols_spec/NFV-SOL002ed241v233.zip
basePath: /vnfind/v1
......@@ -221,18 +227,17 @@ paths:
type: string
required: true
get:
summary: Query multiple indicators related to a VNF instance.
summary: Read an inidividual VNF indicator 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.
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: >
The list of VNF indicators was queried successfully.
The response body shall contain the representations of all VNF indicators that match
the attribute-based filtering parameters.
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' }
......@@ -250,7 +255,7 @@ paths:
/subscriptions:
post:
summary: Create a new subscription
summary: Create a new subscription to VNF indicator change notifications
description: Create a new subscription
parameters:
- name: subscription
......@@ -284,7 +289,7 @@ paths:
500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }
get:
summary: Query subscriptions.
summary: Query multiple subscriptions.
description: >
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.
......@@ -384,7 +389,7 @@ paths:
/subscriptions/{subscriptionId}:
get:
summary: Query subscriptions.
summary: Read an individual subscription.
description: >
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.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment