SOL005_41 -> SOL005_46: subscriptionId added to required properties in NSD... (56fe8c5f) · Commits · NFV - Network Functions Virtualisation / SOL005

src/SOL005/NSDManagement/definitions/SOL005NSDescriptorManagement_def.yaml

+193 −169

Original line number	Diff line number	Diff line
		@@ -6,7 +6,7 @@ definitions:
		- nsdOnboardingState
		- nsdOperationalState
		- nsdUsageState
		- _links"
		- _links
		properties:
		id:
		description: >
		@@ -23,8 +23,8 @@ definitions:
		nsdName:
		type: string
		description: >
		"Name of the on boarded NSD. This information is copied from the
		NSD content and shall be present after the NSD content is on-boarded."
		Name of the on boarded NSD. This information is copied from the
		NSD content and shall be present after the NSD content is on-boarded.
		nsdVersion:
		description: >
		Version of the on-boarded NSD. This information is
		@@ -34,8 +34,8 @@ definitions:
		nsdDesigner:
		type: string
		description: >
		"Designer of the on-boarded NSD. This information is copied
		from the NSD content and shall be present after the NSD content is on-boarded."
		Designer of the on-boarded NSD. This information is copied
		from the NSD content and shall be present after the NSD content is on-boarded.
		nsdInvariantId:
		description: >
		This identifier, which is allocated by the NSD
		@@ -116,7 +116,7 @@ definitions:
		This type represents a response for the query NSD operation.

		NsdInfoModifications:
		type: "object"
		type: object
		description: >
		This type represents attribute modifications for an individual NS
		descriptor resource based on the NsdInfo data type. The attributes of
		@@ -132,26 +132,25 @@ definitions:
		data type. See note. If present, these modifications shall be applied
		according to the rules of JSON Merge PATCH (see IETF RFC 7396 [25]).
		NOTE- At least one of the attributes - nsdOperationalState and userDefinedData - shall be present.
		type: "array"
		type: array
		items:
		$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"

		NsdOperationalState:
		description: >
		"New value of the "nsdOperationalState" attribute in "NsdInfo"
		New value of the "nsdOperationalState" attribute in "NsdInfo"
		data type. See note.Permitted values:
		ENABLED,
		DISABLED"
		type: "array"
		ENABLED, DISABLED.
		type: array
		items:
		$ref: "#/definitions/NsdInfoModifications"

		NsdmSubscription:
		type: "object"
		type: object
		required:
		- "id"
		- "callbackUri"
		- "_links"
		- id
		- callbackUri
		- _links
		properties:
		id:
		description: >
		@@ -169,7 +168,7 @@ definitions:
		The URI of the endpoint to send the notification to.
		$ref: "SOL005_def.yaml#/definitions/Uri"
		_links:
		type: "object"
		type: object
		description: >
		Links to resources related to this resource.
		properties:
		@@ -179,14 +178,14 @@ definitions:
		This type represents a subscription related to notifications about NSD management.

		NsdmSubscriptionRequest:
		type: "object"
		type: object
		required:
		- "callbackUri"
		- callbackUri
		properties:
		filter:
		$ref: "#/definitions/NsdmNotificationsFilter"
		callbackUri:
		type: "string"
		type: string
		description: >
		The URI of the endpoint to send the notification to.
		authentication:
		@@ -194,36 +193,37 @@ definitions:
		description: >
		This type represents a subscription request related to notifications
		about NSD management.

		NsdmNotificationsFilter:
		type: "object"
		type: object
		description: >
		"This type represents a subscription filter related to notifications
		This type represents a subscription filter related to notifications
		about NSD management. It shall comply with the provisions defined in Table
		5.5.3.2-1 of GS NFV-SOL 005. At a particular nesting level in the filter structure,
		the following applies: All attributes shall match in order for the filter
		to match (logical "and" between different filter attributes). If an attribute
		is an array, the attribute shall match if at least one of the values in the
		array matches (logical "or" between the values of one filter attribute)."
		array matches (logical "or" between the values of one filter attribute).
		properties:
		notificationTypes:
		description: >
		"Match particular notification types. Permitted values: NsdOnBoardingNotification,
		Match particular notification types. Permitted values: NsdOnBoardingNotification,
		NsdOnboardingFailureNotification, NsdChangeNotification, NsdDeletionNotification
		PnfdOnBoardingNotification, PnfdOnBoardingFailureNotification, PnfdDeletionNotification.
		The permitted values of the "notificationTypes" ] attribute are spelled
		exactly as the names of the notification types to facilitate automated
		code generation systems."
		code generation systems.
		type: array
		items:
		type: string
		enum:
		- "NsdOnBoardingNotification"
		- "NsdOnboardingFailureNotification"
		- "NsdChangeNotification"
		- "NsdDeletionNotification"
		- "PnfdOnBoardingNotification"
		- "PnfdOnBoardingFailureNotification"
		- "PnfdDeletionNotification"
		- NsdOnBoardingNotification
		- NsdOnboardingFailureNotification
		- NsdChangeNotification
		- NsdDeletionNotification
		- PnfdOnBoardingNotification
		- PnfdOnBoardingFailureNotification
		- PnfdDeletionNotification
		nsdInfoId:
		description: >
		Match the NsdInfo identifier which is allocated by the NFVO.
		@@ -250,7 +250,7 @@ definitions:
		$ref: "SOL005_def.yaml#/definitions/Version"
		nsdDesigner:
		description: >
		"Match the NSD designer of the on-boarded NSD."
		Match the NSD designer of the on-boarded NSD.
		type: array
		items:
		$ref: "SOL005_def.yaml#/definitions/String"
		@@ -343,6 +343,7 @@ definitions:
		type: array
		items:
		$ref: "#/definitions/PnfdUsageStateType"

		SubscriptionAuthentication:
		description: >
		The procedure defined in clause 4.5.2 allows an API consumer to
		@@ -353,9 +354,9 @@ definitions:
		If an API consumer requires the API producer to authorize for sending notifications to that API consumer, it shall
		include in the subscription request a data structure that defines the authorization requirements, as defined in
		Table 4.5.3.4-1.
		type: "object"
		type: object
		required:
		- "authType"
		- authType
		properties:
		authType:
		description: >
		@@ -386,7 +387,7 @@ definitions:
		- OAUTH2_CLIENT_CREDENTIALS
		- TLS_CERT
		paramsBasic:
		type: "object"
		type: object
		description: >
		Parameters for authentication/authorization using BASIC.
		Shall be present if authType is "BASIC" and
		@@ -404,12 +405,12 @@ definitions:
		Shall be present if it has not been provisioned out of band.
		type: string
		paramsOauth2ClientCredentials:
		type: "object"
		type: object
		description: >
		Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS.
		Shall be present if authType is "OAUTH2_CLIENT_CREDENTIALS" and the
		contained information has not been provisioned out of band.
		Shall be absent otherwise
		Shall be absent otherwise.
		properties:
		clientId:
		description: >
		@@ -433,52 +434,56 @@ definitions:
		$ref: "SOL005_def.yaml#/definitions/Uri"

		NsdOperationalStateType:
		type: "string"
		type: string
		description: >
		"The enumeration NsdOperationalStateType shall comply with the provisions
		The enumeration NsdOperationalStateType shall comply with the provisions
		defined in Table 5.5.4.3-1 of GS NFV_SOL 005. It indicates the operational
		state of the resource.
		ENABLED = The operational state of the resource is enabled.
		DISABLED = The operational state of the resource is disabled."
		DISABLED = The operational state of the resource is disabled.
		enum:
		- "ENABLED"
		- "DISABLED"
		- ENABLED
		- DISABLED

		NsdOnboardingStateType:
		type: "string"
		type: string
		description: >
		"The enumeration NsdOnboardingStateType shall comply with the provisions
		The enumeration NsdOnboardingStateType shall comply with the provisions
		defined in Table 5.5.4.5-1 of GS NFV-SOL 005. It indicates the on-boarding
		state of the NSD.
		CREATED = The NSD information object is created.
		UPLOADING = The associated NSD content is being uploaded.
		PROCESSING = The associated NSD content is being processed, e.g. validation.
		ONBOARDED = The associated NSD content is on-boarded."
		ONBOARDED = The associated NSD content is on-boarded.
		enum:
		- "CREATED"
		- "UPLOADING"
		- "PROCESSING"
		- "ONBOARDED"
		- CREATED
		- UPLOADING
		- PROCESSING
		- ONBOARDED

		NsdUsageStateType:
		type: "string"
		type: string
		description: >
		"The enumeration NsdUsageStateType shall comply with the provisions
		The enumeration NsdUsageStateType shall comply with the provisions
		defined in Table 5.5.4.4-1 of GS NFV-SOL 005. It indicates the usage state
		of the resource.IN_USE = The resource is in use.NOT_IN_USE = The resource
		is not-in-use."
		is not-in-use.
		enum:
		- "IN_USE"
		- "NOT_IN_USE"
		- IN_USE
		- NOT_IN_USE

		CreateNsdInfoRequest:
		type: "object"
		type: object
		properties:
		userDefinedData:
		$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
		description: >
		"This type creates a completely new NS descriptor resource."
		This type creates a completely new NS descriptor resource.

		PnfdInfoModifications:
		type: "object"
		type: object
		required:
		- "userDefinedData"
		- userDefinedData
		properties:
		userDefinedData:
		$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
		@@ -487,6 +492,7 @@ definitions:
		descriptor resource based on the "PnfdInfo" data type. The attributes of
		"PnfdInfo" that can be modified are included in the "PnfdInfoModifications"
		data type.

		PnfdInfo:
		type: object
		required:
		@@ -518,8 +524,8 @@ definitions:
		$ref: "SOL005_def.yaml#/definitions/Version"
		pnfdProvider:
		description: >
		"Provider of the on-boarded PNFD. This information is copied from
		the PNFD content and shall be present after the PNFD content is on-boarded."
		Provider of the on-boarded PNFD. This information is copied from
		the PNFD content and shall be present after the PNFD content is on-boarded.
		type: string
		pnfdInvariantId:
		description: >
		@@ -553,7 +559,7 @@ definitions:
		- self
		type: object
		description: >
		"Links to resources related to this resource."
		Links to resources related to this resource.
		properties:
		self:
		$ref: "SOL005_def.yaml#/definitions/Link"
		@@ -573,22 +579,24 @@ definitions:
		PROCESSING = The associated PNFD content is being processed, e.g. validation.
		ONBOARDED = The associated PNFD content is on-boarded.
		enum:
		- "CREATED"
		- "UPLOADING"
		- "PROCESSING"
		- "ONBOARDING"
		- CREATED
		- UPLOADING
		- PROCESSING
		- ONBOARDING

		PnfdUsageStateType:
		type: "string"
		type: string
		description: >
		"The enumeration PnfdUsageStateType shall comply with the provisions
		The enumeration PnfdUsageStateType shall comply with the provisions
		defined in Table 5.5.4.7-1 of GS NFV-SOL005. It indicates the usage state
		of the resource.IN-USE = The resource is in use.NOT_IN_USE = The resource
		is not-in-use."
		is not-in-use.
		enum:
		- "IN_USE"
		- "NOT_IN_USE"
		- IN_USE
		- NOT_IN_USE
		-
		CreatePnfdInfoRequest:
		type: "object"
		type: object
		properties:
		userDefinedData:
		$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
		@@ -596,49 +604,53 @@ definitions:
		User-defined data for the PNF descriptor resource to be created.
		It shall be present when the user defined data is set for
		the individual PNF descriptor resource to be created.

		NsdmLinks:
		type: "object"
		type: object
		required:
		- "nsdInfo"
		- "subscription"
		- nsdInfo
		- subscription
		properties:
		nsdInfo:
		$ref: "SOL005_def.yaml#/definitions/Link"
		subscription:
		$ref: "SOL005_def.yaml#/definitions/Link"
		description: >
		"This type represents the links to resources that an NSD management
		notification can contain."
		This type represents the links to resources that an NSD management
		notification can contain.

		PnfdmLinks:
		type: "object"
		type: object
		required:
		- "pnfdInfo"
		- "subscription"
		- pnfdInfo
		- subscription
		properties:
		pnfdInfo:
		$ref: "SOL005_def.yaml#/definitions/Link"
		subscription:
		$ref: "SOL005_def.yaml#/definitions/Link"
		description: >
		"This type represents the links to resources that a PNFD management
		notification can contain."
		This type represents the links to resources that a PNFD management
		notification can contain.

		NsdOnBoardingNotification:
		type: "object"
		type: object
		required:
		- "_links"
		- "id"
		- "notificationType"
		- "nsdId"
		- "nsdInfoId"
		- "timeStamp"
		- _links
		- id
		- notificationType
		- subscriptionId
		- nsdId
		- nsdInfoId
		- timeStamp
		properties:
		id:
		$ref: "SOL005_def.yaml#/definitions/Identifier"
		notificationType:
		type: "string"
		type: string
		description: >
		"Discriminator for the different notification types. Shall be
		set to "NsdOnboardingNotification" for this notification type."
		Discriminator for the different notification types. Shall be
		set to "NsdOnboardingNotification" for this notification type.
		subscriptionId:
		$ref: "SOL005_def.yaml#/definitions/Identifier"
		timeStamp:
		@@ -652,28 +664,30 @@ definitions:
		_links:
		$ref: "#/definitions/NsdmLinks"
		description: >
		"This type represents an NSD management notification, which informs
		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"."
		nsdOnboardingState" attribute of a new NSD has changed to "ONBOARDED".

		NsdOnBoardingFailureNotification:
		type: "object"
		type: object
		required:
		- "_links"
		- "id"
		- "notificationType"
		- "nsdInfoId"
		- "onboardingFailureDetails"
		- "timeStamp"
		- _links
		- id
		- notificationType
		- subscriptionId
		- nsdInfoId
		- onboardingFailureDetails
		- timeStamp
		properties:
		id:
		$ref: "SOL005_def.yaml#/definitions/Identifier"
		notificationType:
		type: "string"
		type: string
		description: >
		"Discriminator for the different notification types. Shall be
		set to "NsdOnboardingFailureNotification" for this notification type."
		Discriminator for the different notification types. Shall be
		set to "NsdOnboardingFailureNotification" for this notification type.
		subscriptionId:
		$ref: "SOL005_def.yaml#/definitions/Identifier"
		timeStamp:
		@@ -689,29 +703,31 @@ definitions:
		_links:
		$ref: "#/definitions/NsdmLinks"
		description: >
		"This type represents an NSD management notification, which informs
		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."
		of an NSD has failed.

		NsdChangeNotification:
		type: "object"
		type: object
		required:
		- "_links"
		- "id"
		- "notificationType"
		- "nsdId"
		- "nsdInfoId"
		- "nsdOperationalState"
		- "timeStamp"
		- _links
		- id
		- notificationType
		- subscriptionId
		- nsdId
		- nsdInfoId
		- nsdOperationalState
		- timeStamp
		properties:
		id:
		$ref: "SOL005_def.yaml#/definitions/Identifier"
		notificationType:
		type: "string"
		type: string
		description: >
		"Discriminator for the different notification types. Shall be
		set to "NsdChangeNotification" for this notification type."
		Discriminator for the different notification types. Shall be
		set to "NsdChangeNotification" for this notification type.
		subscriptionId:
		$ref: "SOL005_def.yaml#/definitions/Identifier"
		timeStamp:
		@@ -727,31 +743,33 @@ definitions:
		_links:
		$ref: "#/definitions/NsdmLinks"
		description: >
		"This type represents an NSD management notification, which informs
		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"."
		"ONBOARDED".

		NsdDeletionNotification:
		type: "object"
		type: object
		required:
		- "_links"
		- "id"
		- "notificationType"
		- "nsdId"
		- "nsdInfoId"
		- "timeStamp"
		- _links
		- id
		- notificationType
		- subscriptionId
		- nsdId
		- nsdInfoId
		- timeStamp
		properties:
		id:
		$ref: "SOL005_def.yaml#/definitions/Identifier"
		notificationType:
		type: "string"
		type: string
		description: >
		"Discriminator for the different notification types. Shall be
		set to "NsdDeletionNotification " for this notification type."
		Discriminator for the different notification types. Shall be
		set to "NsdDeletionNotification " for this notification type.
		subscriptionId:
		$ref: "SOL005_def.yaml#/definitions/Identifier"
		timeStamp:
		@@ -765,28 +783,30 @@ definitions:
		_links:
		$ref: "#/definitions/NsdmLinks"
		description: >
		"This type represents an NSD management notification, which informs
		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."
		when it has deleted an on-boarded NSD.

		PnfdOnBoardingNotification:
		type: "object"
		type: object
		required:
		- "_links"
		- "id"
		- "notificationType"
		- "pnfdId"
		- "pnfdInfoId"
		- "timeStamp"
		- _links
		- id
		- notificationType
		- subscriptionId
		- pnfdId
		- pnfdInfoId
		- timeStamp
		properties:
		id:
		$ref: "SOL005_def.yaml#/definitions/Identifier"
		notificationType:
		type: "string"
		type: string
		description: >
		"Discriminator for the different notification types. Shall be
		set to "PnfdOnboardingNotification" for this notification type."
		Discriminator for the different notification types. Shall be
		set to "PnfdOnboardingNotification" for this notification type.
		subscriptionId:
		$ref: "SOL005_def.yaml#/definitions/Identifier"
		timeStamp:
		@@ -800,27 +820,29 @@ definitions:
		_links:
		$ref: "#/definitions/PnfdmLinks"
		description: >
		"This type represents a PNFD management notification, which informs
		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."
		is mandatory. The notification is triggered when a new PNFD is on-boarded.

		PnfdOnBoardingFailureNotification:
		type: "object"
		type: object
		required:
		- "_links"
		- "id"
		- "notificationType"
		- "onboardingFailureDetails"
		- "pnfdInfoId"
		- "timeStamp"
		- _links
		- id
		- notificationType
		- subscriptionId
		- onboardingFailureDetails
		- pnfdInfoId
		- timeStamp
		properties:
		id:
		$ref: "SOL005_def.yaml#/definitions/Identifier"
		notificationType:
		type: "string"
		type: string
		description: >
		"Discriminator for the different notification types. Shall be
		set to "PnfdOnboardingFailureNotification" for this notification type."
		Discriminator for the different notification types. Shall be
		set to "PnfdOnboardingFailureNotification" for this notification type.
		subscriptionId:
		$ref: "SOL005_def.yaml#/definitions/Identifier"
		timeStamp:
		@@ -836,32 +858,34 @@ definitions:
		_links:
		$ref: "#/definitions/PnfdmLinks"
		description: >
		"This type represents a PNFD management notification, which informs
		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."
		fails.

		PnfdDeletionNotification:
		type: "object"
		type: object
		required:
		- "_links"
		- "id"
		- "notificationType"
		- "pnfdId"
		- "pnfdInfoId"
		- "timeStamp"
		- _links
		- id
		- notificationType
		- subscriptionId
		- pnfdId
		- pnfdInfoId
		- timeStamp
		properties:
		id:
		type: "string"
		type: string
		description: >
		"Identifier of this notification. If a notification is sent multiple
		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."
		notifications shall have the same value.
		notificationType:
		type: "string"
		type: string
		description: >
		"Discriminator for the different notification types. Shall be
		set to "PnfdDeletionNotification " for this notification type."
		Discriminator for the different notification types. Shall be
		set to "PnfdDeletionNotification " for this notification type.
		subscriptionId:
		$ref: "SOL005_def.yaml#/definitions/Identifier"
		timeStamp:
		@@ -875,8 +899,8 @@ definitions:
		_links:
		$ref: "#/definitions/PnfdmLinks"
		description: >
		"This type represents a PNFD management notification, which informs
		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."
		No newline at end of file
		PNFD is deleted.
		No newline at end of file