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#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
moscatelli
committed
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/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#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/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#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/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
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
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#/responses/400"
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
412:
$ref: "../responses/SOL005_resp.yaml#/responses/412"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/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#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/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#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/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#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/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#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/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#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/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#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
412:
$ref: "../responses/SOL005_resp.yaml#/responses/412"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/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#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
moscatelli
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
$ref: "../responses/SOL005_resp.yaml#/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
# type: string
#
# post:
# summary: Subscribe to PM notifications.
# description: >
# The POST method creates a new subscription.
# This method shall follow the provisions specified in the Tables 7.4.7.3.1-1 and 7.4.7.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 subscription" resource shall exist as defined
# in clause 7.4.8. This method shall not trigger any notification.
# Creation of two subscription resources with the same callbackURI and the same filter can result in performance
# degradation and will provide duplicates of notifications to the OSS, and might make sense only in very rare use cases.
# Consequently, the NFVO may either allow creating a subscription resource if another subscription resource with the
# same filter and callbackUri already exists (in which case it shall return the "201 Created" response code), or may decide
# to not create a duplicate subscription resource (in which case it shall return a "303 See Other" response code referencing
# the existing subscription resource with the same filter and callbackUri)
# 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
# - name: body
# in: body
# required: true
# schema:
# $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmSubscriptionRequest"
# description: >
# Details of the subscription to be created.
# responses:
# 201:
# description: >
# 201 CREATED
#
# Shall be returned when the subscription has been created successfully.
# A representation of the created subscription resource
# shall be returned in the response body, as defined in clause 7.5.2.3.
# The HTTP response shall include a "Location" HTTP
# header that contains the resource URI of the created subscription resource.
# schema:
# $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmSubscription"
# headers:
# Content-Type:
# 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.
# maximum: 1
# minimum: 1
# 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
# 303:
# $ref: "../responses/SOL005_resp.yaml#/responses/303"
# 400:
# $ref: "../responses/SOL005_resp.yaml#/responses/400"
# 401:
# $ref: "../responses/SOL005_resp.yaml#/responses/401"
# 403:
# $ref: "../responses/SOL005_resp.yaml#/responses/403"
# 404:
# $ref: "../responses/SOL005_resp.yaml#/responses/404"
# 405:
# $ref: "../responses/SOL005_resp.yaml#/responses/405"
# 406:
# $ref: "../responses/SOL005_resp.yaml#/responses/406"
# 500:
# $ref: "../responses/SOL005_resp.yaml#/responses/500"
# 503:
# $ref: "../responses/SOL005_resp.yaml#/responses/503"
#
# get:
# summary: Query PM related subscriptions.
# description: >
# The client can use this method to query the list of active subscriptions to Performance management notifications
# subscribed by the client.
# This method shall follow the provisions specified in the Tables 7.4.7.3.2-1 and 7.4.7.3.2-2 for URI query parameters,
# request and response data structures, and response codes.
# parameters:
# - name: filter
# in: query
# required: false
# 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 PmSubscription and in data types referenced from it
# shall be supported by the NFVO in the filter expression.
# - 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 013 for this resource.
# - name: Accept
# description: >
# Content-Types that are acceptable for the response.
# Reference: IETF RFC 7231.
# in: header
# required: true
# type: string
# responses:
# 200:
# description: >
# 200 OK
#
# Shall be returned when the list of subscriptions has
# been queried successfully.
# The response body shall contain the representations of
# all active subscriptions of the functional block that
# invokes the method, as defined in clause 7.5.2.3.
# 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.
# 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:
# Content-Type:
# description: The MIME type of the body of the response.
# type: string
# maximum: 1
# minimum: 1
# 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
# 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
# schema:
# type: array
# items:
# $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmSubscription"
# 400:
# $ref: "../responses/SOL005_resp.yaml#/responses/400"
# 401:
# $ref: "../responses/SOL005_resp.yaml#/responses/401"
# 403:
# $ref: "../responses/SOL005_resp.yaml#/responses/403"
# 404:
# $ref: "../responses/SOL005_resp.yaml#/responses/404"
# 405:
# $ref: "../responses/SOL005_resp.yaml#/responses/405"
# 406:
# $ref: "../responses/SOL005_resp.yaml#/responses/406"
# 500:
# $ref: "../responses/SOL005_resp.yaml#/responses/500"
# 503:
# $ref: "../responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# Individual subscription #
###############################################################################
# '/subscriptions/{subscriptionId}':
# #ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.8
# parameters:
# - name: subscriptionId
# description: >
# Identifier of the subscription.
# This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response
# to a POST request creating a new subscription resource. It can also be retrieved from the "id" attribute in the
# payload body of that response.
# in: path
# type: string
# required: true
# - 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
#
# get:
# summary: Query a single PM related subscription.
# description: >
# The client can use this method for reading an individual subscription about Performance management notifications
# subscribed by the client.
# This method shall follow the provisions specified in the Tables 7.4.8.3.2-1 and 7.4.8.3.2-2 for URI query parameters,
# request and response data structures, and response codes.
# parameters:
# - name: Accept
# description: >
# Content-Types that are acceptable for the response.
# Reference: IETF RFC 7231
# in: header
# required: true
# type: string
# responses:
# 200:
# description: >
# 200 OK
#
# Shall be returned when the subscription has been read successfully.
# The response body shall contain a representation of
# the subscription resource, as defined in clause 7.5.2.3.
# schema:
# $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmSubscription"
# headers:
# Content-Type:
# 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:
# 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
# 400:
# $ref: "../responses/SOL005_resp.yaml#/responses/400"
# 401:
# $ref: "../responses/SOL005_resp.yaml#/responses/401"
# 403:
# $ref: "../responses/SOL005_resp.yaml#/responses/403"
# 404:
# $ref: "../responses/SOL005_resp.yaml#/responses/404"
# 405:
# $ref: "../responses/SOL005_resp.yaml#/responses/405"
# 406:
# $ref: "../responses/SOL005_resp.yaml#/responses/406"
# 500:
# $ref: "../responses/SOL005_resp.yaml#/responses/500"
# 503:
# $ref: "../responses/SOL005_resp.yaml#/responses/503"
#
# delete:
# summary: Terminate a subscription.
# description: >
# This method terminates an individual subscription.
# This method shall follow the provisions specified in the
# Tables 7.4.8.3.5-1 and 7.4.8.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 subscription" resource shall not exist any longer.
# This means that no notifications for that subscription shall
# be sent to the formerly-subscribed API consumer.
# NOTE: Due to race conditions, some notifications might still be
# received by the formerly-subscribed API consumer for a
# certain time period after the deletion.
# parameters:
# - name: Accept
# description: >
# Content-Types that are acceptable for the response.
# Reference: IETF RFC 7231.
# in: header
# required: true
# type: string
# responses:
# 204:
# description: >
# 204 NO CONTENT
#
# Shall be returned when the subscription resource has been
# deleted successfully.
# The response body shall be empty.
# 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
# 400:
# $ref: "../responses/SOL005_resp.yaml#/responses/400"
# 401:
# $ref: "../responses/SOL005_resp.yaml#/responses/401"
# 403:
# $ref: "../responses/SOL005_resp.yaml#/responses/403"
# 404:
# $ref: "../responses/SOL005_resp.yaml#/responses/404"
# 405:
# $ref: "../responses/SOL005_resp.yaml#/responses/405"
# 406:
# $ref: "../responses/SOL005_resp.yaml#/responses/406"
# 500:
# $ref: "../responses/SOL005_resp.yaml#/responses/500"
# 503:
# $ref: "../responses/SOL005_resp.yaml#/responses/503"