Newer
Older
swagger: "2.0"
info:
version: "2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
moscatelli
committed
title: "SOL005 - NS Performance Management Interface"
IMPORTANT: Please note that this file might be not aligned to the current
version of the ETSI Group Specification it refers to and has not been
approved by the ETSI NFV ISG. In case of discrepancies the published ETSI
Group Specification takes precedence.
Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
license:
moscatelli
committed
name: "ETSI Forge copyright notice"
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
moscatelli
committed
contact:
moscatelli
committed
name: "NFV-SOL WG"
description: ETSI GS NFV-SOL 005 V2.7.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.07.01_60/gs_NFV-SOL005v020701p.pdf
moscatelli
committed
- http
moscatelli
committed
###############################################################################
# API Versions #
###############################################################################
moscatelli
committed
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
moscatelli
committed
moscatelli
committed
###############################################################################
# PM Jobs #
###############################################################################
rameshnaraya
committed
'/pm_jobs':
#ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.2
moscatelli
committed
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
rameshnaraya
committed
post:
description: >
The POST method creates a PM job.
This method shall follow the provisions specified in the
Tables 7.4.2.3.1-1 and 7.4.2.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 PM job" resource exist as defined in
clause 7.4.3 shall have been created.
rameshnaraya
committed
parameters:
moscatelli
committed
- name: CreatePmJobRequest
in: body
required: true
schema:
$ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/CreatePmJobRequest"
moscatelli
committed
description: >
The VNF creation parameters.
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
responses:
rameshnaraya
committed
201:
moscatelli
committed
description: >
moscatelli
committed
201 CREATED
moscatelli
committed
Shall be returned when the "Individual PM job" has been created successfully.
The response body shall contain a representation of
the created PM job resource, as defined in clause 7.5.2.7.
The HTTP response shall include a "Location" HTTP
header that points to the created "Individual PM job" resource.
rameshnaraya
committed
schema:
$ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmJob"
moscatelli
committed
type: string
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message
body.
WWW-Authenticate:
moscatelli
committed
type: string
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
maximum: 1
moscatelli
committed
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
rameshnaraya
committed
get:
moscatelli
committed
description: >
The API consumer can use this method to retrieve information about PM jobs.
rameshnaraya
committed
parameters:
moscatelli
committed
- name: filter
in: query
rameshnaraya
committed
required: false
moscatelli
committed
type: string
description: >
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 OSS/BSS may supply this parameter.
rameshnaraya
committed
All attribute names that appear in the PmJob and in data types referenced from it
shall be supported by the NFVO in the filter expression.
moscatelli
committed
- name: all_fields
in: query
rameshnaraya
committed
required: false
moscatelli
committed
type: string
description: >
Include all complex attributes in the response. See clause 5.3 of ETSI GS NFV-SOL 013
for details. The NFVO shall support this parameter.
- name: fields
moscatelli
committed
in: query
rameshnaraya
committed
required: false
moscatelli
committed
type: string
description: >
Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV-SOL 013
for details. The NFVO should support this parameter.
- name: exclude_fields
moscatelli
committed
in: query
rameshnaraya
committed
required: false
moscatelli
committed
type: string
description: >
Complex attributes to be excluded from the response. See clause 5.3 of ETSI GS NFV-SOL 013
for details. The NFVO should support this parameter.
moscatelli
committed
- name: exclude_default
in: query
rameshnaraya
committed
required: false
moscatelli
committed
type: string
description: >
Indicates to exclude the following complex attributes from the response.
See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFVO shall support this
parameter.
rameshnaraya
committed
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:
moscatelli
committed
reports.
- name: nextpage_opaque_marker
description: >
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 5.4.2.1 of
ETSI GS NFV-SOL 013 for this resource.
moscatelli
committed
in: query
required: false
type: string
rameshnaraya
committed
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
moscatelli
committed
type: string
rameshnaraya
committed
responses:
moscatelli
committed
Shall be returned when information about zero or more PM jobs has been queried successfully.
The response body shall contain in an array the representations of
moscatelli
committed
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.
rameshnaraya
committed
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
moscatelli
committed
type: string
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
maximum: 1
moscatelli
committed
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
Link:
description: >
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
type: string
maximum: 1
minimum: 0
$ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmJob"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
moscatelli
committed
###############################################################################
# Individual PM job #
###############################################################################
rameshnaraya
committed
'/pm_jobs/{pmJobId}':
#ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.3
parameters:
- name: pmJobId
description: >
Identifier of the PM job.
This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response
to a POST request creating a new PM job resource. It can also be retrieved from the "id" attribute in the
payload body of that response.
rameshnaraya
committed
in: path
type: string
required: true
moscatelli
committed
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235.
in: header
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
rameshnaraya
committed
get:
rameshnaraya
committed
description: >
The API consumer can use this method for reading an individual PM job.
rameshnaraya
committed
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
moscatelli
committed
Reference: IETF RFC 7231.
rameshnaraya
committed
in: header
required: true
type: string
responses:
200:
moscatelli
committed
Shall be returned when information about an individual
PM job has been queried successfully.
The response body shall contain a representation of
the "Individual PM job resource", as defined in clause 7.5.2.7.
$ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmJob"
rameshnaraya
committed
headers:
moscatelli
committed
type: string
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message body.
rameshnaraya
committed
WWW-Authenticate:
moscatelli
committed
type: string
rameshnaraya
committed
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
moscatelli
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
patch:
summary: Modify a PM job.
description: >
This method allows to modify an "individual PM job" resource.
This method shall follow the provisions specified in the
Tables 7.4.3.3.4-1 and 7.4.3.3.4-2 for URI query parameters,
request and response data structures, and response codes.
parameters:
- name: pmJobModifications
in: body
required: true
schema:
$ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmJobModifications"
- name: Content-type
description: >
The Content-Type header shall be set to "application/merge-patch+json"
according to IETF RFC 7396.
in: header
required: true
type: string
enum:
- application/merge-patch+json
responses:
200:
description: >
200 OK
Shall be returned when the request has been processed successfully.
The response body shall contain a data structure of type "PmJobModifications".
headers:
WWW-Authenticate:
type: string
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
schema:
$ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmJobModifications"
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/412"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
rameshnaraya
committed
delete:
rameshnaraya
committed
description: >
This method terminates an individual PM job.
This method shall follow the provisions specified in the Tables 7.4.3.3.5-1
and 7.4.3.3.5-2 for URI query parameters, request and response data structures,
and response codes.
As the result of successfully executing this method, the "Individual PM job"
resource shall not exist any longer.
rameshnaraya
committed
responses:
204:
moscatelli
committed
description: >
moscatelli
committed
204 NO CONTENT
moscatelli
committed
Shall be returned when the PM job has been deleted successfully.
rameshnaraya
committed
The response body shall be empty.
headers:
WWW-Authenticate:
moscatelli
committed
type: string
rameshnaraya
committed
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
rameshnaraya
committed
maximum: 1
minimum: 0
moscatelli
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
rameshnaraya
committed
moscatelli
committed
###############################################################################
# Individual performance report #
###############################################################################
rameshnaraya
committed
'/pm_jobs/{pmJobId}/reports/{reportId}':
#ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.4
parameters:
- name: pmJobId
description: >
Identifier of the PM job.
in: path
type: string
required: true
- name: reportId
description: >
Identifier of the performance report.
in: path
type: string
required: true
moscatelli
committed
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235.
in: header
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
rameshnaraya
committed
get:
rameshnaraya
committed
description: >
The API consumer can use this method for reading an individual performance
rameshnaraya
committed
report.
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
moscatelli
committed
Reference: IETF RFC 7231.
rameshnaraya
committed
in: header
required: true
type: string
responses:
200:
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 7.5.2.10.
$ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PerformanceReport"
rameshnaraya
committed
headers:
moscatelli
committed
type: string
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message body.
rameshnaraya
committed
WWW-Authenticate:
moscatelli
committed
type: string
rameshnaraya
committed
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
moscatelli
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
rameshnaraya
committed
moscatelli
committed
###############################################################################
# Thresholds #
###############################################################################
rameshnaraya
committed
'/thresholds':
#ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.5
moscatelli
committed
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
rameshnaraya
committed
post:
moscatelli
committed
description: >
The POST method can be used by the API consumer to create
a threshold.
moscatelli
committed
This method shall follow the provisions specified in the
table 7.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 7.4.6 shall have been created.
rameshnaraya
committed
parameters:
moscatelli
committed
- name: CreateThresholdRequest
in: body
required: true
schema:
$ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/CreateThresholdRequest"
moscatelli
committed
description: >
Request parameters to create a new "Individual threshold" resource.
moscatelli
committed
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
rameshnaraya
committed
responses:
201:
moscatelli
committed
201 CREATED
moscatelli
committed
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 7.5.2.9.
The HTTP response shall include a "Location" HTTP
header that contains the resource URI of the created
threshold resource.
$ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/Threshold"
rameshnaraya
committed
headers:
moscatelli
committed
type: string
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message
body.
rameshnaraya
committed
WWW-Authenticate:
moscatelli
committed
type: string
rameshnaraya
committed
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
moscatelli
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
moscatelli
committed
summary: Query thresholds.
rameshnaraya
committed
description: >
The API consumer can use this method to query information about thresholds.
rameshnaraya
committed
parameters:
moscatelli
committed
- name: filter
in: query
rameshnaraya
committed
required: false
moscatelli
committed
type: string
description: >
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 OSS/BSS 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 NFVO in the filter expression.
moscatelli
committed
- name: nextpage_opaque_marker
in: query
required: false
type: string
description: >
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 5.4.2.1 of
ETSI GS NFV SOL 013for this resource.
rameshnaraya
committed
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
responses:
200:
moscatelli
committed
Shall be returned when information about zero or more thresholds was 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 representations of zero or more thresholds,
as defined in clause 7.5.2.9.
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.
rameshnaraya
committed
headers:
Content-Type:
description: The MIME type of the body of the response.
rameshnaraya
committed
type: string
rameshnaraya
committed
WWW-Authenticate:
moscatelli
committed
type: string
rameshnaraya
committed
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
maximum: 1
moscatelli
committed
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
Link:
description: >
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
type: string
maximum: 1
minimum: 0
rameshnaraya
committed
schema:
type: array
$ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/Threshold"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
moscatelli
committed
###############################################################################
# Individual threshold #
###############################################################################
rameshnaraya
committed
'/thresholds/{thresholdId}':
moscatelli
committed
#ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.6
parameters:
rameshnaraya
committed
- name: thresholdId
description: >
Identifier of the threshold.
This identifier can be retrieved from the resource referenced by the
"Location" HTTP header in the response to a POST request creating a
new threshold resource. It can also be retrieved from the "id"
attribute in the payload body of that response.
in: path
type: string
required: true
moscatelli
committed
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
rameshnaraya
committed
get:
rameshnaraya
committed
description: >
The API consumer can use this method for reading an individual
threshold.
This method shall follow the provisions specified in the
Tables 7.4.6.3.2-1 and 7.4.6.3.2-2 for URI query parameters,
request and response data structures, and response codes.
rameshnaraya
committed
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
responses:
200:
moscatelli
committed
Shall be returned when information about an individual threshold
has been queried successfully.
The response body shall contain a representation of
the threshold, as defined in clause 7.5.2.9.
$ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/Threshold"
rameshnaraya
committed
headers:
moscatelli
committed
type: string
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message body.
rameshnaraya
committed
WWW-Authenticate:
moscatelli
committed
type: string
rameshnaraya
committed
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
moscatelli
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
patch:
summary: Modify a Threshold
rameshnaraya
committed
description: >
This method allows to modify an "Individual threshold" resource.
This method shall follow the provisions specified in the Tables
7.4.6.3.4-1 and 7.4.6.3.4-2 for URI query parameters, request
and response data structures, and response codes.
rameshnaraya
committed
parameters:
- name: thresholdModifications
moscatelli
committed
in: body
required: true
schema:
$ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/ThresholdModifications"
- name: Content-type
rameshnaraya
committed
in: header
required: true
type: string
enum:
- application/merge-patch+json
rameshnaraya
committed
responses:
200:
moscatelli
committed
Shall be returned when the request has been processed successfully.
The response body shall contain a data structure of type "ThresholdModifications".
rameshnaraya
committed
headers:
WWW-Authenticate:
moscatelli
committed
type: string
rameshnaraya
committed
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
maximum: 1
moscatelli
committed
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
schema:
$ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/ThresholdModifications"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/412"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
rameshnaraya
committed
delete:
summary: Delete a Threshold.
rameshnaraya
committed
description: >
This method allows to delete a threshold.
Samir Medjiah
committed
As the result of successfully executing this method, the
"Individual threshold" resource shall not exist any longer.
rameshnaraya
committed
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
rameshnaraya
committed
in: header
required: true
type: string
responses:
204:
moscatelli
committed
description: >
moscatelli
committed
204 NO CONTENT
moscatelli
committed
Shall be returned when the threshold has been deleted successfully.
rameshnaraya
committed
The response body shall be empty.
headers:
WWW-Authenticate:
moscatelli
committed
type: string
rameshnaraya
committed
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
maximum: 1
moscatelli
committed
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
moscatelli
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
moscatelli
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
###############################################################################
# Subscriptions #
###############################################################################
# '/subscriptions':
# #ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.7
# parameters:
# - name: Authorization
# description: >
# The authorization token for the request.
# Reference: IETF RFC 7235.
# in: header
# required: false
# type: string
# - name: Version
# description: >
# Version of the API requested to use when responding to this request.
# in: header
# required: true