Commit cbc64a0d authored by Samir Medjiah's avatar Samir Medjiah

SOL005_#080 GET Method (on PM jobs) request and response updated

parent f3d8d6c6
...@@ -151,7 +151,7 @@ paths: ...@@ -151,7 +151,7 @@ paths:
required: false required: false
type: string type: string
description: > description: >
Attribute-based filtering expression according to clause 4.3.2. Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
The NFVO shall support receiving this parameter as part of the URI query string. The NFVO shall support receiving this parameter as part of the URI query string.
The OSS/BSS may supply this parameter. The OSS/BSS may supply this parameter.
All attribute names that appear in the PmJob and in data types referenced from it All attribute names that appear in the PmJob and in data types referenced from it
...@@ -161,29 +161,30 @@ paths: ...@@ -161,29 +161,30 @@ paths:
required: false required: false
type: string type: string
description: > description: >
Include all complex attributes in the response. See clause 4.3.3 for details. The Include all complex attributes in the response. See clause 5.3 of ETSI GS NFV-SOL 013
NFVO shall support this parameter. for details. The NFVO shall support this parameter.
- name: include - name: fields
in: query in: query
required: false required: false
type: string type: string
description: > description: >
Complex attributes to be included into the response. See clause 4.3.3 for details. The Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV-SOL 013
NFVO should support this parameter. for details. The NFVO should support this parameter.
- name: exclude - name: exclude_fields
in: query in: query
required: false required: false
type: string type: string
description: > description: >
Complex attributes to be excluded from the response. See clause 4.3.3 for details. Complex attributes to be excluded from the response. See clause 5.3 of ETSI GS NFV-SOL 013
The NFVO should support this parameter. for details. The NFVO should support this parameter.
- name: exclude_default - name: exclude_default
in: query in: query
required: false required: false
type: string type: string
description: > description: >
Indicates to exclude the following complex attributes from the response. Indicates to exclude the following complex attributes from the response.
See clause 4.3.3 for details. The NFVO shall support this parameter. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFVO shall support this
parameter.
The following attributes shall be excluded from the PmJob structure in the response 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", body if this parameter is provided, or none of the parameters "all_fields," "fields",
"exclude_fields", "exclude_default" are provided: "exclude_fields", "exclude_default" are provided:
...@@ -191,7 +192,8 @@ paths: ...@@ -191,7 +192,8 @@ paths:
- name: nextpage_opaque_marker - name: nextpage_opaque_marker
description: > description: >
Marker to obtain the next page of a paged response. Shall be supported by the NFVO Marker to obtain the next page of a paged response. Shall be supported by the NFVO
if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource. if the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of
ETSI GS NFV-SOL 013 for this resource.
in: query in: query
required: false required: false
type: string type: string
...@@ -214,9 +216,19 @@ paths: ...@@ -214,9 +216,19 @@ paths:
description: > description: >
200 OK 200 OK
Information about zero or more PM jobs was queried successfully. Shall be returned when information about zero or more PM jobs has been queried successfully.
The response body shall contain representations of The response body shall contain in an array the representations of
zero or more PM jobs, as defined in clause 7.5.2.7. zero or more PM jobs, as defined in clause 7.5.2.7.
If the "filter" URI parameter or one of the "all_fields", "fields", "include_fields",
"exclude_fields" or "exclude_default" URI parameters was supplied in the request and is
supported, the data in the response body shall have been transformed according to the
rules specified in clauses 5.2.2 and 5.3.2 of ETSI GS NFV SOL 013, respectively.
If the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of
ETSI GS NFV SOL 013 for this resource, inclusion of the Link HTTP header
in this response shall follow the provisions in clause 5.4.2.3 of
ETSI GS NFV SOL 013.
headers: headers:
Content-Type: Content-Type:
description: The MIME type of the body of the response. description: The MIME type of the body of the response.
......
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