Skip to content
GitLab
Commit f50e77f3 authored by moscatelli's avatar moscatelli
Browse files

SOL003_122/SOL003_123/SOL003_124/SOL003_125: Thresholds POST and GET description fields updated

parent 56412743
Pipeline #1184 passed with stage
in 0 seconds
Hide whitespace changes
Inline Side-by-side
src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml
View file @ f50e77f3
......@@ -450,7 +450,7 @@ paths:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
###############################################################################
# Individual performance report #
###############################################################################
......@@ -471,8 +471,9 @@ paths:
required: true
get:
description: >
The client can use this method for reading an individual performance
report.
The client can use this method for reading an individual performance report.
This method shall follow the provisions specified in the tables 6.4.4.3.2-1 and 6.4.4.3.2-2
for URI query parameters, request and response data structures, and response codes.
parameters:
- name: Accept
description: >
......@@ -499,10 +500,9 @@ paths:
description: >
200 OK
Information of an individual performance report was read
successfully.
The response body shall contain a representation of the
performance report resource.
Shall be returned when information of an individual performance report has been read successfully.
The response body shall contain a representation of the "Individual performance report" resource,
as defined in clause 6.5.2.10.
headers:
Content-Type:
description: >
......@@ -533,14 +533,21 @@ paths:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
422:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
###############################################################################
# Thresholds #
###############################################################################
......@@ -548,10 +555,12 @@ paths:
#SOL003 location: 6.4.5
post:
description: >
Create Threshold
Create Threshold.
The POST method can be used by the client to create a threshold.
This method shall follow the provisions specified in the tables 6.4.5.3.1-1 and 6.4.5.3.1-2
for URI query parameters, request and response data structures, and response codes.
As the result of successfully executing this method, a new "Individual threshold" resource
as defined in clause 6.4.6 shall have been created.
parameters:
- name: CreateThresholdRequest
description: >
......@@ -592,10 +601,11 @@ paths:
description: >
201 CREATED
A threshold was created successfully. The response body shall
contain a representation of the created threshold resource.
The HTTP response shall include a "Location" HTTP header that
contains the resource URI of the created threshold resource.
Shall be returned when a threshold has been created successfully.
The response body shall contain a representation of the created "Individual threshold" resource,
as defined in clause 6.5.2.9.
The HTTP response shall include a "Location" HTTP header that contains the resource URI of the
created threshold resource.
headers:
Location:
description: The resource URI of the created VNF instance
......@@ -630,20 +640,27 @@ paths:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
422:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
get:
description: >
Query Threshold
Query Threshold.
The client can use this method to query information about thresholds.
This method shall follow the provisions specified in the tables 6.4.5.3.2-1 and 6.4.5.3.2-2
for URI query parameters, request and response data structures, and response codes.
parameters:
- name: Accept
description: >
......@@ -661,24 +678,19 @@ paths:
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 NFVO may supply this parameter.
All attribute names that appear in the Thresholds and in
data types referenced from it shall be supported by the VNFM
in the filter expression.
NOTE: There are no attribute selectors defined for this resource as
the threshold attributes with cardinality 0..1 or 0..N are not
structurally complex in nature.
Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
The VNFM shall support receiving this parameter as part of the URI query string.
The NFVO may supply this parameter.
All attribute names that appear in the Thresholds data type and in data types referenced
from it shall be supported by the VNFM in the filter expression.
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.
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
5.4.2.1 of ETSI GS NFV-SOL 013 for this resource.
in: query
required: false
type: string
......@@ -693,14 +705,15 @@ paths:
description: >
200 OK
Information about zero or more thresholds was queried
successfully.
The response body shall contain in an array representations
of zero or more thresholds, as defined in 6.5.2.9.
If the VNFM supports alternative 2 (paging) according to
clause 4.7.2.1 for this resource, inclusion of the Link
HTTP header in this response shall follow the provisions
in clause 4.7.2.3.
Shall be returned when information about zero or more thresholds has been queried successfully.
If the "filter" URI parameter was supplied in the request, the data in the response body shall have
been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013.
The response body shall contain in an array the representations of zero or more thresholds,
as defined in clause 6.5.2.9.
If the VNFM 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:
Location:
description: The resource URI of the created VNF instance
......
Supports Markdown
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