Commit 8fe76a84 authored by moscatelli's avatar moscatelli
Browse files

SOl005: Notification interfaces added

parent 5051b771
Pipeline #754 failed with stage
in 0 seconds
......@@ -17,7 +17,6 @@ info:
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
basePath: /{apiName}
schemes:
- http
- https
......@@ -29,51 +28,17 @@ paths:
###############################################################################
# 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:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
responses:
200:
description: >
200 OK
'/nsd/api-versions':
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
API version information was read successfully.
The response body shall contain API version information, as defined in clause 4.4.1.7.
schema:
$ref: '../definitions/SOL005_def.yaml#/definitions/ApiVersionInformation'
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
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' }
413: { $ref: '../responses/SOL005_resp.yaml#/responses/413' }
414: { $ref: '../responses/SOL005_resp.yaml#/responses/414' }
416: { $ref: '../responses/SOL005_resp.yaml#/responses/416' }
422: { $ref: '../responses/SOL005_resp.yaml#/responses/422' }
429: { $ref: '../responses/SOL005_resp.yaml#/responses/429' }
500: { $ref: '../responses/SOL005_resp.yaml#/responses/500' }
503: { $ref: '../responses/SOL005_resp.yaml#/responses/503' }
504: { $ref: '../responses/SOL005_resp.yaml#/responses/504' }
\ No newline at end of file
'/nsfm/api-versions':
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
'/nslcm/api-versions':
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
'/nspm/api-versions':
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
'/vnfpkgm/api-versions':
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
\ No newline at end of file
This diff is collapsed.
......@@ -293,278 +293,6 @@ definitions:
description: >
This type represents a subscription related to notifications about NSD management.
NsdOnBoardingNotification:
type: object
required:
- _links
- id
- notificationType
- subscriptionId
- nsdId
- nsdInfoId
- timeStamp
properties:
id:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
notificationType:
type: string
description: >
Discriminator for the different notification types. Shall be
set to "NsdOnboardingNotification" for this notification type.
subscriptionId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
timeStamp:
description: >
Date-time of the generation of the notification.
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
nsdInfoId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
nsdId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
_links:
$ref: "#/definitions/NsdmLinks"
description: >
This type represents an NSD management notification, which informs
the receiver of the successful on-boarding of an NSD. It shall comply with
the provisions defined in Table 5.5.2.9-1. The support of this notification
is mandatory. The notification shall be triggered by the NFVO when the "
nsdOnboardingState" attribute of a new NSD has changed to "ONBOARDED".
NsdOnBoardingFailureNotification:
type: object
required:
- _links
- id
- notificationType
- subscriptionId
- nsdInfoId
- onboardingFailureDetails
- timeStamp
properties:
id:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
notificationType:
type: string
description: >
Discriminator for the different notification types. Shall be
set to "NsdOnboardingFailureNotification" for this notification type.
subscriptionId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
timeStamp:
description: >
Date-time of the generation of the notification.
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
nsdInfoId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
nsdId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
onboardingFailureDetails:
$ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
_links:
$ref: "#/definitions/NsdmLinks"
description: >
This type represents an NSD management notification, which informs
the receiver of the failure of on-boarding an NSD. It shall comply with the
provisions defined in Table 5.5.2.10-1. The support of this notification is
mandatory. The notification shall be triggered by the NFVO when the on-boarding
of an NSD has failed.
NsdChangeNotification:
type: object
required:
- _links
- id
- notificationType
- subscriptionId
- nsdId
- nsdInfoId
- nsdOperationalState
- timeStamp
properties:
id:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
notificationType:
type: string
description: >
Discriminator for the different notification types. Shall be
set to "NsdChangeNotification" for this notification type.
subscriptionId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
timeStamp:
description: >
Date-time of the generation of the notification.
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
nsdInfoId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
nsdId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
nsdOperationalState:
$ref: "#/definitions/NsdOperationalStateType"
_links:
$ref: "#/definitions/NsdmLinks"
description: >
This type represents an NSD management notification, which informs
the receiver of a change of the "nsdOperationalState" attribute of an on-boarded
NSD. Changes in the value of the "nsdUsageState" and "nsdOnboardingState"
attributes are not reported. The notification shall comply with the provisions
defined in Table 5.5.2.11-1. The support of this notification is mandatory.
The notification shall be triggered by the NFVO when the value of the "nsdOperationalState"
attribute has changed, and the "nsdOperationalState" attribute has the value
"ONBOARDED".
NsdDeletionNotification:
type: object
required:
- _links
- id
- notificationType
- subscriptionId
- nsdId
- nsdInfoId
- timeStamp
properties:
id:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
notificationType:
type: string
description: >
Discriminator for the different notification types. Shall be
set to "NsdDeletionNotification " for this notification type.
subscriptionId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
timeStamp:
description: >
Date-time of the generation of the notification.
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
nsdInfoId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
nsdId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
_links:
$ref: "#/definitions/NsdmLinks"
description: >
This type represents an NSD management notification, which informs
the receiver of the deletion of an on-boarded NSD. The notification shall
comply with the provisions defined in Table 5.5.2.12-1. The support of this
notification is mandatory. The notification shall be triggered by the NFVO
when it has deleted an on-boarded NSD.
PnfdOnBoardingNotification:
type: object
required:
- _links
- id
- notificationType
- subscriptionId
- pnfdId
- pnfdInfoId
- timeStamp
properties:
id:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
notificationType:
type: string
description: >
Discriminator for the different notification types. Shall be
set to "PnfdOnboardingNotification" for this notification type.
subscriptionId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
timeStamp:
description: >
Date-time of the generation of the notification.
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
pnfdInfoId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
pnfdId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
_links:
$ref: "#/definitions/PnfdmLinks"
description: >
This type represents a PNFD management notification, which informs
the receiver of the successful on-boarding of aPNFD. It shall comply with
the provisions defined in Table 5.5.2.13-1. The support of this notification
is mandatory. The notification is triggered when a new PNFD is on-boarded.
PnfdOnBoardingFailureNotification:
type: object
required:
- _links
- id
- notificationType
- subscriptionId
- onboardingFailureDetails
- pnfdInfoId
- timeStamp
properties:
id:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
notificationType:
type: string
description: >
Discriminator for the different notification types. Shall be
set to "PnfdOnboardingFailureNotification" for this notification type.
subscriptionId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
timeStamp:
description: >
Date-time of the generation of the notification.
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
pnfdInfoId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
pnfdId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
onboardingFailureDetails:
$ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
_links:
$ref: "#/definitions/PnfdmLinks"
description: >
This type represents a PNFD management notification, which informs
the receiver of the failure of on-boarding a PNFD. It shall comply with
the provisions defined in Table 5.5.2.14-1. The support of this notification
is mandatory. The notification is triggered when the on-boarding of a PNFD
fails.
PnfdDeletionNotification:
type: object
required:
- _links
- id
- notificationType
- subscriptionId
- pnfdId
- pnfdInfoId
- timeStamp
properties:
id:
type: string
description: >
Identifier of this notification. If a notification is sent multiple
times due to multiple subscriptions, the "id" attribute of all these
notifications shall have the same value.
notificationType:
type: string
description: >
Discriminator for the different notification types. Shall be
set to "PnfdDeletionNotification " for this notification type.
subscriptionId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
timeStamp:
description: >
Date-time of the generation of the notification.
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
pnfdInfoId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
pnfdId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
_links:
$ref: "#/definitions/PnfdmLinks"
description: >
This type represents a PNFD management notification, which informs
the receiver of the deletion of an on-boarded PNFD. The notification shall
comply with the provisions defined in Table 5.5.2.15-1. The support of this
notification is mandatory. The notification is triggered when an on-boarded
PNFD is deleted.
NsdmNotificationsFilter:
type: object
description: >
......@@ -715,34 +443,6 @@ definitions:
items:
$ref: "#/definitions/PnfdUsageStateType"
NsdmLinks:
type: object
required:
- nsdInfo
- subscription
properties:
nsdInfo:
$ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
subscription:
$ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
description: >
This type represents the links to resources that an NSD management
notification can contain.
PnfdmLinks:
type: object
required:
- pnfdInfo
- subscription
properties:
pnfdInfo:
$ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
subscription:
$ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
description: >
This type represents the links to resources that a PNFD management
notification can contain.
NsdOperationalStateType:
type: string
description: >
......
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
definitions:
NsdOnBoardingNotification:
type: object
required:
- _links
- id
- notificationType
- subscriptionId
- nsdId
- nsdInfoId
- timeStamp
properties:
id:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
notificationType:
type: string
description: >
Discriminator for the different notification types. Shall be
set to "NsdOnboardingNotification" for this notification type.
subscriptionId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
timeStamp:
description: >
Date-time of the generation of the notification.
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
nsdInfoId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
nsdId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
_links:
$ref: "#/definitions/NsdmLinks"
description: >
This type represents an NSD management notification, which informs
the receiver of the successful on-boarding of an NSD. It shall comply with
the provisions defined in Table 5.5.2.9-1. The support of this notification
is mandatory. The notification shall be triggered by the NFVO when the "
nsdOnboardingState" attribute of a new NSD has changed to "ONBOARDED".
NsdOnBoardingFailureNotification:
type: object
required:
- _links
- id
- notificationType
- subscriptionId
- nsdInfoId
- onboardingFailureDetails
- timeStamp
properties:
id:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
notificationType:
type: string
description: >
Discriminator for the different notification types. Shall be
set to "NsdOnboardingFailureNotification" for this notification type.
subscriptionId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
timeStamp:
description: >
Date-time of the generation of the notification.
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
nsdInfoId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
nsdId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
onboardingFailureDetails:
$ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
_links:
$ref: "#/definitions/NsdmLinks"
description: >
This type represents an NSD management notification, which informs
the receiver of the failure of on-boarding an NSD. It shall comply with the
provisions defined in Table 5.5.2.10-1. The support of this notification is
mandatory. The notification shall be triggered by the NFVO when the on-boarding
of an NSD has failed.
NsdChangeNotification:
type: object
required:
- _links
- id
- notificationType
- subscriptionId
- nsdId
- nsdInfoId
- nsdOperationalState
- timeStamp
properties:
id:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
notificationType:
type: string
description: >
Discriminator for the different notification types. Shall be
set to "NsdChangeNotification" for this notification type.
subscriptionId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
timeStamp:
description: >
Date-time of the generation of the notification.
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
nsdInfoId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
nsdId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
nsdOperationalState:
$ref: "../../NSDManagement/definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdOperationalStateType"
_links:
$ref: "#/definitions/NsdmLinks"
description: >
This type represents an NSD management notification, which informs
the receiver of a change of the "nsdOperationalState" attribute of an on-boarded
NSD. Changes in the value of the "nsdUsageState" and "nsdOnboardingState"
attributes are not reported. The notification shall comply with the provisions
defined in Table 5.5.2.11-1. The support of this notification is mandatory.
The notification shall be triggered by the NFVO when the value of the "nsdOperationalState"
attribute has changed, and the "nsdOperationalState" attribute has the value
"ONBOARDED".
NsdDeletionNotification:
type: object
required:
- _links
- id
- notificationType
- subscriptionId
- nsdId
- nsdInfoId
- timeStamp
properties:
id:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
notificationType:
type: string
description: >
Discriminator for the different notification types. Shall be
set to "NsdDeletionNotification " for this notification type.
subscriptionId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
timeStamp:
description: >
Date-time of the generation of the notification.
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
nsdInfoId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
nsdId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
_links:
$ref: "#/definitions/NsdmLinks"
description: >
This type represents an NSD management notification, which informs
the receiver of the deletion of an on-boarded NSD. The notification shall
comply with the provisions defined in Table 5.5.2.12-1. The support of this
notification is mandatory. The notification shall be triggered by the NFVO
when it has deleted an on-boarded NSD.
PnfdOnBoardingNotification:
type: object
required:
- _links
- id
- notificationType
- subscriptionId
- pnfdId
- pnfdInfoId
- timeStamp
properties:
id:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
notificationType:
type: string
description: >
Discriminator for the different notification types. Shall be
set to "PnfdOnboardingNotification" for this notification type.
subscriptionId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
timeStamp:
description: >
Date-time of the generation of the notification.
$ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
pnfdInfoId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
pnfdId:
$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
_links:
$ref: "#/definitions/PnfdmLinks"