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
...@@ -30,12 +30,6 @@ paths: ...@@ -30,12 +30,6 @@ paths:
# API Versions # # API Versions #
############################################################################### ###############################################################################
'/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: parameters:
- name: Version - name: Version
description: > description: >
...@@ -43,6 +37,12 @@ paths: ...@@ -43,6 +37,12 @@ paths:
in: header in: header
required: false required: false
type: string 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: responses:
200: 200:
description: > description: >
......
...@@ -30,19 +30,19 @@ paths: ...@@ -30,19 +30,19 @@ paths:
# API Versions # # API Versions #
############################################################################### ###############################################################################
'/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: parameters:
- name: Version - name: Version
description: > description: >
Version of the API requested to use when responding to this request. Version of the API requested to use when responding to this request.
in: header in: header
required: false required: true
type: string 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: responses:
200: 200:
description: > description: >
...@@ -81,17 +81,17 @@ paths: ...@@ -81,17 +81,17 @@ paths:
# VNF Configuration # # VNF Configuration #
############################################################################### ###############################################################################
'/configuration': '/configuration':
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: parameters:
- name: Version - name: Version
description: > description: >
Version of the API requested to use when responding to this request. Version of the API requested to use when responding to this request.
in: header in: header
required: false required: true
type: string 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.
responses: responses:
200: 200:
description: > description: >
...@@ -138,12 +138,6 @@ paths: ...@@ -138,12 +138,6 @@ 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: >
......
...@@ -12,5 +12,10 @@ responses: ...@@ -12,5 +12,10 @@ responses:
type: string type: string
maximum: 1 maximum: 1
minimum: 1 minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema: schema:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
...@@ -40,19 +40,19 @@ paths: ...@@ -40,19 +40,19 @@ paths:
# API Versions # # API Versions #
############################################################################### ###############################################################################
'/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: parameters:
- name: Version - name: Version
description: > description: >
Version of the API requested to use when responding to this request. Version of the API requested to use when responding to this request.
in: header in: header
required: false required: true
type: string 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: responses:
200: 200:
description: > description: >
...@@ -97,7 +97,7 @@ paths: ...@@ -97,7 +97,7 @@ paths:
description: > description: >
Version of the API requested to use when responding to this request. Version of the API requested to use when responding to this request.
in: header in: header
required: false required: true
type: string type: string
get: get:
description: > description: >
...@@ -235,7 +235,7 @@ paths: ...@@ -235,7 +235,7 @@ paths:
description: > description: >
Version of the API requested to use when responding to this request. Version of the API requested to use when responding to this request.
in: header in: header
required: false required: true
type: string type: string
get: get:
description: > description: >
...@@ -393,7 +393,7 @@ paths: ...@@ -393,7 +393,7 @@ paths:
description: > description: >
Version of the API requested to use when responding to this request. Version of the API requested to use when responding to this request.
in: header in: header
required: false required: true
type: string type: string
post: post:
description: > description: >
...@@ -456,7 +456,7 @@ paths: ...@@ -456,7 +456,7 @@ paths:
description: > description: >
Version of the API requested to use when responding to this request. Version of the API requested to use when responding to this request.
in: header in: header
required: false required: true
type: string type: string
post: post:
description: > description: >
...@@ -674,7 +674,7 @@ paths: ...@@ -674,7 +674,7 @@ paths:
description: > description: >
Version of the API requested to use when responding to this request. Version of the API requested to use when responding to this request.
in: header in: header
required: false required: true
type: string type: string
get: get:
description: > description: >
......
...@@ -27,5 +27,10 @@ responses: ...@@ -27,5 +27,10 @@ responses:
type: string type: string
maximum: 1 maximum: 1
minimum: 0 minimum: 0
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema: schema:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
swagger: "2.0" swagger: "2.0"
info: info:
version: "1.1.1" version: "1.2.0"
title: "SOL002 - VNF Indicator interface" title: "SOL002 - VNF Indicator interface"
description: > description: >
VNF Indicator interface of ETSI NFV SOL002. VNF Indicator interface of ETSI NFV SOL002.
...@@ -23,8 +23,8 @@ info: ...@@ -23,8 +23,8 @@ info:
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
externalDocs: externalDocs:
description: ETSI GS NFV-SOL 002 V2.4.1 description: ETSI GS NFV-SOL 002 V2.5.1
url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.04.01_60/gs_NFV-SOL002v020401p.pdf url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.05.01_60/gs_nfv-sol002v020501p.pdf
basePath: /vnfind/v1 basePath: /vnfind/v1
...@@ -49,7 +49,7 @@ paths: ...@@ -49,7 +49,7 @@ paths:
description: > description: >
Version of the API requested to use when responding to this request. Version of the API requested to use when responding to this request.
in: header in: header
required: false required: true
type: string type: string
get: get:
summary: Retrieve API version information summary: Retrieve API version information
...@@ -100,7 +100,7 @@ paths: ...@@ -100,7 +100,7 @@ paths:
description: > description: >
Version of the API requested to use when responding to this request. Version of the API requested to use when responding to this request.
in: header in: header
required: false required: true
type: string type: string
get: get:
summary: Query multiple indicators summary: Query multiple indicators
...@@ -202,7 +202,7 @@ paths: ...@@ -202,7 +202,7 @@ paths:
description: > description: >
Version of the API requested to use when responding to this request. Version of the API requested to use when responding to this request.
in: header in: header
required: false required: true
type: string type: string
get: get:
summary: Query multiple indicators related to a VNF instance. summary: Query multiple indicators related to a VNF instance.
...@@ -315,7 +315,7 @@ paths: ...@@ -315,7 +315,7 @@ paths:
description: > description: >
Version of the API requested to use when responding to this request. Version of the API requested to use when responding to this request.
in: header in: header
required: false required: true
type: string type: string
get: get:
summary: Read an inidividual VNF indicator related to a VNF instance. summary: Read an inidividual VNF indicator related to a VNF instance.
...@@ -368,7 +368,7 @@ paths: ...@@ -368,7 +368,7 @@ paths:
description: > description: >
Version of the API requested to use when responding to this request. Version of the API requested to use when responding to this request.
in: header in: header
required: false required: true
type: string type: string
get: get:
summary: Read an inidividual VNF indicator related to a VNF instance. summary: Read an inidividual VNF indicator related to a VNF instance.
...@@ -412,7 +412,7 @@ paths: ...@@ -412,7 +412,7 @@ paths:
description: > description: >
Version of the API requested to use when responding to this request. Version of the API requested to use when responding to this request.
in: header in: header
required: false required: true
type: string type: string
post: post:
summary: Create a new subscription to VNF indicator change notifications summary: Create a new subscription to VNF indicator change notifications
...@@ -556,7 +556,7 @@ paths: ...@@ -556,7 +556,7 @@ paths:
description: > description: >
Version of the API requested to use when responding to this request. Version of the API requested to use when responding to this request.
in: header in: header
required: false required: true
type: string type: string
get: get:
summary: Read an individual subscription. summary: Read an individual subscription.
......
swagger: "2.0" swagger: "2.0"
info: info:
version: "1.1.1" version: "1.2.0"
title: "SOL002 - VNF Indicator Notification Endpoint interface" title: "SOL002 - VNF Indicator Notification Endpoint interface"
description: > description: >
VNF Indicator Notification Endpoint interface of ETSI NFV SOL002 VNF Indicator Notification Endpoint interface of ETSI NFV SOL002
...@@ -22,8 +22,6 @@ externalDocs: ...@@ -22,8 +22,6 @@ externalDocs:
description: ETSI GS NFV-SOL 002 V2.4.1 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 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 - http
- https - https
...@@ -38,6 +36,13 @@ produces: ...@@ -38,6 +36,13 @@ produces:
paths: paths:
/notificationendpoint: /notificationendpoint:
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
post: post:
summary: Notification endpoint summary: Notification endpoint
description: > description: >
...@@ -59,6 +64,13 @@ paths: ...@@ -59,6 +64,13 @@ paths:
No Content No Content
The notification was delivered successfully. The response body shall be empty. 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' } 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' }
...@@ -83,6 +95,12 @@ paths: ...@@ -83,6 +95,12 @@ paths:
No Content No Content
The notification endpoint was tested successfully. The response body shall be empty. 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' } 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' }
......
...@@ -12,5 +12,10 @@ responses: ...@@ -12,5 +12,10 @@ responses:
type: string type: string
maximum: 1 maximum: 1
minimum: 1 minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema: schema:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
...@@ -39,6 +39,13 @@ paths: ...@@ -39,6 +39,13 @@ paths:
# API Versions # # API Versions #
############################################################################### ###############################################################################
'/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: get:
summary: Retrieve API version information summary: Retrieve API version information
description: > description: >
...@@ -83,6 +90,13 @@ paths: ...@@ -83,6 +90,13 @@ paths:
############################################################################### ###############################################################################
'/vnf_instances': '/vnf_instances':
#SOL003 location: 5.4.2 #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: post:
#TODO: Add headers defined in 4.3.4.2 #TODO: Add headers defined in 4.3.4.2
description: "The POST method creates a new VNF instance resource." description: "The POST method creates a new VNF instance resource."
...@@ -138,6 +152,11 @@ paths: ...@@ -138,6 +152,11 @@ paths:
type: string type: string
maximum: 1 maximum: 1
minimum: 0 minimum: 0
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema: schema:
$ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/VnfInstance" $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
400: 400:
...@@ -268,6 +287,11 @@ paths: ...@@ -268,6 +287,11 @@ paths:
type: string type: string
maximum: 1 maximum: 1
minimum: 0 minimum: 0
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema: schema:
type: array type: array
items: items:
...@@ -308,6 +332,12 @@ paths: ...@@ -308,6 +332,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: true
type: string
get: get:
description: > description: >
Information about an individual VNF instance was queried successfully. Information about an individual VNF instance was queried successfully.
...@@ -333,6 +363,11 @@ paths: ...@@ -333,6 +363,11 @@ paths:
type: string type: string
maximum: 1 maximum: 1
minimum: 0 minimum: 0
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
schema: schema:
$ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/VnfInstance" $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
400: 400:
...@@ -415,6 +450,11 @@ paths: ...@@ -415,6 +450,11 @@ paths:
type: string type: string
maximum: 1 maximum: 1
minimum: 0 minimum: 0
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
400: 400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400-attr-selector" $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400-attr-selector"
401: 401:
...@@ -451,6 +491,12 @@ paths: ...@@ -451,6 +491,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