Edit TS29522_VFLNFDiscovery.yaml (13c67155) · Commits · All Groups / 5G APIs

TS29522_VFLNFDiscovery.yaml

+50 −17

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

		info:
		title: 3gpp-vfl-nf-discovery
		version: 1.0.0
		version: 1.1.0-alpha.1
		description: \|
		API for VFL NF Discovery.
		© 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.522 V19.5.0; 5G System; Network Exposure Function Northbound APIs.
		3GPP TS 29.522 V20.0.0; 5G System; Network Exposure Function Northbound APIs.
		url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/'

		servers:
		@@ -27,10 +27,10 @@ security:
		paths:
		/discover-nwdaf:
		post:
		summary: Request of NWDAF(s) that are to act as VFL client(s).
		tags:
		- VFL NF discovery
		summary: Request to discover the NWDAF(s) that are to act as VFL Client(s).
		operationId: DiscoverNwdaf
		tags:
		- VFL NF Discovery Request (custom operation without associated resources)
		requestBody:
		description: Representation of the request of NWDAF that are to act as VFL client(s).
		required: true
		@@ -41,7 +41,7 @@ paths:
		responses:
		'200':
		description: >
		OK. Successful case. The external NWDAF ID is provisioned.
		OK. The external NWDAF ID(s) to act as the VFL Client(s) are returned.
		content:
		application/json:
		schema:
		@@ -75,10 +75,10 @@ paths:

		/release-nwdaf:
		post:
		summary: Request to inform the external NWDAF ID(s) are not used anymore.
		summary: Request to inform that the external NWDAF ID(s) are not used anymore.
		operationId: ReleaseNwdaf
		tags:
		- VFL NF discovery release
		- VFL NF Release Request
		requestBody:
		required: true
		content:
		@@ -87,7 +87,7 @@ paths:
		$ref: '#/components/schemas/NwdafReleaseRequest'
		responses:
		'204':
		description: No Content. Successful case.
		description: No Content. The provided external NWDAF(s) are released.
		'307':
		$ref: 'TS29122_CommonData.yaml#/components/responses/307'
		'308':
		@@ -125,10 +125,15 @@ components:
		scopes: {}

		schemas:

		#
		# STRUCTURED DATA TYPES
		#

		NwdafDiscoveryRequest:
		description: >
		Represents the parameters to request the NWDAF(s) that are to act as VFL client(s).
		type: object
		Represents the parameters to request to discover the NWDAF(s) that are to act as VFL
		client(s).
		properties:
		analyticIds:
		type: array
		@@ -152,13 +157,16 @@ components:
		items:
		$ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea'
		minItems: 1
		suppFeat:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
		required:
		- analyticIds
		- vflCapType

		NwdafDiscoveryResponse:
		description: >
		Represents the external NWDAF ID(s) to act as the VFL client(s).
		Represents the response to the request to discover the NWDAF(s) that are to act as VFL
		Client(s).
		type: object
		properties:
		exNwdafIds:
		@@ -167,12 +175,29 @@ components:
		type: string
		description: The current external NWDAF identifier.
		minItems: 1
		vflInterInfo:
		type: string
		description: String representing the VFL Interoperability Information.
		timePeriod:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
		reqFeatureIds:
		type: array
		items:
		type: string
		minItems: 1
		serviceAreas:
		type: array
		items:
		$ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea'
		minItems: 1
		suppFeat:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
		required:
		- exNwdafIds

		NwdafReleaseRequest:
		description: >
		Represents the parameters to inform the external NWDAF ID(s) are not used anymore.
		Represents the parameters to inform that the external NWDAF ID(s) are not used anymore.
		type: object
		properties:
		exNwdafIds:
		@@ -181,6 +206,8 @@ components:
		type: string
		description: The current external NWDAF identifier.
		minItems: 1
		suppFeat:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
		required:
		- exNwdafIds

		@@ -198,8 +225,14 @@ components:
		enum:
		- VFL_CLIENT
		- type: string
		description: Represents the VFL capability type to be discovered.
		description: >
		This string provides forward-compatibility with future extensions to the enumeration and
		is not used to encode content defined in the present version of this API.
		description: \|
		Represents the VFL capability type to be discovered.
		Represents the VFL capability type.
		Possible values are:
		- VFL_CLIENT: Represents the VFL capability type to be discovered is VFL client.
		- VFL_CLIENT: Indicates that the VFL capability type is VFL Client.

		#
		# Data types describing alternative data types or combinations of data types
		#