diff --git a/OpenAPI/README.md b/OpenAPI/README.md index e6bb374b1e0a899cd981470f831ee110dc03b979..76505cbef21be41d0c72381e0cd4c3ab43a8206d 100644 --- a/OpenAPI/README.md +++ b/OpenAPI/README.md @@ -15,10 +15,38 @@ 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_ComDefs.yaml)) ([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28623_ComDefs.yaml)) +* Management Data Collection NRM (TS 28.623) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28623_ManagementDataCollectionNrm.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28623_ManagementDataCollectionNrm.yaml)) + +* MnS Registry NRM (TS 28.623) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28623_MnSRegistryNrm.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28623_MnSRegistryNrm.yaml)) + +* PM control NRM (TS 28.623) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28623_PmControlNrm.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28623_PmControlNrm.yaml)) + +* QoE Measurement Collection NRM (TS 28.623) +([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) +([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)) + +* 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)) + * Trace Control NRM (TS 28.623) ([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28623_TraceControlNrm.yaml)) ([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28623_TraceControlNrm.yaml)) +* Fault Management NRM(TS 28.111) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28111_FaultNrm.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28111_FaultNrm.yaml)) + * NR NRM (TS 28.541) ([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28541_NrNrm.yaml)) ([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28541_NrNrm.yaml)) @@ -35,18 +63,6 @@ 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/TS28536_CoslaNrm.yaml)) ([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28536_CoslaNrm.yaml)) -* Intent NRM (TS 28.312) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28312_IntentNrm.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28312_IntentNrm.yaml)) - -* Intent Scenario specific Intent Expectations (TS 28.312) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28312_IntentExpectations.yamll)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28312_IntentExpectations.yaml)) - -* Edge NRM (TS 28.538) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28538_EdgeNrm.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28538_EdgeNrm.yaml)) - * MDA NRM (TS 28.104) ([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28104_MdaNrm.yaml)) ([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28104_MdaNrm.yaml)) @@ -59,19 +75,40 @@ The links below will open the Swagger Editor/UI and auto-load the OpenAPI YAML f ([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28105_AiMlNrm.yaml)) ([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28105_AiMlNrm.yaml)) +* Intent NRM (TS 28.312) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28312_IntentNrm.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28312_IntentNrm.yaml)) + +* Intent Scenario specific Intent Expectations (TS 28.312) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28312_IntentExpectations.yamll)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28312_IntentExpectations.yaml)) + +* Edge NRM (TS 28.538) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28538_EdgeNrm.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28538_EdgeNrm.yaml)) + * RANSC NRM (TS 28.317) ([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28317_RanScNrm.yaml)) ([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28317_RanScNrm.yaml)) +* OutageAndRecoveryInfo NRM (TS 28.318) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28319_MsacNrm.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28319_MsacNrm.yaml)) + +* MSAC NRM (TS 28.319) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28318_DsoNrm.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28318_DsoNrm.yaml)) + + ## Management Services (MnS) * Provisioning MnS (TS 28.532) ([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_ProvMnS.yaml)) ([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28532_ProvMnS.yaml)) -* Fault Supervision MnS (TS 28.532) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_FaultMnS.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28532_FaultMnS.yaml)) +* Fault Management Notifications(TS 28.111) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28111_FaultNotifications.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28111_FaultNotifications.yaml)) * Performance Measurement Job Control MnS (28.550) ([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28550_PerfMeasJobCtrlMnS.yaml)) diff --git a/OpenAPI/TS28104_MdaNrm.yaml b/OpenAPI/TS28104_MdaNrm.yaml index 758a190c8cb220a24bb0409fab189743adbe4778..9759ac7d180ce2b5e75f8c08e340041cd3d170f3 100644 --- a/OpenAPI/TS28104_MdaNrm.yaml +++ b/OpenAPI/TS28104_MdaNrm.yaml @@ -1,10 +1,10 @@ openapi: 3.0.1 info: title: MDA NRM - version: 18.0.0 + version: 18.3.0 description: >- OAS 3.0.1 specification of the MDA NRM - © 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.104; MDA @@ -25,6 +25,18 @@ components: items: $ref: '#/components/schemas/MDAOutputPerMDAType' + AnalyticsScopeType: + oneOf: + - type: object + properties: + managedEntitiesScope: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + - type: object + properties: + areaScope: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/GeoArea' + + MDAOutputPerMDAType: type: object properties: @@ -58,18 +70,7 @@ components: ReportingTarget: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' - - AnalyticsScopeType: - oneOf: - - type: object - properties: - managedEntitiesScope: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - - type: object - properties: - areaScope: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/GeoArea' - + AnalyticsSchedule: oneOf: - type: object @@ -106,45 +107,25 @@ components: format: float minimum: 0 +#-------- Definition of types for name-containments ------ + SubNetwork-ncO-MdaNrm: + type: object + properties: + MDAFunction: + $ref: '#/components/schemas/MDAFunction-Multiple' + MDAReport: + $ref: '#/components/schemas/MDAReport-Multiple' + + ManagedElement-ncO-MdaNrm: + type: object + properties: + MDAFunction: + $ref: '#/components/schemas/MDAFunction-Multiple' #-------- Definition of abstract IOCs -------------------------------------------- #-------- Definition of concrete IOCs -------------------------------------------- - - SubNetwork-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-Attr' - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-ncO' - - type: object - properties: - SubNetwork: - $ref: '#/components/schemas/SubNetwork-Multiple' - ManagedElement: - $ref: '#/components/schemas/ManagedElement-Multiple' - MDAFunction: - $ref: '#/components/schemas/MDAFunction-Multiple' - MDAReport: - $ref: '#/components/schemas/MDAReport-Multiple' - - - ManagedElement-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedElement-Attr' - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedElement-ncO' - - type: object - properties: - MDAFunction: - $ref: '#/components/schemas/MDAFunction-Multiple' - MDAFunction-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' @@ -184,21 +165,14 @@ components: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' stopTime: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + recommendationFilter: + $ref: '#/components/schemas/AnalyticsScopeType' MDAReport-Single: $ref: 'TS28104_MdaReport.yaml#/components/schemas/MDAReport' #-------- Definition of JSON arrays for name-contained IOCs ---------------------- - - SubNetwork-Multiple: - type: array - items: - $ref: '#/components/schemas/SubNetwork-Single' - ManagedElement-Multiple: - type: array - items: - $ref: '#/components/schemas/ManagedElement-Single' MDAFunction-Multiple: type: array items: @@ -217,9 +191,6 @@ components: resources-mdaNrm: oneOf: - - $ref: '#/components/schemas/SubNetwork-Single' - - $ref: '#/components/schemas/ManagedElement-Single' - - $ref: '#/components/schemas/MDAFunction-Single' - $ref: '#/components/schemas/MDARequest-Single' - $ref: '#/components/schemas/MDAReport-Single' diff --git a/OpenAPI/TS28104_MdaReport.yaml b/OpenAPI/TS28104_MdaReport.yaml index a81b09f63ec044e86ab055cfe6697cee95d7d2b4..b57be4d1a8e53fd04bfad327601642a4218f4884 100644 --- a/OpenAPI/TS28104_MdaReport.yaml +++ b/OpenAPI/TS28104_MdaReport.yaml @@ -1,10 +1,10 @@ openapi: 3.0.1 info: title: MDA Report - version: 18.2.0 + version: 18.3.0 description: >- OAS 3.0.1 specification of the MDA Report - © 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.104; MDA Report @@ -24,8 +24,6 @@ components: type: array items: $ref: '#/components/schemas/MDAOutputEntry' - mDARequestRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' analyticsWindow: $ref: '#/components/schemas/TimeWindow' confidenceDegree: @@ -64,3 +62,5 @@ components: type: string mDAOutputs: $ref: '#/components/schemas/MDAOutputs' + mDARequestRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' diff --git a/OpenAPI/TS28105_AiMlNrm.yaml b/OpenAPI/TS28105_AiMlNrm.yaml index 71e2d38533fd99bf45dafb46573d57df970de8d9..b96ae1f9c96320f3d6ecbb9f014ff8b4ad341803 100644 --- a/OpenAPI/TS28105_AiMlNrm.yaml +++ b/OpenAPI/TS28105_AiMlNrm.yaml @@ -1,10 +1,10 @@ openapi: 3.0.1 info: title: AI/ML NRM - version: 18.2.0 + version: 18.3.0 description: >- OAS 3.0.1 specification of the AI/ML NRM - © 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.105; AI/ML Management @@ -27,15 +27,11 @@ components: type: string enum: - NOT_STARTED - - TRAINING_IN_PROGRESS + - IN_PROGRESS - SUSPENDED - FINISHED - CANCELLED - - PerformanceRequirements: - type: array - items: - $ref: '#/components/schemas/ModelPerformance' + - CANCELLING ModelPerformance: type: object @@ -45,79 +41,143 @@ components: performanceMetric: type: string performanceScore: - type: number - format: float + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Float' decisionConfidenceScore: - type: number - format: float + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Float' - TrainingProcessMonitor: + ProcessMonitor: description: >- - This data type is the "ProcessMonitor" data type defined in “genericNrm.yaml” with specialisations for usage in the "MLTrainingProcess". + This data type is the "ProcessMonitor" data type defined in “genericNrm.yaml” + with specialisations for usage in TS 28.105. type: object properties: - mLTrainingProcessId: - type: string status: type: string - enum: - - RUNNING - - CANCELLING - - CANCELLED - - SUSPENDED - - FINSHED progressPercentage: type: integer minimum: 0 maximum: 100 progressStateInfo: type: string - enum: - - COLLECTING_DATA - - PREPARING_TRAINING_DATA - - TRAINING resultStateInfo: type: string -#-------- Definition of abstract IOCs -------------------------------------------- - - + AIMLManagementPolicy: + description: >- + This data type represents the properties of a policy for AI/ML management. + type: object + properties: + thresholdList: + type: array + items: + $ref: 'TS28623_ThresholdMonitorNrm.yaml#/components/schemas/ThresholdInfo' -#-------- Definition of concrete IOCs -------------------------------------------- + SupportedPerfIndicator: + type: object + properties: + performanceIndicatorName: + type: string + isSupportedForTraining: + type: boolean + isSupportedForTesting: + type: boolean - SubNetwork-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-Attr' - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-ncO' + ManagedActivationScope: + oneOf: - type: object properties: - SubNetwork: - $ref: '#/components/schemas/SubNetwork-Multiple' - ManagedElement: - $ref: '#/components/schemas/ManagedElement-Multiple' - MLTrainingFunction: - $ref: '#/components/schemas/MLTrainingFunction-Multiple' - MLEntityRepository: - $ref: '#/components/schemas/MLEntityRepository-Multiple' - - ManagedElement-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + dNList: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - type: object properties: - attributes: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedElement-Attr' - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedElement-ncO' + timeWindow: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeWindow' - type: object properties: - MLTrainingFunction: - $ref: '#/components/schemas/MLTrainingFunction-Multiple' - MLEntityRepository: - $ref: '#/components/schemas/MLEntityRepository-Multiple' + geoPolygon: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/GeoArea' + + MLCapabilityInfo: + type: object + properties: + inferenceType: + type: string + capabilityName: + type: string + mLCapabilityParameters: + description: A map (list of key-value pairs) for an inferenceType and capabilityName + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' + + AvailMLCapabilityReport: + type: object + properties: + mLCapabilityVersionId: + type: array + items: + type: string + expectedPerformanceGains: + type: array + items: + $ref: '#/components/schemas/ModelPerformance' + mLEntityRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + + InferenceOutput: + type: object + properties: + inferenceOutputId: + type: array + items: + type: string + inferenceType: + type: string + inferenceOutputTime: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + # FIXME, isOrder/isUnique both as True + inferencePerformance: + $ref: '#/components/schemas/ModelPerformance' + outputResult: + description: A map (list of key-value pairs) for Inference result name and it's value + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' + +#-------- Definition of types for name-containments ------ + SubNetwork-ncO-AiMlNrm: + type: object + properties: + MLTrainingFunction: + $ref: '#/components/schemas/MLTrainingFunction-Multiple' + MLTestingFunction: + $ref: '#/components/schemas/MLTestingFunction-Multiple' + MLEntityRepository: + $ref: '#/components/schemas/MLEntityRepository-Multiple' + MLUpdateFunction: + $ref: '#/components/schemas/MLUpdateFunction-Multiple' + AIMLInferenceFunction: + $ref: '#/components/schemas/AIMLInferenceFunction-Multiple' + + ManagedElement-ncO-AiMlNrm: + type: object + properties: + MLTrainingFunction: + $ref: '#/components/schemas/MLTrainingFunction-Multiple' + MLTestingFunction: + $ref: '#/components/schemas/MLTestingFunction-Multiple' + MLEntityRepository: + $ref: '#/components/schemas/MLEntityRepository-Multiple' + MLUpdateFunction: + $ref: '#/components/schemas/MLUpdateFunction-Multiple' + AIMLInferenceFunction: + $ref: '#/components/schemas/AIMLInferenceFunction-Multiple' + +#-------- Definition of concrete IOCs -------------------------------------------- MLTrainingFunction-Single: allOf: @@ -130,7 +190,7 @@ components: - type: object properties: mLEntityRepositoryRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - type: object properties: @@ -140,6 +200,8 @@ components: $ref: '#/components/schemas/MLTrainingProcess-Multiple' MLTrainingReport: $ref: '#/components/schemas/MLTrainingReport-Multiple' + ThresholdMonitors: + $ref: 'TS28623_ThresholdMonitorNrm.yaml#/components/schemas/ThresholdMonitor-Multiple' MLTrainingRequest-Single: allOf: @@ -150,8 +212,6 @@ components: allOf: - type: object properties: - mLEntityId: - type: string inferenceType: type: string candidateTrainingDataSource: @@ -159,8 +219,7 @@ components: items: type: string trainingDataQualityScore: - type: number - format: float + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Float' trainingRequestSource: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' requestStatus: @@ -168,13 +227,17 @@ components: expectedRuntimeContext: $ref: '#/components/schemas/MLContext' performanceRequirements: - $ref: '#/components/schemas/PerformanceRequirements' + type: array + items: + $ref: '#/components/schemas/ModelPerformance' cancelRequest: type: boolean suspendRequest: - type: boolean + type: boolean mLEntityToTrainRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + mLEntityCoordinationGroupToTrainRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' MLTrainingProcess-Single: allOf: @@ -185,14 +248,17 @@ components: allOf: - type: object properties: - mLTrainingProcessId: - type: string priority: type: integer terminationConditions: type: string + enum: + - UPDATED_IN_INFERENCE_FUNCTION + - INFERENCE FUNCTION_TERMINATED + - INFERENCE FUNCTION_UPGRADED + - INFERENCE_CONTEXT_CHANGED progressStatus: - $ref: '#/components/schemas/TrainingProcessMonitor' + $ref: '#/components/schemas/ProcessMonitor' cancelProcess: type: boolean suspendProcess: @@ -201,9 +267,8 @@ components: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' trainingReportRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - mLEnityGeneratedRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - + mLEntityRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' MLTrainingReport-Single: allOf: @@ -214,32 +279,158 @@ components: allOf: - type: object properties: - mLEntityId: - type: string areConsumerTrainingDataUsed: - type: boolean + type: string + enum: + - ALL + - PARTIALLY + - NONE usedConsumerTrainingData: type: array items: type: string - modelConfidenceIndication: + modelconfidenceIndication: type: integer modelPerformanceTraining: type: array items: $ref: '#/components/schemas/ModelPerformance' + modelPerformanceValidation: + type: array + items: + $ref: '#/components/schemas/ModelPerformance' + dataRatioTrainingAndValidation: + type: integer areNewTrainingDataUsed: type: boolean trainingRequestRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' trainingProcessRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - trainingReportRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' lastTrainingRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' mLEnityGeneratedRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + mLEntityCoordinationGroupGeneratedRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + mLEntityRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + + MLTestingFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + mLEntityRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + MLTestingRequest: + $ref: '#/components/schemas/MLTestingRequest-Multiple' + MLTestingReport: + $ref: '#/components/schemas/MLTestingReport-Multiple' + + MLTestingRequest-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + requestStatus: + $ref: '#/components/schemas/RequestStatus' + cancelRequest: + type: boolean + suspendRequest: + type: boolean + mLEntityToTestRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + mLEntityCoordinationGroupToTestRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + + MLTestingReport-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + modelPerformanceTesting: + type: array + items: + $ref: '#/components/schemas/ModelPerformance' + mLTestingResult: + type: string + testingRequestRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + + MLEntityLoadingRequest-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + requestStatus: + $ref: '#/components/schemas/RequestStatus' + cancelRequest: + type: boolean + suspendRequest: + type: boolean + mLEntityToLoadRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + + MLEntityLoadingPolicy-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + inferenceType: + type: string + policyForLoading: + $ref: '#/components/schemas/AIMLManagementPolicy' + mLEntityRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + + MLEntityLoadingProcess-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + progressStatus: + $ref: '#/components/schemas/ProcessMonitor' + cancelProcess: + type: boolean + suspendProcess: + type: boolean + resumeProcess: + type: boolean + MLEntityLoadingRequestRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + MLEntityLoadingPolicyRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + LoadedMLEntityRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' MLEntity-Single: allOf: @@ -260,7 +451,17 @@ components: trainingContext: $ref: '#/components/schemas/MLContext' runTimeContext: - $ref: '#/components/schemas/MLContext' + $ref: '#/components/schemas/MLContext' + supportedPerformanceIndicators: + $ref: '#/components/schemas/SupportedPerfIndicator' + mLCapabilitiesInfoList: + type: array + items: + $ref: '#/components/schemas/MLCapabilityInfo' + retrainingEventsMonitorRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + sourceTrainedMLEntityRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' MLEntityRepository-Single: allOf: @@ -270,21 +471,174 @@ components: attributes: type: object properties: - mLRepositoryId: - type: string + mLEntityRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + - type: object + properties: MLEntity: $ref: '#/components/schemas/MLEntity-Multiple' + MLEntityCoordinationGroup: + $ref: '#/components/schemas/MLEntityCoordinationGroup-Multiple' + + MLEntityCoordinationGroup-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + memberMLEntityRefList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + + ## 7.3a.4.1 IOC + MLUpdateFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + availMLCapabilityReport: + $ref: '#/components/schemas/AvailMLCapabilityReport' + mLEntityRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + MLUpdateRequest: + $ref: '#/components/schemas/MLUpdateRequest-Multiple' + MLUpdateProcess: + $ref: '#/components/schemas/MLUpdateProcess-Multiple' + MLUpdateReport: + $ref: '#/components/schemas/MLUpdateReport-Multiple' + + MLUpdateRequest-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + performanceGainThreshold: + type: array + items: + $ref: '#/components/schemas/ModelPerformance' + newCapabilityVersionId: + type: array + items: + type: string + updateTimeDeadline: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeWindow' + requestStatus: + $ref: '#/components/schemas/RequestStatus' + mLUpdateReportingPeriod: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeWindow' + cancelRequest: + type: boolean + suspendRequest: + type: boolean + mLUpdateProcessRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + mLEntityRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + + MLUpdateProcess-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + progressStatus: + $ref: '#/components/schemas/ProcessMonitor' + mLEntityRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + mLUpdateRequestRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + mLUpdateReportRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + + MLUpdateReport-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + updatedMLCapability: + $ref: '#/components/schemas/AvailMLCapabilityReport' + mLEntityRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + mLUpdateProcessRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + + AIMLInferenceFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + activationStatus: + type: string + enum: + - ACTIVATED + - DEACTIVATED + managedActivationScope: + $ref: '#/components/schemas/ManagedActivationScope' + usedByFunctionRefList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + mLEntityRef: # FIXME S5-240805,S5-240917 both define here + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + AIMLInferenceReport: + $ref: '#/components/schemas/AIMLInferenceReport-Multiple' + + AIMLInferenceReport-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + inferenceOutputs: #stage 2: attribute table name as: aimlInferenceOutputs FIXME + type: array + items: + $ref: '#/components/schemas/InferenceOutput' + minItems: 1 + mLEntityRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + + AIMLInferenceEmulationFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $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' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' #-------- Definition of JSON arrays for name-contained IOCs ---------------------- - SubNetwork-Multiple: - type: array - items: - $ref: '#/components/schemas/SubNetwork-Single' - ManagedElement-Multiple: - type: array - items: - $ref: '#/components/schemas/ManagedElement-Single' MLTrainingFunction-Multiple: type: array items: @@ -309,17 +663,84 @@ components: type: array items: $ref: '#/components/schemas/MLEntityRepository-Single' - + MLEntityCoordinationGroup-Multiple: + type: array + items: + $ref: '#/components/schemas/MLEntityCoordinationGroup-Single' + MLTestingFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/MLTestingFunction-Single' + MLTestingRequest-Multiple: + type: array + items: + $ref: '#/components/schemas/MLTestingRequest-Single' + MLTestingReport-Multiple: + type: array + items: + $ref: '#/components/schemas/MLTestingRequest-Single' + MLEntityLoadingRequest-Multiple: + type: array + items: + $ref: '#/components/schemas/MLEntityLoadingRequest-Single' + MLEntityLoadingProcess-Multiple: + type: array + items: + $ref: '#/components/schemas/MLEntityLoadingProcess-Single' + MLEntityLoadingPolicy-Multiple: + type: array + items: + $ref: '#/components/schemas/MLEntityLoadingPolicy-Single' + MLUpdateFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/MLUpdateFunction-Single' + MLUpdateRequest-Multiple: + type: array + items: + $ref: '#/components/schemas/MLUpdateRequest-Single' + MLUpdateProcess-Multiple: + type: array + items: + $ref: '#/components/schemas/MLUpdateProcess-Single' + MLUpdateReport-Multiple: + type: array + items: + $ref: '#/components/schemas/MLUpdateReport-Single' + AIMLInferenceFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/AIMLInferenceFunction-Single' + AIMLInferenceReport-Multiple: + type: array + items: + $ref: '#/components/schemas/AIMLInferenceReport-Single' + AIMLInferenceEmulationFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/AIMLInferenceEmulationFunction-Single' #-------- Definitions in TS 28.104 for TS 28.532 --------------------------------- resources-AiMlNrm: oneOf: - - $ref: '#/components/schemas/SubNetwork-Single' - - $ref: '#/components/schemas/ManagedElement-Single' - - $ref: '#/components/schemas/MLTrainingFunction-Single' - $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/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/MLUpdateFunction-Single' + - $ref: '#/components/schemas/MLUpdateRequest-Single' + - $ref: '#/components/schemas/MLUpdateProcess-Single' + - $ref: '#/components/schemas/MLUpdateReport-Single' + - $ref: '#/components/schemas/AIMLInferenceFunction-Single' + - $ref: '#/components/schemas/AIMLInferenceReport-Single' + - $ref: '#/components/schemas/AIMLInferenceEmulationFunction-Single' diff --git a/OpenAPI/TS28111_FaultNotifications.yaml b/OpenAPI/TS28111_FaultNotifications.yaml new file mode 100644 index 0000000000000000000000000000000000000000..ffac86e1fa6cdeef23e0a5ec9a5f877eb046263c --- /dev/null +++ b/OpenAPI/TS28111_FaultNotifications.yaml @@ -0,0 +1,57 @@ +openapi: 3.0.1 +info: + title: Fault Management Notifications + version: 18.1.0 + description: >- + OAS 3.0.1 definition of the Fault Supervision MnS + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.111; Fault Management + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.111/ +servers: + - url: '{notificationRecipientAddress}' + variables: + notificationRecipientAddress: + description: Address on the MnS consumer side defined by NtfSubscriptionControl.notificationRecipientAddress. See 3GPP TS 28.622 clause 4.3.22 + default: http://exampleConsumer.com/notificationReceiver + MnSversion: + description: Version number of the OpenAPI definition + default: XXX +paths: + /: + post: + summary: Receive one of a set of alarm related notifications + description: >- + The MnS producer sends an alarm to the consumer. + This interface shall be implemented by the notification-receiver and + used by the notification-sender. + requestBody: + required: true + content: + application/json: + schema: + oneOf: + - $ref: 'TS28111_FaultNrm.yaml#/components/schemas/NotifyNewAlarm' + - $ref: 'TS28111_FaultNrm.yaml#/components/schemas/NotifyNewSecAlarm' + - $ref: 'TS28111_FaultNrm.yaml#/components/schemas/NotifyClearedAlarm' + - $ref: 'TS28111_FaultNrm.yaml#/components/schemas/NotifyChangedAlarm' + - $ref: 'TS28111_FaultNrm.yaml#/components/schemas/NotifyChangedAlarmGeneral' + - $ref: 'TS28111_FaultNrm.yaml#/components/schemas/NotifyChangedSecAlarmGeneral' + - $ref: 'TS28111_FaultNrm.yaml#/components/schemas/NotifyCorrelatedNotificationChanged' + - $ref: 'TS28111_FaultNrm.yaml#/components/schemas/NotifyAckStateChanged' + - $ref: 'TS28111_FaultNrm.yaml#/components/schemas/NotifyComments' + - $ref: 'TS28111_FaultNrm.yaml#/components/schemas/NotifyPotentialFaultyAlarmList' + - $ref: 'TS28111_FaultNrm.yaml#/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' diff --git a/OpenAPI/TS28111_FaultNrm.yaml b/OpenAPI/TS28111_FaultNrm.yaml new file mode 100644 index 0000000000000000000000000000000000000000..f4ed7ce77481edc1972a4608889f77a6e4307def --- /dev/null +++ b/OpenAPI/TS28111_FaultNrm.yaml @@ -0,0 +1,551 @@ +openapi: 3.0.1 +info: + title: Fault Management NRM + version: 18.1.0 + description: >- + OAS 3.0.1 definition of the Fault Supervision MnS + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.111; Fault Management + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.111/ +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: {} + +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 + + AlarmList-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + administrativeState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' + operationalState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/OperationalState' + numOfAlarmRecords: + type: integer + lastModification: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + alarmRecords: + description: >- + This resource represents a map of alarm records. + The alarmIds are used as keys in the map. + type: object + additionalProperties: + $ref: '#/components/schemas/AlarmRecord' + + + #---- 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 + 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 + - 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 resources ------------------------------------------------------# + + 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' diff --git a/OpenAPI/TS28312_IntentExpectations.yaml b/OpenAPI/TS28312_IntentExpectations.yaml index b0c35072ee9e541532e79dcec5647a30ce19df84..b48f7afaf39b787dbd54b2709da94e896b47a0fa 100644 --- a/OpenAPI/TS28312_IntentExpectations.yaml +++ b/OpenAPI/TS28312_IntentExpectations.yaml @@ -1,10 +1,10 @@ openapi: 3.0.1 info: title: Scenario specific Intent Expectations - version: 18.2.0 + version: 18.3.0 description: >- OAS 3.0.1 definition of scenario specific Intent Expectations - © 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.312; Intent driven management services for mobile networks @@ -89,7 +89,7 @@ components: expectationVerb: $ref: 'TS28312_IntentNrm.yaml#/components/schemas/ExpectationVerb' expectationObject: - $ref: '#/components/schemas/ServiceSupportExpectationObject' + $ref: '#/components/schemas/EdgeServiceSupportExpectationObject' expectationTargets: type: array items: @@ -146,8 +146,6 @@ components: - $ref: '#/components/schemas/StartTimeContext' - $ref: '#/components/schemas/ResourceSharingLevelContext' - $ref: "TS28312_IntentNrm.yaml#/components/schemas/Context" - expectationfulfilmentInfo: - $ref: "TS28312_IntentNrm.yaml#/components/schemas/FulfilmentInfo" required: - expectationId #-------Definition of the IntentExpectation dataType ----------# @@ -196,7 +194,7 @@ components: - $ref: '#/components/schemas/CoverageAreaPolygonContext' - $ref: '#/components/schemas/ServiceTypeContext' - $ref: 'TS28312_IntentNrm.yaml#/components/schemas/Context' - ServiceSupportExpectationObject: + EdgeServiceSupportExpectationObject: description: >- This data type is the "ExpectationObject" data type with specialisations for EdgeServiceSupportExpectation type: object @@ -212,7 +210,7 @@ components: items: type: object oneOf: - - $ref: '#/components/schemas/EdgeIdenfiticationIdContext' + - $ref: '#/components/schemas/EdgeIdentificationIdContext' - $ref: '#/components/schemas/EdgeIdentificationLocContext' - $ref: '#/components/schemas/CoverageAreaTAContext' - $ref: 'TS28312_IntentNrm.yaml#/components/schemas/Context' @@ -801,7 +799,7 @@ components: $ref: 'TS28312_IntentNrm.yaml#/components/schemas/Frequency' UlFrequencyContext: description: >- - This data type is the "Context" data type with specialisations for Object context "DLFrequencyContext". + 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 @@ -856,7 +854,7 @@ components: type: array items: $ref: "TS28312_IntentNrm.yaml#/components/schemas/UEGroup" - EdgeIdenfiticationIdContext: + EdgeIdentificationIdContext: description: >- This data type is the "ObjectContext" data type with specialisations for EdgeIdentificationIdContext type: object diff --git a/OpenAPI/TS28312_IntentNrm.yaml b/OpenAPI/TS28312_IntentNrm.yaml index 915541a592544d4b9ea15c4353c10e9dabb7b6f3..130494e0230e7c9588ba2cf28d8f1a4d245e379e 100644 --- a/OpenAPI/TS28312_IntentNrm.yaml +++ b/OpenAPI/TS28312_IntentNrm.yaml @@ -1,10 +1,10 @@ openapi: 3.0.1 info: title: Intent NRM - version: 18.2.0 + version: 18.3.0 description: >- OAS 3.0.1 definition of the Intent NRM - © 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.312; Intent driven management services for mobile networks @@ -12,24 +12,16 @@ externalDocs: paths: {} components: schemas: + + #-------- Definition of types for name-containments ------ + SubNetwork-ncO-IntentNrm: + type: object + properties: + IntentHandlingFunction: + $ref: '#/components/schemas/IntentHandlingFunction-Multiple' #-------Definition of generic IOCs ----------# - SubNetwork-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-Attr' - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-ncO' - - type: object - properties: - SubNetwork: - $ref: '#/components/schemas/SubNetwork-Multiple' - IntentHandlingFunction: - $ref: '#/components/schemas/IntentHandlingFunction-Multiple' - Intent-Single: description: >- This IOC represents the properties of an Intent driven management information between MnS consumer and MnS producer. @@ -343,7 +335,7 @@ components: #-------Definition of the generic ExpectationFulfilmentResult dataType----------------# ExpectationFulfilmentResult: description: >- - It includes the expectationFulfilmentInfo and targetFulfilmetResults for each IntentExpectation. + It includes the expectationFulfilmentInfo and targetFulfilmentResults for each IntentExpectation. type: object properties: expectaitonId: @@ -397,6 +389,12 @@ components: description: >- This will be present if the value of conflictType is TARGET_CONFLICT. It describes the targetName of the conflicting ExpectationTarget with an IntentExpectation type: string + recommendedSolutions: + type: string + enum: + - MODIFY + - DELETE + #-------Definition of the concrete IntentConflictReport dataType----------------# #-------Definition of the generic IntentFeasibilityCheckReport dataType----------------# @@ -441,11 +439,6 @@ components: #------Definition of JSON arrays for name-contained IOCs ---------------# - SubNetwork-Multiple: - type: array - items: - $ref: '#/components/schemas/SubNetwork-Single' - Intent-Multiple: type: array items: @@ -467,7 +460,6 @@ components: #----- Definitions in TS 28.312 for TS 28.532 --------------------------# resources-intentNrm: oneOf: - - $ref: '#/components/schemas/SubNetwork-Single' - $ref: '#/components/schemas/IntentHandlingFunction-Single' - $ref: '#/components/schemas/Intent-Single' - $ref: '#/components/schemas/IntentReport-Single' diff --git a/OpenAPI/TS28317_RanScNrm.yaml b/OpenAPI/TS28317_RanScNrm.yaml index ed6566f2312f1c62cdc68a8ae02cf36f0d8f4cee..3b1973463bac5549049ca00a706b4fd418066973 100644 --- a/OpenAPI/TS28317_RanScNrm.yaml +++ b/OpenAPI/TS28317_RanScNrm.yaml @@ -1,10 +1,10 @@ openapi: 3.0.1 info: title: RANSC NRM - version: 18.0.0 + version: 18.1.0 description: >- OAS 3.0.1 definition of the RANSC NRM - © 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.317; Self-configuration of Radio Access Network Entities (RAN NEs) @@ -13,24 +13,17 @@ paths: {} components: schemas: +#-------- Definition of types for name-containments ------ + SubNetwork-ncO-RanScNrm: + type: object + properties: + ScMgmtProfile: + $ref: '#/components/schemas/ScMgmtProfile-Multiple' + Sc_Process: + $ref: '#/components/schemas/Sc_Process-Multiple' + #-------Definition of IOCs ----------# - SubNetwork-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-Attr' - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-ncO' - - type: object - properties: - SubNetwork: - $ref: '#/components/schemas/SubNetwork-Multiple' - ScMgmtProfile: - $ref: '#/components/schemas/ScMgmtProfile-Multiple' - Sc_Process: - $ref: '#/components/schemas/Sc_Process-Multiple' - + ScMgmtProfile-Single: description: >- The ScMgmtProfile represents MnS Consumer's requirements for self-configuration management @@ -77,7 +70,7 @@ components: #-------Definition of Data types ----------# NEType: - type: integer + type: string description: It defines the type of RAN NE GnbId: type: integer @@ -93,13 +86,14 @@ components: oneOf: - $ref: '#/components/schemas/EnbId' - $ref: '#/components/schemas/GnbId' + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' NEInfomration: description: >- It defines the NE Type or the NE instance for which this ScMgmtProfile instance is valid. - oneOf: + anyOf: - $ref: '#/components/schemas/NEType' - - $ref: '#/components/schemas/NEIdentification' + - $ref: '#/components/schemas/NEIdentification' ScProcessMonitor: description: >- This data type is the "ProcessMonitor" data type with specialisations @@ -131,7 +125,7 @@ components: - PREPARE_BASIC_CONFIGURATION_AND_OAMLINK - RETRIEVE_CONFIGURATION_DATA - SETUP_PRECONFIGURED_SIGNALLING_LINKS - - TSET_FINAL_STATE_OF_NE + - SET_FINAL_STATE_OF_NE resultStateInfo: oneOf: - type: string @@ -150,10 +144,6 @@ components: #-------Definition of Data types ----------# #------Definition of JSON arrays for name-contained IOCs ---------------# - SubNetwork-Multiple: - type: array - items: - $ref: '#/components/schemas/SubNetwork-Single' ScMgmtProfile-Multiple: type: array items: @@ -168,7 +158,6 @@ components: #----- Definitions in TS 28.317 for TS 28.532 --------------------------# resources-RanScNrm: oneOf: - - $ref: '#/components/schemas/SubNetwork-Single' - $ref: '#/components/schemas/ScMgmtProfile-Single' - $ref: '#/components/schemas/Sc_Process-Single' diff --git a/OpenAPI/TS28318_DsoNrm.yaml b/OpenAPI/TS28318_DsoNrm.yaml new file mode 100644 index 0000000000000000000000000000000000000000..25c311611f3646367a5b1c174b6dd758a89f039c --- /dev/null +++ b/OpenAPI/TS28318_DsoNrm.yaml @@ -0,0 +1,110 @@ +openapi: 3.0.1 +info: + title: 3GPP NRM + version: 18.5.0 + description: >- + OAS 3.0.1 specification of the OutageAndRecoveryInfo NRM + © 2024, 3GPP Organizational OutageAndRecoveryInfo Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.318; OutageAndRecoveryInfo NRM + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.318/ +paths: {} +components: + schemas: + +#-------- Definition of types----------------------------------------------------- + EnergyServiceLocation: + type: object + properties: + CGI: + type: string + energySupplyId: + type: string + + + +#-------- 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' + + OutageAndRecoveryInfo-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + outageStartTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + expectedOutageEndTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + dsoRapidInterventionTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + dsoRapidInterventionDuration: + type: integer + mnoInterventionTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + mnoInterventionDuration: + type: integer + mnoMaxServiceDuration: + type: integer + affectedArea: + $ref: '#/components/schemas/EnergyServiceLocation' + isAffectedAreaPriority: + type: boolean + actualOutageEndTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + DsoThresholdMonitor-Single: + allOf: + - $ref: 'TS28623_ThresholdMonitorNrm.yaml#/components/schemas/ThresholdMonitor-Single' + - type: object + properties: + targetThresholdLocation: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AreaOfInterest' + + + +#-------- Definition of JSON arrays for name-contained IOCs ---------------------- + + SubNetwork-Multiple: + type: array + items: + $ref: '#/components/schemas/SubNetwork-Single' + OutageAndRecoveryInfo-Multiple: + type: array + items: + $ref: '#/components/schemas/OutageAndRecoveryInfo-Single' + DsoThresholdMonitor-Multiple: + type: array + items: + $ref: '#/components/schemas/DsoThresholdMonitor-Single' + +#--------------------------------- Definition ------------------------------------ + + 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/TS28319_MsacNrm.yaml b/OpenAPI/TS28319_MsacNrm.yaml new file mode 100644 index 0000000000000000000000000000000000000000..ac65e3ebf0c6a657d2a0965dd6e451da814eb7fa --- /dev/null +++ b/OpenAPI/TS28319_MsacNrm.yaml @@ -0,0 +1,87 @@ + +openapi: 3.0.1 +info: + title: MSAC NRM + version: 18.0.0 + description: >- + OAS 3.0.1 definition of the MSAC NRM + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.319; MSAC NRM + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.319/ +paths: {} +components: + schemas: + +#-------- Definition of types----------------------------------------------------- + +#-------- Definition of concrete IOCs -------------------------------------------- + + Identity-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + identityType: + type: string + enum: + - USERNAME + - EMAIL_ADDRESS + - PHONE_NUMBER + - IP_ADDRESS + - MACHINEUSER + identityName: + type: string + credential: + type: string + roleRefList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + + Role-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + roleName: + type: string + accessRulesList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + + AccessRule-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + ruleName: + type: string + resources: + type: string + operations: + type: array + items: + type: string + actions: + type: string + enum: + - ALLOW + - DENY + componentCData: + type: array + items: + type: string + + resources-msacNrm: + oneOf: + - $ref: '#/components/schemas/Identity-Single' + - $ref: '#/components/schemas/Role-Single' + - $ref: '#/components/schemas/AccessRule-Single' diff --git a/OpenAPI/TS28532_FileDataReportingMnS.yaml b/OpenAPI/TS28532_FileDataReportingMnS.yaml index 176070caf42597adb7d513c77aac1f9aadcff622..4138a3c1147353019589b66e035b69954c6199ae 100644 --- a/OpenAPI/TS28532_FileDataReportingMnS.yaml +++ b/OpenAPI/TS28532_FileDataReportingMnS.yaml @@ -1,10 +1,10 @@ openapi: 3.0.1 info: title: File Data Reporting MnS - version: 18.1.0 + version: 18.2.0 description: >- OAS 3.0.1 definition of the File Data Reporting MnS - © 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.532; Generic management services @@ -80,7 +80,7 @@ paths: content: application/json: schema: - $ref: 'TS28532_FaultMnS.yaml#/components/schemas/Subscription' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Subscription' responses: '201': description: >- @@ -90,7 +90,7 @@ paths: content: application/json: schema: - $ref: 'TS28532_FaultMnS.yaml#/components/schemas/Subscription' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Subscription' headers: Location: description: URI of the newly created subscription resource diff --git a/OpenAPI/TS28532_ProvMnS.yaml b/OpenAPI/TS28532_ProvMnS.yaml index a807620364eff05b7f1ccb1effb25facd594ef5d..27e027547821c825e092d6ca23685632bcce13e7 100755 --- a/OpenAPI/TS28532_ProvMnS.yaml +++ b/OpenAPI/TS28532_ProvMnS.yaml @@ -1,10 +1,10 @@ openapi: 3.0.1 info: title: Provisioning MnS - version: 18.1.0 + version: 18.2.0 description: >- OAS 3.0.1 definition of the Provisioning MnS - © 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.532; Generic management services @@ -82,7 +82,7 @@ paths: content: application/json: schema: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponseDefault' callbacks: notifyMOICreation: '{request.body#/notificationRecipientAddress}': @@ -147,6 +147,27 @@ paths: application/json: schema: $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' + notifyEvent: + '{request.body#/notificationRecipientAddress}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotifyEvent' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response + has no message body. + default: + description: Error case. + content: + application/json: + schema: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' notifyMOIChanges: '{request.body#/notificationRecipientAddress}': post: @@ -195,8 +216,7 @@ paths: This parameter reduces the targeted set of resources by applying a filter to the scoped set of resource representations. Only resource representations for which the filter construct evaluates to "true" - are targeted. No filter language is specified in the present - document. + are targeted. required: false schema: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Filter' @@ -224,6 +244,14 @@ paths: type: string style: form explode: false + - name: dataNodeSelector + in: query + description: >- + This parameter contains an expression allowing to conditionally + select data nodes. + required: false + schema: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Filter' responses: '200': description: >- @@ -250,7 +278,7 @@ paths: content: application/json: schema: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponseGet' patch: summary: Patches one or multiple resources description: >- @@ -307,7 +335,9 @@ paths: content: application/json: schema: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' + oneOf: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponseDefault' + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponsePatch' delete: summary: Deletes one resource description: >- @@ -324,7 +354,7 @@ paths: content: application/json: schema: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponseDefault' components: schemas: CmNotificationTypes: @@ -333,6 +363,7 @@ components: - notifyMOICreation - notifyMOIDeletion - notifyMOIAttributeValueChanges + - notifyEvent - notifyMOIChanges SourceIndicator: type: string @@ -397,7 +428,16 @@ components: - $ref: 'TS28104_MdaNrm.yaml#/components/schemas/resources-mdaNrm' - $ref: 'TS28105_AiMlNrm.yaml#/components/schemas/resources-AiMlNrm' - $ref: 'TS28538_EdgeNrm.yaml#/components/schemas/resources-edgeNrm' - - $ref: 'TS28317_RanScNrm.yaml#/components/schemas/resources-RanScNrm' + - $ref: 'TS28317_RanScNrm.yaml#/components/schemas/resources-RanScNrm' + - $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_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' Scope: type: object properties: @@ -489,6 +529,19 @@ components: $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeValueChangeSet' required: - attributeListValueChanges + NotifyEvent: + allOf: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' + - type: object + required: + - specificProblem + properties: + specificProblem: + $ref: 'TS28532_FaultMnS.yaml#/components/schemas/SpecificProblem' + additionalText: + type: string + additionalInformation: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' NotifyMoiChanges: allOf: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' diff --git a/OpenAPI/TS28536_CoslaNrm.yaml b/OpenAPI/TS28536_CoslaNrm.yaml index 3ae269c54bb08b5d48092f98b2de857407da6868..99a1b50c04efd36feed3589dfc54e356d4a3f2fb 100755 --- a/OpenAPI/TS28536_CoslaNrm.yaml +++ b/OpenAPI/TS28536_CoslaNrm.yaml @@ -2,10 +2,10 @@ openapi: 3.0.1 info: title: coslaNrm - version: 17.3.0 + version: 17.4.0 description: >- OAS 3.0.1 specification of the Cosla NRM - © 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: @@ -126,45 +126,34 @@ components: taiList: $ref: 'TS28541_NrNrm.yaml#/components/schemas/TaiList' +#-------- Definition of types for name-containments ------ + SubNetwork-ncO-CoslaNrm: + type: object + properties: + AssuranceClosedControlLoop: + $ref: '#/components/schemas/AssuranceClosedControlLoop-Multiple' + + ManagedElement-ncO-CoslaNrm: + type: object + properties: + AssuranceClosedControlLoop: + $ref: '#/components/schemas/AssuranceClosedControlLoop-Multiple' + #-------- Definition of concrete IOCs -------------------------------------------- MnS: oneOf: - type: object properties: SubNetwork: - $ref: '#/components/schemas/SubNetwork-Multiple' + type: array + items: + $ref: '#/components/schemas/SubNetwork-ncO-CoslaNrm' - type: object properties: ManagedElement: - $ref: '#/components/schemas/ManagedElement-Multiple' - - SubNetwork-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-Attr' - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-ncO' - - type: object - properties: - AssuranceClosedControlLoop: - $ref: '#/components/schemas/AssuranceClosedControlLoop-Multiple' - - ManagedElement-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedElement-Attr' - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedElement-ncO' - - type: object - properties: - AssuranceClosedControlLoop: - $ref: '#/components/schemas/AssuranceClosedControlLoop-Multiple' + type: array + items: + $ref: '#/components/schemas/ManagedElement-ncO-CoslaNrm' AssuranceClosedControlLoop-Single: allOf: @@ -222,16 +211,7 @@ components: $ref: '#/components/schemas/AssuranceGoalStatusList' #-------- Definition of JSON arrays for name-contained IOCs ---------------------- - SubNetwork-Multiple: - type: array - items: - $ref: '#/components/schemas/SubNetwork-Single' - - ManagedElement-Multiple: - type: array - items: - $ref: '#/components/schemas/ManagedElement-Single' - + AssuranceClosedControlLoop-Multiple: type: array items: @@ -250,5 +230,3 @@ components: - $ref: '#/components/schemas/AssuranceClosedControlLoop-Single' - $ref: '#/components/schemas/AssuranceGoal-Single' - $ref: '#/components/schemas/AssuranceReport-Single' - - $ref: '#/components/schemas/SubNetwork-Single' - - $ref: '#/components/schemas/ManagedElement-Single' diff --git a/OpenAPI/TS28538_EdgeNrm.yaml b/OpenAPI/TS28538_EdgeNrm.yaml index cb10b910bbd5e58837ba6ff3c7dd00003d86c0f3..6745e3fa8c318b40217be45f9239b5f3714966c3 100644 --- a/OpenAPI/TS28538_EdgeNrm.yaml +++ b/OpenAPI/TS28538_EdgeNrm.yaml @@ -1,10 +1,10 @@ openapi: 3.0.1 info: title: 3GPP Edge NRM - version: 18.5.0 + version: 18.6.0 description: >- OAS 3.0.1 specification of the Edge NRM - © 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.538; Edge NRM @@ -42,7 +42,7 @@ components: GeographicalCoordinates: type: object properties: - lattitude: + latitude: type: integer longitude: type: integer @@ -71,7 +71,7 @@ components: type: integer virtualDisk: type: integer - virutalCPU: + virtualCPU: type: string vnfdId: type: string @@ -97,20 +97,16 @@ components: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' EASServicePermission: type: string - description: any of enumrated value + description: any of enumerated value enum: - TRIAL - SILVER - GOLD EASFeature: type: string - description: any of enumrated value - enum: - - SINGLE - - MULTIPLE EASStatus: type: string - description: any of enumrated value + description: any of enumerated value enum: - ENABLED - DISABLED @@ -146,44 +142,30 @@ components: - FUTURE futuristicTriggerTime: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' - relocationPolicy: - type: string - description: any of enumrated value - enum: - - YES - - NO - - YESwNOTIFY AvailableEDNList: type: object properties: resourceQuota: $ref: '#/components/schemas/VirtualResource' +#-------- Definition of types for name-containments ------ + SubNetwork-ncO-EdgeNrm: + type: object + properties: + ECSFunction: + $ref: '#/components/schemas/ECSFunction-Multiple' + EdgeDataNetwork: + $ref: '#/components/schemas/EdgeDataNetwork-Multiple' + #-------- 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' - ECSFunction: - $ref: '#/components/schemas/ECSFunction-Multiple' - EdgeDataNetwork: - $ref: '#/components/schemas/EdgeDataNetwork-Multiple' - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-ncO' + type: array + items: + $ref: '#/components/schemas/SubNetwork-ncO-EdgeNrm' EdgeDataNetwork-Single: allOf: @@ -283,7 +265,7 @@ components: $ref: '#/components/schemas/SoftwareImageInfo' serviceContinuitySupport: type: boolean - eASFunctonRef: + eASFunctionRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' @@ -329,13 +311,19 @@ components: eASFeature: $ref: '#/components/schemas/EASFeature' relocationPolicy: - $ref: '#/components/schemas/EASFeature' - federationID: type: string - reservationID: + description: any of enumrated value + enum: + - YES + - NO + - YESwNOTIFY + federationID: type: string - - ResourceReservationJob: + eASDeploymentMonitor: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ProcessMonitor' + reservationJobRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + EASResourceReservationJob-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object @@ -347,7 +335,7 @@ components: items: $ref: '#/components/schemas/ResourceReservationRequirement' requestedReservationExpiration: - type: string + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' resourceReservationStatus: type: array items: @@ -381,8 +369,6 @@ components: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: - availableVirtualResource: - $ref: '#/components/schemas/VirtualResource' availableEASResource: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' edgeDataNetworkRef: @@ -390,11 +376,7 @@ components: #-------- Definition of JSON arrays for name-contained IOCs ---------------------- - - SubNetwork-Multiple: - type: array - items: - $ref: '#/components/schemas/SubNetwork-Single' + EASFunction-Multiple: type: array items: @@ -434,7 +416,6 @@ components: resources-edgeNrm: oneOf: - $ref: '#/components/schemas/MnS' - - $ref: '#/components/schemas/SubNetwork-Single' - $ref: '#/components/schemas/EASFunction-Single' - $ref: '#/components/schemas/ECSFunction-Single' - $ref: '#/components/schemas/EESFunction-Single' @@ -444,3 +425,4 @@ components: - $ref: '#/components/schemas/EdgeFederation-Single' - $ref: '#/components/schemas/OperatorEdgeFederation-Single' - $ref: '#/components/schemas/OperatorEdgeDataNetwork-Single' + - $ref: '#/components/schemas/EASResourceReservationJob-Single' diff --git a/OpenAPI/TS28541_5GcNrm.yaml b/OpenAPI/TS28541_5GcNrm.yaml index 5a7ba35118cdfb3c758b1f6d5f11b9cd306b476f..9379ea46741e3defa4c7f58b30ac3d0ed5945340 100755 --- a/OpenAPI/TS28541_5GcNrm.yaml +++ b/OpenAPI/TS28541_5GcNrm.yaml @@ -1,10 +1,10 @@ openapi: 3.0.1 info: title: 3GPP 5GC NRM - version: 18.6.0 + version: 18.7.0 description: >- OAS 3.0.1 specification of the 5GC NRM - © 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.541; 5G NRM, 5GC NRM @@ -608,8 +608,21 @@ components: dnaiList: type: array items: - type: string - + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + + dnaiSatelliteMapping: + type: object + properties: + dnaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + geoSatelliteId: + type: string + pattern: '^[0-9]{5}$' + SnssaiSmfInfoItem: type: object properties: @@ -2049,18 +2062,18 @@ components: $ref: '#/components/schemas/NwdafInfo' minProperties: 1 minProperties: 1 - # servedPcscfInfoList: - # description: A map (list of key-value pairs) where nfInstanceId serves as key - # type: object - # additionalProperties: - # description: A map (list of key-value pairs) where a valid JSON string serves as key - # type: object - # additionalProperties: - # anyOf: - # - $ref: '#/components/schemas/PcscfInfo' - # - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' - # minProperties: 1 - # minProperties: 1 + servedPcscfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/PcscfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 servedGmlcInfo: description: A map (list of key-value pairs) where nfInstanceId serves as key type: object @@ -2077,12 +2090,12 @@ components: - $ref: '#/components/schemas/LmfInfo' - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' minProperties: 1 - # servedNfInfo: - # description: A map (list of key-value pairs) where nfInstanceId serves as key - # type: object - # additionalProperties: - # $ref: '#/components/schemas/NfInfo' - # minProperties: 1 + servedNfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + $ref: '#/components/schemas/NfInfo' + minProperties: 1 servedHssInfoList: description: A map (list of key-value pairs) where nfInstanceId serves as key type: object @@ -2212,6 +2225,60 @@ components: additionalProperties: $ref: '#/components/schemas/NssaafInfo' minProperties: 1 + SatelliteBackhaulInfo: + description: defines the list of satellite backhaul information + type: object + properties: + globalRanNodeID: + $ref: '#/components/schemas/GlobalRanNodeID' + SatelliteBackhaulCategory: + anyOf: + - type: string + enum: + - GEO + - MEO + - LEO + - OTHER_SAT + - DYNAMIC_GEO + - DYNAMIC_MEO + - DYNAMIC_LEO + - DYNAMIC_OTHER_SAT + - NON_SATELLITE + - type: string + geoSatelliteId: + type: string + pattern: '^[0-9]{5}$' + GlobalRanNodeID: + description: globally identification of an NG-RAN node + type: object + oneOf: + - required: [ pLmnId, n3IwfId] + - required: [ plmnId, gNbId] + - required: [ pLmnId, ngeNbId] + - required: [ plmnId, wagfId] + - required: [ pLmnId, tngfId] + - required: [ plmnId, twifId] + properties: + pLmnId: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' + n3IwfId: + type: string + pattern: '^[A-Fa-f0-9]+$' + gNbId: + type: integer + minimum: 0 + maximum: 4294967295 + ngeNbId: + type: string + pattern: '^(MacroNGeNB-[A-Fa-f0-9]{5}|LMacroNGeNB-[A-Fa-f0-9]{6}|SMacroNGeNB-[A-Fa-f0-9]{5})$' + wagfId: + type: string + pattern: '^[A-Fa-f0-9]+$' + tngfId: + type: string + pattern: '^[A-Fa-f0-9]+$' + twifId: + type: string NTNPLMNRestrictionsInfo: description: restrictions per PLMN that relates to non-terrestrial network access type: object @@ -2761,130 +2828,177 @@ components: minItems: 1 required: - msisdnRanges + SliceExpiryInfo : + description: Slice validity + type: object + properties: + pLMNInfo: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfo' + expiryTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + PcscfInfo: + description: Information of a P-CSCF NF Instance + type: object + properties: + accessType: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + dnnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + gmFqdn: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Fqdn' + gmIpv4Addresses: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + gmIpv6Addresses: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + mwFqdn: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Fqdn' + mwIpv4Addresses: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + mwIpv6Addresses: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + servedIpv4AddressRanges: + type: array + items: + $ref: '#/components/schemas/Ipv4AddressRange' + minItems: 1 + servedIpv6PrefixRanges: + type: array + items: + $ref: '#/components/schemas/Ipv6PrefixRange' + minItems: 1 + NfInfo: + description: Information of a generic NF Instance + type: object + properties: + nfType: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/NFType' + +#-------- Definition of types for name-containments ------ + SubNetwork-ncO-5GcNrm: + type: object + properties: + ExternalAmfFunction: + $ref: '#/components/schemas/ExternalAmfFunction-Multiple' + ExternalNrfFunction: + $ref: '#/components/schemas/ExternalNrfFunction-Multiple' + ExternalNssfFunction: + $ref: '#/components/schemas/ExternalNssfFunction-Multiple' + AmfSet: + $ref: '#/components/schemas/AmfSet-Multiple' + AmfRegion: + $ref: '#/components/schemas/AmfRegion-Multiple' + Configurable5QISet: + $ref: '#/components/schemas/Configurable5QISet-Multiple' + Dynamic5QISet: + $ref: '#/components/schemas/Dynamic5QISet-Multiple' + EcmConnectionInfo: + $ref: '#/components/schemas/EcmConnectionInfo-Multiple' + + ManagedElement-ncO-5GcNrm: + type: object + properties: + AmfFunction: + $ref: '#/components/schemas/AmfFunction-Multiple' + SmfFunction: + $ref: '#/components/schemas/SmfFunction-Multiple' + UpfFunction: + $ref: '#/components/schemas/UpfFunction-Multiple' + N3iwfFunction: + $ref: '#/components/schemas/N3iwfFunction-Multiple' + PcfFunction: + $ref: '#/components/schemas/PcfFunction-Multiple' + AusfFunction: + $ref: '#/components/schemas/AusfFunction-Multiple' + UdmFunction: + $ref: '#/components/schemas/UdmFunction-Multiple' + UdrFunction: + $ref: '#/components/schemas/UdrFunction-Multiple' + UdsfFunction: + $ref: '#/components/schemas/UdsfFunction-Multiple' + NrfFunction: + $ref: '#/components/schemas/NrfFunction-Multiple' + NssfFunction: + $ref: '#/components/schemas/NssfFunction-Multiple' + SmsfFunction: + $ref: '#/components/schemas/SmsfFunction-Multiple' + LmfFunction: + $ref: '#/components/schemas/LmfFunction-Multiple' + NgeirFunction: + $ref: '#/components/schemas/NgeirFunction-Multiple' + SeppFunction: + $ref: '#/components/schemas/SeppFunction-Multiple' + NwdafFunction: + $ref: '#/components/schemas/NwdafFunction-Multiple' + ScpFunction: + $ref: '#/components/schemas/ScpFunction-Multiple' + NefFunction: + $ref: '#/components/schemas/NefFunction-Multiple' + Configurable5QISet: + $ref: '#/components/schemas/Configurable5QISet-Multiple' + Dynamic5QISet: + $ref: '#/components/schemas/Dynamic5QISet-Multiple' + EcmConnectionInfo: + $ref: '#/components/schemas/EcmConnectionInfo-Multiple' + EASDFFunction: + $ref: '#/components/schemas/EASDFFunction-Multiple' + NSSAAFFunction: + $ref: '#/components/schemas/NssaafFunction-Multiple' + AFFunction: + $ref: '#/components/schemas/AfFunction-Multiple' + DCCFFunction: + $ref: '#/components/schemas/DccfFunction-Multiple' + ChfFunction: + $ref: '#/components/schemas/ChfFunction-Multiple' + MFAFFunction: + $ref: '#/components/schemas/MfafFunction-Multiple' + GMLCFunction: + $ref: '#/components/schemas/GmlcFunction-Multiple' + TSCTSFFunction: + $ref: '#/components/schemas/TsctsfFunction-Multiple' + AANFFunction: + $ref: '#/components/schemas/AanfFunction-Multiple' + BSFFunction: + $ref: '#/components/schemas/BsfFunction-Multiple' + MBSMFFunction: + $ref: '#/components/schemas/MbSmfFunction-Multiple' + MBUPFFunction: + $ref: '#/components/schemas/MbUpfFunction-Multiple' + MNPFFunction: + $ref: '#/components/schemas/MnpfFunction-Multiple' #-------- Definition of concrete IOCs -------------------------------------------- - ProvMnS: + MnS: oneOf: - type: object properties: SubNetwork: - $ref: '#/components/schemas/SubNetwork-Multiple' - - type: object - properties: - ManagedElement: - $ref: '#/components/schemas/ManagedElement-Multiple' - - SubNetwork-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-Attr' - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-ncO' + type: array + items: + $ref: '#/components/schemas/SubNetwork-ncO-5GcNrm' - type: object properties: - SubNetwork: - $ref: '#/components/schemas/SubNetwork-Multiple' ManagedElement: - $ref: '#/components/schemas/ManagedElement-Multiple' - ExternalAmfFunction: - $ref: '#/components/schemas/ExternalAmfFunction-Multiple' - ExternalNrfFunction: - $ref: '#/components/schemas/ExternalNrfFunction-Multiple' - ExternalNssfFunction: - $ref: '#/components/schemas/ExternalNssfFunction-Multiple' - AmfSet: - $ref: '#/components/schemas/AmfSet-Multiple' - AmfRegion: - $ref: '#/components/schemas/AmfRegion-Multiple' - Configurable5QISet: - $ref: '#/components/schemas/Configurable5QISet-Multiple' - Dynamic5QISet: - $ref: '#/components/schemas/Dynamic5QISet-Multiple' - EcmConnectionInfo: - $ref: '#/components/schemas/EcmConnectionInfo-Multiple' - - ManagedElement-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedElement-Attr' - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedElement-ncO' - - type: object - properties: - AmfFunction: - $ref: '#/components/schemas/AmfFunction-Multiple' - SmfFunction: - $ref: '#/components/schemas/SmfFunction-Multiple' - UpfFunction: - $ref: '#/components/schemas/UpfFunction-Multiple' - N3iwfFunction: - $ref: '#/components/schemas/N3iwfFunction-Multiple' - PcfFunction: - $ref: '#/components/schemas/PcfFunction-Multiple' - AusfFunction: - $ref: '#/components/schemas/AusfFunction-Multiple' - UdmFunction: - $ref: '#/components/schemas/UdmFunction-Multiple' - UdrFunction: - $ref: '#/components/schemas/UdrFunction-Multiple' - UdsfFunction: - $ref: '#/components/schemas/UdsfFunction-Multiple' - NrfFunction: - $ref: '#/components/schemas/NrfFunction-Multiple' - NssfFunction: - $ref: '#/components/schemas/NssfFunction-Multiple' - SmsfFunction: - $ref: '#/components/schemas/SmsfFunction-Multiple' - LmfFunction: - $ref: '#/components/schemas/LmfFunction-Multiple' - NgeirFunction: - $ref: '#/components/schemas/NgeirFunction-Multiple' - SeppFunction: - $ref: '#/components/schemas/SeppFunction-Multiple' - NwdafFunction: - $ref: '#/components/schemas/NwdafFunction-Multiple' - ScpFunction: - $ref: '#/components/schemas/ScpFunction-Multiple' - NefFunction: - $ref: '#/components/schemas/NefFunction-Multiple' - Configurable5QISet: - $ref: '#/components/schemas/Configurable5QISet-Multiple' - Dynamic5QISet: - $ref: '#/components/schemas/Dynamic5QISet-Multiple' - EcmConnectionInfo: - $ref: '#/components/schemas/EcmConnectionInfo-Multiple' - EASDFFunction: - $ref: '#/components/schemas/EASDFFunction-Multiple' - NSSAAFFunction: - $ref: '#/components/schemas/NssaafFunction-Multiple' - AFFunction: - $ref: '#/components/schemas/AfFunction-Multiple' - DCCFFunction: - $ref: '#/components/schemas/DccfFunction-Multiple' - ChfFunction: - $ref: '#/components/schemas/ChfFunction-Multiple' - MFAFFunction: - $ref: '#/components/schemas/MfafFunction-Multiple' - GMLCFunction: - $ref: '#/components/schemas/GmlcFunction-Multiple' - TSCTSFFunction: - $ref: '#/components/schemas/TsctsfFunction-Multiple' - AANFFunction: - $ref: '#/components/schemas/AanfFunction-Multiple' - BSFFunction: - $ref: '#/components/schemas/BsfFunction-Multiple' - MBSMFFunction: - $ref: '#/components/schemas/MbSmfFunction-Multiple' - MBUPFFunction: - $ref: '#/components/schemas/MbUpfFunction-Multiple' - MNPFFunction: - $ref: '#/components/schemas/MnpfFunction-Multiple' + type: array + items: + $ref: '#/components/schemas/ManagedElement-ncO-5GcNrm' AmfFunction-Single: allOf: @@ -2917,7 +3031,11 @@ components: nTNPLMNInfoList: $ref: '#/components/schemas/NTNPLMNRestrictionsInfo' amfInfo: - $ref: '#/components/schemas/AmfInfo' + $ref: '#/components/schemas/AmfInfo' + sliceExpiryInfo: + $ref: '#/components/schemas/SliceExpiryInfo' + SatelliteBackhaulInfoList: + $ref: '#/components/schemas/SatelliteBackhaulInfo' - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - type: object properties: @@ -2977,6 +3095,7 @@ components: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' aMFSetMemberList: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' AmfRegion-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' @@ -2997,6 +3116,7 @@ components: $ref: '#/components/schemas/SnssaiList' aMFSetListRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' SmfFunction-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' @@ -3025,6 +3145,10 @@ components: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' dynamic5QISetRef: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + dnaiSatelliteMappingList: + type: array + items: + $ref: '#/components/schemas/dnaiSatelliteMapping' - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - type: object properties: @@ -3245,7 +3369,7 @@ components: $ref: '#/components/schemas/ManagedNFProfile' udrInfo: $ref: '#/components/schemas/UdrInfo' - + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' UdsfFunction-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' @@ -3264,7 +3388,7 @@ components: $ref: '#/components/schemas/ManagedNFProfile' udsfInfo: $ref: '#/components/schemas/UdsfInfo' - + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' NrfFunction-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' @@ -3653,6 +3777,7 @@ components: $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' amfIdentifier: $ref: '#/components/schemas/AmfIdentifier' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' ExternalNrfFunction-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' @@ -3665,6 +3790,7 @@ components: properties: plmnIdList: $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' ExternalNssfFunction-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' @@ -3677,6 +3803,7 @@ components: properties: plmnIdList: $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' ExternalSeppFunction-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' @@ -3693,7 +3820,7 @@ components: type: integer fqdn: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Fqdn' - + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' EP_N2-Single: allOf: @@ -5154,14 +5281,6 @@ components: #-------- Definition of JSON arrays for name-contained IOCs ---------------------- - SubNetwork-Multiple: - type: array - items: - $ref: '#/components/schemas/SubNetwork-Single' - ManagedElement-Multiple: - type: array - items: - $ref: '#/components/schemas/ManagedElement-Single' AmfFunction-Multiple: type: array items: @@ -5604,9 +5723,7 @@ components: resources-5gcNrm: oneOf: - - $ref: '#/components/schemas/ProvMnS' - - $ref: '#/components/schemas/SubNetwork-Single' - - $ref: '#/components/schemas/ManagedElement-Single' + - $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 dd2a8ec6d5cd9d929e2417d8fe34a9c2b8ee751d..9cfcb39b7ced716dc5b825d2362b0400824dbeb8 100755 --- a/OpenAPI/TS28541_NrNrm.yaml +++ b/OpenAPI/TS28541_NrNrm.yaml @@ -1,10 +1,10 @@ openapi: 3.0.1 info: title: NR NRM - version: 18.6.0 + version: 18.7.0 description: >- OAS 3.0.1 specification of the NR NRM - © 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.541; 5G NRM, NR NRM @@ -59,6 +59,8 @@ components: $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' snssai: $ref: '#/components/schemas/Snssai' + sliceExpiryTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' PlmnInfoList: type: array items: @@ -692,6 +694,73 @@ components: minimum: 0 maximum: 16777215 +#-------- Definition of types for name-containments ------ + SubNetwork-ncO-NrNrm: + type: object + properties: + NRFrequency: + $ref: '#/components/schemas/NRFrequency-Multiple' + ExternalGnbCuCpFunction: + $ref: '#/components/schemas/ExternalGnbCuCpFunction-Multiple' + ExternalGnbCuUpFunction: + $ref: '#/components/schemas/ExternalGnbCuUpFunction-Multiple' + ExternalGnbDuFunction: + $ref: '#/components/schemas/ExternalGnbDuFunction-Multiple' + ExternalENBFunction: + $ref: '#/components/schemas/ExternalENBFunction-Multiple' + EUtranFrequency: + $ref: '#/components/schemas/EUtranFrequency-Multiple' + DESManagementFunction: + $ref: '#/components/schemas/DESManagementFunction-Single' + DRACHOptimizationFunction: + $ref: '#/components/schemas/DRACHOptimizationFunction-Single' + DMROFunction: + $ref: '#/components/schemas/DMROFunction-Single' + DLBOFunction: + $ref: '#/components/schemas/DLBOFunction-Single' + DPCIConfigurationFunction: + $ref: '#/components/schemas/DPCIConfigurationFunction-Single' + CPCIConfigurationFunction: + $ref: '#/components/schemas/CPCIConfigurationFunction-Single' + CESManagementFunction: + $ref: '#/components/schemas/CESManagementFunction-Single' + Configurable5QISet: + $ref: 'TS28541_5GcNrm.yaml#/components/schemas/Configurable5QISet-Multiple' + RimRSGlobal: + $ref: '#/components/schemas/RimRSGlobal-Single' + Dynamic5QISet: + $ref: 'TS28541_5GcNrm.yaml#/components/schemas/Dynamic5QISet-Multiple' + CCOFunction: + $ref: '#/components/schemas/CCOFunction-Single' + + ManagedElement-ncO-NrNrm: + type: object + properties: + GnbDuFunction: + $ref: '#/components/schemas/GnbDuFunction-Multiple' + GnbCuUpFunction: + $ref: '#/components/schemas/GnbCuUpFunction-Multiple' + GnbCuCpFunction: + $ref: '#/components/schemas/GnbCuCpFunction-Multiple' + DESManagementFunction: + $ref: '#/components/schemas/DESManagementFunction-Single' + DRACHOptimizationFunction: + $ref: '#/components/schemas/DRACHOptimizationFunction-Single' + DMROFunction: + $ref: '#/components/schemas/DMROFunction-Single' + DLBOFunction: + $ref: '#/components/schemas/DLBOFunction-Single' + DPCIConfigurationFunction: + $ref: '#/components/schemas/DPCIConfigurationFunction-Single' + CPCIConfigurationFunction: + $ref: '#/components/schemas/CPCIConfigurationFunction-Single' + CESManagementFunction: + $ref: '#/components/schemas/CESManagementFunction-Single' + Configurable5QISet: + $ref: 'TS28541_5GcNrm.yaml#/components/schemas/Configurable5QISet-Multiple' + Dynamic5QISet: + $ref: 'TS28541_5GcNrm.yaml#/components/schemas/Dynamic5QISet-Multiple' + #-------- Definition of abstract IOCs -------------------------------------------- RrmPolicy_-Attr: @@ -702,7 +771,6 @@ components: rRMPolicyMemberList: $ref: '#/components/schemas/RrmPolicyMemberList' - #-------- Definition of concrete IOCs -------------------------------------------- MnS: @@ -710,90 +778,15 @@ components: - type: object properties: SubNetwork: - $ref: '#/components/schemas/SubNetwork-Multiple' - - type: object - properties: - ManagedElement: - $ref: '#/components/schemas/ManagedElement-Multiple' - - SubNetwork-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-Attr' - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-ncO' + type: array + items: + $ref: '#/components/schemas/SubNetwork-ncO-NrNrm' - type: object properties: - SubNetwork: - $ref: '#/components/schemas/SubNetwork-Multiple' ManagedElement: - $ref: '#/components/schemas/ManagedElement-Multiple' - NRFrequency: - $ref: '#/components/schemas/NRFrequency-Multiple' - ExternalGnbCuCpFunction: - $ref: '#/components/schemas/ExternalGnbCuCpFunction-Multiple' - ExternalENBFunction: - $ref: '#/components/schemas/ExternalENBFunction-Multiple' - EUtranFrequency: - $ref: '#/components/schemas/EUtranFrequency-Multiple' - DESManagementFunction: - $ref: '#/components/schemas/DESManagementFunction-Single' - DRACHOptimizationFunction: - $ref: '#/components/schemas/DRACHOptimizationFunction-Single' - DMROFunction: - $ref: '#/components/schemas/DMROFunction-Single' - DLBOFunction: - $ref: '#/components/schemas/DLBOFunction-Single' - DPCIConfigurationFunction: - $ref: '#/components/schemas/DPCIConfigurationFunction-Single' - CPCIConfigurationFunction: - $ref: '#/components/schemas/CPCIConfigurationFunction-Single' - CESManagementFunction: - $ref: '#/components/schemas/CESManagementFunction-Single' - Configurable5QISet: - $ref: 'TS28541_5GcNrm.yaml#/components/schemas/Configurable5QISet-Multiple' - RimRSGlobal: - $ref: '#/components/schemas/RimRSGlobal-Single' - Dynamic5QISet: - $ref: 'TS28541_5GcNrm.yaml#/components/schemas/Dynamic5QISet-Multiple' - CCOFunction: - $ref: '#/components/schemas/CCOFunction-Single' - ManagedElement-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedElement-Attr' - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedElement-ncO' - - type: object - properties: - GnbDuFunction: - $ref: '#/components/schemas/GnbDuFunction-Multiple' - GnbCuUpFunction: - $ref: '#/components/schemas/GnbCuUpFunction-Multiple' - GnbCuCpFunction: - $ref: '#/components/schemas/GnbCuCpFunction-Multiple' - DESManagementFunction: - $ref: '#/components/schemas/DESManagementFunction-Single' - DRACHOptimizationFunction: - $ref: '#/components/schemas/DRACHOptimizationFunction-Single' - DMROFunction: - $ref: '#/components/schemas/DMROFunction-Single' - DLBOFunction: - $ref: '#/components/schemas/DLBOFunction-Single' - DPCIConfigurationFunction: - $ref: '#/components/schemas/DPCIConfigurationFunction-Single' - CPCIConfigurationFunction: - $ref: '#/components/schemas/CPCIConfigurationFunction-Single' - CESManagementFunction: - $ref: '#/components/schemas/CESManagementFunction-Single' - Configurable5QISet: - $ref: 'TS28541_5GcNrm.yaml#/components/schemas/Configurable5QISet-Multiple' - Dynamic5QISet: - $ref: 'TS28541_5GcNrm.yaml#/components/schemas/Dynamic5QISet-Multiple' + type: array + items: + $ref: '#/components/schemas/ManagedElement-ncO-NrNrm' GnbDuFunction-Single: allOf: @@ -1521,7 +1514,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'" DRACHOptimizationFunction-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' @@ -1555,6 +1551,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'" DLBOFunction-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' @@ -1569,7 +1569,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'" DPCIConfigurationFunction-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' @@ -2012,14 +2015,6 @@ components: #-------- Definition of JSON arrays for name-contained IOCs ---------------------- - SubNetwork-Multiple: - type: array - items: - $ref: '#/components/schemas/SubNetwork-Single' - ManagedElement-Multiple: - type: array - items: - $ref: '#/components/schemas/ManagedElement-Single' GnbDuFunction-Multiple: type: array items: @@ -2182,9 +2177,6 @@ components: resources-nrNrm: oneOf: - $ref: '#/components/schemas/MnS' - - - $ref: '#/components/schemas/SubNetwork-Single' - - $ref: '#/components/schemas/ManagedElement-Single' - $ref: '#/components/schemas/GnbDuFunction-Single' - $ref: '#/components/schemas/GnbCuUpFunction-Single' diff --git a/OpenAPI/TS28541_SliceNrm.yaml b/OpenAPI/TS28541_SliceNrm.yaml index 52620a6bfd9c6e9aab0fd9f3b17bb514fc53f9bb..d64929f39929cf1c5324b42886e5c1f63e7b03f6 100755 --- a/OpenAPI/TS28541_SliceNrm.yaml +++ b/OpenAPI/TS28541_SliceNrm.yaml @@ -1,10 +1,10 @@ openapi: 3.0.1 info: title: Slice NRM - version: 18.6.0 + version: 18.7.0 description: >- OAS 3.0.1 specification of the Slice NRM - @ 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.541; 5G NRM, Slice NRM @@ -410,7 +410,13 @@ components: $ref: '#/components/schemas/DataNetwork' dataNetworkAccess: $ref: '#/components/schemas/DataNetworkAccess' - + dLPktDelayVariation: + $ref: '#/components/schemas/Float' + uLPktDelayVariation: + $ref: '#/components/schemas/Float' + sliceSubnetAvailability: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SchedulingTime' + RANSliceSubnetProfile: type: object properties: @@ -478,6 +484,10 @@ components: type: number kPIMonitoring: $ref: '#/components/schemas/KPIMonitoring' + dLPktDelayVariation: + $ref: '#/components/schemas/Float' + uLPktDelayVariation: + $ref: '#/components/schemas/Float' TopSliceSubnetProfile: type: object @@ -556,6 +566,12 @@ components: $ref: '#/components/schemas/DataNetwork' dataNetworkAccess: $ref: '#/components/schemas/DataNetworkAccess' + dLPktDelayVariation: + $ref: '#/components/schemas/Float' + uLPktDelayVariation: + $ref: '#/components/schemas/Float' + sliceSubnetAvailability: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SchedulingTime' ServiceProfile: type: object @@ -622,8 +638,6 @@ components: $ref: '#/components/schemas/Float' uESpeed: type: integer - jitter: - type: integer survivalTime: type: number dLReliability: @@ -648,6 +662,12 @@ components: $ref: '#/components/schemas/DataNetwork' dataNetworkAccess: $ref: '#/components/schemas/DataNetworkAccess' + dLPktDelayVariation: + $ref: '#/components/schemas/Float' + uLPktDelayVariation: + $ref: '#/components/schemas/Float' + sliceAvailability: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SchedulingTime' SliceProfile: type: object @@ -783,6 +803,27 @@ components: - NETWORKSLICE - NETWORKSLICESUBNET +#-------- Definition of types for name-containments ------ + SubNetwork-ncO-SliceNrm: + type: object + properties: + NetworkSlice: + $ref: '#/components/schemas/NetworkSlice-Multiple' + NetworkSliceSubnet: + $ref: '#/components/schemas/NetworkSliceSubnet-Multiple' + EP_Transport: + $ref: '#/components/schemas/EP_Transport-Multiple' + NetworkSliceSubnetProviderCapabilities: + $ref: '#/components/schemas/NetworkSliceSubnetProviderCapabilities-Multiple' + FeasibilityCheckAndReservationJob: + $ref: '#/components/schemas/FeasibilityCheckAndReservationJob-Multiple' + NetworkSliceController: + $ref: '#/components/schemas/NetworkSliceController-Multiple' + NetworkSliceSubnetController: + $ref: '#/components/schemas/NetworkSliceSubnetController-Multiple' + IsolationProfile: + $ref: '#/components/schemas/IsolationProfile-Multiple' + #------------ Definition of concrete IOCs ---------------------------------------- MnS: @@ -790,42 +831,14 @@ components: - type: object properties: SubNetwork: - $ref: '#/components/schemas/SubNetwork-Multiple' + type: array + items: + $ref: '#/components/schemas/SubNetwork-ncO-SliceNrm' # - type: object # properties: # ManagedElement: # $ref: '#/components/schemas/ManagedElement-Multiple' - SubNetwork-Single: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - - type: object - properties: - attributes: - allOf: - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-Attr' - - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-ncO' - - type: object - properties: - SubNetwork: - $ref: '#/components/schemas/SubNetwork-Multiple' - NetworkSlice: - $ref: '#/components/schemas/NetworkSlice-Multiple' - NetworkSliceSubnet: - $ref: '#/components/schemas/NetworkSliceSubnet-Multiple' - EP_Transport: - $ref: '#/components/schemas/EP_Transport-Multiple' - NetworkSliceSubnetProviderCapabilities: - $ref: '#/components/schemas/NetworkSliceSubnetProviderCapabilities-Multiple' - FeasibilityCheckAndReservationJob: - $ref: '#/components/schemas/FeasibilityCheckAndReservationJob-Multiple' - NetworkSliceController: - $ref: '#/components/schemas/NetworkSliceController-Multiple' - NetworkSliceSubnetController: - $ref: '#/components/schemas/NetworkSliceSubnetController-Multiple' - IsolationProfile: - $ref: '#/components/schemas/IsolationProfile-Multiple' - NetworkSlice-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' @@ -1026,10 +1039,6 @@ components: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' #-------- Definition of JSON arrays for name-contained IOCs ---------------------- - SubNetwork-Multiple: - type: array - items: - $ref: '#/components/schemas/SubNetwork-Single' NetworkSlice-Multiple: type: array @@ -1076,7 +1085,6 @@ components: oneOf: - $ref: '#/components/schemas/MnS' - - $ref: '#/components/schemas/SubNetwork-Single' - $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 88dbbd989655e24e03949bb20322941fd13bb635..c4e866243a02a48d56bb306f3996edf09466db13 100755 --- a/OpenAPI/TS28623_ComDefs.yaml +++ b/OpenAPI/TS28623_ComDefs.yaml @@ -1,10 +1,10 @@ openapi: 3.0.1 info: title: Common Type Definitions - version: 18.5.0 + version: 18.6.0 description: >- OAS 3.0.1 specification of common type definitions in the Generic NRM - © 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; Common type definitions @@ -232,7 +232,7 @@ components: Filter: description: >- - The filter format shall be compliant to XPath 1.0. + The filter format shall be compliant to Jex (TS 32.161). type: string SystemDN: type: string @@ -241,7 +241,7 @@ components: type: integer NotificationType: oneOf: - - $ref: 'TS28532_FaultMnS.yaml#/components/schemas/AlarmNotificationTypes' + - $ref: 'TS28111_FaultNrm.yaml#/components/schemas/AlarmNotificationTypes' - $ref: 'TS28532_ProvMnS.yaml#/components/schemas/CmNotificationTypes' - $ref: 'TS28532_PerfMnS.yaml#/components/schemas/PerfNotificationTypes' - $ref: 'TS28532_HeartbeatNtf.yaml#/components/schemas/HeartbeatNotificationTypes' @@ -277,3 +277,135 @@ components: properties: errorInfo: type: string + Subscription: + type: object + properties: + consumerReference: + $ref: '#/components/schemas/Uri' + timeTick: + type: integer + filter: + $ref: '#/components/schemas/Filter' + + ErrorResponseGet: + description: >- + Default schema for the response message body in case the Get + is not successful. + type: object + properties: + status: + type: string + type: + type: string + reason: + type: string + title: + type: string + badQueryParams: + type: array + items: + type: string + otherProblems: + type: array + items: + type: object + properties: + status: + type: string + type: + type: string + reason: + type: string + title: + type: string + badQueryParams: + type: array + items: + type: string + required: + - type + required: + - type + + ErrorResponseDefault: + type: object + properties: + status: + type: string + type: + type: string + reason: + type: string + title: + type: string + badAttributes: + type: array + items: + type: string + badObjects: + type: array + items: + type: string + otherProblems: + type: array + items: + type: object + properties: + status: + type: string + type: + type: string + reason: + type: string + title: + type: string + badAttributes: + type: array + items: + type: string + badObjects: + type: array + items: + type: string + required: + - type + required: + - type + + ErrorResponsePatch: + description: >- + Default schema for the response message body in case the patch + is not successful. + type: object + properties: + status: + type: string + type: + type: string + reason: + type: string + title: + type: string + badOP: + type: string + otherProblems: + type: array + items: + type: object + properties: + status: + type: string + type: + type: string + reason: + type: string + title: + type: string + badOp: + type: string + required: + - type + - badOp + required: + - type + - badOp diff --git a/OpenAPI/TS28623_FileManagementNrm.yaml b/OpenAPI/TS28623_FileManagementNrm.yaml new file mode 100644 index 0000000000000000000000000000000000000000..6cdfde23ee47e4873a2eb5f239fd6defb213a53b --- /dev/null +++ b/OpenAPI/TS28623_FileManagementNrm.yaml @@ -0,0 +1,157 @@ +openapi: 3.0.1 +info: + title: File Management NRM + version: 18.6.0 + description: >- + OAS 3.0.1 definition of the File Management NRM fragment + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.623; Generic NRM, File Management NRM + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/ +paths: {} +components: + schemas: +#-------- Definition of types----------------------------------------------------- + FileDownloadJobProcessMonitor: + description: >- + This data type is the "ProcessMonitor" data type with specialisations + for usage in the "FileDownloadJob". + type: object + properties: + jobId: + type: string + status: + type: string + enum: + - NOT_STARTED + - RUNNING + - FINSHED + - FAILED + - CANCELLING + - CANCELLED + progressPercentage: + type: integer + minimum: 0 + maximum: 100 + progressStateInfo: + type: string + resultStateInfo: + oneOf: + - type: string + enum: + - NULL + - UNKNOWN + - NO_STORAGE + - LOW_MEMROY + - NO_CONNECTION_TO_REMOTE_SERVER + - FILE_NOT_AVAILABLE + - DNS_CANNOT_BE_RESOLVED + - TIMER_EXPIRED + - OTHER + - type: string + startTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + endTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + timer: + type: integer + +#-------- Definition of concrete IOCs -------------------------------------------- + + + FileDownloadJob-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + fileLocation: + type: string + notificationRecipientAddress: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' + cancelJob: + type: string + enum: + - TRUE + - FALSE + jobMonitor: + $ref: '#/components/schemas/FileDownloadJobProcessMonitor' + Files-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + numberOfFiles: + type: integer + jobRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + jobId: + type: string + File: + $ref: '#/components/schemas/File-Multiple' + File-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + fileLocation: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' + fileCompression: + type: string + fileSize: + type: integer + fileDataType: + type: string + enum: + - PERFORMANCE + - TRACE + - ANALYTICS + - PROPRIETARY + fileFormat: + type: string + fileReadyTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + fileExpirationTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + fileContent: + type: string + jobRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + jobId: + type: string + + + +#-------- Definition of YAML arrays for name-contained IOCs ---------------------- + + FileDownloadJob-Multiple: + type: array + items: + $ref: '#/components/schemas/FileDownloadJob-Single' + Files-Multiple: + type: array + items: + $ref: '#/components/schemas/Files-Single' + File-Multiple: + type: array + items: + $ref: '#/components/schemas/File-Single' + + + +#-------- Definitions in TS 28.623 for TS 28.532 --------------------------------- + resources-fileMgmtNrm: + oneOf: + - $ref: '#/components/schemas/FileDownloadJob-Single' + - $ref: '#/components/schemas/Files-Single' + - $ref: '#/components/schemas/File-Single' + diff --git a/OpenAPI/TS28623_GenericNrm.yaml b/OpenAPI/TS28623_GenericNrm.yaml index 64b9c018e95b5122a281d5bdca04ffbb90a978f5..3d72b9232b2632b4135a9c6f0964a2c0c08d3297 100755 --- a/OpenAPI/TS28623_GenericNrm.yaml +++ b/OpenAPI/TS28623_GenericNrm.yaml @@ -1,10 +1,10 @@ openapi: 3.0.1 info: title: Generic NRM - version: 18.5.0 + version: 18.6.0 description: >- OAS 3.0.1 definition of the Generic NRM - © 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 @@ -51,30 +51,6 @@ components: type: string powerInterface: type: string - ThresholdInfo: - type: object - properties: - performanceMetrics: - type: array - items: - type: string - thresholdDirection: - type: string - enum: - - UP - - DOWN - - UP_AND_DOWN - thresholdValue: - oneOf: - - type: integer - - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Float' - hysteresis: - oneOf: - - type: integer - minimum: 0 - - type: number - format: float - minimum: 0 Operation: type: object properties: @@ -209,6 +185,12 @@ components: properties: fileReportingPeriod: type: integer + - type: object + properties: + fileReportingPeriod: + type: integer + notificationRecipientAddress: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' - type: object properties: fileReportingPeriod: @@ -220,17 +202,22 @@ components: streamTarget: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' Scope: - type: object - properties: - scopeType: - type: string - enum: - - BASE_ONLY - - BASE_ALL - - BASE_NTH_LEVEL - - BASE_SUBTREE - scopeLevel: - type: integer + oneOf: + - type: object + properties: + scopeType: + type: string + enum: + - BASE_ONLY + - BASE_ALL + - BASE_NTH_LEVEL + - BASE_SUBTREE + scopeLevel: + type: integer + - type: object + properties: + dataNodeSelector: + type: string ProcessMonitor: description: >- This data type is the "ProcessMonitor" data type without specialisations. @@ -262,49 +249,6 @@ components: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' timer: type: integer - FileDownloadJobProcessMonitor: - description: >- - This data type is the "ProcessMonitor" data type with specialisations - for usage in the "FileDownloadJob". - type: object - properties: - jobId: - type: string - status: - type: string - enum: - - NOT_STARTED - - RUNNING - - FINSHED - - FAILED - - CANCELLING - - CANCELLED - progressPercentage: - type: integer - minimum: 0 - maximum: 100 - progressStateInfo: - type: string - resultStateInfo: - oneOf: - - type: string - enum: - - NULL - - UNKNOWN - - NO_STORAGE - - LOW_MEMROY - - NO_CONNECTION_TO_REMOTE_SERVER - - FILE_NOT_AVAILABLE - - DNS_CANNOT_BE_RESOLVED - - TIMER_EXPIRED - - OTHER - - type: string - startTime: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' - endTime: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' - timer: - type: integer AreaScope: oneOf: - type: array @@ -346,37 +290,6 @@ components: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr' - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv6Addr' - ManagementData: - oneOf: - - type: array - items: - type: string - enum: - - COVERAGE - - CAPACITY - - ENERGY_EFFICIENCY - - MOBILITY - - ACCESSIBILITY - - type: array - items: - type: string - NodeFilter: - type: object - properties: - areaOfInterest: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/AreaOfInterest' - networkDomain: - type: string - enum: - - CN - - RAN - cpUpType: - type: string - enum: - - CP - - UP - sst: - type: integer SchedulingTime: oneOf: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeWindow' @@ -531,23 +444,23 @@ components: MeContext: $ref: '#/components/schemas/MeContext-Multiple' PerfMetricJob: - $ref: '#/components/schemas/PerfMetricJob-Multiple' + $ref: 'TS28623_PmControlNrm.yaml#/components/schemas/PerfMetricJob-Multiple' ThresholdMonitor: - $ref: '#/components/schemas/ThresholdMonitor-Multiple' + $ref: 'TS28623_ThresholdMonitorNrm.yaml#/components/schemas/ThresholdMonitor-Multiple' TraceJob: $ref: 'TS28623_TraceControlNrm.yaml#/components/schemas/TraceJob-Multiple' ManagementDataCollection: - $ref: '#/components/schemas/ManagementDataCollection-Multiple' + $ref: 'TS28623_ManagementDataCollectionNrm.yaml#/components/schemas/ManagementDataCollection-Multiple' NtfSubscriptionControl: - $ref: '#/components/schemas/NtfSubscriptionControl-Multiple' + $ref: 'TS28623_SubscriptionControlNrm.yaml#/components/schemas/NtfSubscriptionControl-Multiple' AlarmList: - $ref: '#/components/schemas/AlarmList-Single' + $ref: 'TS28111_FaultNrm.yaml#/components/schemas/AlarmList-Single' FileDownloadJob: - $ref: '#/components/schemas/FileDownloadJob-Multiple' + $ref: 'TS28623_FileManagementNrm.yaml#/components/schemas/FileDownloadJob-Multiple' Files: - $ref: '#/components/schemas/Files-Multiple' + $ref: 'TS28623_FileManagementNrm.yaml#/components/schemas/Files-Multiple' MnsRegistry: - $ref: '#/components/schemas/MnsRegistry-Single' + $ref: 'TS28623_MnSRegistryNrm.yaml#/components/schemas/MnsRegistry-Single' Scheduler: $ref: '#/components/schemas/Scheduler-Multiple' ConditionMonitor: @@ -555,7 +468,7 @@ components: SupportedNotifications: $ref: '#/components/schemas/SupportedNotifications-Single' QMCJobs: - $ref: '#/components/schemas/QMCJob-Multiple' + $ref: 'TS28623_QoEMeasurementCollectionNrm.yaml#/components/schemas/QMCJob-Multiple' ManagedElement-ncO: type: object @@ -563,19 +476,19 @@ components: MnsAgent: $ref: '#/components/schemas/MnsAgent-Multiple' PerfMetricJob: - $ref: '#/components/schemas/PerfMetricJob-Multiple' + $ref: 'TS28623_PmControlNrm.yaml#/components/schemas/PerfMetricJob-Multiple' ThresholdMonitor: - $ref: '#/components/schemas/ThresholdMonitor-Multiple' + $ref: 'TS28623_ThresholdMonitorNrm.yaml#/components/schemas/ThresholdMonitor-Multiple' TraceJob: $ref: 'TS28623_TraceControlNrm.yaml#/components/schemas/TraceJob-Multiple' NtfSubscriptionControl: - $ref: '#/components/schemas/NtfSubscriptionControl-Multiple' + $ref: 'TS28623_SubscriptionControlNrm.yaml#/components/schemas/NtfSubscriptionControl-Multiple' AlarmList: - $ref: '#/components/schemas/AlarmList-Single' + $ref: 'TS28111_FaultNrm.yaml#/components/schemas/AlarmList-Single' FileDownloadJob: - $ref: '#/components/schemas/FileDownloadJob-Multiple' + $ref: 'TS28623_FileManagementNrm.yaml#/components/schemas/FileDownloadJob-Multiple' Files: - $ref: '#/components/schemas/Files-Multiple' + $ref: 'TS28623_FileManagementNrm.yaml#/components/schemas/Files-Multiple' Scheduler: $ref: '#/components/schemas/Scheduler-Multiple' ConditionMonitor: @@ -583,7 +496,7 @@ components: SupportedNotifications: $ref: '#/components/schemas/SupportedNotifications-Single' QMCJobs: - $ref: '#/components/schemas/QMCJob-Multiple' + $ref: 'TS28623_QoEMeasurementCollectionNrm.yaml#/components/schemas/QMCJob-Multiple' #-------- Definition of abstract IOCs -------------------------------------------- @@ -626,9 +539,9 @@ components: type: object properties: PerfMetricJob: - $ref: '#/components/schemas/PerfMetricJob-Multiple' + $ref: 'TS28623_PmControlNrm.yaml#/components/schemas/PerfMetricJob-Multiple' ThresholdMonitor: - $ref: '#/components/schemas/ThresholdMonitor-Multiple' + $ref: 'TS28623_ThresholdMonitorNrm.yaml#/components/schemas/ThresholdMonitor-Multiple' ManagedNFService: $ref: '#/components/schemas/ManagedNFService-Multiple' TraceJob: @@ -720,248 +633,6 @@ components: properties: dnPrefix: type: string - PerfMetricJob-Single: - allOf: - - $ref: '#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - not: - required: [ conditionMonitorRef, schedulerRef ] - properties: - administrativeState: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' - operationalState: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/OperationalState' - jobId: - type: string - performanceMetrics: - type: array - items: - type: string - granularityPeriod: - type: integer - minimum: 1 - objectInstances: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - rootObjectInstances: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - conditionMonitorRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - schedulerRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - reportingCtrl: - $ref: '#/components/schemas/ReportingCtrl' - Files: - $ref: '#/components/schemas/Files-Multiple' - - ThresholdMonitor-Single: - allOf: - - $ref: '#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - administrativeState: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' - operationalState: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/OperationalState' - thresholdInfoList: - type: array - items: - $ref: '#/components/schemas/ThresholdInfo' - monitorGranularityPeriod: - type: integer - minimum: 1 - objectInstances: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - rootObjectInstances: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' - NtfSubscriptionControl-Single: - allOf: - - $ref: '#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - notificationRecipientAddress: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' - notificationTypes: - type: array - items: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationType' - scope: - $ref: '#/components/schemas/Scope' - notificationFilter: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Filter' - HeartbeatControl: - $ref: '#/components/schemas/HeartbeatControl-Single' - HeartbeatControl-Single: - allOf: - - $ref: '#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - heartbeatNtfPeriod: - type: integer - minimum: 0 - triggerHeartbeatNtf: - type: boolean - - ManagementDataCollection-Single: - allOf: - - $ref: '#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - managementData: - $ref: '#/components/schemas/ManagementData' - targetNodeFilter: - $ref: '#/components/schemas/NodeFilter' - collectionTimeWindow: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeWindow' - reportingCtrl: - $ref: '#/components/schemas/ReportingCtrl' - dataScope: - type: string - enum: - - SNSSAI - - 5QI - - PLMN - AlarmList-Single: - allOf: - - $ref: '#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - administrativeState: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' - operationalState: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/OperationalState' - numOfAlarmRecords: - type: integer - lastModification: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' - alarmRecords: - description: >- - This resource represents a map of alarm records. - The alarmIds are used as keys in the map. - type: object - additionalProperties: - $ref: 'TS28532_FaultMnS.yaml#/components/schemas/AlarmRecord' - FileDownloadJob-Single: - allOf: - - $ref: '#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - fileLocation: - type: string - notificationRecipientAddress: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' - cancelJob: - type: string - enum: - - TRUE - - FALSE - jobMonitor: - $ref: '#/components/schemas/FileDownloadJobProcessMonitor' - Files-Single: - allOf: - - $ref: '#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - numberOfFiles: - type: integer - jobRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - jobId: - type: string - File: - $ref: '#/components/schemas/File-Multiple' - File-Single: - allOf: - - $ref: '#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - fileLocation: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' - fileCompression: - type: string - fileSize: - type: integer - fileDataType: - type: string - enum: - - PERFORMANCE - - TRACE - - ANALYTICS - - PROPRIETARY - fileFormat: - type: string - fileReadyTime: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' - fileExpirationTime: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' - fileContent: - type: string - jobRef: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - jobId: - type: string - MnsRegistry-Single: - allOf: - - $ref: '#/components/schemas/Top' - - type: object - properties: - MnsInfo: - $ref: '#/components/schemas/MnsInfo-Multiple' - - MnsInfo-Single: - allOf: - - $ref: '#/components/schemas/Top' - - type: object - properties: - mnsLabel: - type: string - mnsType: - type: string - enum: - - ProvMnS - - FaultSupervisionMnS - - StreamingDataReportingMnS - - FileDataReportingMnS - mnsVersion: - type: string - mnsAddress: - description: Resource URI as defined in the relevant Technical Specification - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' - mnsScope: - description: >- - List of the managed object instances that can be accessed using the MnS. - If a complete SubNetwork can be accessed using the MnS, this attribute may - contain the DN of the SubNetwork instead of the DNs of the individual managed - entities within the SubNetwork. - type: array - items: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' Scheduler-Single: allOf: - $ref: '#/components/schemas/Top' @@ -1011,51 +682,34 @@ components: - HTTP_VES_ENCAPS minItems: 1 - QMCJob-Single: + + SubNetwork-Single: + allOf: + - $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' + - $ref: 'TS28317_RanScNrm.yaml#/components/schemas/SubNetwork-ncO-RanScNrm' + - $ref: 'TS28536_CoslaNrm.yaml#/components/schemas/SubNetwork-ncO-CoslaNrm' + - $ref: 'TS28538_EdgeNrm.yaml#/components/schemas/SubNetwork-ncO-EdgeNrm' + - $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' + + ManagedElement-Single: allOf: - $ref: '#/components/schemas/Top' - - type: object - properties: - attributes: - type: object - properties: - serviceType: - type: string - enum: - - DASH - - MTSI - - VR - areaScope: - type: array - items: - $ref: '#/components/schemas/AreaScope' - qoECollectionEntityAddress: - $ref: '#/components/schemas/IpAddr' - pLMNTarget: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' - qoETarget: - type: string - qoEReference: - type: string - jobId: - type: string - sliceScope: - type: array - items: - $ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai' - qMCConfigFile: - type: string - mDTAlignmentInformation: - $ref: 'TS28623_TraceControlNrm.yaml#/components/schemas/traceReference-Type' - availableRANqoEMetrics: - type: array - items: - type: string - enum: - - APPLAYERBUFFERLEVELLIST - - PLAYOUTDELAYFORMEDIA_STARTUP - minItems: 0 - maxItems: 2 + - $ref: '#/components/schemas/ManagedElement-Attr' + - $ref: '#/components/schemas/ManagedElement-ncO' + - $ref: 'TS28104_MdaNrm.yaml#/components/schemas/ManagedElement-ncO-MdaNrm' + - $ref: 'TS28105_AiMlNrm.yaml#/components/schemas/ManagedElement-ncO-AiMlNrm' + - $ref: 'TS28536_CoslaNrm.yaml#/components/schemas/ManagedElement-ncO-CoslaNrm' + - $ref: 'TS28541_NrNrm.yaml#/components/schemas/ManagedElement-ncO-NrNrm' + - $ref: 'TS28541_5GcNrm.yaml#/components/schemas/ManagedElement-ncO-5GcNrm' #-------- Definition of YAML arrays for name-contained IOCs ---------------------- @@ -1079,38 +733,6 @@ components: type: array items: $ref: '#/components/schemas/MeContext-Single' - PerfMetricJob-Multiple: - type: array - items: - $ref: '#/components/schemas/PerfMetricJob-Single' - ThresholdMonitor-Multiple: - type: array - items: - $ref: '#/components/schemas/ThresholdMonitor-Single' - ManagementDataCollection-Multiple: - type: array - items: - $ref: '#/components/schemas/ManagementDataCollection-Single' - NtfSubscriptionControl-Multiple: - type: array - items: - $ref: '#/components/schemas/NtfSubscriptionControl-Single' - FileDownloadJob-Multiple: - type: array - items: - $ref: '#/components/schemas/FileDownloadJob-Single' - Files-Multiple: - type: array - items: - $ref: '#/components/schemas/Files-Single' - File-Multiple: - type: array - items: - $ref: '#/components/schemas/File-Single' - MnsInfo-Multiple: - type: array - items: - $ref: '#/components/schemas/MnsInfo-Single' Scheduler-Multiple: type: array items: @@ -1119,10 +741,15 @@ components: type: array items: $ref: '#/components/schemas/ConditionMonitor-Single' - QMCJob-Multiple: + SubNetwork-Multiple: + type: array + items: + $ref: '#/components/schemas/SubNetwork-Single' + ManagedElement-Multiple: type: array items: - $ref: '#/components/schemas/QMCJob-Single' + $ref: '#/components/schemas/ManagedElement-Single' + #-------- Definitions in TS 28.623 for TS 28.532 --------------------------------- @@ -1130,29 +757,12 @@ components: oneOf: - $ref: '#/components/schemas/VsDataContainer-Single' - - $ref: '#/components/schemas/ManagementNode-Single' - $ref: '#/components/schemas/MnsAgent-Single' - $ref: '#/components/schemas/MeContext-Single' - - $ref: '#/components/schemas/ManagedNFService-Single' - - - $ref: '#/components/schemas/PerfMetricJob-Single' - - $ref: '#/components/schemas/ThresholdMonitor-Single' - - $ref: '#/components/schemas/ManagementDataCollection-Single' - - - $ref: '#/components/schemas/NtfSubscriptionControl-Single' - - $ref: '#/components/schemas/HeartbeatControl-Single' - - - $ref: '#/components/schemas/AlarmList-Single' - - - $ref: '#/components/schemas/FileDownloadJob-Single' - - $ref: '#/components/schemas/Files-Single' - - $ref: '#/components/schemas/File-Single' - - - $ref: '#/components/schemas/MnsRegistry-Single' - - $ref: '#/components/schemas/MnsInfo-Single' - $ref: '#/components/schemas/Scheduler-Single' - $ref: '#/components/schemas/ConditionMonitor-Single' - - $ref: '#/components/schemas/SupportedNotifications-Single' - - $ref: '#/components/schemas/QMCJob-Single' + - $ref: '#/components/schemas/SupportedNotifications-Single' + - $ref: '#/components/schemas/SubNetwork-Single' + - $ref: '#/components/schemas/ManagedElement-Single' diff --git a/OpenAPI/TS28623_ManagementDataCollectionNrm.yaml b/OpenAPI/TS28623_ManagementDataCollectionNrm.yaml new file mode 100644 index 0000000000000000000000000000000000000000..185272364845362b9300407f310bcb572f64d26c --- /dev/null +++ b/OpenAPI/TS28623_ManagementDataCollectionNrm.yaml @@ -0,0 +1,84 @@ +openapi: 3.0.1 +info: + title: Management Data Collection NRM + version: 18.6.0 + description: >- + OAS 3.0.1 definition of the Management Data Collection NRM fragment + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.623; Generic NRM, Management Data Collection NRM + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/ +paths: {} +components: + schemas: +#-------- Definition of types----------------------------------------------------- + + ManagementData: + oneOf: + - type: array + items: + type: string + enum: + - COVERAGE + - CAPACITY + - ENERGY_EFFICIENCY + - MOBILITY + - ACCESSIBILITY + - type: array + items: + type: string + NodeFilter: + type: object + properties: + areaOfInterest: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AreaOfInterest' + networkDomain: + type: string + enum: + - CN + - RAN + cpUpType: + type: string + enum: + - CP + - UP + sst: + type: integer +#-------- Definition of concrete IOCs -------------------------------------------- + + ManagementDataCollection-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + managementData: + $ref: '#/components/schemas/ManagementData' + targetNodeFilter: + $ref: '#/components/schemas/NodeFilter' + collectionTimeWindow: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeWindow' + reportingCtrl: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ReportingCtrl' + dataScope: + type: string + enum: + - SNSSAI + - 5QI + - PLMN + +#-------- Definition of YAML arrays for name-contained IOCs ---------------------- + ManagementDataCollection-Multiple: + type: array + items: + $ref: '#/components/schemas/ManagementDataCollection-Single' + +#-------- Definitions in TS 28.623 for TS 28.532 --------------------------------- + resources-mgmtDataCollectionNrm: + oneOf: + - $ref: '#/components/schemas/ManagementDataCollection-Single' + + diff --git a/OpenAPI/TS28623_MnSRegistryNrm.yaml b/OpenAPI/TS28623_MnSRegistryNrm.yaml new file mode 100644 index 0000000000000000000000000000000000000000..a5a022a43f8b576e39191a012fce3acccae370d9 --- /dev/null +++ b/OpenAPI/TS28623_MnSRegistryNrm.yaml @@ -0,0 +1,67 @@ +openapi: 3.0.1 +info: + title: MnS Registry NRM + version: 18.6.0 + description: >- + OAS 3.0.1 definition of the MnS Registry NRM fragment + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.623; Generic NRM, MnS Registry NRM + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/ +paths: {} +components: + schemas: +#-------- Definition of types----------------------------------------------------- + +#-------- Definition of concrete IOCs -------------------------------------------- + MnsRegistry-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + MnsInfo: + $ref: '#/components/schemas/MnsInfo-Multiple' + + MnsInfo-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + mnsLabel: + type: string + mnsType: + type: string + enum: + - ProvMnS + - FaultSupervisionMnS + - StreamingDataReportingMnS + - FileDataReportingMnS + mnsVersion: + type: string + mnsAddress: + description: Resource URI as defined in the relevant Technical Specification + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' + mnsScope: + description: >- + List of the managed object instances that can be accessed using the MnS. + If a complete SubNetwork can be accessed using the MnS, this attribute may + contain the DN of the SubNetwork instead of the DNs of the individual managed + entities within the SubNetwork. + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + +#-------- Definition of YAML arrays for name-contained IOCs ---------------------- + + MnsInfo-Multiple: + type: array + items: + $ref: '#/components/schemas/MnsInfo-Single' + + +#-------- Definitions in TS 28.623 for TS 28.532 --------------------------------- + resources-mnSRegistryNrm: + oneOf: + - $ref: '#/components/schemas/MnsInfo-Single' + - $ref: '#/components/schemas/MnsRegistry-Single' diff --git a/OpenAPI/TS28623_PmControlNrm.yaml b/OpenAPI/TS28623_PmControlNrm.yaml new file mode 100644 index 0000000000000000000000000000000000000000..23581d77711c1ee2a42c43c17f6ff70ea80a265c --- /dev/null +++ b/OpenAPI/TS28623_PmControlNrm.yaml @@ -0,0 +1,64 @@ +openapi: 3.0.1 +info: + title: PM control NRM + version: 18.6.0 + description: >- + OAS 3.0.1 definition of the PM control NRM fragment + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.623; Generic NRM,PM control NRM + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/ +paths: {} +components: + schemas: +#-------- Definition of types----------------------------------------------------- + + +#-------- Definition of concrete IOCs -------------------------------------------- + PerfMetricJob-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + not: + required: [ conditionMonitorRef, schedulerRef ] + properties: + administrativeState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' + operationalState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/OperationalState' + jobId: + type: string + performanceMetrics: + type: array + items: + type: string + granularityPeriod: + type: integer + minimum: 1 + objectInstances: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + rootObjectInstances: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + conditionMonitorRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + schedulerRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + reportingCtrl: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ReportingCtrl' + Files: + $ref: 'TS28623_FileManagementNrm.yaml#/components/schemas/Files-Multiple' + +#-------- Definition of YAML arrays for name-contained IOCs ---------------------- + PerfMetricJob-Multiple: + type: array + items: + $ref: '#/components/schemas/PerfMetricJob-Single' + +#-------- Definitions in TS 28.623 for TS 28.532 --------------------------------- + resources-pmControlNrm: + oneOf: + - $ref: '#/components/schemas/PerfMetricJob-Single' diff --git a/OpenAPI/TS28623_QoEMeasurementCollectionNrm.yaml b/OpenAPI/TS28623_QoEMeasurementCollectionNrm.yaml new file mode 100644 index 0000000000000000000000000000000000000000..27c4f7d1eab84bd70e3e6466d16a719c99ba232d --- /dev/null +++ b/OpenAPI/TS28623_QoEMeasurementCollectionNrm.yaml @@ -0,0 +1,75 @@ +openapi: 3.0.1 +info: + title: QoE Measurement Collection NRM + version: 18.6.0 + description: >- + OAS 3.0.1 definition of the QoE Measurement Collection NRM + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.623; Generic NRM,QoE Measurement Collection NRM fragment + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/ +paths: {} +components: + schemas: +#-------- Definition of types----------------------------------------------------- + +#-------- Definition of concrete IOCs -------------------------------------------- + QMCJob-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + serviceType: + type: string + enum: + - DASH + - MTSI + - VR + areaScope: + type: array + items: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/AreaScope' + qoECollectionEntityAddress: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/IpAddr' + pLMNTarget: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId' + qoETarget: + type: string + qoEReference: + type: string + jobId: + type: string + sliceScope: + type: array + items: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai' + qMCConfigFile: + type: string + mDTAlignmentInformation: + $ref: 'TS28623_TraceControlNrm.yaml#/components/schemas/traceReference-Type' + availableRANqoEMetrics: + type: array + items: + type: string + enum: + - APPLAYERBUFFERLEVELLIST + - PLAYOUTDELAYFORMEDIA_STARTUP + minItems: 0 + maxItems: 2 + + +#-------- Definition of YAML arrays for name-contained IOCs ---------------------- + + QMCJob-Multiple: + type: array + items: + $ref: '#/components/schemas/QMCJob-Single' + +#-------- Definitions in TS 28.623 for TS 28.532 --------------------------------- + resources-qoEMeasuremetCollectionNrm: + oneOf: + - $ref: '#/components/schemas/QMCJob-Single' diff --git a/OpenAPI/TS28623_SubscriptionControlNrm.yaml b/OpenAPI/TS28623_SubscriptionControlNrm.yaml new file mode 100644 index 0000000000000000000000000000000000000000..750d318331e881f9a1a03aa03cca16ab5a93ebe4 --- /dev/null +++ b/OpenAPI/TS28623_SubscriptionControlNrm.yaml @@ -0,0 +1,75 @@ +openapi: 3.0.1 +info: + title: Subscription Control NRM + version: 18.2.0 + description: >- + OAS 3.0.1 definition of the Subscription Control NRM fragment + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.623; Generic NRM, Subscription Control NRM + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/ +paths: {} +components: + schemas: +#-------- Definition of types----------------------------------------------------- + Scope: + type: object + properties: + scopeType: + type: string + enum: + - BASE_ONLY + - BASE_ALL + - BASE_NTH_LEVEL + - BASE_SUBTREE + scopeLevel: + type: integer + +#-------- Definition of concrete IOCs -------------------------------------------- + NtfSubscriptionControl-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + notificationRecipientAddress: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' + notificationTypes: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationType' + scope: + $ref: '#/components/schemas/Scope' + notificationFilter: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Filter' + HeartbeatControl: + $ref: '#/components/schemas/HeartbeatControl-Single' + HeartbeatControl-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + heartbeatNtfPeriod: + type: integer + minimum: 0 + triggerHeartbeatNtf: + type: boolean + +#-------- Definition of YAML arrays for name-contained IOCs ---------------------- + NtfSubscriptionControl-Multiple: + type: array + items: + $ref: '#/components/schemas/NtfSubscriptionControl-Single' + + +#-------- Definitions in TS 28.623 for TS 28.532 --------------------------------- + resources-subscriptionControlNrm: + oneOf: + - $ref: '#/components/schemas/NtfSubscriptionControl-Single' + - $ref: '#/components/schemas/HeartbeatControl-Single' \ No newline at end of file diff --git a/OpenAPI/TS28623_ThresholdMonitorNrm.yaml b/OpenAPI/TS28623_ThresholdMonitorNrm.yaml new file mode 100644 index 0000000000000000000000000000000000000000..d4fd1aac13b8626765a66fec90517223ecfea802 --- /dev/null +++ b/OpenAPI/TS28623_ThresholdMonitorNrm.yaml @@ -0,0 +1,76 @@ +openapi: 3.0.1 +info: + title: Threshold Monitor NRM + version: 18.2.0 + description: >- + OAS 3.0.1 definition of the Threshold Monitor NRM fragment + © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.623; Generic NRM,Threshold Monitor NRM + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/ +paths: {} +components: + schemas: +#-------- Definition of types----------------------------------------------------- + ThresholdInfo: + type: object + properties: + performanceMetrics: + type: array + items: + type: string + thresholdDirection: + type: string + enum: + - UP + - DOWN + - UP_AND_DOWN + thresholdValue: + oneOf: + - type: integer + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Float' + hysteresis: + oneOf: + - type: integer + minimum: 0 + - type: number + format: float + + +#-------- Definition of concrete IOCs -------------------------------------------- + ThresholdMonitor-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + administrativeState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' + operationalState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/OperationalState' + thresholdInfoList: + type: array + items: + $ref: '#/components/schemas/ThresholdInfo' + monitorGranularityPeriod: + type: integer + minimum: 1 + objectInstances: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + rootObjectInstances: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + + +#-------- Definition of YAML arrays for name-contained IOCs ---------------------- + ThresholdMonitor-Multiple: + type: array + items: + $ref: '#/components/schemas/ThresholdMonitor-Single' + +#-------- Definitions in TS 28.623 for TS 28.532 --------------------------------- + resources-thresholdMonitorNrm: + oneOf: + - $ref: '#/components/schemas/ThresholdMonitor-Single' diff --git a/OpenAPI/TS28623_TraceControlNrm.yaml b/OpenAPI/TS28623_TraceControlNrm.yaml index 340072563d03f6b6c931bc4486b9394fd5564ecd..fb231f448635097042cd2aa803e25bf0a6461de2 100644 --- a/OpenAPI/TS28623_TraceControlNrm.yaml +++ b/OpenAPI/TS28623_TraceControlNrm.yaml @@ -1,13 +1,13 @@ openapi: 3.0.1 info: title: Trace Control NRM - version: 18.5.0 + version: 18.6.0 description: >- OAS 3.0.1 definition of the Trace Control NRM fragment © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 28.623; Generic NRM:Trace Control NRM + description: 3GPP TS 28.623; Generic NRM,Trace Control NRM url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/ paths: {} components: @@ -21,10 +21,14 @@ components: - IMMEDIATE_MDT_ONLY - LOGGED_MDT_ONLY - TRACE_ONLY - - IMMEDIATE_MDT AND TRACE + - IMMEDIATE_MDT_AND_TRACE - RLF_REPORT_ONLY - RCEF_REPORT_ONLY - LOGGED_MBSFN_MDT + - 5GC_UE_LEVEL_MEASUREMENTS_ONLY + - TRACE_AND_5GC_UE_LEVEL_MEASUREMENTS + - IMMEDIATE_MDT_AND_5GC_UE_LEVEL_MEASUREMENTS + - TRACE_AND_IMMEDIATE_MDT_AND_5GC_UE_LEVEL_MEASUREMENTS listOfInterfaces-Type: description: The interfaces to be recorded in the Network Element. See 3GPP TS 32.422 clause 5.5 for additional details. @@ -1363,6 +1367,22 @@ components: $ref: '#/components/schemas/immediateMDTConfig-Type' loggedMDTConfig: $ref: '#/components/schemas/loggedMDTConfig-Type' + + UEMeasConfig-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: + type: string + ueMeasGranularityPeriod: + type: integer + nfTypeToMeasure: + type: string + objectInstances: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + rootObjectInstances: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + AreaScope: oneOf: - type: array @@ -1444,6 +1464,8 @@ components: $ref: '#/components/schemas/traceConfig-Type' mdtConfig: $ref: '#/components/schemas/mdtConfig-Type' + ueMeasConfig: + $ref: '#/components/schemas/UEMeasConfig-Type' #-------- end of Definition of types used in Trace control NRM fragment ---------- @@ -1456,7 +1478,7 @@ components: attributes: $ref: '#/components/schemas/TraceJob-Attr' Files: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Files-Multiple' + $ref: 'TS28623_FileManagementNrm.yaml#/components/schemas/Files-Multiple' #-------- Definition of YAML arrays for name-contained IOCs ---------------------- @@ -1465,6 +1487,6 @@ components: items: $ref: '#/components/schemas/TraceJob-Single' #-------- Definitions in TS 28.623 for TS 28.532 --------------------------------- - resources-TraceControlNrm: + resources-traceControlNrm: oneOf: - $ref: '#/components/schemas/TraceJob-Single'