From 82a4d253986d33102cdfde81e766e087b8d2815b Mon Sep 17 00:00:00 2001 From: ruiyue Date: Sat, 28 Oct 2023 08:26:26 +0000 Subject: [PATCH 1/5] Update file TS28312_IntentNrm.yaml --- OpenAPI/TS28312_IntentNrm.yaml | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/OpenAPI/TS28312_IntentNrm.yaml b/OpenAPI/TS28312_IntentNrm.yaml index 55eae9617..9d5557a46 100644 --- a/OpenAPI/TS28312_IntentNrm.yaml +++ b/OpenAPI/TS28312_IntentNrm.yaml @@ -15,7 +15,7 @@ components: #-------Definition of generic IOCs ----------# - SubNetwork-Single: + SubNetwork-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object @@ -31,6 +31,8 @@ components: $ref: '#/components/schemas/IntentHandlingFunction-Multiple' Intent-Single: + description: >- + This IOC represents the properties of an Intent driven management information between MnS consumer and MnS producer. allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object @@ -58,12 +60,19 @@ components: enum: - ACTIVATED - DEACTIVATED + description: >- + It describes the intent administrative state. + This attribute is used when MnS consumer-suspension mechanism is supported intentPriority: type: integer observationPeriod: type: integer + description: It represents the observation period of the fulfilmentInfo for corresponding ExpectationTargets, IntentExpectations and Intent. intentReportReference: - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + description: >- + It indicates the associated intent report instance.The observation period can be set by the + MnS consumer or by the MnS producer if the MnS consumer does not provide a value IntentReport-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' -- GitLab From 26e83f4cf280b0e046a49134e2d0792692bd9f8c Mon Sep 17 00:00:00 2001 From: ruiyue Date: Sat, 28 Oct 2023 08:30:21 +0000 Subject: [PATCH 2/5] Update file TS28312_IntentNrm.yaml --- OpenAPI/TS28312_IntentNrm.yaml | 3 --- 1 file changed, 3 deletions(-) diff --git a/OpenAPI/TS28312_IntentNrm.yaml b/OpenAPI/TS28312_IntentNrm.yaml index 9d5557a46..8844b2d2d 100644 --- a/OpenAPI/TS28312_IntentNrm.yaml +++ b/OpenAPI/TS28312_IntentNrm.yaml @@ -70,9 +70,6 @@ components: description: It represents the observation period of the fulfilmentInfo for corresponding ExpectationTargets, IntentExpectations and Intent. intentReportReference: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - description: >- - It indicates the associated intent report instance.The observation period can be set by the - MnS consumer or by the MnS producer if the MnS consumer does not provide a value IntentReport-Single: allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' -- GitLab From 695a0158a9c3a821e6e95ca6570169e96c9b9808 Mon Sep 17 00:00:00 2001 From: ruiyue Date: Mon, 30 Oct 2023 01:43:38 +0000 Subject: [PATCH 3/5] Update file TS28312_IntentNrm.yaml --- OpenAPI/TS28312_IntentNrm.yaml | 77 ++++++++++++++++++++++++---------- 1 file changed, 54 insertions(+), 23 deletions(-) diff --git a/OpenAPI/TS28312_IntentNrm.yaml b/OpenAPI/TS28312_IntentNrm.yaml index 8844b2d2d..ee7f74ce9 100644 --- a/OpenAPI/TS28312_IntentNrm.yaml +++ b/OpenAPI/TS28312_IntentNrm.yaml @@ -55,6 +55,9 @@ components: type: array items: $ref: '#/components/schemas/IntentContext' + description: >- + It describes the list of IntentContext(s) which represents the constraints and conditions that should apply + for the entire intent even if there may be specific contexts defined for specific parts of the intent intentAdminState: type: string enum: @@ -67,10 +70,13 @@ components: type: integer observationPeriod: type: integer - description: It represents the observation period of the fulfilmentInfo for corresponding ExpectationTargets, IntentExpectations and Intent. + description: >- + It represents the observation period of the fulfilmentInfo for corresponding + ExpectationTargets, IntentExpectations and Intent. intentReportReference: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' IntentReport-Single: + description: It represents intent report information from MnS producer to MnS consumer. allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object @@ -83,11 +89,14 @@ components: $ref: '#/components/schemas/IntentConflictReport' intentFeasibilityCheckReport: $ref: '#/components/schemas/IntentFeasibilityCheckReport' - lastUpdated: + lastUpdatedTime: $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' intentReference: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' IntentHandlingFunction-Single: + description: >- + It represents the intent handling capabilities can be supported by a specific inteng + handling function of MnS producer. allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object @@ -107,10 +116,12 @@ components: IntentExpectation: description: >- This data type is the "IntentExpectation" data type without specialisations + It represents MnS consumer's requirements, goals and contexts given to a 3GPP system type: object properties: expectationId: type: string + description: A unique identifier of the intentExpectation within the intent. expectationVerb: $ref: "#/components/schemas/ExpectationVerb" expectationObject: @@ -132,6 +143,7 @@ components: #-------Definition of the generic ExpectationObject dataType ----------# ExpectationObject: description: >- + It represents the Object to which the IntentExpectation should apply. This data type is the "ExpectationObject" data type without specialisations type: object properties: @@ -143,12 +155,13 @@ components: - 5GC_SubNetwork #value for 5GC Network Expectation--# objectInstance: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - contextSelectivity: - $ref: "#/components/schemas/Selectivity" objectContexts: type: array items: - $ref: '#/components/schemas/ObjectContext' + $ref: '#/components/schemas/ObjectContext' + description: >- + It describes the list of ObjectContext(s) which represents the constraints and conditions to be + used as filter information to identify the object(s) to which a given intentExpectation should apply. #-------Definition of the generic ExpectationObject dataType ----------# @@ -172,12 +185,13 @@ components: - ALL_OF - ONE_OF - ANY_OF - FulfilStatus: + FulfilmentStatus: type: string readOnly: true enum: - FULFILLED - NOT_FULFILLED + description: It describes the current status of the intent fulfilment result. NotFulfilledState: type: string readOnly: true @@ -188,25 +202,31 @@ components: - SUSPENDED - TERMINATED - FULFILMENTFAILED + description: It describes the current progress of or the reason for not achieving fulfilment + for the intent, intentExpectation or expectationTarget. + An attribute which is used when FulfilmentInfo is implemented for IntentFulfilmentInfo FulfilmentInfo: + description: >- + This dataType represents the properties of a specific fulfilment information for an aspect of + the intent (i.e. either an expectation, a target or the whole intent). type: object properties: - fulfilStatus: - $ref: '#/components/schemas/FulfilStatus' + fulfilmentStatus: + $ref: '#/components/schemas/FulfilmentStatus' notFullfilledState: - description: -> - An attribute which is used when FulfilmentInfo is implemented for IntentFulfilmentInfo $ref: "#/components/schemas/NotFulfilledState" notFulfilledReasons: - description: -> - An attribute which is used when FulfilmentInfo is implemented for IntentFulfilmentInfo - type: string - readOnly: true + type: array + items: + type: string + readOnly: true + description: An attribute which is used when FulfilmentInfo is implemented for IntentFulfilmentInfo ExpectationVerb: type: string enum: - DELIVER - ENSURE + description: It describes the characteristic of the intentExpectation and is the property that describes the types of intentExpectations. ValueRangeType: oneOf: - type: number @@ -241,6 +261,7 @@ components: #-------Definition of the generic ExpectationTarget dataType----------# ExpectationTarget: description: >- + This data type represents the target of the IntentExpectation that are required to be achieved. This data type is the "ExpectationTarget" data type without specialisations type: object properties: @@ -260,6 +281,7 @@ components: type: array items: $ref: '#/components/schemas/TargetContext' + description: It describes the list of constraints and conditions that should apply for a specific expectationTarget. TargetContext: description: >- This data type is the "TargetContext" data type without specialisations @@ -315,7 +337,8 @@ components: #-------Definition of the generic IntentFulfilmentReport dataType----------------# IntentFulfilmentReport: description: >- - This data type is the "IntentFulfilmentReport" data type without specialisations + It includes the intentFulfilmentInfo and expectationFulfilmetResult. + This attribute shall be supported when intent fulfilment information is supported by IntentReport type: object properties: intentFulfilmentInfo: @@ -329,7 +352,7 @@ components: #-------Definition of the generic ExpectationFulfilmentResult dataType----------------# ExpectationFulfilmentResult: description: >- - This data type is the "ExpectationFulfilmentResult" data type without specialisations + It includes the expectationFulfilmentInfo and targetFulfilmetResults for each IntentExpectation. type: object properties: expectaitonId: @@ -345,7 +368,7 @@ components: #-------Definition of the generic TargetFulfilmentResult dataType----------------# TargetFulfilmentResult: description: >- - This data type is the "TargetFulfilmentResult" data type without specialisations + This data type includes targetFulfilmentInfo and targetAchievedValue for each ExpectationTarget. type: object properties: targetName: @@ -359,7 +382,8 @@ components: #-------Definition of the generic IntentConflictReport dataType----------------# IntentConflictReport: description: >- - This data type is the "IntentConflictReport" data type without specialisations + It represents the conflict information for the detected conflict + This attribute shall be supported when intent conflict information is supported by IntentReport type: object properties: conflictId: @@ -387,7 +411,8 @@ components: #-------Definition of the generic IntentFeasibilityCheckReport dataType----------------# IntentFeasibilityCheckReport: description: >- - This data type is the "IntentFeasibilityCheckReport" data type without specialisations + It represents the intent feasibility check information + This attribute shall be supported when intent feasibility check information information is supported by IntentReport type: object properties: feasibilityCheckResult: @@ -396,13 +421,15 @@ components: - FEASIBLE - INFEASIBLE infeasibilityReason: - description: -> - An attribute which is used when feasibilityCheckResult is INFEASIBLE type: string + description: An attribute which is used when feasibilityCheckResult is INFEASIBLE #-------Definition of the concrete IntentFeasibilityCheckReport dataType----------------# #-------Definition of the generic IntentHandlingCapability dataType----------------# IntentHandlingCapability: + description: >- + It represents expectation object information and expectation target information + which can be supported by a specific intent handling function of MnS producer. type: object properties: intentHandlingCapabilityId: @@ -413,8 +440,12 @@ components: - RAN_SUBNETWORK - EDGE_SERVICE_SUPPORT - 5GC_SUBNETWORK - supportedExpectationTargetType: - type: string + description: It describes the expectation object type which can be supported by a specific intent handling function of MnS producer. + supportedExpectationTargetNames: + type: array + items: + type: string + description: It describes the supported expectation targets for the supported expectation object type. #-------Definition of the concrete IntentHandlingCapability dataType----------------# #------Definition of JSON arrays for name-contained IOCs ---------------# -- GitLab From 8613a12d495b2fa0e99f7dcce0f7e538fe391920 Mon Sep 17 00:00:00 2001 From: ruiyue Date: Wed, 15 Nov 2023 20:11:16 +0000 Subject: [PATCH 4/5] Update file TS28312_IntentNrm.yaml --- OpenAPI/TS28312_IntentNrm.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/OpenAPI/TS28312_IntentNrm.yaml b/OpenAPI/TS28312_IntentNrm.yaml index ee7f74ce9..406abf6ec 100644 --- a/OpenAPI/TS28312_IntentNrm.yaml +++ b/OpenAPI/TS28312_IntentNrm.yaml @@ -95,7 +95,7 @@ components: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' IntentHandlingFunction-Single: description: >- - It represents the intent handling capabilities can be supported by a specific inteng + It represents the intent handling capabilities can be supported by a specific intent handling function of MnS producer. allOf: - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' -- GitLab From ade6e46be09c7b9ddbee4a05826288e8305896fe Mon Sep 17 00:00:00 2001 From: ruiyue Date: Thu, 16 Nov 2023 05:22:07 +0000 Subject: [PATCH 5/5] Update file TS28312_IntentNrm.yaml --- OpenAPI/TS28312_IntentNrm.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/OpenAPI/TS28312_IntentNrm.yaml b/OpenAPI/TS28312_IntentNrm.yaml index 406abf6ec..29981d385 100644 --- a/OpenAPI/TS28312_IntentNrm.yaml +++ b/OpenAPI/TS28312_IntentNrm.yaml @@ -155,6 +155,8 @@ components: - 5GC_SubNetwork #value for 5GC Network Expectation--# objectInstance: $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + contextSelectivity: + $ref: "#/components/schemas/Selectivity" objectContexts: type: array items: -- GitLab