diff --git a/src/SOL002/VNFPerformanceManagement/VNFPerformanceManagement.yaml b/src/SOL002/VNFPerformanceManagement/VNFPerformanceManagement.yaml index a207176f2595d5128e33e4e539fe11fcc150e724..c8e6149afb323890d0330d38fdcd85aa27d8cdee 100644 --- a/src/SOL002/VNFPerformanceManagement/VNFPerformanceManagement.yaml +++ b/src/SOL002/VNFPerformanceManagement/VNFPerformanceManagement.yaml @@ -72,6 +72,78 @@ 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 PmJob + and in data types referenced from it shall be supported by the VNFM in attribute-based filtering 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 PmJob structure in + the response body if this parameter is provided, or none of the parameters + "all_fields", "fields", "exclude_fields", "exclude_default" are provided: + - reports + 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 VNFM if the VNFM supports alternative 2 + (paging) according to clause 4.7.2.1 for this resource. + in: query + required: false + type: string responses: 201: description: >