Skip to content
GitLab
Commit 11542aeb authored by Giacomo Bernini's avatar Giacomo Bernini
Browse files

updates related to SOL002_5 and SOL002_6

parent 724fee2d
Pipeline #736 passed with stage
in 0 seconds
Hide whitespace changes
Inline Side-by-side
src/SOL002/APIVersion/APIVersion.yaml
View file @ 11542aeb
......@@ -30,19 +30,19 @@ 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.
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: >
......
src/SOL002/VNFConfiguration/VNFConfiguration.yaml
View file @ 11542aeb
......@@ -30,19 +30,19 @@ paths:
# API Versions #
###############################################################################
'/api-versions':
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
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.
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: >
......@@ -81,17 +81,17 @@ paths:
# VNF Configuration #
###############################################################################
'/configuration':
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
get:
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: >
......@@ -138,12 +138,6 @@ 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: >
......
src/SOL002/VNFConfiguration/responses/VNFConfiguration_resp.yaml
View file @ 11542aeb
......@@ -12,5 +12,10 @@ responses:
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml
View file @ 11542aeb
......@@ -40,19 +40,19 @@ paths:
# API Versions #
###############################################################################
'/api-versions':
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
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.
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: >
......@@ -97,7 +97,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
get:
description: >
......@@ -235,7 +235,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
get:
description: >
......@@ -384,7 +384,7 @@ paths:
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
###############################################################################
# Escalate Perceived Severity task #
# Escalate Perceived Severity task #
###############################################################################
'/alarms/{alarmId}/escalate':
#SOL002 location: 7.4.4
......@@ -393,7 +393,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
post:
description: >
......@@ -456,7 +456,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
post:
description: >
......@@ -674,7 +674,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
get:
description: >
......
src/SOL002/VNFFaultManagement/responses/VNFFaultManagement_resp.yaml
View file @ 11542aeb
......@@ -27,5 +27,10 @@ responses:
type: string
maximum: 1
minimum: 0
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
src/SOL002/VNFIndicator/VNFIndicator.yaml
View file @ 11542aeb
......@@ -2,7 +2,7 @@
swagger: "2.0"
info:
version: "1.1.1"
version: "1.2.0"
title: "SOL002 - VNF Indicator interface"
description: >
VNF Indicator interface of ETSI NFV SOL002.
......@@ -23,8 +23,8 @@ info:
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
externalDocs:
description: ETSI GS NFV-SOL 002 V2.4.1
url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.04.01_60/gs_NFV-SOL002v020401p.pdf
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: /vnfind/v1
......@@ -49,7 +49,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
get:
summary: Retrieve API version information
......@@ -100,7 +100,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
get:
summary: Query multiple indicators
......@@ -202,7 +202,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
get:
summary: Query multiple indicators related to a VNF instance.
......@@ -315,7 +315,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
get:
summary: Read an inidividual VNF indicator related to a VNF instance.
......@@ -368,7 +368,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
get:
summary: Read an inidividual VNF indicator related to a VNF instance.
......@@ -412,7 +412,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
post:
summary: Create a new subscription to VNF indicator change notifications
......@@ -556,7 +556,7 @@ paths:
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
required: true
type: string
get:
summary: Read an individual subscription.
......
src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml
View file @ 11542aeb
swagger: "2.0"
info:
version: "1.1.1"
version: "1.2.0"
title: "SOL002 - VNF Indicator Notification Endpoint interface"
description: >
VNF Indicator Notification Endpoint interface of ETSI NFV SOL002
......@@ -22,9 +22,7 @@ externalDocs:
description: ETSI GS NFV-SOL 002 V2.4.1
url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.04.01_60/gs_NFV-SOL002v020401p.pdf
basePath: /callback/v1
schemes:
schemes:
- http
- https
......@@ -38,6 +36,13 @@ produces:
paths:
/notificationendpoint:
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
post:
summary: Notification endpoint
description: >
......@@ -59,6 +64,13 @@ paths:
No Content
The notification was delivered 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: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' }
403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' }
......@@ -83,6 +95,12 @@ paths:
No Content
The notification endpoint was tested 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: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' }
403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' }
......
src/SOL002/VNFIndicatorNotification/responses/VNFIndicatorNotification_resp.yaml
View file @ 11542aeb
......@@ -12,5 +12,10 @@ responses:
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml
View file @ 11542aeb
......@@ -39,6 +39,13 @@ paths:
# API Versions #
###############################################################################
'/api-versions':
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
get:
summary: Retrieve API version information
description: >
......@@ -83,6 +90,13 @@ paths:
###############################################################################
'/vnf_instances':
#SOL003 location: 5.4.2
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
post:
#TODO: Add headers defined in 4.3.4.2
description: "The POST method creates a new VNF instance resource."
......@@ -138,6 +152,11 @@ paths:
type: string
maximum: 1
minimum: 0
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
400:
......@@ -268,6 +287,11 @@ paths:
type: string
maximum: 1
minimum: 0
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
type: array
items:
......@@ -308,6 +332,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: true
type: string
get:
description: >
Information about an individual VNF instance was queried successfully.
......@@ -333,6 +363,11 @@ paths:
type: string
maximum: 1
minimum: 0
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
400:
......@@ -415,6 +450,11 @@ paths:
type: string
maximum: 1
minimum: 0
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400-attr-selector"
401:
......@@ -451,6 +491,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: true
type: string
post:
#SOL003 location: 5.4.4.3.1
description: >
......@@ -484,6 +530,11 @@ paths:
type: string
maximum: 1
minimum: 0
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
$ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
400:
......@@ -522,6 +573,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: true
type: string
post:
#SOL003 location: 5.4.5.3.1
description: >
......@@ -571,6 +628,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: true
type: string
post:
#SOL003 location: 5.4.6.3.1
description: >
......@@ -621,6 +684,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: true
type: string
post:
description: >
The POST method changes the deployment flavour of a VNF instance.
......@@ -668,6 +737,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: true
type: string
post:
description: >
The POST method terminates a VNF instance.
......@@ -715,6 +790,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: true
type: string
post:
description: >
The POST method requests to heal a VNF instance resource.
......@@ -762,6 +843,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: true
type: string
post:
description: >
The POST method changes the operational state of a VNF instance resource.
......@@ -810,6 +897,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: true
type: string
post:
description: >
The POST method changes the external connectivity of a VNF instance.
......@@ -847,6 +940,13 @@ paths:
###############################################################################
'/vnf_lcm_op_occs':
#SOL003 location: 5.4.12
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
get:
description: >
The client can use this method to query status information about
......@@ -928,6 +1028,12 @@ paths:
in: query
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
responses:
200:
description: >
......@@ -953,6 +1059,12 @@ paths:
type: string
maximum: 1
minimum: 0
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
schema:
$ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc"
400:
......@@ -990,6 +1102,12 @@ paths:
in: path
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:
description: >
The client can use this method to retrieve status information about a
......@@ -1019,6 +1137,12 @@ paths:
type: string
maximum: 1
minimum: 0
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema:
schema:
$ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc"
400:
......@@ -1056,6 +1180,12 @@ paths:
in: path
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true