Code Moderator address the implementation issue (5d2ff57e) · Commits · SA5 – Management & Orchestration and Charging / Management and Orchestration APIs

OpenAPI/README.md

+4 −0

Original line number	Diff line number	Diff line
		@@ -51,6 +51,10 @@ The links below will open the Swagger Editor/UI and auto-load the OpenAPI YAML f
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28105_AiMlNrm.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28105_AiMlNrm.yaml))

		* RANSC NRM (TS 28.105)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28317_RanScNrm.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28317_RanScNrm.yaml))

		## Management Services (MnS)

		* Provisioning MnS (TS 28.532)

OpenAPI/TS28105_AiMlNrm.yaml

+1 −1

Original line number	Diff line number	Diff line
		@@ -222,7 +222,7 @@ components:
		type: array
		items:
		type: string
		confidenceIndication:
		modelConfidenceIndication:
		type: integer
		modelPerformanceTraining:
		type: array

OpenAPI/TS28312_IntentExpectations.yaml

+28 −13

Original line number	Diff line number	Diff line
		@@ -166,7 +166,8 @@ components:
		- $ref: '#/components/schemas/CoverageAreaPolygonContext'
		- $ref: '#/components/schemas/CoverageTACContext'
		- $ref: '#/components/schemas/PLMNContext'
		- $ref: '#/components/schemas/NRFqBandContext'
		- $ref: '#/components/schemas/DlFrequencyContext'
		- $ref: '#/components/schemas/UlFrequencyContext'
		- $ref: '#/components/schemas/RATContext'
		- $ref: "#/components/schemas/UEGroupContext"
		- $ref: 'TS28312_IntentNrm.yaml#/components/schemas/ObjectContext'
		@@ -737,15 +738,17 @@ components:
		type: array
		items:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId'
		NRFqBandContext:
		DlFrequencyContext:
		description: >-
		This data type is the "ObjectContext" data type with specialisations for NRFqBandContext
		This data type is the "Context" data type with specialisations for Object context "DLFrequencyContext".
		It describes the downlink frequency information (RF reference frequencies and/ or the
		frequency operating band) supported by the RAN SubNetwork that the intent expectation is applied.
		type: object
		properties:
		contextAttribute:
		type: string
		enum:
		- NRFqBand
		- DlFrequency
		contextCondition:
		type: string
		enum:
		@@ -753,7 +756,26 @@ components:
		contextValueRange:
		type: array
		items:
		$ref: 'TS28312_IntentNrm.yaml#/components/schemas/Frequency'
		UlFrequencyContext:
		description: >-
		This data type is the "Context" data type with specialisations for Object context "DLFrequencyContext".
		It describes the uplink frequency information (RF reference frequencies and/ or the frequency
		operating band) supported by the RAN SubNetwork that the intent expectation is applied.
		type: object
		properties:
		contextAttribute:
		type: string
		enum:
		- UlFrequency
		contextCondition:
		type: string
		enum:
		- IS_ALL_OF
		contextValueRange:
		type: array
		items:
		$ref: 'TS28312_IntentNrm.yaml#/components/schemas/Frequency'
		RATContext:
		description: >-
		This data type is the "ObjectContext" data type with specialisations for RATContext
		@@ -791,14 +813,7 @@ components:
		contextValueRange:
		type: array
		items:
		$ref: "#/components/schemas/UEGroup"
		UEGroup:
		type: object
		properties:
		fiveQI:
		type: integer
		sNssai:
		$ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai'
		$ref: "TS28312_IntentNrm.yaml#/components/schemas/UEGroup"
		EdgeIdenfiticationIdContext:
		description: >-
		This data type is the "ObjectContext" data type with specialisations for EdgeIdentificationIdContext

OpenAPI/TS28312_IntentNrm.yaml

+98 −24

Original line number	Diff line number	Diff line
		@@ -31,6 +31,8 @@ components:
		$ref: '#/components/schemas/IntentHandlingFunction-Multiple'

		Intent-Single:
		description: >-
		This IOC represents the properties of an Intent driven management information between MnS consumer and MnS producer.
		allOf:
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'
		- type: object
		@@ -53,18 +55,31 @@ components:
		type: array
		items:
		$ref: '#/components/schemas/IntentContext'
		description: >-
		It describes the list of IntentContext(s) which represents the constraints and conditions that should apply
		for the entire intent even if there may be specific contexts defined for specific parts of the intent
		intentAdminState:
		type: string
		enum:
		- ACTIVATED
		- DEACTIVATED
		description: >-
		It describes the intent administrative state.
		This attribute is used when MnS consumer-suspension mechanism is supported
		intentPriority:
		type: integer
		minimum: 1
		maximum: 100
		description: It expresses the priority of the stated intent within a MnS consumer.
		observationPeriod:
		type: integer
		description: >-
		It represents the observation period of the fulfilmentInfo for corresponding
		ExpectationTargets, IntentExpectations and Intent.
		intentReportReference:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'
		IntentReport-Single:
		description: It represents intent report information from MnS producer to MnS consumer.
		allOf:
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'
		- type: object
		@@ -77,11 +92,14 @@ components:
		$ref: '#/components/schemas/IntentConflictReport'
		intentFeasibilityCheckReport:
		$ref: '#/components/schemas/IntentFeasibilityCheckReport'
		lastUpdated:
		lastUpdatedTime:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'
		intentReference:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'
		IntentHandlingFunction-Single:
		description: >-
		It represents the intent handling capabilities can be supported by a specific intent
		handling function of MnS producer.
		allOf:
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'
		- type: object
		@@ -101,10 +119,12 @@ components:
		IntentExpectation:
		description: >-
		This data type is the "IntentExpectation" data type without specialisations
		It represents MnS consumer's requirements, goals and contexts given to a 3GPP system
		type: object
		properties:
		expectationId:
		type: string
		description: A unique identifier of the intentExpectation within the intent.
		expectationVerb:
		$ref: "#/components/schemas/ExpectationVerb"
		expectationObject:
		@@ -126,6 +146,7 @@ components:
		#-------Definition of the generic ExpectationObject dataType ----------#
		ExpectationObject:
		description: >-
		It represents the Object to which the IntentExpectation should apply.
		This data type is the "ExpectationObject" data type without specialisations
		type: object
		properties:
		@@ -143,6 +164,9 @@ components:
		type: array
		items:
		$ref: '#/components/schemas/ObjectContext'
		description: >-
		It describes the list of ObjectContext(s) which represents the constraints and conditions to be
		used as filter information to identify the object(s) to which a given intentExpectation should apply.

		#-------Definition of the generic ExpectationObject dataType ----------#

		@@ -166,12 +190,13 @@ components:
		- ALL_OF
		- ONE_OF
		- ANY_OF
		FulfilStatus:
		FulfilmentStatus:
		type: string
		readOnly: true
		enum:
		- FULFILLED
		- NOT_FULFILLED
		description: It describes the current status of the intent fulfilment result.
		NotFulfilledState:
		type: string
		readOnly: true
		@@ -182,25 +207,48 @@ components:
		- SUSPENDED
		- TERMINATED
		- FULFILMENTFAILED
		description: It describes the current progress of or the reason for not achieving fulfilment
		for the intent, intentExpectation or expectationTarget.
		An attribute which is used when FulfilmentInfo is implemented for IntentFulfilmentInfo
		FulfilmentInfo:
		description: >-
		This dataType represents the properties of a specific fulfilment information for an aspect of
		the intent (i.e. either an expectation, a target or the whole intent).
		type: object
		properties:
		fulfilStatus:
		$ref: '#/components/schemas/FulfilStatus'
		fulfilmentStatus:
		$ref: '#/components/schemas/FulfilmentStatus'
		notFullfilledState:
		description: ->
		An attribute which is used when FulfilmentInfo is implemented for IntentFulfilmentInfo
		$ref: "#/components/schemas/NotFulfilledState"
		notFulfilledReasons:
		description: ->
		An attribute which is used when FulfilmentInfo is implemented for IntentFulfilmentInfo
		type: array
		items:
		type: string
		readOnly: true
		description: An attribute which is used when FulfilmentInfo is implemented for IntentFulfilmentInfo
		ExpectationVerb:
		type: string
		enum:
		- DELIVER
		- ENSURE
		description: It describes the characteristic of the intentExpectation and is the property that describes the types of intentExpectations.
		Frequency:
		description: >-
		It desribes the RF reference frequency (i.e. Absolute Radio Frequency Channel Number)
		and/or the frequency operating band used for a given direction (UL or DL) in FDD or
		for both UL and DL directions in TDD.
		type: object
		properties:
		arfcn:
		type: integer
		description: >-
		This attribute shall be supported, when the frequency information represent RF reference frequency.
		The allowed values for NR see TS 38.104 subclause 5.4.2.1; The allowed values for EUTRAN see TS 36.104 [X] subclause 5.7.3;
		freqband:
		type: string
		description: >-
		This attribute shall be supported, when the frequency information represent frequency operating band.
		The allowed values for NR see TS 38.104 subclause 5.4.2.3; The allowed value for EUTRAN see TS 36.104 subclause 5.7.3
		ValueRangeType:
		oneOf:
		- type: number
		@@ -212,6 +260,21 @@ components:
		- $ref: 'TS28623_ComDefs.yaml#/components/schemas/GeoArea'
		- $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId'
		- $ref: 'TS28623_ComDefs.yaml#/components/schemas/GeoCoordinate'
		- $ref: '#/components/schemas/UEGroup'
		- $ref: '#/components/schemas/Frequency'
		UEGroup:
		description: >-
		It describes the UE Group, which is
		represented by specific 5QI, specific S-NSSAI, or a specific combination
		of S-NSSAI and 5QI
		type: object
		properties:
		fiveQI:
		type: integer
		minimum: 0
		maximum: 255
		sNssai:
		$ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai'
		#-------Definition of the generic dataType --------------#

		#-------Definition of the generic IntentContext dataType --------------#
		@@ -235,6 +298,7 @@ components:
		#-------Definition of the generic ExpectationTarget dataType----------#
		ExpectationTarget:
		description: >-
		This data type represents the target of the IntentExpectation that are required to be achieved.
		This data type is the "ExpectationTarget" data type without specialisations
		type: object
		properties:
		@@ -254,6 +318,7 @@ components:
		type: array
		items:
		$ref: '#/components/schemas/TargetContext'
		description: It describes the list of constraints and conditions that should apply for a specific expectationTarget.
		TargetContext:
		description: >-
		This data type is the "TargetContext" data type without specialisations
		@@ -309,7 +374,8 @@ components:
		#-------Definition of the generic IntentFulfilmentReport dataType----------------#
		IntentFulfilmentReport:
		description: >-
		This data type is the "IntentFulfilmentReport" data type without specialisations
		It includes the intentFulfilmentInfo and expectationFulfilmetResult.
		This attribute shall be supported when intent fulfilment information is supported by IntentReport
		type: object
		properties:
		intentFulfilmentInfo:
		@@ -323,7 +389,7 @@ components:
		#-------Definition of the generic ExpectationFulfilmentResult dataType----------------#
		ExpectationFulfilmentResult:
		description: >-
		This data type is the "ExpectationFulfilmentResult" data type without specialisations
		It includes the expectationFulfilmentInfo and targetFulfilmetResults for each IntentExpectation.
		type: object
		properties:
		expectaitonId:
		@@ -339,7 +405,7 @@ components:
		#-------Definition of the generic TargetFulfilmentResult dataType----------------#
		TargetFulfilmentResult:
		description: >-
		This data type is the "TargetFulfilmentResult" data type without specialisations
		This data type includes targetFulfilmentInfo and targetAchievedValue for each ExpectationTarget.
		type: object
		properties:
		targetName:
		@@ -353,7 +419,8 @@ components:
		#-------Definition of the generic IntentConflictReport dataType----------------#
		IntentConflictReport:
		description: >-
		This data type is the "IntentConflictReport" data type without specialisations
		It represents the conflict information for the detected conflict
		This attribute shall be supported when intent conflict information is supported by IntentReport
		type: object
		properties:
		conflictId:
		@@ -381,7 +448,8 @@ components:
		#-------Definition of the generic IntentFeasibilityCheckReport dataType----------------#
		IntentFeasibilityCheckReport:
		description: >-
		This data type is the "IntentFeasibilityCheckReport" data type without specialisations
		It represents the intent feasibility check information
		This attribute shall be supported when intent feasibility check information information is supported by IntentReport
		type: object
		properties:
		feasibilityCheckResult:
		@@ -390,13 +458,15 @@ components:
		- FEASIBLE
		- INFEASIBLE
		infeasibilityReason:
		description: ->
		An attribute which is used when feasibilityCheckResult is INFEASIBLE
		type: string
		description: An attribute which is used when feasibilityCheckResult is INFEASIBLE
		#-------Definition of the concrete IntentFeasibilityCheckReport dataType----------------#

		#-------Definition of the generic IntentHandlingCapability dataType----------------#
		IntentHandlingCapability:
		description: >-
		It represents expectation object information and expectation target information
		which can be supported by a specific intent handling function of MnS producer.
		type: object
		properties:
		intentHandlingCapabilityId:
		@@ -407,8 +477,12 @@ components:
		- RAN_SUBNETWORK
		- EDGE_SERVICE_SUPPORT
		- 5GC_SUBNETWORK
		supportedExpectationTargetType:
		description: It describes the expectation object type which can be supported by a specific intent handling function of MnS producer.
		supportedExpectationTargetNames:
		type: array
		items:
		type: string
		description: It describes the supported expectation targets for the supported expectation object type.
		#-------Definition of the concrete IntentHandlingCapability dataType----------------#

		#------Definition of JSON arrays for name-contained IOCs ---------------#

OpenAPI/TS28317_RanScNrm.yaml

0 → 100644

+176 −0

Original line number	Diff line number	Diff line
		openapi: 3.0.1
		info:
		title: RANSC NRM
		version: 18.0.0
		description: >-
		OAS 3.0.1 definition of the RANSC NRM
		© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.
		externalDocs:
		description: 3GPP TS 28.317; Self-configuration of Radio Access Network Entities (RAN NEs)
		url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.317/
		paths: {}
		components:
		schemas:

		#-------Definition of IOCs ----------#
		SubNetwork-Single:
		allOf:
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		attributes:
		$ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-Attr'
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-ncO'
		- type: object
		properties:
		SubNetwork:
		$ref: '#/components/schemas/SubNetwork-Multiple'
		ScMgmtProfile:
		$ref: '#/components/schemas/ScMgmtProfile-Multiple'
		Sc_Process:
		$ref: '#/components/schemas/Sc_Process-Multiple'

		ScMgmtProfile-Single:
		description: >-
		The ScMgmtProfile represents MnS Consumer's requirements for self-configuration management
		for a set of RAN NEs or RAN NE types.
		allOf:
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		nEInformation:
		type: array
		items:
		$ref: '#/components/schemas/NEInfomration'
		description: >-
		This attribute defines the NE Type(s) or the NE instance(s) for which this
		ScMgmtProfile instance is valid.
		configDataFileLocation:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri'

		Sc_Process-Single:
		description: >-
		This IOC represents the self-configuration process for a RAN NE, which allows the MnS
		Consumer to be informed about the current situation of the Self Configuration process.
		When the automated management process for an RAN NE starts, an instance of the Sc_Process
		is created automatically by the MnS Producer and informed to MnS consumer.
		allOf:
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		nEIdentification:
		$ref: '#/components/schemas/NEIdentification'
		scProcessMonitor:
		$ref: '#/components/schemas/ScProcessMonitor'
		cancelScProcess:
		type: string
		enum:
		- TRUE
		- FALSE
		description: >-
		Setting this attribute to "TRUE" cancels the self configuration process.
		scMgmtProfileRef:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'
		#-------Definition of IOCs ----------#


		#-------Definition of Data types ----------#
		NEType:
		type: integer
		description: It defines the type of RAN NE
		GnbId:
		type: integer
		minimum: 0
		maximum: 4294967295
		description: It is the identity of gNB
		EnbId:
		type: string
		minimum: 0
		maximum: 268435455
		description: It is the identity of ng-eNB
		NEIdentification:
		oneOf:
		- $ref: '#/components/schemas/EnbId'
		- $ref: '#/components/schemas/GnbId'
		NEInfomration:
		description: >-
		It defines the NE Type or the NE instance for which this
		ScMgmtProfile instance is valid.
		oneOf:
		- $ref: '#/components/schemas/NEType'
		- $ref: '#/components/schemas/NEIdentification'
		ScProcessMonitor:
		description: >-
		This data type is the "ProcessMonitor" data type with specialisations
		for usage in the RANSC management for monitoring for the self configuration process.
		type: object
		properties:
		jobId:
		type: string
		status:
		type: string
		enum:
		- NOT_STARTED
		- RUNNING
		- FINSHED
		- FAILED
		- CANCELLING
		- CANCELLED
		progressPercentage:
		type: integer
		minimum: 0
		maximum: 100
		progressStateInfo:
		type: string
		enum:
		- NE_HEALTH_CHECK
		- SW_DOWNLOAD
		- SW_INSTALLATION
		- SW_ACTIVATION
		- PREPARE_BASIC_CONFIGURATION_AND_OAMLINK
		- RETRIEVE_CONFIGURATION_DATA
		- SETUP_PRECONFIGURED_SIGNALLING_LINKS
		- TSET_FINAL_STATE_OF_NE
		resultStateInfo:
		oneOf:
		- type: string
		enum:
		- UNKNOWN
		- INCORRECT_CONFIGURATION
		- NE_HARDWARE_ERROR_DELECTED
		- DISCONNECTION_BETWEEN_NE_AND_OAM
		- OTHER
		- type: string
		startTime:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'
		endTime:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'

		#-------Definition of Data types ----------#

		#------Definition of JSON arrays for name-contained IOCs ---------------#
		SubNetwork-Multiple:
		type: array
		items:
		$ref: '#/components/schemas/SubNetwork-Single'
		ScMgmtProfile-Multiple:
		type: array
		items:
		$ref: '#/components/schemas/ScMgmtProfile-Single'
		Sc_Process-Multiple:
		type: array
		items:
		$ref: '#/components/schemas/Sc_Process-Single'
		#------Definition of JSON arrays for name-contained IOCs ---------------#


		#----- Definitions in TS 28.317 for TS 28.532 --------------------------#
		resources-RanScNrm:
		oneOf:
		- $ref: '#/components/schemas/SubNetwork-Single'
		- $ref: '#/components/schemas/ScMgmtProfile-Single'
		- $ref: '#/components/schemas/Sc_Process-Single'

		#----- Definitions in TS 28.317 for TS 28.532 --------------------------#