From acae564f1a6a18456408094decde9de13573ad24 Mon Sep 17 00:00:00 2001 From: SyeddR Date: Thu, 7 Sep 2023 20:42:17 -0400 Subject: [PATCH 1/5] issue_194_PR --- code/API_definitions/qod-api.yaml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/code/API_definitions/qod-api.yaml b/code/API_definitions/qod-api.yaml index 4937bb382d..c7a56d830d 100644 --- a/code/API_definitions/qod-api.yaml +++ b/code/API_definitions/qod-api.yaml @@ -433,6 +433,12 @@ components: description: Attributes required to create a session type: object properties: + applicationConsumerId: + description: | + Identifies the application consumer that initiates a qos session. The ID is systematically relayed to downstream systems, including but not limited to, the Network Exposure Function (NEF) and the Policy Control Function (PCF) within the 5G framework. + The primary utility of this transmission is to facilitate the application of relevant policies, ensuring that the application consumer is appropriately tagged within usage records. + type: string + example: XRapp123 duration: description: | Session duration in seconds. Maximal value of 24 hours is used if not set. From df7ba572fd5360aeea3da497b2fc78a255ef45ed Mon Sep 17 00:00:00 2001 From: SyeddR Date: Mon, 16 Oct 2023 11:58:42 -0400 Subject: [PATCH 2/5] updated application Id --- code/API_definitions/qod-api.yaml | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/code/API_definitions/qod-api.yaml b/code/API_definitions/qod-api.yaml index c7a56d830d..332f62cc54 100644 --- a/code/API_definitions/qod-api.yaml +++ b/code/API_definitions/qod-api.yaml @@ -433,12 +433,7 @@ components: description: Attributes required to create a session type: object properties: - applicationConsumerId: - description: | - Identifies the application consumer that initiates a qos session. The ID is systematically relayed to downstream systems, including but not limited to, the Network Exposure Function (NEF) and the Policy Control Function (PCF) within the 5G framework. - The primary utility of this transmission is to facilitate the application of relevant policies, ensuring that the application consumer is appropriately tagged within usage records. - type: string - example: XRapp123 + duration: description: | Session duration in seconds. Maximal value of 24 hours is used if not set. @@ -872,6 +867,12 @@ components: * `ipv6Address` type: object properties: + applicationId: + description: | + A public identifier that uniquely identifies the application initiating a QoS session. The applicationId is more granular than the clientId, which identifies the unique customer. A client or customer could have one or more applications that need to be tracked. The Id is systematically relayed to downstream systems, including but not limited to, the Network Exposure Function (NEF) and the Policy Control Function (PCF) within the 5G framework. + The primary utility of this transmission is to facilitate the application of relevant policies, ensuring that the application is appropriately tagged within usage records. + type: string + example: XRapp123 ipv4Address: $ref: "#/components/schemas/Ipv4Address" ipv6Address: From ee8fda1d396a92f031e50a8bf0ea33c437262c68 Mon Sep 17 00:00:00 2001 From: SyeddR Date: Wed, 25 Oct 2023 13:00:50 -0400 Subject: [PATCH 3/5] removed empty line 436 --- code/API_definitions/qod-api.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/code/API_definitions/qod-api.yaml b/code/API_definitions/qod-api.yaml index 332f62cc54..52caa66b5f 100644 --- a/code/API_definitions/qod-api.yaml +++ b/code/API_definitions/qod-api.yaml @@ -433,7 +433,6 @@ components: description: Attributes required to create a session type: object properties: - duration: description: | Session duration in seconds. Maximal value of 24 hours is used if not set. From f798b86eca79184ba7df058429790dd3db4a3e8f Mon Sep 17 00:00:00 2001 From: Eric Murray Date: Thu, 26 Oct 2023 16:23:00 +0100 Subject: [PATCH 4/5] Update qod-api.yaml ApplicationServer schema description Clarified that applicationId is not sufficient to identify the application server --- code/API_definitions/qod-api.yaml | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/code/API_definitions/qod-api.yaml b/code/API_definitions/qod-api.yaml index 52caa66b5f..197ee1d2d0 100644 --- a/code/API_definitions/qod-api.yaml +++ b/code/API_definitions/qod-api.yaml @@ -858,12 +858,14 @@ components: ApplicationServer: description: | - A server hosting backend applications to deliver some business logic to clients. + A server hosting backend applications to deliver a service to the identified `device`. - The developer can choose to provide the below specified device identifiers: - + The developer must provide at least one of the following device identifiers: * `ipv4Address` - * `ipv6Address` + * `ipv6Address` + + In addition, the developer can specify an `applicationId` for policy control / audit purposes. The `applicationId` is not sufficient in itself to identity the application server. + type: object properties: applicationId: From f0b5adfdac13e26d2d810a6414e4aaeb44147331 Mon Sep 17 00:00:00 2001 From: Eric Murray Date: Tue, 31 Oct 2023 16:27:57 +0000 Subject: [PATCH 5/5] Update qod-api.yaml Fixed trailing space linter errors --- code/API_definitions/qod-api.yaml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/code/API_definitions/qod-api.yaml b/code/API_definitions/qod-api.yaml index e176a18d4e..9de97cf1fa 100644 --- a/code/API_definitions/qod-api.yaml +++ b/code/API_definitions/qod-api.yaml @@ -859,13 +859,12 @@ components: ApplicationServer: description: | A server hosting backend applications to deliver a service to the identified `device`. - + The developer must provide at least one of the following device identifiers: * `ipv4Address` * `ipv6Address` In addition, the developer can specify an `applicationId` for policy control / audit purposes. The `applicationId` is not sufficient in itself to identity the application server. - type: object properties: applicationId: