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

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:
......
......@@ -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: /vnfind/v1
......@@ -63,7 +63,7 @@ paths:
parameters:
- 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/VNF may supply this parameter. The VNF may supply its instance Id as an attribute filter.
All attribute names that appear in the VnfIndicator data type and in data types referenced from
......@@ -98,7 +98,8 @@ paths:
- name: nextpage_opaque_marker
description: >
Marker to obtain the next page of a paged response. Shall be supported by the EM/VNF
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 5.4.2.1 of
ETSI GS NFV-SOL 013for this resource.
in: query
required: false
type: string
......@@ -107,12 +108,18 @@ paths:
description: >
200 OK
Information about zero or more VNF indicators was queried successfully.
The response body shall contain in an array the representations of all
VNF indicators that match the attribute-based filtering parameters,
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,
inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3.
Shall be returned when information about zero or more VNF indicators was
queried successfully. The response body shall contain in an array the
representations of all VNF indicators that match the attribute-based
filtering parameters, i.e. zero or more representations of VNF indicators
as defined in clause 8.5.2.2.
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 EM/VNF 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.
......@@ -133,7 +140,7 @@ paths:
schema:
type: array
items:
$ref: '../../definitions/SOL002SOl003VNFIndicator_def.yaml#/definitions/VnfIndicator'
$ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator'
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
401:
......@@ -195,7 +202,7 @@ paths:
parameters:
- 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/VNF shall support receiving filtering parameters as part of the URI query string.
The VNFM may supply filtering parameters.
......@@ -229,8 +236,9 @@ paths:
type: string
- name: nextpage_opaque_marker
description: >
Marker to obtain the next page of a paged response. Shall be supported by the EM/VNF
if the EM/VNF supports alternative 2 (paging) according to clause 4.7.2.1 for this resource.
Marker to obtain the next page of a paged response. Shall be supported
by the EM/VNF if the EM/VNF supports alternative 2 (paging) according
to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource.
in: query
required: false
type: string
......@@ -239,14 +247,19 @@ paths:
description: >
200 OK
Information about zero or more VNF indicators was queried successfully.
Shall be returned when information about zero or more VNF indicators
was queried successfully.
The response body shall contain in an array the representations of all
VNF indicators that are related to the particular VNF instance and that
match the attribute filter., i.e. zero or more representations of VNF
indicators as defined in clause 8.5.2.2.
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
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 EM/VMF supports alternative 2 (paging) according to clause 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.
......@@ -267,7 +280,7 @@ paths:
schema:
type: array
items:
$ref: '../../definitions/SOL002SOl003VNFIndicator_def.yaml#/definitions/VnfIndicator'
$ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator'
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
401:
......@@ -341,7 +354,7 @@ paths:
description: >
200 OK
The VNF indicator was read successfully.
Shall be returned when the VNF indicator has been read successfully.
The response body shall contain the representation of the VNF indicator.
headers:
Content-Type:
......@@ -355,7 +368,7 @@ paths:
maximum: 1
minimum: 1
schema:
$ref: '../../definitions/SOL002SOl003VNFIndicator_def.yaml#/definitions/VnfIndicator'
$ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator'
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
401:
......@@ -411,7 +424,7 @@ paths:
description: >
200 OK
The VNF indicator was read successfully.
Shall be returned when the VNF indicator has been read successfully.
The response body shall contain the representation of the VNF indicator.
headers:
Content-Type:
......@@ -425,7 +438,7 @@ paths:
maximum: 1
minimum: 1
schema:
$ref: '../../definitions/SOL002SOl003VNFIndicator_def.yaml#/definitions/VnfIndicator'
$ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator'
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
401:
......@@ -471,7 +484,11 @@ paths:
type: string
post:
summary: Create a new subscription to VNF indicator change notifications
description: Create a new subscription
description: >
This method creates a new subscription.
As the result of successfully executing this method, a new "Individual
subscription" resource as defined in clause 8.4.6 shall have been created.
This method shall not trigger any notification.
parameters:
- name: vnfIndicatorSubscriptionRequest
in: body
......@@ -484,8 +501,9 @@ paths:
description: >
201 CREATED
The subscription was created successfully.
The response body shall contain a representation of the created subscription resource.
Shall be returned when the subscription has been created successfully.
The response body shall contain a representation of the created
"Individual subscription" resource.
schema:
$ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription'
headers:
......@@ -508,10 +526,11 @@ paths:
description: >
303 SEE OTHER
A subscription with the same callbackURI and the same filter already exists and the policy
of the VNFM is to not create redundant subscriptions.
The HTTP response shall include a "Location" HTTP header that contains the resource URI of
the existing subscription resource.
Shall be returned when a subscription with the same callbackURI and
the same filter already exists and the policy of the VNFM is to not
create redundant subscriptions.
The HTTP response shall include a "Location" HTTP header that contains
the resource URI of the existing "Individual subscription" resource.
The response body shall be empty.
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303"
400:
......@@ -548,7 +567,7 @@ paths:
parameters:
- 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 EM shall and the VNF may support receiving this parameter as part
of the URI query string. The VNFM may supply this parameter.
All attribute names that appear in the VnfIndicatorSubscription data
......@@ -583,8 +602,9 @@ paths:
type: string
- name: nextpage_opaque_marker
description: >
Marker to obtain the next page of a paged response. Shall be supported by the EM
if the EM supports alternative 2 (paging) according to clause 4.7.2.1 for this resource.
Marker to obtain the next page of a paged response. Shall be supported
by the EM if the EM supports alternative 2 (paging) according to
clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource.
in: query
required: false
type: string
......@@ -593,13 +613,18 @@ paths:
description: >
200 OK
The list of subscriptions was queried successfully.
The response body shall contain in an array the representations of all active
subscriptions of the functional block that invokes the method which match the
attribute filter, i.e. zero or more representations of VNF indicators subscriptions
as defined in clause 8.5.2.4.
If the EM 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.
Shall be returned when the list of subscriptions was queried successfully.
The response body shall contain in an array the representations of all
active subscriptions of the functional block that invokes the method which
match the attribute filter, i.e. zero or more representations of VNF
indicators subscriptions as defined in clause 8.5.2.4.
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 EM supports alternative 2 (paging) according to clause 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.
......@@ -687,8 +712,10 @@ paths:
description: >
200 OK
The subscriptions was queried successfully. The response body shall contain
the representation of the requested subscription.
Shall be returned when information about an individual subscription
has been read successfully.
The response body shall contain the representation of the
"Individual subscription" resource.
headers:
Content-Type:
description: The MIME type of the body of the response.
......@@ -728,7 +755,15 @@ paths:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
delete:
summary: Delete a subscription
description: Terminate an individual subscription.
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.
parameters:
- name: subscriptionId
description: >
......@@ -747,7 +782,7 @@ paths:
description: >
204 NO CONTENT
The subscription was deleted successfully.
Shall be returned when the subscription has been deleted successfully.
The response body shall be empty.
headers:
Version:
......