Skip to content
GitLab
Commit fdff003d authored by Samir Medjiah's avatar Samir Medjiah
Browse files

SOL005: NS PM interface migrated to OpenAPI 3.0.2

parent 36f59b63
Hide whitespace changes
Inline Side-by-side
src/SOL005/NSDManagement/NSDManagement.yaml
View file @ fdff003d
......@@ -1378,7 +1378,7 @@ components:
content:
application/json:
schema:
ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreateNsdInfoRequest"
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreateNsdInfoRequest"
required: true
NsdInfoModifications:
......
src/SOL005/NSPerformanceManagement/NSPerformanceManagement.yaml
View file @ fdff003d
swagger: "2.0"
openapi: 3.0.2
info:
version: "2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: "SOL005 - NS Performance Management Interface"
description: >
title: SOL005 - NS Performance Management Interface
description: |
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
contact:
name: NFV-SOL WG
license:
name: "ETSI Forge copyright notice"
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
contact:
name: "NFV-SOL WG"
version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
externalDocs:
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
basePath: /nspm/v2
schemes:
- http
- https
consumes:
- application/json
description: ETSI GS NFV-SOL 005 V3.3.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.06.01_60/gs_NFV-SOL005v020701p.pdf
produces:
- application/json
servers:
- url: http://127.0.0.1/nspm/v2
- url: https://127.0.0.1/nspm/v2
paths:
###############################################################################
# API Versions #
###############################################################################
'/api_versions':
/api_versions:
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
###############################################################################
# PM Jobs #
###############################################################################
'/pm_jobs':
/pm_jobs:
#ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.2
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
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
post:
summary: Create a PM job.
description: >
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,
......@@ -69,61 +53,11 @@ paths:
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.
parameters:
- name: CreatePmJobRequest
in: body
required: true
schema:
$ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/CreatePmJobRequest"
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
requestBody:
$ref: '#/components/requestBodies/CreatePmJobRequest'
responses:
201:
description: >
201 CREATED
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.
schema:
$ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmJob"
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
$ref: '#/components/responses/PMJobs.Post.201'
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
401:
......@@ -143,122 +77,18 @@ paths:
get:
summary: Query PM jobs.
description: >
description: |
The API consumer can use this method to retrieve information about PM jobs.
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 PmJob and in data types referenced from it
shall be supported by the NFVO in the filter expression.
- name: all_fields
in: query
required: false
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
in: query
required: false
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
in: query
required: false
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.
- name: exclude_default
in: query
required: false
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.
The following attributes shall be excluded from the PmJob structure in the response
body if this parameter is provided, or none of the parameters "all_fields," "fields",
"exclude_fields", "exclude_default" are provided:
reports.
- 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.
in: query
required: false
type: string
- 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
- $ref: ../components/SOL005_params.yaml#/components/parameters/filter
- $ref: ../components/SOL005_params.yaml#/components/parameters/all_fields
- $ref: ../components/SOL005_params.yaml#/components/parameters/fields
- $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_fields
- $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_default
- $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
responses:
200:
description: >
200 OK
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
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:
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/PmJob"
$ref: '#/components/responses/PMJobs.Get.200'
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
401:
......@@ -279,75 +109,22 @@ paths:
###############################################################################
# Individual PM job #
###############################################################################
'/pm_jobs/{pmJobId}':
/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.
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
- $ref: '#/components/parameters/PmJobId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
get:
summary: Read a single PM job.
description: >
description: |
The API consumer can use this method for reading an individual PM job.
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231.
in: header
required: true
type: string
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
responses:
200:
description: >
200 OK
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.
schema:
$ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmJob"
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
$ref: '#/components/responses/IndividualPMJob.Get.200'
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
401:
......@@ -367,50 +144,18 @@ paths:
patch:
summary: Modify a PM job.
description: >
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
- $ref: '#/components/parameters/ContentTypeMergePatchJSON'
requestBody:
$ref: '#/components/requestBodies/PmJobModifications'
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"
$ref: '#/components/responses/IndividualPMJob.Patch.200'
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
401:
......@@ -432,7 +177,7 @@ paths:
delete:
summary: Delete a PM job.
description: >
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,
......@@ -441,26 +186,7 @@ paths:
resource shall not exist any longer.
responses:
204:
description: >
204 NO CONTENT
Shall be returned when the PM job 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
$ref: '#/components/responses/IndividualPMJob.Delete.204'
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
401:
......@@ -481,79 +207,24 @@ paths:
###############################################################################
# Individual performance report #
###############################################################################
'/pm_jobs/{pmJobId}/reports/{reportId}':
/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
- 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
- $ref: '#/components/parameters/PmJobId'
- $ref: '#/components/parameters/ReportId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
get:
summary: Read an individual performance report.
description: >
description: |
The API consumer can use this method for reading an individual performance
report.
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231.
in: header
required: true
type: string
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
responses:
200:
description: >
200 OK
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.
schema:
$ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PerformanceReport"
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
$ref: '#/components/responses/IndividualPerformanceReport.Get.200'
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
401:
......@@ -574,26 +245,16 @@ paths:
###############################################################################
# Thresholds #
###############################################################################
'/thresholds':
/thresholds:
#ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.5
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
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
post:
summary: Create a threshold.
description: >
description: |
The POST method can be used by the API consumer to create
a threshold.
......@@ -605,61 +266,12 @@ paths:
"Individual threshold" resource as defined
in clause 7.4.6 shall have been created.
parameters:
- name: CreateThresholdRequest
in: body
required: true
schema:
$ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/CreateThresholdRequest"
description: >
Request parameters to create a new "Individual threshold" resource.
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string