Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
NFV - Network Functions Virtualisation
SOL002-SOL003
Commits
b0592192
Commit
b0592192
authored
Mar 15, 2019
by
moscatelli
Browse files
SOL002_62: filters implemented in VNF Indicators GET
parent
e95dc2f9
Changes
1
Show whitespace changes
Inline
Side-by-side
src/SOL002/VNFIndicator/VNFIndicator.yaml
View file @
b0592192
...
@@ -47,61 +47,48 @@ paths:
...
@@ -47,61 +47,48 @@ paths:
get
:
get
:
summary
:
Query multiple indicators
summary
:
Query multiple indicators
description
:
Get a list of indicators. Support of attribute based filtering via query parameters.
description
:
Get a list of indicators. Support of attribute based filtering via query parameters.
# parameters:
parameters
:
# - name: id.eq
-
name
:
filter
# in: query
description
:
>
# description: Attribute based filtering for indicator identifer as specified in VNFD.
Attribute-based filtering expression according to clause 4.3.2.
# type: array
The VNFM shall support receiving this parameter as part of the URI query string.
# items:
The EM/VNF may supply this parameter. The VNF may supply its instance Id as an attribute filter.
# type: string
All attribute names that appear in the VnfIndicator data type and in data types referenced from
# - name: name.eq
it shall be supported by the VNFM in the filter expression. If receiving, this parameter is not
# in: query
supported a 400 Bad Request response shall be returned (See table 8.4.2.3.2-2).
# description: Attribute based filtering for indicator name as specified in VNFD.
# type: array
EXAMPLE
# items:
objects
# type: string
obj1: {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}
# - name: value.eq
obj2: {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]}
# in: query
# description: Attribute based filtering for indicator value equality.
Request 1:
# type: array
GET …/container
# items:
# type: string
Response 1:
# - name: value.neq
[
# in: query
{"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]},
# description: Attribute based filtering for indicator value unequality.
{"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]}
# type: array
]
# items:
# type: string
Request 2:
# - name: value.gt
GET …/container?filter=(eq.weight,100)
# in: query
# description: Attribute based filtering for indicator value greater than.
Response 2:
# type: array
[
# items:
{"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}
# type: string
]
# - name: value.gte
#Request 2 in EXAMPLE from clause 4.3.2 probably wrong, since "," should be used after opOne (eq), "." is used
# in: query
in
:
query
# description: Attribute based filtering for indicator value greater then or equal.
required
:
false
# type: array
type
:
string
# items:
-
name
:
nextpage_opaque_marker
# type: string
description
:
>
# - name: value.lt
Marker to obtain the next page of a paged response. Shall be supported by the EM/VNF
# in: query
if the EM/VNF supports alternative 2 (paging) according to clause 4.7.2.1 for this resource
# description: Attribute based filtering for indicator value less than.
in
:
query
# type: array
required
:
false
# items:
type
:
string
# 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
:
responses
:
200
:
200
:
description
:
>
description
:
>
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment