diff --git a/OpenAPI/README.md b/OpenAPI/README.md index 76505cbef21be41d0c72381e0cd4c3ab43a8206d..c0e969a3423284f17d20fc4487b36687dc426e9f 100644 --- a/OpenAPI/README.md +++ b/OpenAPI/README.md @@ -31,10 +31,14 @@ 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/TS28623_QoEMeasurementCollectionNrm.yaml)) ([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28623_QoEMeasurementCollectionNrm.yaml)) -* Subscription Control NRM NRM (TS 28.623) +* Subscription Control NRM (TS 28.623) ([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28623_SubscriptionControlNrm.yaml)) ([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28623_SubscriptionControlNrm.yaml)) +* File Management NRM (TS 28.623) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28623_FileManagementNrm.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28623_FileManagementNrm.yaml)) + * Threshold Monitor NRM(TS 28.623) ([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28623_ThresholdMonitorNrm.yaml)) ([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28623_ThresholdMonitorNrm.yaml)) @@ -130,6 +134,14 @@ 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/TS28532_StreamingDataMnS.yaml)) ([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28532_StreamingDataMnS.yaml)) +* Network Slice Provisioning MnS (TS 28.531) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28531_NSProvMnS.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28531_NSProvMnS.yaml)) + +* Network Slice Subnet Provisioning MnS (TS 28.531) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28531_NSSProvMnS.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28531_NSSProvMnS.yaml)) + ## Tools * [Frontend](https://forge.3gpp.org/swagger/tools/GitlabOpenAPIFrontend.htm) to invoke the Swagger Editor, Swagger UI, or to parse OpenAPI files with APIDevTools Swagger Parser/Validator, or to search for APIs referencing a data structure diff --git a/OpenAPI/TS28104_MdaNrm.yaml b/OpenAPI/TS28104_MdaNrm.yaml index 9759ac7d180ce2b5e75f8c08e340041cd3d170f3..c229cc7d83a8e88075b1297a3beca6855b6a42f1 100644 --- a/OpenAPI/TS28104_MdaNrm.yaml +++ b/OpenAPI/TS28104_MdaNrm.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: MDA NRM - version: 18.3.0 + version: 18.4.0 description: >- OAS 3.0.1 specification of the MDA NRM © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -138,6 +138,10 @@ components: properties: supportedMDACapabilities: $ref: '#/components/schemas/MDATypes' + mlModelRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + aIMLInferenceFunctionRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - type: object properties: diff --git a/OpenAPI/TS28105_AiMlNrm.yaml b/OpenAPI/TS28105_AiMlNrm.yaml index b96ae1f9c96320f3d6ecbb9f014ff8b4ad341803..7566d90a21594f143cf809d49baa0f4239ab2235 100644 --- a/OpenAPI/TS28105_AiMlNrm.yaml +++ b/OpenAPI/TS28105_AiMlNrm.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: AI/ML NRM - version: 18.3.0 + version: 18.4.0 description: >- OAS 3.0.1 specification of the AI/ML NRM © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -18,7 +18,7 @@ components: MLContext: type: object properties: - inferenceEntityRef: + inferenceModelRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' dataProviderRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' @@ -71,6 +71,9 @@ components: type: array items: $ref: 'TS28623_ThresholdMonitorNrm.yaml#/components/schemas/ThresholdInfo' + managedActivationScope: + $ref: '#/components/schemas/ManagedActivationScope' + SupportedPerfIndicator: type: object @@ -106,17 +109,19 @@ components: MLCapabilityInfo: type: object properties: - inferenceType: + aIMLInferenceName: type: string capabilityName: type: string mLCapabilityParameters: - description: A map (list of key-value pairs) for an inferenceType and capabilityName + description: A map (list of key-value pairs) for an aIMLInferenceName and capabilityName $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' AvailMLCapabilityReport: type: object properties: + availMLCapabilityReportID: + type: string mLCapabilityVersionId: type: array items: @@ -125,7 +130,7 @@ components: type: array items: $ref: '#/components/schemas/ModelPerformance' - mLEntityRef: + mLModelRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' InferenceOutput: @@ -135,7 +140,7 @@ components: type: array items: type: string - inferenceType: + aIMLInferenceName: type: string inferenceOutputTime: type: array @@ -156,12 +161,14 @@ components: $ref: '#/components/schemas/MLTrainingFunction-Multiple' MLTestingFunction: $ref: '#/components/schemas/MLTestingFunction-Multiple' - MLEntityRepository: - $ref: '#/components/schemas/MLEntityRepository-Multiple' + MLModelRepository: + $ref: '#/components/schemas/MLModelRepository-Multiple' MLUpdateFunction: $ref: '#/components/schemas/MLUpdateFunction-Multiple' AIMLInferenceFunction: - $ref: '#/components/schemas/AIMLInferenceFunction-Multiple' + $ref: '#/components/schemas/AIMLInferenceFunction-Multiple' + AIMLInferenceEmulationFunction: + $ref: '#/components/schemas/AIMLInferenceEmulationFunction-Multiple' ManagedElement-ncO-AiMlNrm: type: object @@ -170,12 +177,14 @@ components: $ref: '#/components/schemas/MLTrainingFunction-Multiple' MLTestingFunction: $ref: '#/components/schemas/MLTestingFunction-Multiple' - MLEntityRepository: - $ref: '#/components/schemas/MLEntityRepository-Multiple' + MLModelRepository: + $ref: '#/components/schemas/MLModelRepository-Multiple' MLUpdateFunction: $ref: '#/components/schemas/MLUpdateFunction-Multiple' AIMLInferenceFunction: $ref: '#/components/schemas/AIMLInferenceFunction-Multiple' + AIMLInferenceEmulationFunction: + $ref: '#/components/schemas/AIMLInferenceEmulationFunction-Multiple' #-------- Definition of concrete IOCs -------------------------------------------- @@ -189,7 +198,7 @@ components: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' - type: object properties: - mLEntityRepositoryRef: + mLModelRepositoryRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - type: object @@ -202,6 +211,10 @@ components: $ref: '#/components/schemas/MLTrainingReport-Multiple' ThresholdMonitors: $ref: 'TS28623_ThresholdMonitorNrm.yaml#/components/schemas/ThresholdMonitor-Multiple' + MLTestingRequest: + $ref: '#/components/schemas/MLTestingRequest-Multiple' + MLTestingReport: + $ref: '#/components/schemas/MLTestingReport-Multiple' MLTrainingRequest-Single: allOf: @@ -212,7 +225,7 @@ components: allOf: - type: object properties: - inferenceType: + aIMLInferenceName: type: string candidateTrainingDataSource: type: array @@ -234,9 +247,9 @@ components: type: boolean suspendRequest: type: boolean - mLEntityToTrainRef: + mLModelRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - mLEntityCoordinationGroupToTrainRef: + mLModelCoordinationGroupRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' MLTrainingProcess-Single: @@ -252,23 +265,20 @@ components: type: integer terminationConditions: type: string - enum: - - UPDATED_IN_INFERENCE_FUNCTION - - INFERENCE FUNCTION_TERMINATED - - INFERENCE FUNCTION_UPGRADED - - INFERENCE_CONTEXT_CHANGED progressStatus: $ref: '#/components/schemas/ProcessMonitor' cancelProcess: type: boolean suspendProcess: type: boolean - trainingRequestRef: + trainingRequestRef: ## Figure 7.3a.1.1.1-1 has no such pointer $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' trainingReportRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - mLEntityRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + mLModelGeneratedRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + mLModelRef: ## Figure 7.3a.1.1.1-1 is 1-0..1 mapping, hence should be single + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' MLTrainingReport-Single: allOf: @@ -279,17 +289,11 @@ components: allOf: - type: object properties: - areConsumerTrainingDataUsed: - type: string - enum: - - ALL - - PARTIALLY - - NONE usedConsumerTrainingData: type: array items: type: string - modelconfidenceIndication: + modelConfidenceIndication: type: integer modelPerformanceTraining: type: array @@ -309,11 +313,11 @@ components: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' lastTrainingRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - mLEnityGeneratedRef: + mLModelGeneratedRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - mLEntityCoordinationGroupGeneratedRef: + mLModelCoordinationGroupGeneratedRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - mLEntityRef: + mLModelRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' MLTestingFunction-Single: @@ -325,8 +329,8 @@ components: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' - type: object - properties: - mLEntityRef: + properties: ##FIXME pointer to MLModelCoordinationGroup missing + mLModelRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - type: object @@ -344,6 +348,9 @@ components: attributes: allOf: - type: object + oneOf: + - required: [ requestStatus, mLModelToTestRef ] + - required: [ requestStatus, mLModelCoordinationGroupToTestRef ] properties: requestStatus: $ref: '#/components/schemas/RequestStatus' @@ -351,9 +358,9 @@ components: type: boolean suspendRequest: type: boolean - mLEntityToTestRef: + mLModelToTestRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - mLEntityCoordinationGroupToTestRef: + mLModelCoordinationGroupToTestRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' MLTestingReport-Single: @@ -374,7 +381,7 @@ components: testingRequestRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - MLEntityLoadingRequest-Single: + MLModelLoadingRequest-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object @@ -389,10 +396,10 @@ components: type: boolean suspendRequest: type: boolean - mLEntityToLoadRef: + mLModelToLoadRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - MLEntityLoadingPolicy-Single: + MLModelLoadingPolicy-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object @@ -401,14 +408,14 @@ components: allOf: - type: object properties: - inferenceType: + aIMLInferenceName: type: string policyForLoading: $ref: '#/components/schemas/AIMLManagementPolicy' - mLEntityRef: + mLModelRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - MLEntityLoadingProcess-Single: + MLModelLoadingProcess-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object @@ -423,16 +430,14 @@ components: type: boolean suspendProcess: type: boolean - resumeProcess: - type: boolean - MLEntityLoadingRequestRef: + mLModelLoadingRequestRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - MLEntityLoadingPolicyRef: + mLModelLoadingPolicyRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - LoadedMLEntityRef: + loadedMLModelRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - MLEntity-Single: + MLModel-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object @@ -440,11 +445,11 @@ components: attributes: type: object properties: - mLEntityId: + mLModelId: type: string - inferenceType: + aIMLInferenceName: type: string - mLEntityVersion: + mLModelVersion: type: string expectedRunTimeContext: $ref: '#/components/schemas/MLContext' @@ -460,27 +465,20 @@ components: $ref: '#/components/schemas/MLCapabilityInfo' retrainingEventsMonitorRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - sourceTrainedMLEntityRef: + sourceTrainedMLModelRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - MLEntityRepository-Single: + MLModelRepository-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: - attributes: - type: object - properties: - mLEntityRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - - type: object - properties: - MLEntity: - $ref: '#/components/schemas/MLEntity-Multiple' - MLEntityCoordinationGroup: - $ref: '#/components/schemas/MLEntityCoordinationGroup-Multiple' + MLModel: + $ref: '#/components/schemas/MLModel-Multiple' + MLModelCoordinationGroup: + $ref: '#/components/schemas/MLModelCoordinationGroup-Multiple' - MLEntityCoordinationGroup-Single: + MLModelCoordinationGroup-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object @@ -488,7 +486,7 @@ components: attributes: type: object properties: - memberMLEntityRefList: + memberMLModelRefList: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' ## 7.3a.4.1 IOC @@ -504,7 +502,7 @@ components: properties: availMLCapabilityReport: $ref: '#/components/schemas/AvailMLCapabilityReport' - mLEntityRef: + mLModelRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - type: object @@ -544,7 +542,7 @@ components: type: boolean mLUpdateProcessRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - mLEntityRef: + mLModelRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' MLUpdateProcess-Single: @@ -557,7 +555,7 @@ components: properties: progressStatus: $ref: '#/components/schemas/ProcessMonitor' - mLEntityRef: + mLModelRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' mLUpdateRequestRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' @@ -574,7 +572,7 @@ components: properties: updatedMLCapability: $ref: '#/components/schemas/AvailMLCapabilityReport' - mLEntityRef: + mLModelRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' mLUpdateProcessRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' @@ -595,16 +593,24 @@ components: - ACTIVATED - DEACTIVATED managedActivationScope: - $ref: '#/components/schemas/ManagedActivationScope' + $ref: '#/components/schemas/AIMLManagementPolicy' usedByFunctionRefList: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - mLEntityRef: # FIXME S5-240805,S5-240917 both define here + mLModelRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - type: object properties: AIMLInferenceReport: $ref: '#/components/schemas/AIMLInferenceReport-Multiple' + MLModelLoadingRequest: + $ref: '#/components/schemas/MLModelLoadingRequest-Multiple' + MLModelLoadingProcess: + $ref: '#/components/schemas/MLModelLoadingProcess-Multiple' + MLModelLoadingPolicy: + $ref: '#/components/schemas/MLModelLoadingPolicy-Multiple' + MLModel: + $ref: '#/components/schemas/MLModel-Multiple' AIMLInferenceReport-Single: allOf: @@ -615,12 +621,12 @@ components: allOf: - type: object properties: - inferenceOutputs: #stage 2: attribute table name as: aimlInferenceOutputs FIXME + inferenceOutputs: type: array items: $ref: '#/components/schemas/InferenceOutput' minItems: 1 - mLEntityRef: + mLModelRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' AIMLInferenceEmulationFunction-Single: @@ -633,8 +639,8 @@ components: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' - type: object properties: - AIMLInferenceEmulationReportRefs: # FIXME stage 2 of IOC AIMLInferenceEmulationReport missing - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + AIMLInferenceEmulationReport: + $ref: '#/components/schemas/AIMLInferenceReport-Multiple' - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' #-------- Definition of JSON arrays for name-contained IOCs ---------------------- @@ -655,18 +661,18 @@ components: type: array items: $ref: '#/components/schemas/MLTrainingReport-Single' - MLEntity-Multiple: + MLModel-Multiple: type: array items: - $ref: '#/components/schemas/MLEntity-Single' - MLEntityRepository-Multiple: + $ref: '#/components/schemas/MLModel-Single' + MLModelRepository-Multiple: type: array items: - $ref: '#/components/schemas/MLEntityRepository-Single' - MLEntityCoordinationGroup-Multiple: + $ref: '#/components/schemas/MLModelRepository-Single' + MLModelCoordinationGroup-Multiple: type: array items: - $ref: '#/components/schemas/MLEntityCoordinationGroup-Single' + $ref: '#/components/schemas/MLModelCoordinationGroup-Single' MLTestingFunction-Multiple: type: array items: @@ -679,18 +685,18 @@ components: type: array items: $ref: '#/components/schemas/MLTestingRequest-Single' - MLEntityLoadingRequest-Multiple: + MLModelLoadingRequest-Multiple: type: array items: - $ref: '#/components/schemas/MLEntityLoadingRequest-Single' - MLEntityLoadingProcess-Multiple: + $ref: '#/components/schemas/MLModelLoadingRequest-Single' + MLModelLoadingProcess-Multiple: type: array items: - $ref: '#/components/schemas/MLEntityLoadingProcess-Single' - MLEntityLoadingPolicy-Multiple: + $ref: '#/components/schemas/MLModelLoadingProcess-Single' + MLModelLoadingPolicy-Multiple: type: array items: - $ref: '#/components/schemas/MLEntityLoadingPolicy-Single' + $ref: '#/components/schemas/MLModelLoadingPolicy-Single' MLUpdateFunction-Multiple: type: array items: @@ -727,15 +733,15 @@ components: - $ref: '#/components/schemas/MLTrainingRequest-Single' - $ref: '#/components/schemas/MLTrainingProcess-Single' - $ref: '#/components/schemas/MLTrainingReport-Single' - - $ref: '#/components/schemas/MLEntity-Single' - - $ref: '#/components/schemas/MLEntityRepository-Single' - - $ref: '#/components/schemas/MLEntityCoordinationGroup-Single' + - $ref: '#/components/schemas/MLModel-Single' + - $ref: '#/components/schemas/MLModelRepository-Single' + - $ref: '#/components/schemas/MLModelCoordinationGroup-Single' - $ref: '#/components/schemas/MLTestingFunction-Single' - $ref: '#/components/schemas/MLTestingRequest-Single' - $ref: '#/components/schemas/MLTestingReport-Single' - - $ref: '#/components/schemas/MLEntityLoadingRequest-Single' - - $ref: '#/components/schemas/MLEntityLoadingProcess-Single' - - $ref: '#/components/schemas/MLEntityLoadingPolicy-Single' + - $ref: '#/components/schemas/MLModelLoadingRequest-Single' + - $ref: '#/components/schemas/MLModelLoadingProcess-Single' + - $ref: '#/components/schemas/MLModelLoadingPolicy-Single' - $ref: '#/components/schemas/MLUpdateFunction-Single' - $ref: '#/components/schemas/MLUpdateRequest-Single' diff --git a/OpenAPI/TS28111_FaultNrm.yaml b/OpenAPI/TS28111_FaultNrm.yaml index f4ed7ce77481edc1972a4608889f77a6e4307def..7a525d13f635f975e14c2f0b5dd108cae8f18e59 100644 --- a/OpenAPI/TS28111_FaultNrm.yaml +++ b/OpenAPI/TS28111_FaultNrm.yaml @@ -229,6 +229,8 @@ components: type: object additionalProperties: $ref: '#/components/schemas/AlarmRecord' + unreliableAlarmScope: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' #---- Definition of alarm notifications --------------------------------------------# @@ -312,6 +314,8 @@ components: $ref: '#/components/schemas/AlarmType' probableCause: $ref: '#/components/schemas/ProbableCause' + specificProblem: + $ref: '#/components/schemas/SpecificProblem' perceivedSeverity: $ref: '#/components/schemas/PerceivedSeverity' correlatedNotifications: @@ -549,3 +553,10 @@ components: type: object additionalProperties: $ref: '#/components/schemas/Comment' + + #----- Definitions in TS 28.111 for TS 28.532 --------------------------# + resources-faultNrm: + oneOf: + - $ref: '#/components/schemas/AlarmList-Single' + + #----- Definitions in TS 28.111 for TS 28.532 --------------------------# \ No newline at end of file diff --git a/OpenAPI/TS28312_IntentExpectations.yaml b/OpenAPI/TS28312_IntentExpectations.yaml index b48f7afaf39b787dbd54b2709da94e896b47a0fa..82031387f92e7b5a1a985d4a895bb530b3aed843 100644 --- a/OpenAPI/TS28312_IntentExpectations.yaml +++ b/OpenAPI/TS28312_IntentExpectations.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: Scenario specific Intent Expectations - version: 18.3.0 + version: 18.4.0 description: >- OAS 3.0.1 definition of scenario specific Intent Expectations © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -243,7 +243,10 @@ components: #-------Definition of the Scenario specific ExpectationTarget dataType----------# WeakRSRPRatioTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for WeakRSRPRatioTarget + This data type is the "ExpectationTarget" data type with specialisations for WeakRSRPRatioTarget. It describes + the downlink weak coverage ratio target for the RAN SubNetwork that the intent expectation is applied. + The numerator is the number of the cells with downlink weak RSRP, and the denominator is the total number + of cells of the RAN Subnetwork in the specified area. type: object properties: targetName: @@ -262,7 +265,9 @@ components: $ref: '#/components/schemas/WeakRSRPContext' WeakRSRPContext: description: >- - This data type is the "TargetContext" data type with specialisations for WeakRSRPContext + This data type is the "TargetContext" data type with specialisations for WeakRSRPContext. It describes the threshold + for downlink weak RSRP of the cells (see RSRP measurements in TS 28.552 [6]) of the RAN SubNetwork that the intent + expectation is applied. type: object properties: contextAttribute: @@ -277,7 +282,9 @@ components: type: number LowSINRRatioTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for LowSINRatioTarget + This data type is the "ExpectationTarget" data type with specialisations for LowSINRatioTarget.It describes the low SINR + ratio target for the RAN SubNetwork that the intent expectation is applied. The numerator is the number of the cells with + low SINR, and the denominator is the total number of cells of the RAN Subnetwork in the specified area. type: object properties: targetName: @@ -296,7 +303,8 @@ components: $ref: '#/components/schemas/LowSINRContext' LowSINRContext: description: >- - This data type is the "TargetContext" data type with specialisations for LowSINRContext + This data type is the "TargetContext" data type with specialisations for LowSINRContext.It describes the threshold for + low SINR of the cells (see SINR measurements in TS 28.552 [6]) of the RAN SubNetwork that the intent expectation is applied. type: object properties: contextAttribute: @@ -311,7 +319,9 @@ components: type: integer AveULRANUEThptTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for AveULRANUEThptTarget + This data type is the "ExpectationTarget" data type with specialisations for AveULRANUEThptTarget.It describes the average + UL RAN UE throughput target for RAN SubNetwork (see UL RAN UE throughput for a sub-network in TS 28.554[11]) that the intent + expectation is applied. type: object properties: targetName: @@ -326,7 +336,9 @@ components: type: integer AveDLRANUEThptTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for AveDLRANUEThptTarget + This data type is the "ExpectationTarget" data type with specialisations for AveDLRANUEThptTarget.It describes the average + DL RAN UE throughput target for RAN SubNetwork (see DL RAN UE throughput for a sub-network in TS 28.554[11]) that the intent + expectation is applied. type: object properties: targetName: @@ -341,7 +353,10 @@ components: type: integer LowULRANUEThptRatioTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for LowULRANUEThptRatioTarget + This data type is the "ExpectationTarget" data type with specialisations for LowULRANUEThptRatioTarget.It describes the low + UL RAN UE throughput ratio target for the RAN SubNetwork that the intent expectation is applied. The numerator is the number + of the cells with low UL RAN UE throughput, and the denominator is the total number of cells of the RAN Subnetwork in the + specified area. type: object properties: targetName: @@ -360,7 +375,9 @@ components: $ref: '#/components/schemas/LowULRANUEThptContext' LowULRANUEThptContext: description: >- - This data type is the "TargetContext" data type with specialisations for LowULRANUEThptContext + This data type is the "TargetContext" data type with specialisations for LowULRANUEThptContext.It describes the threshold + for the low UL RAN UE throughput cells (see average UL RAN UE throughput in gNB and distribution of UL UE throughput in gNB + in TS 28.552[6]) of the RAN SubNetwork that the intent expectation is applied. type: object properties: contextAttribute: @@ -375,7 +392,10 @@ components: type: number LowDLRANUEThptRatioTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for LowDLRANUEThptRatioTarget + This data type is the "ExpectationTarget" data type with specialisations for LowDLRANUEThptRatioTarget. It describes + the low DL RAN UE throughput ratio target for the RAN SubNetwork that the intent expectation is applied.The numerator + is the number of the cells with low DL RAN UE throughput, and the denominator is the total number of cells of the + RAN Subnetwork in the specified area. type: object properties: targetName: @@ -394,7 +414,9 @@ components: $ref: '#/components/schemas/LowDLRANUEThptContext' LowDLRANUEThptContext: description: >- - This data type is the "TargetContext" data type with specialisations for LowDLRANUEThptContext + This data type is the "TargetContext" data type with specialisations for LowDLRANUEThptContext.It describes the threshold + for the low DL RAN UE throughput cells ((see average DL RAN UE throughput in gNB and distribution of DL UE throughput in gNB + in TS 28.552[6]) ) of the RAN SubNetwork that the intent expectation is applied. type: object properties: contextAttribute: @@ -409,7 +431,9 @@ components: type: number HighULPrbLoadRatioTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for HighULPrbLoadRatioTarget + This data type is the "ExpectationTarget" data type with specialisations for HighULPrbLoadRatioTarget. It describes the high UL + PRB load ratio target (as percentage) for the RAN SubNetwork that the intent expectation is applied. The numerator is the number + of the cells with high UL PRB load, and the denominator is the total number of cells of the RAN Subnetwork in the specified area. type: object properties: targetName: @@ -428,7 +452,9 @@ components: $ref: '#/components/schemas/HighULPrbLoadContext' HighULPrbLoadContext: description: >- - This data type is the "TargetContext" data type with specialisations for HighULPrbLoadContext + This data type is the "TargetContext" data type with specialisations for HighULPrbLoadContext.It describes the threshold for high + uplink PRB load (i.e. UL Total PRB Usage in TS 28.552 [12] to represent the percentage of UL PRBs used) of the cells of the RAN + SubNetwork in the specified area that the intent expectation is applied. type: object properties: contextAttribute: @@ -445,7 +471,9 @@ components: maximum: 100 HighDLPrbLoadRatioTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for HighDLPrbLoadRatioTarget + This data type is the "ExpectationTarget" data type with specialisations for HighDLPrbLoadRatioTarget.It describes the high DL PRB + load ratio target (as percentage) for the RAN SubNetwork that the intent expectation is applied. The numerator is the number of the + cells with high DL PRB load, and the denominator is the total number of cells of the RAN Subnetwork in the specified area. type: object properties: targetName: @@ -464,7 +492,9 @@ components: $ref: '#/components/schemas/HighDLPrbLoadContext' HighDLPrbLoadContext: description: >- - This data type is the "TargetContext" data type with specialisations for HighDLPrbLoadContext + This data type is the "TargetContext" data type with specialisations for HighDLPrbLoadContext.It describes the threshold for high downlink + PRB load (i.e. DL Total PRB Usage in TS 28.552 [12] to represent the percentage of DL PRBs used) of the cells of the RAN SubNetwork in the + specified area that the intent expectation is applied. type: object properties: contextAttribute: @@ -481,7 +511,9 @@ components: maximum: 100 AveULPrbLoadTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for AveULPrbLoadTarget + This data type is the "ExpectationTarget" data type with specialisations for AveULPrbLoadTarget.It describes the average uplink PRB load target + (i.e. UL Total PRB Usage in TS 28.552 [12] to represent the percentage of UL PRBs used) of the cells of the RAN SubNetwork that the intent + expectation is applied. type: object properties: targetName: @@ -498,7 +530,9 @@ components: maximum: 100 AveDLPrbLoadTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for AveDLPrbLoadTarget + This data type is the "ExpectationTarget" data type with specialisations for AveDLPrbLoadTarget.It describes the average dowlink PRB load + (i.e. DL Total PRB Usage in TS 28.552 [12] to represent the percentage of DL PRBs used) target for RAN SubNetwork that the intent expectation + is applied. type: object properties: targetName: @@ -515,7 +549,9 @@ components: maximum: 100 RANEnergyConsumptionTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for RANEnergyConsumptionTarget + This data type is the "ExpectationTarget" data type with specialisations for RANEnergyConsumptionTarget.It describes the RAN energy consumption + target for RAN SubNetwork that the intent expectation is applied. The definition for RAN energy consumption see ECNG-RAN in clause 6.7.3.4.1 in + TS 28.554 [11]. type: object properties: targetName: @@ -530,7 +566,9 @@ components: type: integer RANEnergyEfficiencyTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for RANEnergyEfficiencyTarget + This data type is the "ExpectationTarget" data type with specialisations for RANEnergyEfficiencyTarget.It describes the RAN energy efficiency target + for RAN SubNetwork that the intent expectation is applied. The unit of this target is bit/J. The definition for RAN energy efficiency target for RAN + SubNetwork see EEMN,DV in clause 6.7.1.1 in TS 28.554 [11]. type: object properties: targetName: @@ -545,7 +583,8 @@ components: type: integer DLThptPerUETarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for DLThptPerUETarget + This data type is the "ExpectationTarget" data type with specialisations for DLThptPerUETarget. It describes the DL throughput target by the per UE for the + edge service supporting or radio servicde that the intent expectation is applied. For details see dlThptPerUE defined in clause 6.3.1 of TS 28.541 [5]. type: object properties: targetName: @@ -560,7 +599,8 @@ components: $ref: 'TS28541_SliceNrm.yaml#/components/schemas/XLThpt' ULThptPerUETarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for ULThptPerUETarget + This data type is the "ExpectationTarget" data type with specialisations for ULThptPerUETarget.It describes the UL throughput target by the per UE for the edge + service supporting or radio service that the intent expectation is applied. For details see ulThptPerUE defined in clause 6.3.1 of TS 28.541 [5]. type: object properties: targetName: @@ -572,10 +612,11 @@ components: enum: - IS_GREATER_THAN targetValueRange: - $ref: 'TS28541_SliceNrm.yaml#/components/schemas/XLThpt' + $ref: 'TS28541_SliceNrm.yaml#/components/schemas/XLThpt' DLLatencyTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for DLLatencyTarget + This data type is the "ExpectationTarget" data type with specialisations for DLLatencyTarget.It describes the DL latency target for the edge service supporting or radio service + that the intent expectation is applied type: object properties: targetName: @@ -590,7 +631,8 @@ components: type: integer ULLatencyTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for ULLatencyTarget + This data type is the "ExpectationTarget" data type with specialisations for ULLatencyTarget. It describes the UL latency target for the edge service supporting or radioService + that the intent expectation is applied. For details see attribute ulLatency defined in clause 6.3.1 of TS 28.541 [5] type: object properties: targetName: @@ -605,7 +647,8 @@ components: type: integer MaxNumberofUEsTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for MaxNumberofUEsTarget + This data type is the "ExpectationTarget" data type with specialisations for MaxNumberofUEsTarget.It describes the the number of UEs for edge service supporting + that the intent expectation is applied. For details see attribute maxNumberofUE defined in clause 6.3.1 of of TS 28.541 [5] type: object properties: targetName: @@ -620,7 +663,9 @@ components: type: integer ActivityFactorTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for ActivityFactorTarget + This data type is the "ExpectationTarget" data type with specialisations for ActivityFactorTarget.It describes the percentage value of the amount of simultaneous + active UEs to the total number of UEs where active means the UEs are exchanging data with the edge service supporting that the intent expectation is applied. + For details see activityFactor in clause 6.3.1 in TS 28.541 [5]. type: object properties: targetName: @@ -635,7 +680,8 @@ components: type: integer UESpeedTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for UESpeedTarget + This data type is the "ExpectationTarget" data type with specialisations for UESpeedTarget.It describes the speed (in km/hour) supported for edge service supporting + that the intent expectation is applied. For details see uESpeed in clause 6.3.1 in TS 28.541[5]. type: object properties: targetName: @@ -650,7 +696,8 @@ components: type: integer MaxNumberofPDUsessionsTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for MaxNumberofPDUsessionsTarget + This data type is the "ExpectationTarget" data type with specialisations for MaxNumberofPDUsessionsTarget.It describes the maximum number of PDU sessions for 5GC + SubNetwork supporting that the intent expectation is applied. For details, see maxNumberofPDUsessions in clause 5.3.1.2 in TS 28.552 [12]. type: object properties: targetName: @@ -667,7 +714,8 @@ components: $ref: '#/components/schemas/5GSessionContext' 5GSessionContext: description: >- - This data type is the "TargetContext" data type with specialisations for 5GSessionContext + This data type is the "TargetContext" data type with specialisations for 5GSessionContext.It describes the maximum supported 5G PDU session of the 5GC SubNetwork + related to the intent expectation. type: object properties: contextAttribute: @@ -682,7 +730,8 @@ components: type: integer MaxNumberofRegisteredsubscribersTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for MaxNumberofRegisteredsubscribersTarget + This data type is the "ExpectationTarget" data type with specialisations for MaxNumberofRegisteredsubscribersTarget.It describes the maximum number of Registered + subscribers for 5GC SubNetwork supporting that the intent expectation is applied. For details, see maxNumberofRegisteredsubscribers in clause 5.6.2 in TS 28.552 [12]. type: object properties: targetName: @@ -697,7 +746,8 @@ components: type: integer IncomingDataTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for IncomingDataTarget + This data type is the "ExpectationTarget" data type with specialisations for IncomingDataTarget.It describes the maximum incoming data packets for 5GC SubNetwork + related to the intent expectation. For details, see N6 incoming link usage measurement in clause 5.4.2.1 in TS 28.552 [12]. type: object properties: targetName: @@ -712,7 +762,8 @@ components: type: integer OutgoingDataTarget: description: >- - This data type is the "ExpectationTarget" data type with specialisations for OutgoingDataTarget + This data type is the "ExpectationTarget" data type with specialisations for OutgoingDataTarget.It describes the maximum outgoing data packets for 5GC SubNetwork + related to the intent expectation. For details, see N6 outgoing link usage measurement in clause 5.4.2.2 in TS 28.552 [12]. type: object properties: targetName: @@ -731,7 +782,8 @@ components: #-------Definition of the concrete ObjectTarget dataType----------------# CoverageAreaPolygonContext: description: >- - This data type is the "ObjectContext" data type with specialisations for CoverageAreaPolygonContext + This data type is the "ObjectContext" data type with specialisations for CoverageAreaPolygonContext.It describes the coverage areas for the RAN SubNetwork that the + intent expectation is applied in the form of polygon. type: object properties: contextAttribute: @@ -746,7 +798,8 @@ components: $ref: 'TS28623_ComDefs.yaml#/components/schemas/GeoArea' CoverageTACContext: description: >- - This data type is the "ObjectContext" data type with specialisations for CoverageTACContext + This data type is the "ObjectContext" data type with specialisations for CoverageTACContext.It describes the coverage areas for the RAN SubNetwork that the intent + expectation is applied in the form of TAC. type: object properties: contextAttribute: @@ -780,9 +833,8 @@ components: $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' DlFrequencyContext: description: >- - 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. + 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: @@ -799,9 +851,8 @@ components: $ref: 'TS28312_IntentNrm.yaml#/components/schemas/Frequency' UlFrequencyContext: description: >- - This data type is the "Context" data type with specialisations for Object context "ULFrequencyContext". - 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. + This data type is the "Context" data type with specialisations for Object context "ULFrequencyContext".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: @@ -818,7 +869,8 @@ components: $ref: 'TS28312_IntentNrm.yaml#/components/schemas/Frequency' RATContext: description: >- - This data type is the "ObjectContext" data type with specialisations for RATContext + This data type is the "ObjectContext" data type with specialisations for RATContext.It describes the RAT supported by the RAN SubNetwork that the intent expectation + is applied. type: object properties: contextAttribute: @@ -992,7 +1044,8 @@ components: TargetAssuranceTimeContext: description: >- - This data type is the "Expectation Context" data type with specialisations for TargetAssuranceTimeContext + This data type is the "Expectation Context" data type with specialisations for TargetAssuranceTimeContext.It describes the timeWindows + (including startTime, endTime) when the targets in the Intent Expectation need to be assured. type: object properties: contextAttribute: @@ -1068,7 +1121,8 @@ components: $ref: "TS28541_SliceNrm.yaml#/components/schemas/SharingLevel" ServiceTypeContext: description: >- - This data type is the "ExpectationContext" data type with specialisations for ServiceTypeContext + This data type is the "ExpectationContext" data type with specialisations for ServiceTypeContext.It describes + the service type for the Radio Service that the intent expectation is applied. For details see sST in clause 6.4.1 in TS 28.541 [5] type: object properties: contextAttribute: diff --git a/OpenAPI/TS28312_IntentNrm.yaml b/OpenAPI/TS28312_IntentNrm.yaml index 130494e0230e7c9588ba2cf28d8f1a4d245e379e..dc5c4d4e48ca9d7641779bc7bd27ebe49288c5ec 100644 --- a/OpenAPI/TS28312_IntentNrm.yaml +++ b/OpenAPI/TS28312_IntentNrm.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: Intent NRM - version: 18.3.0 + version: 18.4.0 description: >- OAS 3.0.1 definition of the Intent NRM © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -150,13 +150,12 @@ components: objectType: type: string enum: - - RAN_SubNetwork #value for Radio Network Expectation--# - - Edge_Service_Support #value for Edge Service Support Expectation--# - - 5GC_SubNetwork #value for 5GC Network Expectation--# + - RAN_SUBNETWORK #value for Radio Network Expectation--# + - EDGE_SERVICE_SUPPORT #value for Edge Service Support Expectation--# + - 5GC_SUBNETWORK #value for 5GC Network Expectation--# + - Radio_Service #value for Radio Service Expectation--# objectInstance: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - contextSelectivity: - $ref: "#/components/schemas/Selectivity" objectContexts: type: array items: @@ -192,6 +191,7 @@ components: enum: - FULFILLED - NOT_FULFILLED + default: NOT_FULFILLED description: It describes the current status of the intent fulfilment result. NotFulfilledState: type: string @@ -203,6 +203,7 @@ components: - SUSPENDED - TERMINATED - FULFILMENTFAILED + default: ACKNOWLEDGED 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 @@ -227,7 +228,7 @@ components: enum: - DELIVER - ENSURE - description: It describes the characteristic of the intentExpectation and is the property that describes the types of intentExpectations. + description: It describes the characteristic of the intentExpectation and is the property that describes the types of intentExpectations. Vendor extensions are allowed Frequency: description: >- It desribes the RF reference frequency (i.e. Absolute Radio Frequency Channel Number) @@ -360,6 +361,9 @@ components: $ref: '#/components/schemas/FulfilmentInfo' targetAchievedValue: type: number + description: >- + It describes the value that has been achieved for the expectation target at the time at which + the report is generated. #-------Definition of the concrete TargetFulfilmentResult dataType----------------# #-------Definition of the generic IntentConflictReport dataType----------------# @@ -429,6 +433,7 @@ components: - RAN_SUBNETWORK - EDGE_SERVICE_SUPPORT - 5GC_SUBNETWORK + - Radio_Service description: It describes the expectation object type which can be supported by a specific intent handling function of MnS producer. supportedExpectationTargetNames: type: array diff --git a/OpenAPI/TS28318_DsoNrm.yaml b/OpenAPI/TS28318_DsoNrm.yaml index 25c311611f3646367a5b1c174b6dd758a89f039c..7246dca06f5339830621ae57777da15147215f37 100644 --- a/OpenAPI/TS28318_DsoNrm.yaml +++ b/OpenAPI/TS28318_DsoNrm.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: 3GPP NRM - version: 18.5.0 + version: 18.1.0 description: >- OAS 3.0.1 specification of the OutageAndRecoveryInfo NRM © 2024, 3GPP Organizational OutageAndRecoveryInfo Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -25,30 +25,13 @@ components: #-------- Definition of concrete IOCs -------------------------------------------- - MnS: - oneOf: - - type: object - properties: - SubNetwork: - $ref: '#/components/schemas/SubNetwork-Multiple' - - SubNetwork-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-Attr' - - type: object - properties: - Subnetwork: - $ref: '#/components/schemas/SubNetwork-Multiple' - OutageAndRecoveryInfo: - $ref: '#/components/schemas/OutageAndRecoveryInfo-Multiple' - DsoThresholdMonitor: - $ref: '#/components/schemas/DsoThresholdMonitor-Multiple' - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-ncO' + SubNetwork-ncO-DsoNrm: + type: object + properties: + OutageAndRecoveryInfo: + $ref: '#/components/schemas/OutageAndRecoveryInfo-Multiple' + DsoThresholdMonitor: + $ref: '#/components/schemas/DsoThresholdMonitor-Multiple' OutageAndRecoveryInfo-Single: allOf: @@ -87,10 +70,6 @@ components: #-------- Definition of JSON arrays for name-contained IOCs ---------------------- - SubNetwork-Multiple: - type: array - items: - $ref: '#/components/schemas/SubNetwork-Single' OutageAndRecoveryInfo-Multiple: type: array items: @@ -104,7 +83,5 @@ components: resources-DSORecovery: oneOf: - - $ref: '#/components/schemas/MnS' - - $ref: '#/components/schemas/SubNetwork-Single' - $ref: '#/components/schemas/OutageAndRecoveryInfo-Single' - $ref: '#/components/schemas/DsoThresholdMonitor-Single' diff --git a/OpenAPI/TS28531_NSProvMnS.yaml b/OpenAPI/TS28531_NSProvMnS.yaml new file mode 100644 index 0000000000000000000000000000000000000000..fa0c11ffd43cdfa4a58996e2c6651621ad02a59e --- /dev/null +++ b/OpenAPI/TS28531_NSProvMnS.yaml @@ -0,0 +1,82 @@ +openapi: 3.0.1 +info: + title: Network Slice Provisioning MnS + version: 18.6.0 + description: >- + OAS 3.0.1 definition of the Network Slice Provisioning MnS + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.531; Provisioning + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.531/ +servers: + - url: '{MnSRoot}/NSProvMnS/{MnSVersion}' + variables: + MnSRoot: + description: See clause 4.4.2 of TS 32.158 + default: http://example.com/3GPPManagement + MnSVersion: + description: Version number of the OpenAPI definition + default: XXX +paths: + /ServiceProfiles: + post: + summary: Create a ServiceProfile + description: To create a ServiceProfile resource to represent network slice related requirements. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceProfile-Type' + responses: + '201': + description: Success case ("201 Created"). The representation of the newly created ServiceProfile resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceProfileId-Type' + default: + description: Error case. + content: + application/json: + schema: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponseDefault' + + /ServiceProfiles/{ServiceProfileId}: + delete: + summary: Delete a ServiceProfile + description: To delete a ServiceProfile resource to represent network slice related requirements. + parameters: + - name: ServiceProfileId + in: path + description: Identifies an individual ServiceProfille. + required: true + schema: + $ref: '#/components/schemas/ServiceProfileId-Type' + - name: networkSliceDN + in: query + description: Identifies the DN of NetworkSlice MOI uniquely identifying the network slice instance + required: true + schema: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + responses: + '204': + description: >- + Success case ("204 No Content"). + The ServiceProfile resource has been deleted. The response message body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponseDefault' +components: + schemas: + uri-Type: + description: Resource URI + type: string + ServiceProfileId-Type: + $ref: '#/components/schemas/uri-Type' + ServiceProfile-Type: + $ref: 'TS28541_SliceNrm.yaml#/components/schemas/ServiceProfile' \ No newline at end of file diff --git a/OpenAPI/TS28531_NSSProvMnS.yaml b/OpenAPI/TS28531_NSSProvMnS.yaml new file mode 100644 index 0000000000000000000000000000000000000000..69f9ec7386d82542c6dcf0a6787906a44c725baa --- /dev/null +++ b/OpenAPI/TS28531_NSSProvMnS.yaml @@ -0,0 +1,82 @@ +openapi: 3.0.1 +info: + title: Network Slice Subnet Provisioning MnS + version: 18.6.0 + description: >- + OAS 3.0.1 definition of the Network Slice Suubnet Provisioning MnS + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.531; Provisioning + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.531/ +servers: + - url: '{MnSRoot}/NSSProvMnS/{MnSVersion}' + variables: + MnSRoot: + description: See clause 4.4.2 of TS 32.158 + default: http://example.com/3GPPManagement + MnSVersion: + description: Version number of the OpenAPI definition + default: XXX +paths: + /SliceProfiles: + post: + summary: Create a SliceProfile + description: To create a SliceeProfile resource to represent network slice subnet related requirements. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceProfileId-Type' + responses: + '201': + description: Success case ("201 Created"). The representation of the newly created SliceProfile resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/SliceProfileId-Type' + default: + description: Error case. + content: + application/json: + schema: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponseDefault' + + /SliceProfiles/{SliceProfileId}: + delete: + summary: Delete a SliceProfile + description: To delete a SliceProfile resource to represent network slice suubnet related requirements. + parameters: + - name: SliceProfileId + in: path + description: Identifies an individual SliceProfille. + required: true + schema: + $ref: '#/components/schemas/SliceProfileId-Type' + - name: networkSliceSubnetDN + in: query + description: Identifies the DN of NetworkSliceSubnet MOI uniquely identifying the network slice subnet instance + required: true + schema: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + responses: + '204': + description: >- + Success case ("204 No Content"). + The ServiceProfile resource has been deleted. The response message body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponseDefault' +components: + schemas: + uri-Type: + description: Resource URI + type: string + SliceProfileId-Type: + $ref: '#/components/schemas/uri-Type' + ServiceProfileId-Type: + $ref: 'TS28541_SliceNrm.yaml#/components/schemas/SliceProfile' \ No newline at end of file diff --git a/OpenAPI/TS28532_FaultMnS.yaml b/OpenAPI/TS28532_FaultMnS.yaml deleted file mode 100755 index 3c5631aaea71104fb663d5e40c565437a1d4a6c8..0000000000000000000000000000000000000000 --- a/OpenAPI/TS28532_FaultMnS.yaml +++ /dev/null @@ -1,1058 +0,0 @@ -openapi: 3.0.1 -info: - title: Fault Supervision MnS - version: 18.1.0 - description: >- - OAS 3.0.1 definition of the Fault Supervision MnS - © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). - All rights reserved. -externalDocs: - description: 3GPP TS 28.532; Generic management services - url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/ -servers: - - url: '{MnSRoot}/FaultSupervisionMnS/{MnSversion}' - variables: - MnSRoot: - description: See subclause 4.4.3 of TS 32.158 - default: http://example.com/3GPPManagement - MnSversion: - description: Version number of the OpenAPI definition - default: XXX -paths: - /alarms: - get: - summary: Retrieve multiple alarms - description: >- - Retrieves the alarms identified by alarmAckState, baseObjectInstance - and filter. - parameters: - - name: alarmAckState - in: query - required: false - schema: - $ref: '#/components/schemas/AlarmAckState' - - name: baseObjectInstance - in: query - required: false - schema: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - - name: filter - in: query - required: false - schema: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Filter' - responses: - '200': - description: >- - Success case ("200 OK"). - Returns the alarms identified in the request. The alarmId is the key - of the map. - content: - application/json: - schema: - type: object - additionalProperties: - type: object - allOf: - - type: object - properties: - lastNotificationHeader: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' - - $ref: '#/components/schemas/AlarmRecord' - - type: object - properties: - comments: - $ref: '#/components/schemas/Comments' - default: - description: Response in case of error. - content: - application/json: - schema: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' - patch: - summary: 'Clear, acknowledge or unacknowledge multiple alarms' - description: >- - Clears, acknowledges or unacknowledges multiple alarms using patch. Depending - on which action is to be performed, different merge patch documents need - to be used. - requestBody: - description: >- - Patch documents for acknowledging and unacknowledging, or clearing multiple - alarms. The keys in the map are the alarmIds to be patched. - content: - application/merge-patch+json: - schema: - oneOf: - - type: object - additionalProperties: - $ref: '#/components/schemas/MergePatchAcknowledgeAlarm' - - type: object - additionalProperties: - $ref: '#/components/schemas/MergePatchClearAlarm' - responses: - '204': - description: >- - Success case ("204 No content"). - The response message body is empty. - default: - description: Response in case of error. - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/FailedAlarm' - /alarms/alarmCount: - get: - summary: Get the alarm count per perceived severity - parameters: - - name: alarmAckState - in: query - required: false - schema: - $ref: '#/components/schemas/AlarmAckState' - - name: filter - in: query - required: false - schema: - type: string - responses: - '200': - description: >- - Success case ("200 OK"). - The alarm count per perceived severity is returned. - content: - application/json: - schema: - $ref: '#/components/schemas/AlarmCount' - default: - description: Response in case of error. The error case needs rework. - content: - application/json: - schema: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' - /alarms/{alarmId}: - patch: - summary: 'Clear, acknowledge or unacknowledge a single alarm' - description: >- - Clears, acknowledges or unacknowldeges a single alarm by patching the alarm - information. A conditional acknowledge request based on the perceived - severity is not supported. - parameters: - - name: alarmId - in: path - description: Identifies the alarm to be patched. - required: true - schema: - type: string - requestBody: - required: true - content: - application/merge-patch+json: - schema: - oneOf: - - $ref: '#/components/schemas/MergePatchAcknowledgeAlarm' - - $ref: '#/components/schemas/MergePatchClearAlarm' - responses: - '204': - description: >- - Success case (204 No content). - The response message body is absent. - default: - description: Response in case of error. - content: - application/json: - schema: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' - /alarms/{alarmId}/comments: - post: - summary: Add a comment to a single alarm - description: >- - Adds a comment to an alarm identified by alarmId. The id of the new comment - is allocated by the producer. - parameters: - - name: alarmId - in: path - description: Identifies the alarm to which the comment shall be added. - required: true - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/Comment' - responses: - '201': - description: >- - Success case (201 Created). - The representation of the newly created comment resource shall be returned. - content: - application/json: - schema: - $ref: '#/components/schemas/Comment' - headers: - Location: - description: URI of the newly created comment resource. - required: true - schema: - type: string - default: - description: Error case. - content: - application/json: - schema: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' - - /subscriptions: - post: - summary: Create a subscription - description: >- - To create a subscription the representation of the subscription is - POSTed on the /subscriptions collection resource. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/Subscription' - responses: - '201': - description: >- - Success case ("201 Created"). - The representation of the newly created subscription resource shall - be returned. - content: - application/json: - schema: - $ref: '#/components/schemas/Subscription' - headers: - Location: - description: URI of the newly created subscription resource - required: true - schema: - type: string - default: - description: Error case. - content: - application/json: - schema: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' - callbacks: - notifyNewAlarm: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/NotifyNewAlarm' - - $ref: '#/components/schemas/NotifyNewSecAlarm' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response message - body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' - notifyClearedAlarm: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/NotifyClearedAlarm' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response message - body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' - notifyChangedAlarm: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/NotifyChangedAlarm' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response message - body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' - notifyChangedAlarmGeneral: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/NotifyChangedAlarmGeneral' - - $ref: '#/components/schemas/NotifyChangedSecAlarmGeneral' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response message - body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' - notifyCorrelatedNotificationChanged: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/NotifyCorrelatedNotificationChanged' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response message - body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' - notifyAckStateChanged: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/NotifyAckStateChanged' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response message - body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' - notifyComments: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/NotifyComments' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response message - body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' - notifyPotentialFaultyAlarmList: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/NotifyPotentialFaultyAlarmList' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response message - body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' - notifyAlarmListRebuilt: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/NotifyAlarmListRebuilt' - responses: - '204': - description: >- - Success case ("204 No Content"). - The notification is successfully delivered. The response message - body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' - /subscriptions/{subscriptionId}: - delete: - summary: Delete a subscription - description: >- - The subscription is deleted by deleting the corresponding subscription - resource. The resource to be deleted is identified with the path - component of the URI. - parameters: - - name: subscriptionId - in: path - description: Identifies the subscription to be deleted. - required: true - schema: - type: string - responses: - '204': - description: >- - Success case ("204 No Content"). - The subscription resource has been deleted. The response message body - is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' - -components: - schemas: - - #---- Definition of AlarmRecord ----------------------------------------------------# - - AlarmId: - type: string - AlarmType: - type: string - enum: - - COMMUNICATIONS_ALARM - - QUALITY_OF_SERVICE_ALARM - - PROCESSING_ERROR_ALARM - - EQUIPMENT_ALARM - - ENVIRONMENTAL_ALARM - - INTEGRITY_VIOLATION - - OPERATIONAL_VIOLATION - - PHYSICAL_VIOLATION - - SECURITY_SERVICE_OR_MECHANISM_VIOLATION - - TIME_DOMAIN_VIOLATION - ProbableCause: - description: >- - The value of the probable cause may be a specific standardized string, or any - vendor provided string. Probable cause strings are not standardized in the - present document. They may be added in a future version. Up to then the - mapping of the generic probable cause strings "PROBABLE_CAUSE_001" to - "PROBABLE_CAUSE_005" is vendor specific. - The value of the probable cause may also be an integer. The mapping of integer - values to probable causes is vendor specific. - oneOf: - - anyOf: - - type: string - enum: - - PROBABLE_CAUSE_001 - - PROBABLE_CAUSE_002 - - PROBABLE_CAUSE_003 - - PROBABLE_CAUSE_004 - - PROBABLE_CAUSE_005 - - type: string - - type: integer - SpecificProblem: - oneOf: - - type: string - - type: integer - PerceivedSeverity: - type: string - enum: - - INDETERMINATE - - CRITICAL - - MAJOR - - MINOR - - WARNING - - CLEARED - TrendIndication: - type: string - enum: - - MORE_SEVERE - - NO_CHANGE - - LESS_SEVERE - ThresholdHysteresis: - type: object - required: - - high - properties: - high: - oneOf: - - type: integer - - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Float' - low: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Float' - ThresholdLevelInd: - oneOf: - - type: object - properties: - up: - $ref: '#/components/schemas/ThresholdHysteresis' - - type: object - properties: - down: - $ref: '#/components/schemas/ThresholdHysteresis' - ThresholdInfo: - type: object - properties: - observedMeasurement: - type: string - observedValue: - type: number - thresholdLevel: - $ref: '#/components/schemas/ThresholdLevelInd' - armTime: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' - required: - - observedMeasurement - - observedValue - CorrelatedNotification: - type: object - properties: - sourceObjectInstance: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - notificationIds: - type: array - items: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationId' - required: - - sourceObjectInstance - - notificationIds - CorrelatedNotifications: - type: array - items: - $ref: '#/components/schemas/CorrelatedNotification' - AckState: - type: string - enum: - - ACKNOWLEDGED - - UNACKNOWLEDGED - - AlarmRecord: - description: >- - The alarmId is not a property of an alarm record. It is used as key - in the map of alarm records instead. - type: object - properties: - # alarmId: - # $ref: '#/components/schemas/AlarmId' - objectInstance: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - notificationId: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationId' - alarmRaisedTime: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' - alarmChangedTime: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' - alarmClearedTime: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' - alarmType: - $ref: '#/components/schemas/AlarmType' - probableCause: - $ref: '#/components/schemas/ProbableCause' - specificProblem: - $ref: '#/components/schemas/SpecificProblem' - perceivedSeverity: - $ref: '#/components/schemas/PerceivedSeverity' - backedUpStatus: - type: boolean - backUpObject: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - trendIndication: - $ref: '#/components/schemas/TrendIndication' - thresholdinfo: - $ref: '#/components/schemas/ThresholdInfo' - correlatedNotifications: - $ref: '#/components/schemas/CorrelatedNotifications' - stateChangeDefinition: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeValueChangeSet' - monitoredAttributes: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' - proposedRepairActions: - type: string - additionalText: - type: string - additionalInformation: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' - - rootCauseIndicator: - type: boolean - - ackTime: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' - ackUserId: - type: string - ackSystemId: - type: string - ackState: - $ref: '#/components/schemas/AckState' - - clearUserId: - type: string - clearSystemId: - type: string - serviceUser: - type: string - serviceProvider: - type: string - securityAlarmDetector: - type: string - - #---- Definition of alarm notifications --------------------------------------------# - - AlarmNotificationTypes: - type: string - enum: - - notifyNewAlarm - - notifyChangedAlarm - - notifyChangedAlarmGeneral - - notifyAckStateChanged - - notifyCorrelatedNotificationChanged - - notifyComments - - notifyClearedAlarm - - notifyAlarmListRebuilt - - notifyPotentialFaultyAlarmList - AlarmListAlignmentRequirement: - type: string - enum: - - ALIGNMENT_REQUIRED - - ALIGNMENT_NOT_REQUIRED - - NotifyNewAlarm: - allOf: - - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' - - type: object - required: - - alarmId - - alarmType - - probableCause - - perceivedSeverity - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - alarmType: - $ref: '#/components/schemas/AlarmType' - probableCause: - $ref: '#/components/schemas/ProbableCause' - specificProblem: - $ref: '#/components/schemas/SpecificProblem' - perceivedSeverity: - $ref: '#/components/schemas/PerceivedSeverity' - backedUpStatus: - type: boolean - backUpObject: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - trendIndication: - $ref: '#/components/schemas/TrendIndication' - thresholdInfo: - $ref: '#/components/schemas/ThresholdInfo' - correlatedNotifications: - $ref: '#/components/schemas/CorrelatedNotifications' - stateChangeDefinition: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeValueChangeSet' - monitoredAttributes: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' - proposedRepairActions: - type: string - additionalText: - type: string - additionalInformation: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' - rootCauseIndicator: - type: boolean - NotifyNewSecAlarm: - allOf: - - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' - - type: object - required: - - alarmId - - alarmType - - probableCause - - perceivedSeverity - - serviceUser - - serviceProvider - - securityAlarmDetector - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - alarmType: - $ref: '#/components/schemas/AlarmType' - probableCause: - $ref: '#/components/schemas/ProbableCause' - perceivedSeverity: - $ref: '#/components/schemas/PerceivedSeverity' - correlatedNotifications: - $ref: '#/components/schemas/CorrelatedNotifications' - additionalText: - type: string - additionalInformation: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' - rootCauseIndicator: - type: boolean - serviceUser: - type: string - serviceProvider: - type: string - securityAlarmDetector: - type: string - NotifyClearedAlarm: - allOf: - - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' - - type: object - required: - - alarmId - - alarmType - - probableCause - - perceivedSeverity - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - alarmType: - $ref: '#/components/schemas/AlarmType' - probableCause: - $ref: '#/components/schemas/ProbableCause' - perceivedSeverity: - $ref: '#/components/schemas/PerceivedSeverity' - correlatedNotifications: - $ref: '#/components/schemas/CorrelatedNotifications' - clearUserId: - type: string - clearSystemId: - type: string - NotifyChangedAlarm: - allOf: - - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' - - type: object - required: - - alarmId - - alarmType - - probableCause - - perceivedSeverity - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - alarmType: - $ref: '#/components/schemas/AlarmType' - probableCause: - $ref: '#/components/schemas/ProbableCause' - perceivedSeverity: - $ref: '#/components/schemas/PerceivedSeverity' - NotifyChangedAlarmGeneral: - allOf: - - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' - - type: object - required: - - alarmId - - alarmType - - probableCause - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - alarmType: - $ref: '#/components/schemas/AlarmType' - probableCause: - $ref: '#/components/schemas/ProbableCause' - specificProblem: - $ref: '#/components/schemas/SpecificProblem' - perceivedSeverity: - $ref: '#/components/schemas/PerceivedSeverity' - correlatedNotifications: - $ref: '#/components/schemas/CorrelatedNotifications' - backedUpStatus: - type: boolean - backUpObject: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - trendIndication: - $ref: '#/components/schemas/TrendIndication' - thresholdInfo: - $ref: '#/components/schemas/ThresholdInfo' - stateChangeDefinition: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeValueChangeSet' - monitoredAttributes: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' - proposedRepairActions: - type: string - additionalText: - type: string - additionalInformation: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' - rootCauseIndicator: - type: boolean - changedAlarmAttributes: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' - NotifyChangedSecAlarmGeneral: - allOf: - - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' - - type: object - required: - - alarmId - - alarmType - - probableCause - - serviceUser - - serviceProvider - - securityAlarmDetector - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - alarmType: - $ref: '#/components/schemas/AlarmType' - probableCause: - $ref: '#/components/schemas/ProbableCause' - perceivedSeverity: - $ref: '#/components/schemas/PerceivedSeverity' - correlatedNotifications: - $ref: '#/components/schemas/CorrelatedNotifications' - additionalText: - type: string - additionalInformation: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' - rootCauseIndicator: - type: boolean - serviceUser: - type: string - serviceProvider: - type: string - securityAlarmDetector: - type: string - changedAlarmAttributes: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' - NotifyCorrelatedNotificationChanged: - allOf: - - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' - - type: object - required: - - alarmId - - correlatedNotifications - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - correlatedNotifications: - $ref: '#/components/schemas/CorrelatedNotifications' - rootCauseIndicator: - type: boolean - NotifyAckStateChanged: - allOf: - - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' - - type: object - required: - - alarmId - - alarmType - - probableCause - - perceivedSeverity - - ackState - - ackUserId - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - alarmType: - $ref: '#/components/schemas/AlarmType' - probableCause: - $ref: '#/components/schemas/ProbableCause' - perceivedSeverity: - $ref: '#/components/schemas/PerceivedSeverity' - ackState: - $ref: '#/components/schemas/AckState' - ackUserId: - type: string - ackSystemId: - type: string - NotifyComments: - allOf: - - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' - - type: object - required: - - alarmId - - alarmType - - probableCause - - perceivedSeverity - - comments - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - alarmType: - $ref: '#/components/schemas/AlarmType' - probableCause: - $ref: '#/components/schemas/ProbableCause' - perceivedSeverity: - $ref: '#/components/schemas/PerceivedSeverity' - comments: - $ref: '#/components/schemas/Comments' - NotifyPotentialFaultyAlarmList: - allOf: - - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' - - type: object - required: - - reason - properties: - reason: - type: string - NotifyAlarmListRebuilt: - allOf: - - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' - - type: object - required: - - reason - properties: - reason: - type: string - alarmListAlignmentRequirement: - $ref: '#/components/schemas/AlarmListAlignmentRequirement' - - #---- Definition of query parameters -----------------------------------------------# - - AlarmAckState: - type: string - enum: - - ALL_ALARMS - - ALL_ACTIVE_ALARMS - - ALL_ACTIVE_AND_ACKNOWLEDGED_ALARMS - - ALL_ACTIVE_AND_UNACKNOWLEDGED_ALARMS - - ALL_CLEARED_AND_UNACKNOWLEDGED_ALARMS - - ALL_UNACKNOWLEDGED_ALARMS - - #---- Definition of patch documents ------------------------------------------------# - - MergePatchAcknowledgeAlarm: - description: >- - Patch document acknowledging or unacknowledging a single alarm. For - acknowledging an alarm the value of ackState is ACKNOWLEDGED, for unacknowledging - an alarm the value of ackState is UNACKNOWLEDGED. - type: object - required: - - ackUserId - - ackState - properties: - ackUserId: - type: string - ackSystemId: - type: string - ackState: - $ref: '#/components/schemas/AckState' - MergePatchClearAlarm: - description: Patch document for clearing a single alarm - type: object - required: - - clearUserId - - perceivedSeverity - properties: - clearUserId: - type: string - clearSystemId: - type: string - perceivedSeverity: - type: string - enum: - - CLEARED - - #---- Definition of method responses -----------------------------------------------# - - FailedAlarm: - type: object - required: - - alarmId - - failureReason - properties: - alarmId: - $ref: '#/components/schemas/AlarmId' - failureReason: - type: string - - #---- Definition of resources ------------------------------------------------------# - - AlarmCount: - type: object - required: - - criticalCount - - majorCount - - minorCount - - warningCount - - indeterminateCount - - clearedCount - properties: - criticalCount: - type: integer - majorCount: - type: integer - minorCount: - type: integer - warningCount: - type: integer - indeterminateCount: - type: integer - clearedCount: - type: integer - Comment: - type: object - properties: - commentTime: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' - commentUserId: - type: string - commentSystemId: - type: string - commentText: - type: string - Comments: - description: >- - Collection of comments. The comment identifiers are allocated by the - MnS producer and used as key in the map. - type: object - additionalProperties: - $ref: '#/components/schemas/Comment' - Subscription: - type: object - properties: - consumerReference: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' - timeTick: - type: integer - filter: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Filter' diff --git a/OpenAPI/TS28532_ProvMnS.yaml b/OpenAPI/TS28532_ProvMnS.yaml index 27e027547821c825e092d6ca23685632bcce13e7..116dfc4b7d44bcd8df8eafb2f94fadb728a982fa 100755 --- a/OpenAPI/TS28532_ProvMnS.yaml +++ b/OpenAPI/TS28532_ProvMnS.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: Provisioning MnS - version: 18.2.0 + version: 18.3.0 description: >- OAS 3.0.1 definition of the Provisioning MnS © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -432,12 +432,14 @@ components: - $ref: 'TS28623_FileManagementNrm.yaml#/components/schemas/resources-fileMgmtNrm' - $ref: 'TS28623_ManagementDataCollectionNrm.yaml#/components/schemas/resources-mgmtDataCollectionNrm' - $ref: 'TS28623_MnSRegistryNrm.yaml#/components/schemas/resources-mnSRegistryNrm' - - $ref: 'TS28623_PmControlNrm.yaml#/components/schemas/resources-pmControlNrm' + - $ref: 'TS28623_PmControlNrm.yaml#/components/schemas/resources-pmControlNrm' + - $ref: 'TS28111_FaultNrm.yaml#/components/schemas/resources-faultNrm' - $ref: 'TS28623_QoEMeasurementCollectionNrm.yaml#/components/schemas/resources-qoEMeasuremetCollectionNrm' - $ref: 'TS28623_SubscriptionControlNrm.yaml#/components/schemas/resources-subscriptionControlNrm' - $ref: 'TS28623_ThresholdMonitorNrm.yaml#/components/schemas/resources-thresholdMonitorNrm' - $ref: 'TS28623_TraceControlNrm.yaml#/components/schemas/resources-traceControlNrm' - $ref: 'TS28319_MsacNrm.yaml#/components/schemas/resources-msacNrm' + - $ref: 'TS28318_DsoNrm.yaml#/components/schemas/resources-DSORecovery' Scope: type: object properties: @@ -537,7 +539,7 @@ components: - specificProblem properties: specificProblem: - $ref: 'TS28532_FaultMnS.yaml#/components/schemas/SpecificProblem' + $ref: 'TS28111_FaultNrm.yaml#/components/schemas/SpecificProblem' additionalText: type: string additionalInformation: diff --git a/OpenAPI/TS28536_CoslaNrm.yaml b/OpenAPI/TS28536_CoslaNrm.yaml index 99a1b50c04efd36feed3589dfc54e356d4a3f2fb..a81e08261fc6cd845e072718fccae9bdee4553ce 100755 --- a/OpenAPI/TS28536_CoslaNrm.yaml +++ b/OpenAPI/TS28536_CoslaNrm.yaml @@ -2,14 +2,14 @@ openapi: 3.0.1 info: title: coslaNrm - version: 17.4.0 + version: 18.1.0 description: >- OAS 3.0.1 specification of the Cosla NRM © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 28.536 V17.3.0; Cosla NRM + description: 3GPP TS 28.536; Cosla NRM url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.536/ paths: {} @@ -140,21 +140,6 @@ components: $ref: '#/components/schemas/AssuranceClosedControlLoop-Multiple' #-------- Definition of concrete IOCs -------------------------------------------- - MnS: - oneOf: - - type: object - properties: - SubNetwork: - type: array - items: - $ref: '#/components/schemas/SubNetwork-ncO-CoslaNrm' - - type: object - properties: - ManagedElement: - type: array - items: - $ref: '#/components/schemas/ManagedElement-ncO-CoslaNrm' - AssuranceClosedControlLoop-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' @@ -226,7 +211,6 @@ components: resources-coslaNrm: oneOf: - - $ref: '#/components/schemas/MnS' - $ref: '#/components/schemas/AssuranceClosedControlLoop-Single' - $ref: '#/components/schemas/AssuranceGoal-Single' - $ref: '#/components/schemas/AssuranceReport-Single' diff --git a/OpenAPI/TS28538_EdgeNrm.yaml b/OpenAPI/TS28538_EdgeNrm.yaml index 6745e3fa8c318b40217be45f9239b5f3714966c3..0848b77d43bfaeb0f655cfe23151d47ccfde4018 100644 --- a/OpenAPI/TS28538_EdgeNrm.yaml +++ b/OpenAPI/TS28538_EdgeNrm.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: 3GPP Edge NRM - version: 18.6.0 + version: 18.7.0 description: >- OAS 3.0.1 specification of the Edge NRM © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -147,6 +147,18 @@ components: properties: resourceQuota: $ref: '#/components/schemas/VirtualResource' + FederatedECSInfo: + type: object + properties: + federateECSIdentifier: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + federatedECSProfile: + type: integer + servedEASList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + servedEESList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + #-------- Definition of types for name-containments ------ SubNetwork-ncO-EdgeNrm: @@ -158,14 +170,6 @@ components: $ref: '#/components/schemas/EdgeDataNetwork-Multiple' #-------- Definition of concrete IOCs -------------------------------------------- - MnS: - oneOf: - - type: object - properties: - SubNetwork: - type: array - items: - $ref: '#/components/schemas/SubNetwork-ncO-EdgeNrm' EdgeDataNetwork-Single: allOf: @@ -289,6 +293,8 @@ components: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' softwareImageInfo: $ref: '#/components/schemas/SoftwareImageInfo' + sharedECSInfo: + $ref: '#/components/schemas/FederatedECSInfo' - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' EASRequirements-Single: @@ -347,8 +353,11 @@ components: properties: participatingOPiD: type: string - originatingOPiD: + leadingOPiD: type: string + federatedECSInfo: + $ref: '#/components/schemas/FederatedECSInfo' + OperatorEdgeFederation-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' @@ -358,7 +367,7 @@ components: type: string FederationExpiry: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' - originatedOPiD: + leadingOPiD: type: string avaibleEDNList: $ref: '#/components/schemas/AvailableEDNList' @@ -415,7 +424,6 @@ components: resources-edgeNrm: oneOf: - - $ref: '#/components/schemas/MnS' - $ref: '#/components/schemas/EASFunction-Single' - $ref: '#/components/schemas/ECSFunction-Single' - $ref: '#/components/schemas/EESFunction-Single' diff --git a/OpenAPI/TS28541_5GcNrm.yaml b/OpenAPI/TS28541_5GcNrm.yaml index 9379ea46741e3defa4c7f58b30ac3d0ed5945340..44dc93e1c80245cd60b6bdd8aef483b28055fe5b 100755 --- a/OpenAPI/TS28541_5GcNrm.yaml +++ b/OpenAPI/TS28541_5GcNrm.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: 3GPP 5GC NRM - version: 18.7.0 + version: 18.8.0 description: >- OAS 3.0.1 specification of the 5GC NRM © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -229,10 +229,14 @@ components: type: array items: $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' + sNPNList: + type: array + items: + $ref: '#/components/schemas/SnpnId' allowedSNPNs: type: array items: - $ref: '#/components/schemas/SnpnInfo' + $ref: '#/components/schemas/SnpnId' allowedNfTypes: type: array items: @@ -672,13 +676,6 @@ components: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mnc' nid: type: string - SnpnInfo: - type: object - properties: - snpnId: - $ref: '#/components/schemas/SnpnId' - snssai: - $ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai' TaiList: type: array items: @@ -1352,6 +1349,38 @@ components: - NG_ENB - type: string + TrpMappingInfo: + type: object + properties: + satelliteId: + type: string + pattern: '^[0-9]{5}$' + trpIds: + type: array + items: + type: integer + minimum: 1 + maximum: 65535 + + TrpInfo: + description: The mapping relationship between TRP IDs, gNB ID and Satellite ID. + type: object + properties: + gNBId: + type: integer + minimum: 0 + maximum: 4294967295 + trpMappingInfoList: + type: array + items: + $ref: '#/components/schemas/TrpMappingInfo' + minItems: 1 + + TrpInfoList: + type: array + items: + $ref: '#/components/schemas/TrpInfo' + LmfInfo: description: Information of an LMF NF Instance type: object @@ -2985,21 +3014,6 @@ components: $ref: '#/components/schemas/MnpfFunction-Multiple' #-------- Definition of concrete IOCs -------------------------------------------- - MnS: - oneOf: - - type: object - properties: - SubNetwork: - type: array - items: - $ref: '#/components/schemas/SubNetwork-ncO-5GcNrm' - - type: object - properties: - ManagedElement: - type: array - items: - $ref: '#/components/schemas/ManagedElement-ncO-5GcNrm' - AmfFunction-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' @@ -3035,7 +3049,11 @@ components: sliceExpiryInfo: $ref: '#/components/schemas/SliceExpiryInfo' SatelliteBackhaulInfoList: - $ref: '#/components/schemas/SatelliteBackhaulInfo' + $ref: '#/components/schemas/SatelliteBackhaulInfo' + mappedCellIdInfoList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/MappedCellIdInfoList' + mdtUserConsentReqList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/MdtUserConsentReqList' - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - type: object properties: @@ -3265,6 +3283,8 @@ components: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' dynamic5QISetRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + predefinedPccRuleSetRefs: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - type: object properties: @@ -3282,8 +3302,6 @@ components: $ref: '#/components/schemas/EP_Rx-Multiple' EP_N84: $ref: '#/components/schemas/EP_N84-Multiple' - PredefinedPccRuleSet: - $ref: '#/components/schemas/PredefinedPccRuleSet-Single' AusfFunction-Single: allOf: @@ -3494,6 +3512,12 @@ components: $ref: '#/components/schemas/CommModelList' lmfInfo: $ref: '#/components/schemas/LmfInfo' + ephemerisInfos: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/EphemerisInfos' + trpInfoList: + $ref: '#/components/schemas/TrpInfoList' + mappedCellIdInfoList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/MappedCellIdInfoList' - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - type: object properties: @@ -5235,7 +5259,6 @@ components: enum: - ACTIVATED - DEACTIVATED - EP_SM12-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' @@ -5723,7 +5746,6 @@ components: resources-5gcNrm: oneOf: - - $ref: '#/components/schemas/MnS' - $ref: '#/components/schemas/AmfFunction-Single' - $ref: '#/components/schemas/SmfFunction-Single' - $ref: '#/components/schemas/UpfFunction-Single' diff --git a/OpenAPI/TS28541_NrNrm.yaml b/OpenAPI/TS28541_NrNrm.yaml index 9cfcb39b7ced716dc5b825d2362b0400824dbeb8..62e23de93760987a78e011b7ca67c887b8be1dac 100755 --- a/OpenAPI/TS28541_NrNrm.yaml +++ b/OpenAPI/TS28541_NrNrm.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: NR NRM - version: 18.7.0 + version: 18.8.0 description: >- OAS 3.0.1 specification of the NR NRM © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -64,35 +64,11 @@ components: PlmnInfoList: type: array items: - $ref: '#/components/schemas/PlmnInfo' - cagId: - type: string - nid: - type: string - NpnIdentity: - type: object - oneOf: - - required: [ plmnId, cagidList ] - - required: [ plmnId, nidList ] - properties: - plmnId: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' - cagidList: - type: array - items: - $ref: '#/components/schemas/cagId' - minItems: 1 - maxItems: 12 - nidList: - type: array - items: - $ref: '#/components/schemas/nid' - minItems: 1 - maxItems: 12 + $ref: '#/components/schemas/PlmnInfo' NpnIdentityList: type: array items: - $ref: '#/components/schemas/NpnIdentity' + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/NpnId-Type' GGnbId: type: string pattern: '^[0-9]{3}[0-9]{2,3}-(22|23|24|25|26|27|28|29|30|31|32)-[0-9]{1,10}' @@ -137,75 +113,81 @@ components: type: integer backhaulAddress: $ref: '#/components/schemas/BackhaulAddress' - IntraRatEsActivationOriginalCellLoadParameters: + LoadTimeThreshold: type: object properties: loadThreshold: type: integer timeDuration: type: integer + IntraRatEsActivationOriginalCellLoadParameters: + $ref: '#/components/schemas/LoadTimeThreshold' IntraRatEsActivationCandidateCellsLoadParameters: - type: object - properties: - loadThreshold: - type: integer - timeDuration: - type: integer + $ref: '#/components/schemas/LoadTimeThreshold' IntraRatEsDeactivationCandidateCellsLoadParameters: - type: object - properties: - loadThreshold: - type: integer - timeDuration: - type: integer + $ref: '#/components/schemas/LoadTimeThreshold' EsNotAllowedTimePeriod: type: object properties: - startTimeandendTime: + startTime: type: string - periodOfDay: + description: >- + Time of day is in HH:MM or H:MM 24-hour format per UTC time zone. + Examples, 20:15:00, 20:15:00-08:00 (for 8 hours behind UTC). + endTime: type: string - daysOfWeekList: - type: string - listoftimeperiods: + description: >- + Time of day is in HH:MM or H:MM 24-hour format per UTC time zone. + Examples, 20:15:00, 20:15:00-08:00 (for 8 hours behind UTC). + daysOfWeek: type: string + enum: + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + - SUNDAY InterRatEsActivationOriginalCellParameters: - type: object - properties: - loadThreshold: - type: integer - timeDuration: - type: integer + $ref: '#/components/schemas/LoadTimeThreshold' InterRatEsActivationCandidateCellParameters: - type: object - properties: - loadThreshold: - type: integer - timeDuration: - type: integer + $ref: '#/components/schemas/LoadTimeThreshold' InterRatEsDeactivationCandidateCellParameters: - type: object - properties: - loadThreshold: - type: integer - timeDuration: - type: integer + $ref: '#/components/schemas/LoadTimeThreshold' UeAccProbabilityDist: + type: array + items: + $ref: '#/components/schemas/UeAccProbability' + UeAccProbability: type: object properties: targetProbability: type: integer - numberofpreamblessent: + minimum: 0 + maximum: 100 + numberOfPreamblesSent: type: integer + minimum: 0 + maximum: 200 UeAccDelayProbabilityDist: + type: array + items: + $ref: '#/components/schemas/UeAccDelayProbability' + + UeAccDelayProbability: type: object properties: targetProbability: type: integer - accessdelay: + minimum: 0 + maximum: 100 + accessDelay: type: integer + minimum: 10 + maximum: 560 NRPciList: type: array @@ -453,6 +435,9 @@ components: type: integer rimRSCommonCarrierReferencePoint: type: integer + minimum: 0 + maximum: 3279165 + rimRSStartingFrequencyOffsetIdList: type: array items: @@ -478,9 +463,9 @@ components: enum: - ENABLE - DISABLE - RIMRSScrambleTimerMultiplier: + rIMRSScrambleTimerMultiplier: type: integer - RIMRSScrambleTimerOffset: + rIMRSScrambleTimerOffset: type: integer TimeDomainPara: @@ -694,6 +679,48 @@ components: minimum: 0 maximum: 16777215 + MappedCellIdInfo: + type: object + properties: + ntnGeoArea: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/GeoArea' + mappedCellId: + $ref: 'TS28541_5GcNrm.yaml#/components/schemas/Ncgi' + MappedCellIdInfoList: + type: array + items: + $ref: '#/components/schemas/MappedCellIdInfo' + QceIdMappingInfo: + type: object + properties: + qoECollectionEntityAddress: + oneOf: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr' + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv6Addr' + qoECollectionEntityIdentity: + type: string + pLMNTarget: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' + QceIdMappingInfoList: + type: array + items: + $ref: '#/components/schemas/QceIdMappingInfo' + MdtUserConsentReqList: + type: array + items: + type: string + enum: + - M1 + - M2 + - M3 + - M4 + - M5 + - M6 + - M7 + - M8 + - M9 + - MDT_UE_LOCATION + #-------- Definition of types for name-containments ------ SubNetwork-ncO-NrNrm: type: object @@ -773,21 +800,6 @@ components: #-------- Definition of concrete IOCs -------------------------------------------- - MnS: - oneOf: - - type: object - properties: - SubNetwork: - type: array - items: - $ref: '#/components/schemas/SubNetwork-ncO-NrNrm' - - type: object - properties: - ManagedElement: - type: array - items: - $ref: '#/components/schemas/ManagedElement-ncO-NrNrm' - GnbDuFunction-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' @@ -949,6 +961,12 @@ components: type: boolean dDAPSHOControl: type: boolean + mappedCellIdInfoList: + $ref: '#/components/schemas/MappedCellIdInfoList' + qceIdMappingInfoList: + $ref: '#/components/schemas/QceIdMappingInfoList' + mdtUserConsentReqList: + $ref: '#/components/schemas/MdtUserConsentReqList' - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - type: object properties: @@ -1514,10 +1532,10 @@ components: enum: - IS_NOT_ENERGY_SAVING - IS_ENERGY_SAVING - mLEntityRef: - $ref: "#'TS28623_ComDefs.yaml#/components/schemas/Dn'" - aIMLInferenceFunctionRef: - $ref: "#'TS28623_ComDefs.yaml#/components/schemas/Dn'" + mLModelRefList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + aIMLInferenceFunctionRefList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' DRACHOptimizationFunction-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' @@ -1551,10 +1569,10 @@ components: $ref: '#/components/schemas/MinimumTimeBetweenHoTriggerChange' tstoreUEcntxt: $ref: '#/components/schemas/TstoreUEcntxt' - mLEntityRef: - $ref: "#'TS28623_ComDefs.yaml#/components/schemas/Dn'" - aIMLInferenceFunctionRef: - $ref: "#'TS28623_ComDefs.yaml#/components/schemas/Dn'" + mLModelRefList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + aIMLInferenceFunctionRefList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' DLBOFunction-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' @@ -1569,10 +1587,10 @@ components: $ref: '#/components/schemas/MaximumDeviationHoTrigger' minimumTimeBetweenHoTriggerChange: $ref: '#/components/schemas/MinimumTimeBetweenHoTriggerChange' - mLEntityRef: - $ref: "#'TS28623_ComDefs.yaml#/components/schemas/Dn'" - aIMLInferenceFunctionRef: - $ref: "#'TS28623_ComDefs.yaml#/components/schemas/Dn'" + mLModelRefList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + aIMLInferenceFunctionRefList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' DPCIConfigurationFunction-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' @@ -2176,8 +2194,6 @@ components: resources-nrNrm: oneOf: - - $ref: '#/components/schemas/MnS' - - $ref: '#/components/schemas/GnbDuFunction-Single' - $ref: '#/components/schemas/GnbCuUpFunction-Single' - $ref: '#/components/schemas/GnbCuCpFunction-Single' diff --git a/OpenAPI/TS28541_SliceNrm.yaml b/OpenAPI/TS28541_SliceNrm.yaml index d64929f39929cf1c5324b42886e5c1f63e7b03f6..121dc8f67f4d2c3a97d27200e1c9a19d54ea757b 100755 --- a/OpenAPI/TS28541_SliceNrm.yaml +++ b/OpenAPI/TS28541_SliceNrm.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: Slice NRM - version: 18.7.0 + version: 18.8.0 description: >- OAS 3.0.1 specification of the Slice NRM @ 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -765,7 +765,7 @@ components: RequestedReservationExpiration: description: >- An attribute which specifies MnS consuner's requirements for the validity period of the resource reservation. - type: string + $ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeWindow' ResourceReservationStatus: description: >- An attribute which specifies the resource reservation result for the feasibility check job. @@ -777,7 +777,7 @@ components: ReservationExpiration: description: >- An attribute which specifies the actual validity period of the resource reservation.. - type: string + $ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeWindow' ReservationFailureReason: description: >- An attribute that specifies the additional reason information if the reservation is failed. @@ -826,19 +826,6 @@ components: #------------ Definition of concrete IOCs ---------------------------------------- - MnS: - oneOf: - - type: object - properties: - SubNetwork: - type: array - items: - $ref: '#/components/schemas/SubNetwork-ncO-SliceNrm' -# - type: object -# properties: -# ManagedElement: -# $ref: '#/components/schemas/ManagedElement-Multiple' - NetworkSlice-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' @@ -1082,9 +1069,7 @@ components: #------------ Definitions in TS 28.541 for TS 28.532 ----------------------------- resources-sliceNrm: - oneOf: - - $ref: '#/components/schemas/MnS' - + oneOf: - $ref: '#/components/schemas/NetworkSlice-Single' - $ref: '#/components/schemas/NetworkSliceSubnet-Single' - $ref: '#/components/schemas/EP_Transport-Single' diff --git a/OpenAPI/TS28623_ComDefs.yaml b/OpenAPI/TS28623_ComDefs.yaml index c4e866243a02a48d56bb306f3996edf09466db13..f5985b380d3b5e0fe042a76a134ec72c1e6251dc 100755 --- a/OpenAPI/TS28623_ComDefs.yaml +++ b/OpenAPI/TS28623_ComDefs.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: Common Type Definitions - version: 18.6.0 + version: 18.7.0 description: >- OAS 3.0.1 specification of common type definitions in the Generic NRM © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -125,7 +125,9 @@ components: type: integer AreaOfInterest: oneOf: - - $ref: '#/components/schemas/GeoAreaToCellMapping' + - type: array + items: + $ref: '#/components/schemas/GeoAreaToCellMapping' - type: array items: $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Tai' @@ -189,15 +191,17 @@ components: enum: - LOCKED - UNLOCKED + default: LOCKED OperationalState: type: string enum: - ENABLED - DISABLED + default: DISABLED UsageState: type: string enum: - - IDEL + - IDLE - ACTIVE - BUSY AvailabilityStatus: diff --git a/OpenAPI/TS28623_FileManagementNrm.yaml b/OpenAPI/TS28623_FileManagementNrm.yaml index 6cdfde23ee47e4873a2eb5f239fd6defb213a53b..a0b20fe331eb04fc84b438f734814a577bbc437c 100644 --- a/OpenAPI/TS28623_FileManagementNrm.yaml +++ b/OpenAPI/TS28623_FileManagementNrm.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: File Management NRM - version: 18.6.0 + version: 18.7.0 description: >- OAS 3.0.1 definition of the File Management NRM fragment © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -77,6 +77,7 @@ components: enum: - TRUE - FALSE + default: FALSE jobMonitor: $ref: '#/components/schemas/FileDownloadJobProcessMonitor' Files-Single: diff --git a/OpenAPI/TS28623_GenericNrm.yaml b/OpenAPI/TS28623_GenericNrm.yaml index 3d72b9232b2632b4135a9c6f0964a2c0c08d3297..695a96fa442dded3b0438515c7de8c8ad024ef97 100755 --- a/OpenAPI/TS28623_GenericNrm.yaml +++ b/OpenAPI/TS28623_GenericNrm.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: Generic NRM - version: 18.6.0 + version: 18.7.0 description: >- OAS 3.0.1 definition of the Generic NRM © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -331,7 +331,6 @@ components: maximum: 31 NpnId-Type: type: object - description: This describes the PLMN id, CAG ID list or the NID of the SNPN within the PLMN. properties: plmnId: $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' @@ -339,10 +338,17 @@ components: type: array items: type: string + minItems: 1 + maxItems: 256 nIDList: type: array items: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Nid' + minItems: 1 + maxItems: 16 + oneOf: + - required: [plmnId, cAGIdList] + - required: [plmnId, nIDList] #-------- Definition of abstract IOC Top ----------------------------------------- @@ -437,6 +443,10 @@ components: SubNetwork-ncO: type: object properties: + SubNetwork: + $ref: '#/components/schemas/SubNetwork-Multiple' + ManagedElement: + $ref: '#/components/schemas/ManagedElement-Multiple' ManagementNode: $ref: '#/components/schemas/ManagementNode-Multiple' MnsAgent: @@ -688,8 +698,6 @@ components: - $ref: '#/components/schemas/Top' - $ref: '#/components/schemas/SubNetwork-Attr' - $ref: '#/components/schemas/SubNetwork-ncO' - - $ref: '#/components/schemas/SubNetwork-Multiple' - - $ref: '#/components/schemas/ManagedElement-Multiple' - $ref: 'TS28104_MdaNrm.yaml#/components/schemas/SubNetwork-ncO-MdaNrm' - $ref: 'TS28105_AiMlNrm.yaml#/components/schemas/SubNetwork-ncO-AiMlNrm' - $ref: 'TS28312_IntentNrm.yaml#/components/schemas/SubNetwork-ncO-IntentNrm' @@ -699,6 +707,7 @@ components: - $ref: 'TS28541_SliceNrm.yaml#/components/schemas/SubNetwork-ncO-SliceNrm' - $ref: 'TS28541_NrNrm.yaml#/components/schemas/SubNetwork-ncO-NrNrm' - $ref: 'TS28541_5GcNrm.yaml#/components/schemas/SubNetwork-ncO-5GcNrm' + - $ref: 'TS28318_DsoNrm.yaml#/components/schemas/SubNetwork-ncO-DsoNrm' ManagedElement-Single: allOf: @@ -711,6 +720,17 @@ components: - $ref: 'TS28541_NrNrm.yaml#/components/schemas/ManagedElement-ncO-NrNrm' - $ref: 'TS28541_5GcNrm.yaml#/components/schemas/ManagedElement-ncO-5GcNrm' + NrmRoot: + oneOf: + - type: object + properties: + SubNetwork: + $ref: '#/components/schemas/SubNetwork-Multiple' + - type: object + properties: + ManagedElement: + $ref: '#/components/schemas/ManagedElement-Multiple' + #-------- Definition of YAML arrays for name-contained IOCs ---------------------- VsDataContainer-Multiple: @@ -755,7 +775,7 @@ components: resources-genericNrm: oneOf: - + - $ref: '#/components/schemas/NrmRoot' - $ref: '#/components/schemas/VsDataContainer-Single' - $ref: '#/components/schemas/ManagementNode-Single' - $ref: '#/components/schemas/MnsAgent-Single' diff --git a/OpenAPI/TS28623_QoEMeasurementCollectionNrm.yaml b/OpenAPI/TS28623_QoEMeasurementCollectionNrm.yaml index 27c4f7d1eab84bd70e3e6466d16a719c99ba232d..0ec934f5540d55813b22b2d71b2987662cf55e39 100644 --- a/OpenAPI/TS28623_QoEMeasurementCollectionNrm.yaml +++ b/OpenAPI/TS28623_QoEMeasurementCollectionNrm.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: QoE Measurement Collection NRM - version: 18.6.0 + version: 18.7.0 description: >- OAS 3.0.1 definition of the QoE Measurement Collection NRM © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). @@ -60,6 +60,11 @@ components: - PLAYOUTDELAYFORMEDIA_STARTUP minItems: 0 maxItems: 2 + mBSCommunicationServiceType: + type: string + enum: + - BROADCAST + - MULTICAST #-------- Definition of YAML arrays for name-contained IOCs ---------------------- diff --git a/OpenAPI/TS28623_SubscriptionControlNrm.yaml b/OpenAPI/TS28623_SubscriptionControlNrm.yaml index 750d318331e881f9a1a03aa03cca16ab5a93ebe4..5d493262645fbb6458f8ab4ea7730cecd0226216 100644 --- a/OpenAPI/TS28623_SubscriptionControlNrm.yaml +++ b/OpenAPI/TS28623_SubscriptionControlNrm.yaml @@ -1,10 +1,10 @@ openapi: 3.0.1 info: title: Subscription Control NRM - version: 18.2.0 + version: 18.7.0 description: >- OAS 3.0.1 definition of the Subscription Control NRM fragment - © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: description: 3GPP TS 28.623; Generic NRM, Subscription Control NRM @@ -58,8 +58,10 @@ components: heartbeatNtfPeriod: type: integer minimum: 0 + default: 0 triggerHeartbeatNtf: type: boolean + default: FALSE #-------- Definition of YAML arrays for name-contained IOCs ---------------------- NtfSubscriptionControl-Multiple: diff --git a/OpenAPI/TS28623_TraceControlNrm.yaml b/OpenAPI/TS28623_TraceControlNrm.yaml index fb231f448635097042cd2aa803e25bf0a6461de2..0d09284e0e6357c9c2f8d90966a5e65af059ba66 100644 --- a/OpenAPI/TS28623_TraceControlNrm.yaml +++ b/OpenAPI/TS28623_TraceControlNrm.yaml @@ -1,10 +1,10 @@ openapi: 3.0.1 info: title: Trace Control NRM - version: 18.6.0 + version: 18.7.0 description: >- OAS 3.0.1 definition of the Trace Control NRM fragment - © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: description: 3GPP TS 28.623; Generic NRM,Trace Control NRM @@ -29,7 +29,7 @@ components: - TRACE_AND_5GC_UE_LEVEL_MEASUREMENTS - IMMEDIATE_MDT_AND_5GC_UE_LEVEL_MEASUREMENTS - TRACE_AND_IMMEDIATE_MDT_AND_5GC_UE_LEVEL_MEASUREMENTS - + default: TRACE_ONLY listOfInterfaces-Type: description: The interfaces to be recorded in the Network Element. See 3GPP TS 32.422 clause 5.5 for additional details. type: object @@ -403,6 +403,13 @@ components: - mcc - mnc + listOfTraceMetrics: + description: The trace metrics to be reported. See 3GPP TS 32.422 clause 10 for additional details. + type: array + items: + type: string + + traceDepth-Type: description: Specifies how detailed information should be recorded in the Network Element. The Trace Depth is a paremeter for Trace Session level, i.e., the Trace Depth is the same for all of the NEs to be traced in the same Trace Session. See 3GPP TS 32.422 clause 5.3 for additional details. type: string @@ -413,6 +420,7 @@ components: - VENDORMINIMUM - VENDORMEDIUM - VENDORMAXIMUM + default: MAXIMUM traceReference-Type: type: object @@ -435,6 +443,7 @@ components: enum: - FILE-BASED - STREAMING + default: FILE-BASED traceTarget-Type: type: object @@ -624,6 +633,7 @@ components: enum: - NO_IDENTITY - TAC_OF_IMEI + default: NO_IDENTITY beamLevelMeasurement-Type: description: Determines whether beam level measurements shall be included in case of immediate MDT M1 measurement in NR. For additional details see 3GPP TS 32.422 clause 5.10.40. @@ -1368,13 +1378,13 @@ components: loggedMDTConfig: $ref: '#/components/schemas/loggedMDTConfig-Type' - UEMeasConfig-Type: + UECoreMeasConfig-Type: description: UE level measurements configuration parameters for 5G system. See details in 3GPP TS 28.622 clause 4.3.x. type: object properties: - ueMeasurements: + ueCoreMeasurements: type: string - ueMeasGranularityPeriod: + ueCoreMeasGranularityPeriod: type: integer nfTypeToMeasure: type: string @@ -1448,6 +1458,8 @@ components: $ref: '#/components/schemas/plmnTarget-Type' nPNTarget: $ref: 'TS28623_GenericNrm.yaml#/components/schemas/NpnId-Type' + listOfTraceMetrics: + type: array traceReportingConsumerUri: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' traceCollectionEntityIpAddress: @@ -1464,8 +1476,8 @@ components: $ref: '#/components/schemas/traceConfig-Type' mdtConfig: $ref: '#/components/schemas/mdtConfig-Type' - ueMeasConfig: - $ref: '#/components/schemas/UEMeasConfig-Type' + ueCoreMeasConfig: + $ref: '#/components/schemas/UECoreMeasConfig-Type' #-------- end of Definition of types used in Trace control NRM fragment ----------