Update TS29566_Neif_EventExposure.yaml (3b4d9fbc) · Commits · All Groups / 5G APIs

TS29566_Neif_EventExposure.yaml

+79 −3

Original line number	Diff line number	Diff line
		@@ -2,15 +2,15 @@ openapi: 3.0.0

		info:
		title: EIF Event Exposure Service
		version: 1.0.0
		version: 1.1.0-alpha.1
		description: \|
		API for the Neif_EventExposure Service.
		© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		© 2026, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.

		externalDocs:
		description: >
		3GPP TS 29.566 V19.0.0; 5G System; Energy Information Function Services; Stage 3.
		3GPP TS 29.566 V20.0.0; 5G System; Energy Information Function Services; Stage 3.
		url: http://www.3gpp.org/ftp/Specs/archive/29_series/29.566/

		servers:
		@@ -455,6 +455,15 @@ components:
		items:
		$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowDescription'
		minItems: 1
		enePerBitInd:
		type: boolean
		enum:
		- true
		description: >
		Indicates that Energy Consumption per bit information is requested.
		true indicates that the Energy Consumption per bit information is requested.
		When present, this attribute shall be set to true. The presence of this attribute set
		to the value false is forbidden.
		repPeriod:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
		repTimeWin:
		@@ -465,6 +474,30 @@ components:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
		maxReportNbr:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
		appRankingInd:
		type: boolean
		enum:
		- true
		description: >
		Indicates that the information on the top contributing applications to energy
		consumption is requested.
		true indicates that the information on the top contributing applications to energy
		consumption is requested.
		When present, this attribute shall be set to true. The presence of this attribute set
		to the value false is forbidden.
		This attribute may be present only if the event attribute is set to either UE_ENERGY
		or PDU_SESSION_ENERGY.
		afId:
		type: string
		energyCatInd:
		type: boolean
		enum:
		- true
		description: >
		Indicates that the Energy Consumption category information is requested.
		true indicates that the Energy Consumption category is requested.
		When present, this attribute shall be set to true.
		The presence of this attribute set to the value false is forbidden.
		required:
		- event
		- subscSetId
		@@ -487,11 +520,54 @@ components:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
		energyInfo:
		$ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/EnergyInfo'
		appRankingInfo:
		$ref: '#/components/schemas/AppRankingInfo'
		enePerBitInfo:
		$ref: '#/components/schemas/EnergyPerBitData'
		energyCat:
		$ref: '#/components/schemas/EnergyCategory'
		required:
		- event
		- subscSetId
		- timeStamp

		AppRankingInfo:
		description: >
		Represents the application ranking related information.
		type: object
		properties:
		appIds:
		type: array
		items:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId'
		minItems: 1
		required:
		- appIds

		EnergyPerBitData:
		description: >
		Represents the Energy Consumption per bit information.
		type: object
		properties:
		enePerBit:
		format: float
		type: number
		minimum: 0
		required:
		- enePerBit

		EnergyCategory:
		description: >
		Represents an operator-defined scalar category value associated with the reported
		Energy Consumption information. The Energy Consumption Category value is determined
		by the EIF using PLMN-operator defined rules and the value is operator specific
		type: object
		properties:
		enCat:
		type: string
		required:
		- enCat


		# SIMPLE DATA TYPES
		#