diff --git a/src/SOL002/VNFIndicator/VNFIndicator.yaml b/src/SOL002/VNFIndicator/VNFIndicator.yaml index e2e38bd68e8a9b722bea26c7d50361a42f8ef4c4..3b8a9c577df7acc5fc31c8634bc408bfa666992f 100644 --- a/src/SOL002/VNFIndicator/VNFIndicator.yaml +++ b/src/SOL002/VNFIndicator/VNFIndicator.yaml @@ -47,61 +47,48 @@ paths: 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 + parameters: + - name: filter + description: > + Attribute-based filtering expression according to clause 4.3.2. + The VNFM shall support receiving this parameter as part of the URI query string. + The EM/VNF may supply this parameter. The VNF may supply its instance Id as an attribute filter. + All attribute names that appear in the VnfIndicator data type and in data types referenced from + it shall be supported by the VNFM in the filter expression. If receiving, this parameter is not + supported a 400 Bad Request response shall be returned (See table 8.4.2.3.2-2). + + EXAMPLE + objects + obj1: {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]} + obj2: {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]} + + Request 1: + GET …/container + + Response 1: + [ + {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}, + {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]} + ] + + Request 2: + GET …/container?filter=(eq.weight,100) + + Response 2: + [ + {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]} + ] + #Request 2 in EXAMPLE from clause 4.3.2 probably wrong, since "," should be used after opOne (eq), "." is used + in: query + required: false + type: string + - name: nextpage_opaque_marker + description: > + Marker to obtain the next page of a paged response. Shall be supported by the EM/VNF + if the EM/VNF supports alternative 2 (paging) according to clause 4.7.2.1 for this resource + in: query + required: false + type: string responses: 200: description: >