From 610b4f0bec351388b07c637da22dce5b01d038d8 Mon Sep 17 00:00:00 2001 From: moscatelli Date: Fri, 15 Mar 2019 11:29:11 +0100 Subject: [PATCH] SOL002_23: filters implemented for VNF Instances GET --- .../VNFConfiguration/VNFConfiguration.yaml | 5 +- .../VNFLifecycleManagement.yaml | 66 +++++++++++++++++++ 2 files changed, 67 insertions(+), 4 deletions(-) diff --git a/src/SOL002/VNFConfiguration/VNFConfiguration.yaml b/src/SOL002/VNFConfiguration/VNFConfiguration.yaml index cb3c9f30..6f9fd7f9 100644 --- a/src/SOL002/VNFConfiguration/VNFConfiguration.yaml +++ b/src/SOL002/VNFConfiguration/VNFConfiguration.yaml @@ -142,7 +142,4 @@ paths: 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' } - - - + 504: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/504' } \ No newline at end of file diff --git a/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml b/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml index 5e346f8a..38c5a55a 100644 --- a/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml +++ b/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml @@ -137,6 +137,72 @@ paths: in: header required: true type: string + - 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 may supply this parameter. All attribute names that appear in the VnfInstance + and in data types referenced from it shall be supported by the VNFM in the filter expression. + 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: all_fields + description: > + Include all complex attributes in the response. + See clause 4.3.3 for details. The VNFM shall support this parameter. + in: query + required: false + type: string + - name: fields + description: > + Complex attributes to be included into the response. + See clause 4.3.3 for details. The VNFM should support this parameter. + in: query + required: false + type: string + - name: exclude_fields + description: > + Complex attributes to be excluded from the response. + See clause 4.3.3 for details. The VNFM should support this parameter. + in: query + required: false + type: string + - name: exclude_default + description: > + Indicates to exclude the following complex attributes from the response. + See clause 4.3.3 for details. The VNFM shall support this parameter. + The following attributes shall be excluded from the VnfInstance structure + in the response body if this parameter is provided, or none of the parameters + "all_fields," "fields", "exclude_fields", "exclude_default" are provided: + - vnfConfigurableProperties + - instantiatedVnfInfo + - metadata + - extensions + in: query + required: false + type: string responses: 200: description: > -- GitLab