Commit e86f4900 authored by Samir Medjiah's avatar Samir Medjiah
Browse files

Merge branch '2.5.1-dev' of https://forge.etsi.org/gitlab/nfv/SOL002-SOL003 into 2.5.1-dev

parents 5fe0536d 058a4f8c
Pipeline #515 passed with stage
in 0 seconds
swagger: "2.0"
info:
version: "1.2.0"
title: "SOL002 - API version interface"
description: >
SOL002 - API version 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:
name: "ETSI Forge copyright notice"
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
contact:
name: "NFV-SOL WG"
externalDocs:
description: ETSI GS NFV-SOL 002 V2.5.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.05.01_60/gs_nfv-sol002v020501p.pdf
basePath: /{apiName}
schemes:
- http
- https
consumes:
- application/json
produces:
- application/json
paths:
###############################################################################
# API Versions #
###############################################################################
'/api-versions':
get:
summary: Retrieve API version information
description: >
The GET method reads API version information. This method shall follow the provisions specified in
table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not
supported.
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
responses:
200:
description: >
API version information was read successfully.
The response body shall contain 4.4 API version
information, as defined in clause 4.4.1.13.
schema:
$ref: '../../definitions/SOL002SOL003_def.yaml#/definitions/ApiVersionInformation'
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' }
401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' }
403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' }
404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' }
405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' }
406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' }
413: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/413' }
414: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/414' }
416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' }
422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' }
429: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/429' }
500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }
504: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/504' }
swagger: "2.0"
info:
version: "1.1.0"
version: "1.2.0"
title: "SOL002 - VNF Configuration interface"
description: >
SOL002 - VNF Configuration Interface
......@@ -36,6 +36,13 @@ paths:
The GET method reads API version information. This method shall follow the provisions specified in
table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not
supported.
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
responses:
200:
description: >
......@@ -50,6 +57,11 @@ paths:
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' }
401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' }
403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' }
......@@ -73,6 +85,13 @@ paths:
summary: Read VNF/VNFC configuration from VNF
description: >
The client can use this method to read configuration information about a VNF instance and/or its VNFC instances.
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
responses:
200:
description: >
......@@ -87,6 +106,11 @@ paths:
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' }
401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' }
403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' }
......@@ -114,6 +138,12 @@ paths:
in: body
schema:
$ref: 'definitions/VnfConfiguration_def.yaml#/definitions/VnfConfigModifications'
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
responses:
200:
description: >
......@@ -129,6 +159,11 @@ paths:
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' }
401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' }
403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' }
......
swagger: "2.0"
info:
version: "1.1.1"
version: "1.2.0"
title: SOL002 - VNF Configuration interface
description: >
VNF Configuration interface of ETSI NFV SOL002
......@@ -36,11 +36,69 @@ produces:
paths:
###############################################################################
# API Versions #
###############################################################################
'/api-versions':
get:
summary: Retrieve API version information
description: >
The GET method reads API version information. This method shall follow the provisions specified in
table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not
supported.
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
responses:
200:
description: >
API version information was read successfully.
The response body shall contain 4.4 API version
information, as defined in clause 4.4.1.13.
schema:
$ref: '../../definitions/SOL002SOL003_def.yaml#/definitions/ApiVersionInformation'
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' }
401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' }
403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' }
404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' }
405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' }
406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' }
413: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/413' }
414: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/414' }
416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' }
422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' }
429: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/429' }
500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }
504: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/504' }
###############################################################################
# Alarms #
###############################################################################
'/alarms':
#SOL003 location: 7.4.2
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
get:
description: >
The client can use this method to retrieve information about the alarm
......@@ -122,9 +180,12 @@ paths:
inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3.
headers:
Content-Type:
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
......@@ -136,6 +197,7 @@ paths:
type: string
maximum: 1
minimum: 0
schema:
$ref: "./definitions/VNFFaultManagement_def.yaml#/definitions/Alarm"
400:
......@@ -169,6 +231,12 @@ paths:
in: path
type: string
required: true
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
get:
description: >
The client can use this method to read an individual alarm.
......@@ -204,9 +272,12 @@ paths:
alarm.
headers:
Content-Type:
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
......@@ -275,9 +346,12 @@ paths:
resource.
headers:
Content-Type:
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
......@@ -314,6 +388,13 @@ paths:
###############################################################################
'/alarms/{alarmId}/escalate':
#SOL002 location: 7.4.4
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
post:
description: >
The POST method enables the consumer to escalate the perceived severity
......@@ -342,6 +423,12 @@ paths:
The VNFM has received the proposed "escalated perceived severity" value
successfully. The response body shall be empty.
headers:
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
401:
......@@ -364,6 +451,13 @@ paths:
###############################################################################
'/subscriptions':
#SOL003 location: 7.4.4
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
post:
description: >
The POST method creates a new subscription.
......@@ -406,9 +500,12 @@ paths:
points to the created subscription resource.
headers:
Content-Type:
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
......@@ -522,9 +619,12 @@ paths:
response shall follow the provisions in clause 4.7.2.3.
headers:
Content-Type:
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
......@@ -570,6 +670,12 @@ paths:
in: path
type: string
required: true
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
get:
description: >
The client can use this method for reading an individual subscription
......@@ -606,9 +712,12 @@ paths:
subscription resource.
headers:
Content-Type:
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
......@@ -655,10 +764,8 @@ paths:
The subscription resource was deleted successfully.
The response body shall be empty.
headers:
Content-Type:
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
......
......@@ -40,11 +40,69 @@ produces:
paths:
###############################################################################
# API Versions #
###############################################################################
'/api-versions':
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
get:
summary: Retrieve API version information
description: >
The GET method reads API version information. This method shall follow the provisions specified in
table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not
supported.
responses:
200:
description: >
API version information was read successfully.
The response body shall contain 4.4 API version
information, as defined in clause 4.4.1.13.
schema:
$ref: '../../definitions/SOL002SOL003_def.yaml#/definitions/ApiVersionInformation'
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' }
401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' }
403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' }
404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' }
405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' }
406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' }
413: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/413' }
414: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/414' }
416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' }
422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' }
429: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/429' }
500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }
504: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/504' }
###############################################################################
# VNF Indicators #
###############################################################################
/indicators:
get:
/indicators:
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
get:
summary: Query multiple indicators
description: Get a list of indicators. Support of attribute based filtering via query parameters.
parameters:
......@@ -100,6 +158,17 @@ paths:
i.e. zero or more representations of VNF indicators as defined in clause 8.5.2.2.
If the EM/VNF supports alternative 2 (paging) according to clause 4.7.2.1 for this resource,
inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
type: array
items:
......@@ -116,8 +185,7 @@ paths:
500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }
/indicators/{vnfInstanceId}:
/indicators/{vnfInstanceId}:
parameters:
- name: vnfInstanceId
in: path
......@@ -130,6 +198,12 @@ paths:
of that response.
type: string
required: true
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
get:
summary: Query multiple indicators related to a VNF instance.
description: >
......@@ -189,6 +263,17 @@ paths:
If the EM/VMF supports alternative 2 (paging) according to clause 4.7.2.1
for this resource, inclusion of the Link HTTP header in this response shall
follow the provisions in clause 4.7.2.3.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
type: array
items:
......@@ -206,7 +291,7 @@ paths:
503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }
/indicators/{vnfInstanceId}/{indicatorId}:
/indicators/{vnfInstanceId}/{indicatorId}:
parameters:
- name: vnfInstanceId
in: path
......@@ -226,6 +311,12 @@ paths:
# LEH NOTE from SOL002 is strange
type: string
required: true
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
get:
summary: Read an inidividual VNF indicator related to a VNF instance.
description: >
......@@ -240,6 +331,17 @@ paths:
The VNF indicator was read successfully.
The response body shall contain the representation of the VNF indicator.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: 'definitions/VnfIndicator_def.yaml#/definitions/VnfIndicator'
400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' }
......@@ -254,7 +356,7 @@ paths:
500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }
/indicators/{indicatorId}:
/indicators/{indicatorId}:
parameters:
- name: indicatorId
in: path
......@@ -262,6 +364,12 @@ paths:
Identifier of the VNF indicator.
type: string
required: true
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
get:
summary: Read an inidividual VNF indicator related to a VNF instance.
description: >
......@@ -273,6 +381,17 @@ paths:
The VNF indicator was read successfully.
The response body shall contain the representation of the VNF indicator.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1