Update1 CT3#142 TS29569_Naiotf_AIoT.yaml (47b2ba86) · Commits · All Groups / 5G APIs

TS29569_Naiotf_AIoT.yaml

+47 −24

Original line number	Diff line number	Diff line
		openapi: 3.0.0

		info:
		title: Naiotf_AIoT Service API
		version: 1.0.0-alpha.3
		title: AIOTF Ambient IoT Service
		version: 1.0.0
		description: \|
		API for_AIoT Service.
		API for the Naiotf_AIoT Service.
		© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.

		externalDocs:
		description: 3GPP TS 29.569 V1.0.0; Ambient IoT Function (AIOTF) Services.
		description: 3GPP TS 29.569 V1.1.0; Ambient IoT Function (AIOTF) Services.
		url: http://www.3gpp.org/ftp/Specs/archive/29_series/29.569/

		servers:
		@@ -27,7 +27,7 @@ security:
		paths:
		/request-inv:
		post:
		summary: Request to perform an AIoT inventory operation.
		summary: Request to perform an AIoT Inventory operation.
		operationId: InventoryRequest
		tags:
		- AIoT Inventory Request (custom operation without associated resources)
		@@ -47,8 +47,8 @@ paths:
		responses:
		'200':
		description: >
		OK. The AIoT inventory request is successfully received and processed, and the requested
		AIoT inventory related information is returned in the response body.
		OK. The AIoT Inventory request is successfully received and processed, and
		AIoT Inventory related information is returned in the response body.
		content:
		application/json:
		schema:
		@@ -127,7 +127,7 @@ paths:

		/request-cmd:
		post:
		summary: Request to perform an AIoT command operation.
		summary: Request to perform an AIoT Command operation.
		operationId: CommandRequest
		tags:
		- AIoT Command Request (custom operation without associated resources)
		@@ -147,8 +147,8 @@ paths:
		responses:
		'200':
		description: >
		OK. The AIoT command request is successfully received and processed, and the requested
		AIoT command related information is returned in the response body.
		OK. The AIoT Command request is successfully received and processed, and
		AIoT Command related information is returned in the response body.
		content:
		application/json:
		schema:
		@@ -250,7 +250,7 @@ components:
		#

		InventoryReq:
		description: Represents the AIoT inventory request.
		description: Represents the AIoT Inventory request.
		type: object
		properties:
		afId:
		@@ -261,6 +261,8 @@ components:
		$ref: '#/components/schemas/AIoTDevices'
		numDevices:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
		timeInterval:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
		notifUri:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
		suppFeat:
		@@ -273,7 +275,7 @@ components:
		- required: [targetDevices]

		InventoryResp:
		description: Represents the AIoT inventory response.
		description: Represents the AIoT Inventory response.
		type: object
		properties:
		transId:
		@@ -284,7 +286,7 @@ components:
		- transId

		CommandReq:
		description: Represents the AIoT command request.
		description: Represents the AIoT Command request.
		type: object
		properties:
		afId:
		@@ -299,6 +301,12 @@ components:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
		msgSize:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
		offset:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
		length:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
		data:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes'
		notifUri:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
		suppFeat:
		@@ -312,7 +320,7 @@ components:
		- required: [targetDevices]

		CommandResp:
		description: Represents the AIoT command response.
		description: Represents the AIoT Command response.
		type: object
		properties:
		transId:
		@@ -328,24 +336,28 @@ components:
		properties:
		transId:
		type: string
		devices:
		devicesRepData:
		type: array
		items:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/AiotDevPermId'
		$ref: '#/components/schemas/DevicesRepInfo'
		minItems: 1
		lastRepInd:
		type: boolean
		default: false
		enum:
		- true
		description: >
		Contains the Last Report Indication, i.e., indicates whether this is the last reporting
		from the NF service consumer.
		Indicates that this is the last reporting from the AIOTF for the AIoT service
		operation identified by the "transId" attribute.
		true indicates that this is the last report.
		false indicates that this is not the last report.
		The default value is false when this attribute is omitted.
		suppFeat:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
		This attribute shall be present only when this is the last reporting from the NF service
		consumer for the AIoT service operation identified by the transId attribute.
		When present, this attribute shall be set to true. The presence of this attribute set
		to the value false is forbidden.
		required:
		- transId
		anyOf:
		- required: [devicesRepData]
		- required: [lastRepInd]

		AIoTDevices:
		description: Represents the AIoT device(s) related information.
		@@ -358,10 +370,21 @@ components:
		minItems: 1
		filteringInfo:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/AiotFilteringInformation'
		anyOf:
		oneOf:
		- required: [devices]
		- required: [filteringInfo]

		DevicesRepInfo:
		description: Represents the AIoT device(s) related reporting information.
		type: object
		properties:
		deviceId:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/AiotDevPermId'
		readCmdRep:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes'
		required:
		- deviceId


		#
		# SIMPLE DATA TYPES