Commit 058a4f8c authored by Giacomo Bernini's avatar Giacomo Bernini
Browse files

Updated API version resource, and Version HTTP Header - SOL002...

Updated API version resource, and Version HTTP Header - SOL002 #1,5,6,17,19,20,21,22,43,45,53,55,58,61,66,68
parent 1221d34f
Pipeline #505 failed with stages
in 0 seconds
swagger: "2.0" swagger: "2.0"
info: info:
version: "1.1.0" version: "1.2.0"
title: "SOL002 - VNF Configuration interface" title: "SOL002 - VNF Configuration interface"
description: > description: >
SOL002 - VNF Configuration Interface SOL002 - VNF Configuration Interface
...@@ -36,6 +36,13 @@ paths: ...@@ -36,6 +36,13 @@ paths:
The GET method reads API version information. This method shall follow the provisions specified in 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 table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not
supported. supported.
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
responses: responses:
200: 200:
description: > description: >
...@@ -50,6 +57,11 @@ paths: ...@@ -50,6 +57,11 @@ paths:
type: string type: string
maximum: 1 maximum: 1
minimum: 1 minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' }
401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' } 401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' }
403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' } 403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' }
...@@ -73,6 +85,13 @@ paths: ...@@ -73,6 +85,13 @@ paths:
summary: Read VNF/VNFC configuration from VNF summary: Read VNF/VNFC configuration from VNF
description: > description: >
The client can use this method to read configuration information about a VNF instance and/or its VNFC instances. 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: responses:
200: 200:
description: > description: >
...@@ -87,6 +106,11 @@ paths: ...@@ -87,6 +106,11 @@ paths:
type: string type: string
maximum: 1 maximum: 1
minimum: 1 minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' }
401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' } 401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' }
403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' } 403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' }
...@@ -114,6 +138,12 @@ paths: ...@@ -114,6 +138,12 @@ paths:
in: body in: body
schema: schema:
$ref: 'definitions/VnfConfiguration_def.yaml#/definitions/VnfConfigModifications' $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: responses:
200: 200:
description: > description: >
...@@ -129,6 +159,11 @@ paths: ...@@ -129,6 +159,11 @@ paths:
type: string type: string
maximum: 1 maximum: 1
minimum: 1 minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' }
401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' } 401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' }
403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' } 403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' }
......
swagger: "2.0" swagger: "2.0"
info: info:
version: "1.1.1" version: "1.2.0"
title: SOL002 - VNF Configuration interface title: SOL002 - VNF Configuration interface
description: > description: >
VNF Configuration interface of ETSI NFV SOL002 VNF Configuration interface of ETSI NFV SOL002
...@@ -36,11 +36,69 @@ produces: ...@@ -36,11 +36,69 @@ produces:
paths: 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 #
############################################################################### ###############################################################################
'/alarms': '/alarms':
#SOL003 location: 7.4.2 #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: get:
description: > description: >
The client can use this method to retrieve information about the alarm The client can use this method to retrieve information about the alarm
...@@ -122,9 +180,12 @@ paths: ...@@ -122,9 +180,12 @@ paths:
inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3. inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3.
headers: headers:
Content-Type: Content-Type:
description: > description: The MIME type of the body of the response.
The MIME type of the body of the request. type: string
Reference: IETF RFC 7231 maximum: 1
minimum: 1
Version:
description: The used API version.
type: string type: string
maximum: 1 maximum: 1
minimum: 1 minimum: 1
...@@ -136,6 +197,7 @@ paths: ...@@ -136,6 +197,7 @@ paths:
type: string type: string
maximum: 1 maximum: 1
minimum: 0 minimum: 0
schema: schema:
$ref: "./definitions/VNFFaultManagement_def.yaml#/definitions/Alarm" $ref: "./definitions/VNFFaultManagement_def.yaml#/definitions/Alarm"
400: 400:
...@@ -169,6 +231,12 @@ paths: ...@@ -169,6 +231,12 @@ paths:
in: path in: path
type: string type: string
required: true required: true
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
get: get:
description: > description: >
The client can use this method to read an individual alarm. The client can use this method to read an individual alarm.
...@@ -204,9 +272,12 @@ paths: ...@@ -204,9 +272,12 @@ paths:
alarm. alarm.
headers: headers:
Content-Type: Content-Type:
description: > description: The MIME type of the body of the response.
The MIME type of the body of the request. type: string
Reference: IETF RFC 7231 maximum: 1
minimum: 1
Version:
description: The used API version.
type: string type: string
maximum: 1 maximum: 1
minimum: 1 minimum: 1
...@@ -275,9 +346,12 @@ paths: ...@@ -275,9 +346,12 @@ paths:
resource. resource.
headers: headers:
Content-Type: Content-Type:
description: > description: The MIME type of the body of the response.
The MIME type of the body of the request. type: string
Reference: IETF RFC 7231 maximum: 1
minimum: 1
Version:
description: The used API version.
type: string type: string
maximum: 1 maximum: 1
minimum: 1 minimum: 1
...@@ -314,6 +388,13 @@ paths: ...@@ -314,6 +388,13 @@ paths:
############################################################################### ###############################################################################
'/alarms/{alarmId}/escalate': '/alarms/{alarmId}/escalate':
#SOL002 location: 7.4.4 #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: post:
description: > description: >
The POST method enables the consumer to escalate the perceived severity The POST method enables the consumer to escalate the perceived severity
...@@ -342,6 +423,12 @@ paths: ...@@ -342,6 +423,12 @@ paths:
The VNFM has received the proposed "escalated perceived severity" value The VNFM has received the proposed "escalated perceived severity" value
successfully. The response body shall be empty. successfully. The response body shall be empty.
headers:
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
400: 400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
401: 401:
...@@ -364,6 +451,13 @@ paths: ...@@ -364,6 +451,13 @@ paths:
############################################################################### ###############################################################################
'/subscriptions': '/subscriptions':
#SOL003 location: 7.4.4 #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: post:
description: > description: >
The POST method creates a new subscription. The POST method creates a new subscription.
...@@ -406,9 +500,12 @@ paths: ...@@ -406,9 +500,12 @@ paths:
points to the created subscription resource. points to the created subscription resource.
headers: headers:
Content-Type: Content-Type:
description: > description: The MIME type of the body of the response.
The MIME type of the body of the request. type: string
Reference: IETF RFC 7231 maximum: 1
minimum: 1
Version:
description: The used API version.
type: string type: string
maximum: 1 maximum: 1
minimum: 1 minimum: 1
...@@ -522,9 +619,12 @@ paths: ...@@ -522,9 +619,12 @@ paths:
response shall follow the provisions in clause 4.7.2.3. response shall follow the provisions in clause 4.7.2.3.
headers: headers:
Content-Type: Content-Type:
description: > description: The MIME type of the body of the response.
The MIME type of the body of the request. type: string
Reference: IETF RFC 7231 maximum: 1
minimum: 1
Version:
description: The used API version.
type: string type: string
maximum: 1 maximum: 1
minimum: 1 minimum: 1
...@@ -570,6 +670,12 @@ paths: ...@@ -570,6 +670,12 @@ paths:
in: path in: path
type: string type: string
required: true required: true
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
get: get:
description: > description: >
The client can use this method for reading an individual subscription The client can use this method for reading an individual subscription
...@@ -606,9 +712,12 @@ paths: ...@@ -606,9 +712,12 @@ paths:
subscription resource. subscription resource.
headers: headers:
Content-Type: Content-Type:
description: > description: The MIME type of the body of the response.
The MIME type of the body of the request. type: string
Reference: IETF RFC 7231 maximum: 1
minimum: 1
Version:
description: The used API version.
type: string type: string
maximum: 1 maximum: 1
minimum: 1 minimum: 1
...@@ -655,10 +764,8 @@ paths: ...@@ -655,10 +764,8 @@ paths:
The subscription resource was deleted successfully. The subscription resource was deleted successfully.
The response body shall be empty. The response body shall be empty.
headers: headers:
Content-Type: Version:
description: > description: The used API version.
The MIME type of the body of the request.
Reference: IETF RFC 7231
type: string type: string
maximum: 1 maximum: 1
minimum: 1 minimum: 1
......
...@@ -40,11 +40,69 @@ produces: ...@@ -40,11 +40,69 @@ produces:
paths: 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 # # VNF Indicators #
############################################################################### ###############################################################################
/indicators: /indicators:
get: 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 summary: Query multiple indicators
description: Get a list of indicators. Support of attribute based filtering via query parameters. description: Get a list of indicators. Support of attribute based filtering via query parameters.
parameters: parameters:
...@@ -100,6 +158,17 @@ paths: ...@@ -100,6 +158,17 @@ paths:
i.e. zero or more representations of VNF indicators as defined in clause 8.5.2.2. 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, 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. 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: schema:
type: array type: array
items: items:
...@@ -116,8 +185,7 @@ paths: ...@@ -116,8 +185,7 @@ paths:
500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } 500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }
/indicators/{vnfInstanceId}:
/indicators/{vnfInstanceId}:
parameters: parameters:
- name: vnfInstanceId - name: vnfInstanceId
in: path in: path
...@@ -130,6 +198,12 @@ paths: ...@@ -130,6 +198,12 @@ paths:
of that response. of that response.
type: string type: string
required: true required: true
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
get: get:
summary: Query multiple indicators related to a VNF instance. summary: Query multiple indicators related to a VNF instance.
description: > description: >
...@@ -189,6 +263,17 @@ paths: ...@@ -189,6 +263,17 @@ paths:
If the EM/VMF supports alternative 2 (paging) according to clause 4.7.2.1 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 for this resource, inclusion of the Link HTTP header in this response shall
follow the provisions in clause 4.7.2.3. 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: schema:
type: array type: array
items: items:
...@@ -206,7 +291,7 @@ paths: ...@@ -206,7 +291,7 @@ paths:
503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }
/indicators/{vnfInstanceId}/{indicatorId}: /indicators/{vnfInstanceId}/{indicatorId}:
parameters: parameters:
- name: vnfInstanceId - name: vnfInstanceId
in: path