Commit 7ee66cc8 authored by ETSI CTI's avatar ETSI CTI

Merge branch '2.6.1-dev' into 'master'

Merge 2.6.1-dev branch

See merge request !6
parents 34bc0e28 81cb05d9
......@@ -17,8 +17,8 @@ info:
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
description: ETSI GS NFV-SOL 002 V2.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.06.01_60/gs_nfv-sol002v020601p.pdf
basePath: /vnfconfig/v1
......@@ -65,7 +65,9 @@ paths:
200:
description: >
200 OK
Configuration information about a VNF instance was read successfully.
Shall be returned when configuration information about a VNF instance
has been read successfully.
The response body shall contain a representation of the configuration resource.
schema:
$ref: 'definitions/SOL002VNFConfiguration_def.yaml#/definitions/VnfConfiguration'
......@@ -123,16 +125,17 @@ paths:
required: true
in: body
schema:
$ref: 'definitions/SOL002VnfConfiguration_def.yaml#/definitions/VnfConfigModifications'
$ref: 'definitions/SOL002VNFConfiguration_def.yaml#/definitions/VnfConfigModifications'
responses:
200:
description: >
200 OK
The request was accepted and completed. The response body shall contain the parameters
of the configuration modification that was applied to the configuration resource.
Shall be returned when the request has been accepted and completed.
The response body shall contain the parameters of the configuration
modification that was applied to the configuration resource.
schema:
$ref: 'definitions/SOL002VnfConfiguration_def.yaml#/definitions/VnfConfigModifications'
$ref: 'definitions/SOL002VNFConfiguration_def.yaml#/definitions/VnfConfigModifications'
headers:
Content-Type:
description: The MIME type of the body of the response.
......@@ -157,6 +160,16 @@ paths:
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
412:
description: >
412 PRECONDITION FAILED
Shall be returned upon the following error: A precondition given
in an HTTP request header is not fulfilled.
Typically, this is due to an ETag mismatch, indicating that the resource
was modified by another entity. The response body should contain a
ProblemDetails structure, in which the "detail" attribute should convey
more information about the error.
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
416:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
......
......@@ -17,8 +17,8 @@ info:
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
description: ETSI GS NFV-SOL 002 V2.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.06.01_60/gs_nfv-sol002v020601p.pdf
basePath: /vnffm/v1
......@@ -79,7 +79,7 @@ paths:
type: string
- name: filter
description: >
Attribute-based filtering expression according to clause 4.3.2.
Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
The VNFM shall support receiving this parameter as part of the URI query string.
The EM may supply this parameter. The VNF may supply its instance Id as an attribute filter.
The following attribute names shall be supported in the filter expression: id, managedObjectId,
......@@ -116,7 +116,8 @@ paths:
description: >
Marker to obtain the next page of a paged response.
Shall be supported by the VNFM if the VNFM supports alternative 2
(paging) according to clause 4.7.2.1 for this resource.
(paging) according to clause 5.4.2.1 5.2 of ETSI GS NFV-SOL 013
for this resource.
in: query
required: false
type: string
......@@ -125,11 +126,15 @@ paths:
description: >
200 OK
Information about zero or more alarms was queried successfully.
Shall be returned when information about zero or more alarms was queried successfully.
The response body shall contain in an array the representations of zero or more alarms
as defined in clause 7.5.2.4.
If the VNFM 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.
If the "filter" URI parameter was supplied in the request, the data in the response body
shall have been transformed according to the rules specified in clause 5.2.2 of
ETSI GS NFV-SOL 013.
If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of
ETSI GS NFV-SOL 013for 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.
......@@ -235,7 +240,8 @@ paths:
description: >
200 OK
Information about an individual alarm was read successfully.
Shall be returned when information about an individual alarm read
successfully.
The response body shall contain a representation of the individual
alarm.
headers:
......@@ -312,9 +318,9 @@ paths:
description: >
200 OK
The request was accepted and completed. The response body shall
contain attribute modifications for an ‘Individual alarm’
resource.
Shall be returned when the request was accepted and completed.
The response body shall contain attribute modifications for
an "Individual alarm" resource.
headers:
Content-Type:
description: The MIME type of the body of the response.
......@@ -352,14 +358,24 @@ paths:
description: >
409 CONFLICT
Error: The operation cannot be executed currently, due to a conflict with the state of
the "Individual alarm" resource.
Typically, this is due to the fact that the alarm is already in the state that is requested
to be set (such as trying to acknowledge an already-acknowledged alarm).
The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
convey more information about the error.
Shall be returned upon the following error: The operation cannot be executed
currently, due to a conflict with the state of the "Individual alarm" resource.
Typically, this is due to the fact that the alarm is already in the state that
is requested to be set (such as trying to acknowledge an already-acknowledged
alarm).
The response body shall contain a ProblemDetails structure, in which the
"detail" attribute shall convey more information about the error.
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
412:
description: >
412 PRECONDITION FAILED
ErrorShall be returned upon the following error: A precondition given in an
HTTP request header is not fulfilled.
Typically, this is due to an ETag mismatch, indicating that the resource was
modified by another entity.
The response body should contain a ProblemDetails structure, in which the
"detail" attribute should convey more information about the error.
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
416:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
......@@ -397,6 +413,9 @@ paths:
description: >
The POST method enables the consumer to escalate the perceived severity
of an alarm that is represented by an ndividual alarm resource.
As the result of successfully executing this method, a new "Individual
subscription" resource as defined in clause 7.4.5 shall have been created.
This method shall not trigger any notification.
parameters:
- name: alarmId
description: >
......@@ -419,8 +438,8 @@ paths:
description: >
200 OK
The VNFM has received the proposed "escalated perceived severity" value
successfully. The response body shall be empty.
Shall be returned when the VNFM has received the proposed "escalated
perceived severity" value successfully. The response body shall be empty.
headers:
Version:
description: The used API version.
......@@ -586,7 +605,7 @@ paths:
type: string
- name: filter
description: >
Attribute-based filtering expression according to clause 4.3.2.
Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
The VNFM shall support receiving this parameter as part of the URI query string.
The EM may supply this parameter. The VNF may supply its instance Id as an attribute filter.
All attribute names that appear in the FmSubscription and in data types referenced from it
......@@ -621,7 +640,8 @@ paths:
description: >
Marker to obtain the next page of a paged response.
Shall be supported by the VNFM if the VNFM supports alternative 2
(paging) according to clause 4.7.2.1 for this resource.
(paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for
this resource.
in: query
required: false
type: string
......@@ -630,12 +650,16 @@ paths:
description: >
200 OK
The list of subscriptions was queried successfully. The response
The list of subscriptions has been queried successfully. The response
body shall contain the representations of all active
subscriptions of the functional block that invokes the method.
If the "filter" URI parameter was supplied in the request, the data
in the response body shall have been transformed according to the
rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013.
If the VNFM 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.
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.
......@@ -741,9 +765,10 @@ paths:
description: >
200 OK
The operation has completed successfully.
The response body shall contain a representation of the
subscription resource.
Shall be returned when information about an individual subscription
has been read successfully.
The response body shall contain a representation of the "Individual
subscription" resource.
headers:
Content-Type:
description: The MIME type of the body of the response.
......@@ -792,12 +817,20 @@ paths:
delete:
description: >
This method terminates an individual subscription.
As the result of successfully executing this method, the "Individual
subscription" resource shall not exist any longer. This means that no
notifications for that subscription shall be sent to the
formerly-subscribed API consumer.
NOTE: Due to race conditions, some notifications might still be
received by the formerly-subscribed API consumer for a certain time
period after the deletion.
responses:
204:
description: >
204 NO CONTENT
The subscription resource was deleted successfully.
Shall be returned when the "Individual subscription" resource has
been deleted successfully.
The response body shall be empty.
headers:
Version:
......
......@@ -17,8 +17,8 @@ info:
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
description: ETSI GS NFV-SOL 002 V2.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.06.01_60/gs_nfv-sol002v020601p.pdf
basePath: /callback/v1
......@@ -56,7 +56,8 @@ paths:
Notify
The POST method notifies a VNF alarm or that the alarm list has been
rebuilt.
rebuilt. The API consumer shall have previously created an "Individual
subscription" resource with a matching filter.
parameters:
- name: AlarmNotification
description: >
......@@ -78,7 +79,7 @@ paths:
description: >
204 NO CONTENT
The notification was delivered successfully.
Shall be returned when the notification has been delivered successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
......@@ -118,7 +119,8 @@ paths:
description: >
201 NO CONTENT
The notification endpoint was tested successfully.
Shall be returned to indicate the notification endpoint has been
tested successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
......@@ -173,7 +175,8 @@ paths:
Notify
The POST method notifies a VNF alarm or that the alarm list has been
rebuilt.
rebuilt. The API consumer shall have previously created an "Individual
subscription" resource with a matching filter.
parameters:
- name: AlarmClearedNotification
description: >
......@@ -195,7 +198,7 @@ paths:
description: >
204 NO CONTENT
The notification was delivered successfully.
Shall be returned when the notification has been delivered successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
......@@ -235,7 +238,8 @@ paths:
description: >
201 NO CONTENT
The notification endpoint was tested successfully.
Shall be returned to indicate the notification endpoint has been
tested successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
......@@ -290,7 +294,8 @@ paths:
Notify
The POST method notifies a VNF alarm or that the alarm list has been
rebuilt.
rebuilt. The API consumer shall have previously created an "Individual
subscription" resource with a matching filter.
parameters:
- name: AlarmListRebuiltNotification
description: >
......@@ -312,7 +317,7 @@ paths:
description: >
204 NO CONTENT
The notification was delivered successfully.
Shall be returned when the notification has been delivered successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
......@@ -352,7 +357,8 @@ paths:
description: >
204 NO CONTENT
The notification endpoint was tested successfully.
Shall be returned to indicate the notification endpoint has been
tested successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
......
This diff is collapsed.
......@@ -17,8 +17,8 @@ info:
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
description: ETSI GS NFV-SOL 002 V2.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.06.01_60/gs_nfv-sol002v020601p.pdf
schemes:
- http
......@@ -55,7 +55,9 @@ paths:
The API producer can use this resource to send notifications related to VNF indicator
value changes to a subscribed API consumer, which has provided the URI of this resource
during the subscription process.
The POST method delivers a notification from the server to the client.
The POST method delivers a notification from API producer to an API consumer. The API
consumer shall have previously created an "Individual subscription" resource with a
matching filter.
parameters:
- name: vnfIndicatorValueChangeNotification
in: body
......@@ -69,7 +71,8 @@ paths:
description: >
204 NO CONTENT
The notification was delivered successfully. The response body shall be empty.
Shall be returned when the notification has been delivered successfully.
The response body shall be empty.
headers:
Version:
description: The used API version.
......@@ -102,7 +105,8 @@ paths:
description: >
204 NO CONTENT
The notification endpoint was tested successfully. The response body shall be empty.
Shall be returned when the notification endpoint has been tested successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
description: >
......
......@@ -62,7 +62,7 @@ definitions:
# LEH this must be reported as strong candidate for removal.
vnfInstance:
description: >
Link to the related VNF instance resource.
Link to the related "Individual VNF instance" resource.
$ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/Link'
subscription:
description: >
......
swagger: "2.0"
info:
version: "1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: SOL002 - VNF Lifecycle Management Notification interface
description: >
SOL002 - VNF Lifecycle Management Notification interface
......@@ -17,8 +17,8 @@ info:
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
description: ETSI GS NFV-SOL 002 V2.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.06.01_60/gs_nfv-sol002v020601p.pdf
basePath: /callback/v1
......@@ -58,7 +58,7 @@ paths:
The POST method delivers a notification from the server to the client.
parameters:
- name: VnfLcmOperationOccurrenceNotification
description: A notification about on-boarding of a VNF package.
description: A notification about lifecycle changes triggered by a VNF LCM operation occurrence.
in: body
required: true
schema:
......@@ -82,7 +82,7 @@ paths:
description: >
204 NO CONTENT
The notification was delivered successfully.
The notification has been delivered successfully.
headers:
WWW-Authenticate:
description: >
......@@ -138,7 +138,7 @@ paths:
description: >
204 NO CONTENT
The notification endpoint was tested successfully.
The notification endpoint has been tested successfully.
headers:
WWW-Authenticate:
description: >
......@@ -196,7 +196,7 @@ paths:
- name: VnfIdentifierCreationNotification
description: >
A notification about the creation of a VNF identifier and the
related VNF instance resource.
related "Individual VNF instance" resource.
in: body
required: true
schema:
......@@ -220,7 +220,7 @@ paths:
description: >
204 NO CONTENT
The notification was delivered successfully.
The notification has been delivered successfully.
headers:
WWW-Authenticate:
description: >
......@@ -276,7 +276,7 @@ paths:
description: >
204 NO CONTENT
The notification endpoint was tested successfully.
The notification endpoint has been tested successfully.
headers:
WWW-Authenticate:
description: >
......@@ -334,7 +334,7 @@ paths:
- name: VnfIdentifierDeletionNotification
description: >
A notification about the deletion of a VNF identifier and the
related VNF instance resource.
related "Individual VNF instance" resource.
in: body
required: true
schema:
......@@ -358,7 +358,7 @@ paths:
description: >
204 NO CONTENT
The notification was delivered successfully.
The notification has been delivered successfully.
headers:
WWW-Authenticate:
description: >
......@@ -414,7 +414,7 @@ paths:
description: >
No Content
The notification endpoint was tested successfully.
The notification endpoint has been tested successfully.
headers:
WWW-Authenticate:
description: >
......
......@@ -31,8 +31,9 @@ definitions:
If this is a notification about a final or intermediate result state of
a VNF LCM operation occurrence, the notification shall be sent after
all related actions of the LCM operation that led to this state have
been executed. The new state shall be set in the VnfLcmOpOcc resource
before the notification about the state change is sent.
been executed.
The new state shall be set in the "Individual VNF LCM operation occurrence"
resource before the notification about the state change is sent.
type: object
required:
- id
......@@ -159,7 +160,8 @@ definitions:
Information about changed external connectivity, if this
notification represents the result of a lifecycle operation
occurrence. Shall be present if the "notificationStatus" is set to
"RESULT" and the "operation" is set to "CHANGE_EXT_CONN".
"RESULT" and the "operation" has made any change of the external
connectivity of the VNF instance.
Shall be absent otherwise.
type: array
items:
......
......@@ -17,8 +17,8 @@ info:
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
description: ETSI GS NFV-SOL 002 V2.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.06.01_60/gs_nfv-sol002v020601p.pdf
basePath: /callback/v1
......@@ -42,7 +42,9 @@ paths:
Notify
The POST method delivers a notification regarding a performance
management event from the server to the client.
management event from API producer to an API consumer. The API consumer
shall have previously created an "Individual subscription" resource with
a matching filter.
parameters:
- name: PerformanceInformationAvailableNotification
description: >
......@@ -76,7 +78,7 @@ paths:
description: >
No Content
The notification was delivered successfully.
Shall be returned when the notification has been delivered successfully.
headers:
WWW-Authenticate:
description: >
......@@ -129,7 +131,9 @@ paths:
description: >
No Content
The notification endpoint was tested successfully.
Shall be returned to indicate that the notification endpoint has been
tested successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
description: >
......@@ -169,7 +173,9 @@ paths:
Notify
The POST method delivers a notification regarding a performance
management event from the server to the client.
management event from API producer to an API consumer. The API consumer
shall have previously created an "Individual subscription" resource with
a matching filter.
parameters:
- name: ThresholdCrossedNotification
description: >
......@@ -203,7 +209,7 @@ paths:
description: >
204 NO CONTENT
The notification was delivered successfully.
Shall be returned when the notification has been delivered successfully.
headers:
WWW-Authenticate:
description: >
......@@ -256,7 +262,9 @@ paths:
description: >
204 NO CONTENT
The notification endpoint was tested successfully.
Shall be returned to indicate that the notification endpoint has been
tested successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
description: >
......
......@@ -15,8 +15,8 @@ info:
contact:
name: "NFV-SOL WG"
externalDocs:
description: ETSI GS NFV-SOL 003 V2.5.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.05.01_60/gs_nfv-sol003v020501p.pdf
description: ETSI GS NFV-SOL 003 V2.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.06.01_60/gs_NFV-SOL003v020601p.pdf
schemes:
- http
- https
......
responses:
409-alarm-state-conflict:
description: >
Conflict
The operation cannot be executed currently, due to a conflict with the
state of the "Individual alarm" resource.
Typically, this is due to the fact that the alarm is already in the
state that is requested to be set (such as trying to acknowledge an
already-acknowledged alarm).
The response body shall contain a ProblemDetails structure, in which the
"detail" attribute should convey more information about the error.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
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.
type: string
maximum: 1
minimum: 0
schema:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
......@@ -25,8 +25,8 @@ info:
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
externalDocs:
description: ETSI GS NFV-SOL 003 V2.5.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.05.01_60/gs_nfv-sol003v020501p.pdf
description: ETSI GS NFV-SOL 003 V2.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.06.01_60/gs_NFV-SOL003v020601p.pdf
basePath: "/callback/v1"
......@@ -46,11 +46,11 @@ paths:
#SOL003 location: 7.4.6
post:
description: >
Notify
The POST method notifies a VNF alarm or that the alarm list has been
rebuilt.
Notify.
The POST method notifies a VNF alarm or that the alarm list has been rebuilt.
The API consumer shall have previously created an "Individual subscription resource" with a matching filter.
This method shall follow the provisions specified in the tables 7.4.6.3.1-1 and 7.4.6.3.1-2
for URI query parameters, request and response data structures, and response codes.
parameters:
- name: AlarmNotification
description: >
......@@ -58,7 +58,7 @@ paths:
in: body
required: true
schema:
$ref: "../definitions/SOL003_def.yaml#/definitions/AlarmNotification"
$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmNotification"
- name: Authorization
description: >
The authorization token for the request.
......@@ -85,7 +85,7 @@ paths:
description: >
204 NO CONTENT
The notification was delivered successfully.
Shall be returned when the notification has been delivered successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
......@@ -116,10 +116,13 @@ paths:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
get:
description: >
The GET method allows the server to test the notification endpoint
that is provided by the client, e.g. during subscription.
The GET method allows the server to test the notification endpoint that is provided by the client,
e.g. during subscription.
This method shall follow the provisions specified in the tables 7.4.6.3.2-1 and 7.4.6.3.2-2
for URI query parameters, request and response data structures, and response codes.
parameters:
- name: Authorization
description: >
......@@ -139,7 +142,7 @@ paths:
description: >
204 NO CONTENT
The notification endpoint was tested successfully.
Shall be returned to indicate that the notification endpoint has been tested successfully.
The response body shall be empty.