Edit TS29369_Nadm_DM.yaml (f9bf4a62) · Commits · All Groups / 5G APIs

TS29369_Nadm_DM.yaml

+376 −30

Original line number	Diff line number	Diff line
		@@ -41,7 +41,7 @@ paths:
		parameters:
		- name: aiotDevPermId
		in: path
		description: AIoT Device Permanent ID
		description: AIoT Device Permanent Identifier
		required: true
		schema:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/AiotDevPermId'
		@@ -95,7 +95,7 @@ paths:
		parameters:
		- name: aiotDevPermId
		in: path
		description: AIoT Device Permanent ID
		description: AIoT Device Permanent Identifier
		required: true
		schema:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/AiotDevPermId'
		@@ -106,7 +106,7 @@ paths:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
		requestBody:
		content:
		application/merge-patch+json:
		application/json-patch+json:
		schema:
		$ref: '#/components/schemas/AiotDevProfileData'
		required: true
		@@ -151,6 +151,87 @@ paths:
		$ref: 'TS29571_CommonData.yaml#/components/responses/503'
		default:
		description: Unexpected error
		callbacks:
		AiotfDeregistrationNotification:
		'{$request.body#/lastKnownAiotfInfo/deregCallbackUri}':
		post:
		requestBody:
		required: true
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/AiotfDeregistrationData'
		responses:
		'204':
		description: Successful Notification response
		'307':
		$ref: 'TS29571_CommonData.yaml#/components/responses/307'
		'308':
		$ref: 'TS29571_CommonData.yaml#/components/responses/308'
		'400':
		$ref: 'TS29571_CommonData.yaml#/components/responses/400'
		'401':
		$ref: 'TS29571_CommonData.yaml#/components/responses/401'
		'403':
		$ref: 'TS29571_CommonData.yaml#/components/responses/403'
		'404':
		$ref: 'TS29571_CommonData.yaml#/components/responses/404'
		'411':
		$ref: 'TS29571_CommonData.yaml#/components/responses/411'
		'413':
		$ref: 'TS29571_CommonData.yaml#/components/responses/413'
		'415':
		$ref: 'TS29571_CommonData.yaml#/components/responses/415'
		'429':
		$ref: 'TS29571_CommonData.yaml#/components/responses/429'
		'500':
		$ref: 'TS29571_CommonData.yaml#/components/responses/500'
		'502':
		$ref: 'TS29571_CommonData.yaml#/components/responses/502'
		'503':
		$ref: 'TS29571_CommonData.yaml#/components/responses/503'
		default:
		description: Unexpected error
		TargetAfInfoNotification:
		'{$request.body#/lastKnownAiotfInfo/afInfoNotifyUri}':
		post:
		requestBody:
		required: true
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/UpdatedTargetAfInfo'
		responses:
		'204':
		description: Successful Notification response
		'307':
		$ref: 'TS29571_CommonData.yaml#/components/responses/307'
		'308':
		$ref: 'TS29571_CommonData.yaml#/components/responses/308'
		'400':
		$ref: 'TS29571_CommonData.yaml#/components/responses/400'
		'401':
		$ref: 'TS29571_CommonData.yaml#/components/responses/401'
		'403':
		$ref: 'TS29571_CommonData.yaml#/components/responses/403'
		'404':
		$ref: 'TS29571_CommonData.yaml#/components/responses/404'
		'411':
		$ref: 'TS29571_CommonData.yaml#/components/responses/411'
		'413':
		$ref: 'TS29571_CommonData.yaml#/components/responses/413'
		'415':
		$ref: 'TS29571_CommonData.yaml#/components/responses/415'
		'429':
		$ref: 'TS29571_CommonData.yaml#/components/responses/429'
		'500':
		$ref: 'TS29571_CommonData.yaml#/components/responses/500'
		'502':
		$ref: 'TS29571_CommonData.yaml#/components/responses/502'
		'503':
		$ref: 'TS29571_CommonData.yaml#/components/responses/503'
		default:
		description: Unexpected error

		/aiot-device-profile-data:
		get:
		@@ -168,7 +249,7 @@ paths:
		parameters:
		- name: requester-aiot-devices-id
		in: query
		description: a list of AIoT Device Permanent ID
		description: a list of AIoT Device Permanent Identifier
		required: true
		style: form
		explode: false
		@@ -329,6 +410,207 @@ paths:
		default:
		description: Unexpected error

		/af-authorization-data/subscriptions:
		post:
		summary: Create a subscription of AF Authorization Data Changes
		operationId: Subscribe AF Authorization Data Change
		tags:
		- Create a subscription of AF Authorization Data Changes
		security:
		- {}
		- oAuth2ClientCredentials:
		- nadm-dm
		- oAuth2ClientCredentials:
		- nadm-dm
		- nadm-dm:af-authorization-data:subscriptions:create
		requestBody:
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/AfAuthorizationDataSubscription'
		required: true
		callbacks:
		afAuthorizationDataChangeNotification:
		'{$request.body#/notifyCalblackUri}':
		post:
		requestBody: # contents of the callback message
		required: true
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/AfAuthorizationDataChangeNotification'
		responses:
		'204':
		description: successful notification
		'307':
		$ref: 'TS29571_CommonData.yaml#/components/responses/307'
		'308':
		$ref: 'TS29571_CommonData.yaml#/components/responses/308'
		'400':
		$ref: 'TS29571_CommonData.yaml#/components/responses/400'
		'403':
		$ref: 'TS29571_CommonData.yaml#/components/responses/403'
		'404':
		$ref: 'TS29571_CommonData.yaml#/components/responses/404'
		'411':
		$ref: 'TS29571_CommonData.yaml#/components/responses/411'
		'413':
		$ref: 'TS29571_CommonData.yaml#/components/responses/413'
		'415':
		$ref: 'TS29571_CommonData.yaml#/components/responses/415'
		'429':
		$ref: 'TS29571_CommonData.yaml#/components/responses/429'
		'500':
		$ref: 'TS29571_CommonData.yaml#/components/responses/500'
		'502':
		$ref: 'TS29571_CommonData.yaml#/components/responses/502'
		'503':
		$ref: 'TS29571_CommonData.yaml#/components/responses/503'
		responses:
		'201':
		description: successful creation of the subscription
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/AfAuthorizationDataSubscription'
		headers:
		Location:
		description: >
		'Contains the URI of the newly created subscription, according to the structure:
		{apiRoot}/nadm-dm/<apiVersion>/af-authorization-data/subscriptions/{subId}'
		required: true
		schema:
		type: string
		'307':
		$ref: 'TS29571_CommonData.yaml#/components/responses/307'
		'308':
		$ref: 'TS29571_CommonData.yaml#/components/responses/308'
		'400':
		$ref: 'TS29571_CommonData.yaml#/components/responses/400'
		'401':
		$ref: 'TS29571_CommonData.yaml#/components/responses/401'
		'403':
		$ref: 'TS29571_CommonData.yaml#/components/responses/403'
		'404':
		$ref: 'TS29571_CommonData.yaml#/components/responses/404'
		'411':
		$ref: 'TS29571_CommonData.yaml#/components/responses/411'
		'413':
		$ref: 'TS29571_CommonData.yaml#/components/responses/413'
		'415':
		$ref: 'TS29571_CommonData.yaml#/components/responses/415'
		'429':
		$ref: 'TS29571_CommonData.yaml#/components/responses/429'
		'500':
		$ref: 'TS29571_CommonData.yaml#/components/responses/500'
		'502':
		$ref: 'TS29571_CommonData.yaml#/components/responses/502'
		'503':
		$ref: 'TS29571_CommonData.yaml#/components/responses/503'
		'504':
		$ref: 'TS29571_CommonData.yaml#/components/responses/504'
		default:
		$ref: 'TS29571_CommonData.yaml#/components/responses/default'

		/af-authorization-data/subscriptions/{subId}:
		patch:
		summary: Modify a subscription of AF Authorization Data Changes
		operationId: Modify Subscription of AF Authorization Data Change
		tags:
		- Modify a subscription of AF Authorization Data Changes
		security:
		- {}
		- oAuth2ClientCredentials:
		- nadm-dm
		- oAuth2ClientCredentials:
		- nadm-dm
		- nadm-dm:af-authorization-data:subscriptions:modify
		requestBody:
		content:
		application/json-patch+json:
		schema:
		type: array
		items:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem'
		required: true
		responses:
		'200':
		description: Expected response to partially successful patch
		content:
		application/json:
		schema:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult'
		'204':
		description: Expected response to successful patch
		'307':
		$ref: 'TS29571_CommonData.yaml#/components/responses/307'
		'308':
		$ref: 'TS29571_CommonData.yaml#/components/responses/308'
		'400':
		$ref: 'TS29571_CommonData.yaml#/components/responses/400'
		'401':
		$ref: 'TS29571_CommonData.yaml#/components/responses/401'
		'403':
		$ref: 'TS29571_CommonData.yaml#/components/responses/403'
		'404':
		$ref: 'TS29571_CommonData.yaml#/components/responses/404'
		'411':
		$ref: 'TS29571_CommonData.yaml#/components/responses/411'
		'413':
		$ref: 'TS29571_CommonData.yaml#/components/responses/413'
		'415':
		$ref: 'TS29571_CommonData.yaml#/components/responses/415'
		'429':
		$ref: 'TS29571_CommonData.yaml#/components/responses/429'
		'500':
		$ref: 'TS29571_CommonData.yaml#/components/responses/500'
		'502':
		$ref: 'TS29571_CommonData.yaml#/components/responses/502'
		'503':
		$ref: 'TS29571_CommonData.yaml#/components/responses/503'
		default:
		$ref: 'TS29571_CommonData.yaml#/components/responses/default'

		delete:
		summary: Delete a subscription of AF Authorization Data Changes
		operationId: Unsubscribe to AF Authorization Data Change
		tags:
		- Delete a subscription of AF Authorization Data Changes
		security:
		- {}
		- oAuth2ClientCredentials:
		- nadm-dm
		- oAuth2ClientCredentials:
		- nadm-dm
		- nadm-dm:af-authorization-data:subscriptions:modify
		responses:
		'204':
		description: Expected response to successful deletion
		'307':
		$ref: 'TS29571_CommonData.yaml#/components/responses/307'
		'308':
		$ref: 'TS29571_CommonData.yaml#/components/responses/308'
		'400':
		$ref: 'TS29571_CommonData.yaml#/components/responses/400'
		'401':
		$ref: 'TS29571_CommonData.yaml#/components/responses/401'
		'403':
		$ref: 'TS29571_CommonData.yaml#/components/responses/403'
		'404':
		$ref: 'TS29571_CommonData.yaml#/components/responses/404'
		'411':
		$ref: 'TS29571_CommonData.yaml#/components/responses/411'
		'429':
		$ref: 'TS29571_CommonData.yaml#/components/responses/429'
		'500':
		$ref: 'TS29571_CommonData.yaml#/components/responses/500'
		'501':
		$ref: 'TS29571_CommonData.yaml#/components/responses/501'
		'503':
		$ref: 'TS29571_CommonData.yaml#/components/responses/503'
		default:
		$ref: 'TS29571_CommonData.yaml#/components/responses/default'

		components:
		securitySchemes:
		oAuth2ClientCredentials:
		@@ -341,6 +623,8 @@ components:
		nadm-dm:aiot-device-profile-data:read: Access to read AIoT Device Profile Data
		nadm-dm:aiot-device-profile-data:modify: Access to update AIoT Device Profile Data
		nadm-dm:af-authorization-data:read: Access to read AF Authorization Data
		nadm-dm:af-authorization-data:subscriptions:create: Access to create the subscriptions of AF Authorization Data Changes
		nadm-dm:af-authorization-data:subscriptions:modify: Access to modify or delete the subscriptions of AF Authorization Data Changes

		schemas:
		#
		@@ -358,12 +642,15 @@ components:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/AiotDevPermId'
		lastKnownAiotfInfo:
		$ref: '#/components/schemas/LastKnownAiotfInfo'
		tidCurrent:
		$ref: '#/components/schemas/Tid'
		tidPrevious:
		$ref: '#/components/schemas/Tid'
		tidHandlingInformation:
		$ref: '#/components/schemas/TidHandlingInformation'
		doaCapableDevice:
		type: boolean
		default: false
		subscribedAfInfo:
		$ref: '#/components/schemas/TargetAfInfo'
		deregCallbackUri:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
		afInfoNotifyUri:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'

		LastKnownAiotfInfo:
		description: Contains the Last Known AIoTF Info.
		@@ -426,30 +713,88 @@ components:
		additionalProperties:
		$ref: '#/components/schemas/IndividualAfAuthorizationData'
		minProperties: 1
		#
		# SIMPLE TYPES
		#

		AfId:
		description: Indicates the identifier used to identify the AF.
		AfAuthorizationDataSubscription:
		description: Contains a AF Authorization Data Change Subscription.
		type: object
		required:
		- notifyCallbackUri
		- notifyCorrelationId
		properties:
		notifyCallbackUri:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
		notifyCorrelationId:
		type: string
		afId:
		$ref: '#/components/schemas/AfId'
		expiry:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'

		Tid:
		description: Temporary ID of the AIoT device.
		AfAuthorizationDataChangeNotification:
		description: Contains a AF Authorization Data Change Notification.
		type: object
		required:
		- udpateAfAuthData
		- notifyCorrelationId
		properties:
		udpateAfAuthData:
		type: object
		description: >
		'Map carrying the Updated AF Authorization Data.
		The key of the map is the AF ID of the corresponding Authorization Data'
		additionalProperties:
		$ref: '#/components/schemas/IndividualAfAuthorizationData'
		minProperties: 1
		notifyCorrelationId:
		type: string
		pattern: '^[A-Fa-f0-9]{32}$'

		TargetAfInfo:
		description: >
		The information of a target AF which has subscribed to receive the data
		from DO-A capable AIoT device.
		type: object
		required:
		- afId
		- dataRecvUri
		properties:
		afId:
		$ref: '#/components/schemas/AfId'
		dataRecvUri:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
		afAddr:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr'

		TidHandlingInformation:
		description: Contains the T-ID handling information
		AiotfDeregistrationData:
		description: >
		This datatype is supported by the POST HTTP method, and it includes the
		AIOTF deregistration data.
		type: object
		required:
		- tidType
		- aiotDevPermId
		properties:
		tidType:
		$ref: '#/components/schemas/TidType'
		tidHandlingInformation:
		type: boolean
		aiotDevPermId:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/AiotDevPermId'
		cause:
		$ref: '#/components/schemas/Cause'

		UpdatedTargetAfInfo:
		description: Indicate the AF address or AF ID.
		required:
		- aiotDevPermId
		properties:
		aiotDevPermId:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/AiotDevPermId'
		targetAfInfo:
		$ref: '#/components/schemas/TargetAfInfo'

		#
		# SIMPLE TYPES
		#

		AfId:
		description: Indicates the identifier used to identify the AF.
		type: string


		AiotDevProfileDataList:
		description: AIoT Device Profile Data of a list of AIoT devices.
		@@ -479,11 +824,12 @@ components:
		- PERMANENT_DISABLE
		- type: string

		TidType:
		description: Indicates the type of T-ID.
		Cause:
		description: Indicates the cause.
		anyOf:
		- type: string
		enum:
		- STORED
		- CONCEALED
		- OPERATIONAL
		- CHANGE_OF_AIOTF
		- type: string