Commit b0476327 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 !11
parents 2fb4c670 d803cf7f
Pipeline #1603 passed with stage
in 0 seconds
This diff is collapsed.
......@@ -98,7 +98,7 @@ definitions:
onboardingFailureDetails:
description: >
Failure details of current on boarding procedure. See
clause 4.3.5.3 for the details of "ProblemDetails"
clause 6.3 of ETSI GS NFV-SOL 013 for the details of "ProblemDetails"
structure.
It shall be present when the "nsdOnboardingState"
attribute is CREATED and the uploading or
......@@ -207,6 +207,7 @@ definitions:
onboardingFailureDetails:
description: >
Failure details of current on-boarding procedure.
See clause 6.3 of ETSI GS NFV-SOL 013 for the details of "ProblemDetails" structure.
It shall be present when the
pnfdOnboardingState attribute is CREATED
and the uploading or processing fails in the NFVO.
......@@ -257,6 +258,10 @@ definitions:
description: >
The URI of the endpoint to send the notification to.
authentication:
description: >
Authentication parameters to configure the use of Authorization when sending
notifications corresponding to this subscription, as defined in clause 8.3.4 of ETSI GS NFV-SOL 013.
This attribute shall only be present if the subscriber requires authorization of notifications.
$ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication"
description: >
This type represents a subscription request related to notifications
......
......@@ -14,8 +14,8 @@ info:
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
externalDocs:
description: ETSI GS NFV-SOL 005 V2.5.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf
description: ETSI GS NFV-SOL 005 V2.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.06.01_60/gs_NFV-SOL005v020601p.pdf
basePath: /callback/v1
......@@ -86,7 +86,7 @@ paths:
description: >
204 NO CONTENT
The notification was delivered successfully.
Shall be returned when the notification has been delivered successfully.
headers:
WWW-Authenticate:
type: string
......@@ -143,7 +143,7 @@ paths:
description: >
204 NO CONTENT
The notification endpoint was tested successfully.
Shall be returned when the notification endpoint has been tested successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
......@@ -234,7 +234,7 @@ paths:
description: >
204 NO CONTENT
The notification was delivered successfully.
Shall be returned when the notification has been delivered successfully.
headers:
WWW-Authenticate:
type: string
......@@ -291,7 +291,7 @@ paths:
description: >
204 NO CONTENT
The notification endpoint was tested successfully.
Shall be returned when the notification endpoint has been tested successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
......@@ -382,7 +382,7 @@ paths:
description: >
204 NO CONTENT
The notification was delivered successfully.
Shall be returned when the notification has been delivered successfully.
headers:
WWW-Authenticate:
type: string
......@@ -439,7 +439,7 @@ paths:
description: >
204 NO CONTENT
The notification endpoint was tested successfully.
Shall be returned when the notification endpoint has been tested successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
......@@ -530,7 +530,7 @@ paths:
description: >
204 NO CONTENT
The notification was delivered successfully.
Shall be returned when the notification has been delivered successfully.
headers:
WWW-Authenticate:
type: string
......@@ -587,7 +587,7 @@ paths:
description: >
204 NO CONTENT
The notification endpoint was tested successfully.
Shall be returned when the notification endpoint has been tested successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
......@@ -678,7 +678,7 @@ paths:
description: >
204 NO CONTENT
The notification was delivered successfully.
Shall be returned when the notification has been delivered successfully.
headers:
WWW-Authenticate:
type: string
......@@ -735,7 +735,7 @@ paths:
description: >
204 NO CONTENT
The notification endpoint was tested successfully.
Shall be returned when the notification endpoint has been tested successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
......@@ -826,7 +826,7 @@ paths:
description: >
204 NO CONTENT
The notification was delivered successfully.
Shall be returned when the notification has been delivered successfully.
headers:
WWW-Authenticate:
type: string
......@@ -883,7 +883,7 @@ paths:
description: >
204 NO CONTENT
The notification endpoint was tested successfully.
Shall be returned when the notification endpoint has been tested successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
......@@ -974,7 +974,7 @@ paths:
description: >
204 NO CONTENT
The notification was delivered successfully.
Shall be returned when the notification has been delivered successfully.
headers:
WWW-Authenticate:
type: string
......@@ -1031,7 +1031,7 @@ paths:
description: >
204 NO CONTENT
The notification endpoint was tested successfully.
Shall be returned when the notification endpoint has been tested successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
......
......@@ -67,6 +67,9 @@ definitions:
nsdId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
onboardingFailureDetails:
description: >
Failure details of current onboarding procedure. See clause 6.3 of ETSI GS NFV-SOL 013
for the details of "ProblemDetails" structure.
$ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
_links:
$ref: "#/definitions/NsdmLinks"
......@@ -222,6 +225,9 @@ definitions:
pnfdId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
onboardingFailureDetails:
description: >
Failure details of current onboarding procedure. See clause 6.3 of ETSI GS NFV-SOL 013
for the details of "ProblemDetails" structure.
$ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
_links:
$ref: "#/definitions/PnfdmLinks"
......
......@@ -304,10 +304,9 @@ definitions:
format: url
authentication:
description: >
Authentication parameters to configure the use of Authorization when
sending notifications corresponding to this subscription.
This attribute shall only be present if the subscriber requires
authorization of notifications.
Authentication parameters to configure the use of Authorization when sending notifications
corresponding to this subscription, as defined in clause 4.5.3.4.8.3.4 of ETSI GS NFV SOL 013.
This attribute shall only be present if the subscriber requires authorization of notifications.
$ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication"
PerceivedSeverityType:
......
......@@ -14,8 +14,8 @@ info:
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
externalDocs:
description: ETSI GS NFV-SOL 005 V2.5.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf
description: ETSI GS NFV-SOL 005 V2.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.06.01_60/gs_NFV-SOL005v020601p.pdf
basePath: /callback/v1
......@@ -36,7 +36,7 @@ paths:
summary: Notify about NS alarms
description: >
The POST method notifies an alarm related to a NS or that the alarm list has been rebuilt.
The API consumer shall have previously created an "individual subscription resource" with a matching filter.
parameters:
- name: alarmNotification
description: >
......@@ -77,7 +77,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:
......@@ -106,7 +106,7 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
'/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmClearedNotification':
#ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.6
#ETSI GS NFV-SOL 005 V2.6.1 location: 8.4.6
post:
summary: Notify about NS alarms
description: >
......@@ -178,6 +178,70 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
get:
summary: Test the notification endpoint.
description: >
The GET method allows the server to test the notification endpoint that is provided by
the client, e.g. during subscription.
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
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:
204:
description: >
204 No Content
Shall be returned when the notification endpoint has been tested successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
type: string
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.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
'/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmListRebuiltNotification':
post:
......@@ -253,10 +317,10 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
get:
summary: Test the notification endpoint
summary: Test the notification endpoint.
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.
parameters:
- name: Accept
description: >
......@@ -283,7 +347,7 @@ paths:
description: >
204 No Content
The notification endpoint was tested successfully.
Shall be returned when the notification endpoint has been tested successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
......@@ -294,12 +358,24 @@ paths:
has provided an invalid authorization token.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
......
......@@ -198,7 +198,7 @@ definitions:
nsdInfoId:
description: >
Identifier of the NSD information object on which the
NS instance is based. This identifier was allocated by the NFVO.
NS instance is based. This identifier has been allocated by the NFVO.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
flavourId:
description: >
......@@ -388,15 +388,26 @@ definitions:
description: >
Identifier of information held by the NFVO about
the specific VNF package on which the VNF is
based. This identifier was allocated by the NFVO.
based. This identifier has been allocated by the NFVO.
This attribute can be modified with the PATCH
method.
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
vnfConfigurableProperties:
description: >
Current values of the configurable properties of the VNF instance.
Configurable properties referred in this attribute are declared in
Additional VNF-specific attributes that provide the current values
of the configurable properties of the VNF instance.
These attributes represent values that are stored persistently in the
VnfInstance structure and that correspond to configuration parameters
of the VNF instance.
Modifying these attributes affects the configuration of the VNF instance
either directly(if the VNF instance is in INSTANTIATED state at the time
of the modification) or as part of the subsequent VNF instantiation operation
(if the VNF instance is in NOT_INSTANTIATED state at the time of the modification).
Configurable properties referred in these attributes are declared in
the VNFD.
ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD
based on TOSCA specifications.
VNF configurable properties are sometimes also referred to as
......@@ -410,13 +421,14 @@ definitions:
These configurable properties include the following standard
attributes, which are declared in the VNFD if auto-scaling and/or
auto-healing are supported by the VNF:
* isAutoscaleEnabled: If present, the VNF supports auto-scaling. If
set to true, auto-scaling is currently enabled. If set to false,
auto-scaling is currently disabled.
* isAutohealEnabled: If present, the VNF supports auto-healing. If
set to true, auto-healing is currently enabled. If set to false,
auto-healing is currently disabled.
This attribute can be modified with the PATCH method.
- isAutoscaleEnabled: If present, the VNF supports auto-scaling. If
set to true, auto-scaling is currently enabled. If set to false,
auto-scaling is currently disabled.
- isAutohealEnabled: If present, the VNF supports auto-healing. If
set to true, auto-healing is currently enabled. If set to false,
auto-healing is currently disabled.
These attributea can be modified with the PATCH method.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
vimId:
description: >
......@@ -510,16 +522,30 @@ definitions:
$ref: "#/definitions/VirtualStorageResourceInfo"
metadata:
description: >
Additional VNF-specific metadata describing the VNF instance.
Metadata that are writeable are declared in the VNFD.
This attribute can be modified with the PATCH method.
Additional VNF-specific attributes that provide metadata
describing the VNF instance.
These attributes represent values that are stored persistently in the VnfInstance
structure for consumption by functional blocks that invoke the VNF lifecycle management interface.
They are not consumed by the VNFM, or the lifecycle management scripts.
Modifying the values of these attributes has no effect on the VNF instance, it only affects
the information represented in the VnfInstance structure.
Metadata that are writeable are declared in the VNFD .
These attributes can be modified with the PATCH method.
ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
extensions:
description: >
VNF-specific attributes that affect the lifecycle management of this
VNF instance by the VNFM, or the lifecycle management scripts.
Additional VNF-specific attributes that affect the lifecycle management of this VNF instance.
These attributes represent values that are stored persistently in the VnfInstance structure
for consumption by the VNFM, or by the lifecycle management scripts. during the execution
of VNF lifecycle management operations.
Modifying the values of these attributes has no direct effect on the VNF instance; however,
the modified attribute values can be considered during subsequent VNF lifecycle management
operations, which means that the modified values can indirectly affect the configuration of the VNF instance.
Extensions that are writeable are declared in the VNFD.
This attribute can be modified with the PATCH method.
This attribute These attributes can be modified with the PATCH method.
ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
LccnLinks:
......@@ -1666,7 +1692,7 @@ definitions:
type: array
items:
$ref: "#/definitions/NestedNsInstanceData"
localizationLanguage:
locationConstraints:
description: >
Defines the location constraints for the VNF to be
instantiated as part of the NS instantiation.
......@@ -2206,13 +2232,23 @@ definitions:
localizationLanguage:
description: >
Localization language of the VNF to be instantiated.
The value shall comply with the format defined in IETF RFC 5646 [16].
The value shall comply with the format defined in IETF RFC 5646.
type: string
additionalParams:
description: >
Additional input parameters for the instantiation process,
specific to the VNF being instantiated.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
metadata:
description: >
This attribute provides values for the "metadata" input parameter of
the Create VNF Identifier operation.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
extensions:
description: >
This attribute provides values for the "extensions" input parameter of
the Instantiate VNF operation.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
ChangeVnfFlavourData:
description: >
......@@ -2334,25 +2370,23 @@ definitions:
New value of the "vnfInstanceDescription" attribute in "VnfInstance",
or "null" to remove the attribute.
type: string
vnfPkgId:
vnfdId:
description: >
New value of the "vnfPkgId" attribute in "VnfInstance".
New value of the "vnfdId" attribute in "VnfInstance".
The value "null" is not permitted
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
vnfConfigurableProperties:
description: >
Modifications to entries in the
"vnfConfigurableProperties" list, as defined below this Table.
"vnfConfigurableProperties" attribute in "VnfInstance", as defined below in clause 6.5.3.57.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
Metadata:
metadata:
description: >
Modifications to entries in the "metadata" list, as
defined below this Table.
Modifications to entries in the "metadata" attribute in "VnfInstance", as defined below in clause 6.5.3.57.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
Extensions:
extensions:
description: >
Modifications to entries in the "extensions" list, as
defined below this Table.
Modifications to entries in the "extensions" attribute in "VnfInstance", as defined below in clause 6.5.3.57.
$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
ChangeExtVnfConnectivityData:
......@@ -2572,7 +2606,7 @@ definitions:
- IPV6
vlanTag:
description: >
Indicates a VLAN identifier in an IEEE 802.1Q-2014
Indicates a VLAN identifier in an IEEE 802.1Q-2018
tag [6] Multiple tags can be included for QinQ stacking. See note.
type: array
items:
......@@ -3236,7 +3270,7 @@ definitions:
description: >
Authentication parameters to configure the use of Authorization when
sending notifications corresponding to this subscription, as defined
in clause 4.5.3.4.
in clause 8.3.4 of ETSI GS NFV-SOL 013.
This attribute shall only be present if the subscriber requires
authorization of notifications.
$ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication"
......@@ -3705,7 +3739,7 @@ definitions:
$ref: "#/definitions/NsLcmOperationStateType"
stateEnteredTime:
description: >
Date-time when the current state was entered.
Date-time when the current state has been entered.
type: string
format: date-time
nsInstanceId:
......
swagger: "2.0"
info:
version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
version: "1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: "SOL005 - NS Lifecycle Management Notification interface"
description: >
SOL005 - NS Lifecycle Management Notification interface
......@@ -14,8 +14,8 @@ info:
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
externalDocs:
description: ETSI GS NFV-SOL 005 V2.5.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf
description: ETSI GS NFV-SOL 005 V2.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.06.01_60/gs_NFV-SOL005v020601p.pdf
basePath: /callback/v1
......@@ -79,7 +79,75 @@ paths:
description: >
204 No Content
The notification was delivered successfully.
Shall be returned when the notification has been delivered successfully.
headers:
WWW-Authenticate:
type: string
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.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
get:
summary: Test the notification endpoint.
description: >
Query NS Instances.
The GET method queries information about multiple NS instances.
This method shall support the URI query parameters, request and response data structures, and response codes, as
specified in the Tables 6.4.2.3.2-1 and 6.4.2.3.2-2.
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
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:
204:
description: >
204 No Content
Shall be returned when the notification endpoint has been tested successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
type: string
......@@ -107,10 +175,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "../responses/SOL005_resp.yaml#/responses/409"
416:
$ref: "../responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
......@@ -164,7 +228,75 @@ paths:
description: >
204 No Content
The notification was delivered successfully.
Shall be returned when the notification has been delivered successfully.
headers:
WWW-Authenticate:
type: string
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.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
get:
summary: Test the notification endpoint.
description: >
Query NS Instances.
The GET method queries information about multiple NS instances.
This method shall support the URI query parameters, request and response data structures, and response codes, as
specified in the Tables 6.4.2.3.2-1 and 6.4.2.3.2-2.
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header