From 23b550ae6415e201e2ab50d1b67c50f5d7f78cda Mon Sep 17 00:00:00 2001 From: Shilpa Padgaonkar <77152136+shilpa-padgaonkar@users.noreply.github.com> Date: Mon, 16 Jan 2023 14:27:26 +0100 Subject: [PATCH 01/14] Update Glossary.md This change extends the glossary document so that it not only explains the meaning of the terms already used in the APIs/documentations but also suggests developer friendly alternatives for existing identifiers which if agreed within our Camara project can be replaced from current APIs and documentation --- Commonalities/documentation/Glossary.md | 27 ++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/Commonalities/documentation/Glossary.md b/Commonalities/documentation/Glossary.md index 2ae401e6..613adaa5 100644 --- a/Commonalities/documentation/Glossary.md +++ b/Commonalities/documentation/Glossary.md @@ -1,5 +1,26 @@ # Glossary -| Term | Description | -| ----------- | ----------- | -| Sample Term | Sample description | +| Term | Description | Usage(API/Documentation | Alternative developer-friendly terms | +| ----------- | ----------- | ----------- | ----------- | +| UeId | Identifier for devices | API |device_identifier | +| AsId | Identifier for application server | API |server_identifier | +| ExternalId | Mobile network operator provided identifier | API |? | + + + + + + + + + + + + + + + + + + +#### Note: The above entries are currently just samples provided from the commonalities. We propose the individual subprojects to contribute the concreate terms in the document as deemed fit. From 0dfe52bfa022a14c34eea4201978d449a730461d Mon Sep 17 00:00:00 2001 From: Shilpa Padgaonkar <77152136+shilpa-padgaonkar@users.noreply.github.com> Date: Mon, 16 Jan 2023 14:47:01 +0100 Subject: [PATCH 02/14] Update Glossary.md --- Commonalities/documentation/Glossary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Commonalities/documentation/Glossary.md b/Commonalities/documentation/Glossary.md index 613adaa5..b669e626 100644 --- a/Commonalities/documentation/Glossary.md +++ b/Commonalities/documentation/Glossary.md @@ -23,4 +23,4 @@ -#### Note: The above entries are currently just samples provided from the commonalities. We propose the individual subprojects to contribute the concreate terms in the document as deemed fit. +#### Note: The above entries are just samples provided from the commonalities. We propose the individual subprojects to contribute the concrete terms in the document as deemed fit. From 598d876ba1ca23737d491bb0307c3f933c196a7e Mon Sep 17 00:00:00 2001 From: Shilpa Padgaonkar <77152136+shilpa-padgaonkar@users.noreply.github.com> Date: Mon, 16 Jan 2023 14:49:05 +0100 Subject: [PATCH 03/14] Update Glossary.md --- Commonalities/documentation/Glossary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Commonalities/documentation/Glossary.md b/Commonalities/documentation/Glossary.md index b669e626..aa9f47ee 100644 --- a/Commonalities/documentation/Glossary.md +++ b/Commonalities/documentation/Glossary.md @@ -1,6 +1,6 @@ # Glossary -| Term | Description | Usage(API/Documentation | Alternative developer-friendly terms | +| Term | Description | Usage(API/Documentation) | Alternative developer-friendly terms | | ----------- | ----------- | ----------- | ----------- | | UeId | Identifier for devices | API |device_identifier | | AsId | Identifier for application server | API |server_identifier | From 11781fa58e4f620b5b75043c851216213b6060b6 Mon Sep 17 00:00:00 2001 From: Shilpa Padgaonkar <77152136+shilpa-padgaonkar@users.noreply.github.com> Date: Tue, 17 Jan 2023 10:34:11 +0100 Subject: [PATCH 04/14] Update Glossary.md --- Commonalities/documentation/Glossary.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/Commonalities/documentation/Glossary.md b/Commonalities/documentation/Glossary.md index aa9f47ee..19d38af6 100644 --- a/Commonalities/documentation/Glossary.md +++ b/Commonalities/documentation/Glossary.md @@ -1,10 +1,10 @@ # Glossary -| Term | Description | Usage(API/Documentation) | Alternative developer-friendly terms | -| ----------- | ----------- | ----------- | ----------- | -| UeId | Identifier for devices | API |device_identifier | -| AsId | Identifier for application server | API |server_identifier | -| ExternalId | Mobile network operator provided identifier | API |? | +| Term | Description | Usage in API (Parameter/Field) | Alternative developer-friendly terms | +| ------------ | ----------- | ----------- | ----------- | +| Device Identifier | Identifier for a device | UeId | device_identifier | +| Server Identifier | Identifier for an application server | AsId |server_identifier | +| External Id | Mobile network operator provided identifier | ExternalId |? | @@ -23,4 +23,4 @@ -#### Note: The above entries are just samples provided from the commonalities. We propose the individual subprojects to contribute the concrete terms in the document as deemed fit. +#### Note: The above entries are just samples provided from the commonalities. We propose the individual subprojects to contribute the concrete terms in the document as deemed fit. If the usage in an API is already From dec24fca81c6b38697b958238207091f18b4c362 Mon Sep 17 00:00:00 2001 From: Shilpa Padgaonkar <77152136+shilpa-padgaonkar@users.noreply.github.com> Date: Wed, 18 Jan 2023 08:43:52 +0100 Subject: [PATCH 05/14] Update Glossary.md --- Commonalities/documentation/Glossary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Commonalities/documentation/Glossary.md b/Commonalities/documentation/Glossary.md index 19d38af6..6ec18ea7 100644 --- a/Commonalities/documentation/Glossary.md +++ b/Commonalities/documentation/Glossary.md @@ -23,4 +23,4 @@ -#### Note: The above entries are just samples provided from the commonalities. We propose the individual subprojects to contribute the concrete terms in the document as deemed fit. If the usage in an API is already +#### Note: The above entries are just samples provided from the commonalities. We propose the individual subprojects to contribute the concrete terms in the document as deemed fit. If the usage in an API is already using a developer friendly term, the last column can be left blank. From a4b1731a998a42af1c07516c73a633fccf0ea60f Mon Sep 17 00:00:00 2001 From: PEDRO DIEZ GARCIA Date: Fri, 17 Feb 2023 15:03:15 +0100 Subject: [PATCH 06/14] glossary_contribution_from_CarrierBilling_WG --- Commonalities/documentation/Glossary.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/Commonalities/documentation/Glossary.md b/Commonalities/documentation/Glossary.md index 6ec18ea7..037e1bc0 100644 --- a/Commonalities/documentation/Glossary.md +++ b/Commonalities/documentation/Glossary.md @@ -5,7 +5,11 @@ | Device Identifier | Identifier for a device | UeId | device_identifier | | Server Identifier | Identifier for an application server | AsId |server_identifier | | External Id | Mobile network operator provided identifier | ExternalId |? | - +| Carrier Billing (a.k.a. Direct Carrier Billing) | An online payment process which allows users to make purchases by charging payments against OB Billing Systems, accordingly to the user's configuration in the OB. In a common usage in the industry, the payment is processed on current account balance or charged on next bill generated for this line | N/A | N/A | +| Purchase | The action of acquiring a (set of) good(s)/service(s). Order fulfilment is not triggered from this request as it relies on merchant's responsibility | purchase_id | purchase_identifier | +| Payment | The process of paying for a (set of) good(s)/service(s) | paymentId | payment_identifier | +| 1-STEP Payment | Payment process performed in one phase (i.e. one action), that involves all the OB Carrier Billing Systems checking and trigger the charging request against Billing Systems | N/A | N/A | +| 2-STEP Payment | Payment process performed in two phases (i.e. two actions). First action deals with payment preparation request to guarantee the reservation of the involved amount. Second action is an explicit confirmation or cancellation of the payment by the user. Any payment not confirmed/cancelled by a given user is discarded after some time in order to avoid inconsistency in the billing systems | N/A | N/A | From 308e30d4d975184c8846e7e08eb1c17c5ee0ea88 Mon Sep 17 00:00:00 2001 From: Eric Murray <77291605+eric-murray@users.noreply.github.com> Date: Fri, 17 Feb 2023 16:31:42 +0000 Subject: [PATCH 07/14] Update Glossary.md --- Commonalities/documentation/Glossary.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/Commonalities/documentation/Glossary.md b/Commonalities/documentation/Glossary.md index 037e1bc0..49ecc8f8 100644 --- a/Commonalities/documentation/Glossary.md +++ b/Commonalities/documentation/Glossary.md @@ -10,12 +10,12 @@ | Payment | The process of paying for a (set of) good(s)/service(s) | paymentId | payment_identifier | | 1-STEP Payment | Payment process performed in one phase (i.e. one action), that involves all the OB Carrier Billing Systems checking and trigger the charging request against Billing Systems | N/A | N/A | | 2-STEP Payment | Payment process performed in two phases (i.e. two actions). First action deals with payment preparation request to guarantee the reservation of the involved amount. Second action is an explicit confirmation or cancellation of the payment by the user. Any payment not confirmed/cancelled by a given user is discarded after some time in order to avoid inconsistency in the billing systems | N/A | N/A | - - - - - - +| IP Address | An single internet protocol address, specified using either "dotted-decimal" format (for IPv4) or IETF 5952 format (for IPv6). The source ip address is the ip address of the message sender, and the destination ip address is the ip address of the recipient. The description will make it clear which is required. | `IP` | `ip_address` `source_ip_address` `destination_ip_address` | +| Port | A 16 bit number (in the range 0 - 65535) used by the TCP (IETF RFC 9293) and UDP (IETF RFC 768) protocols to identify different applications flows and services. The source port is the port alloacted to the message sender, and the destination port is the port allocated to the recipient. The description will make it clear which is required. | `Port` | `port` `source_port` `destination_port` | +| Anonymised Subscriber Identifier | A secure, pseudonymized token derived from a hashed/encrypted pseudonymous internal identity linked to a user’s network subscription. This token will allow the API caller to recognize a user without revealing any directly identifiable personal data and thereby enable them to optimize the delivery of online display advertising and perform site/app optimization. | `anonymised_subscriber_identifier` | | +| IMEI | The International Mobile Equipment Identity is a fixed unique neumberic identifier for the physical device connected to a mobile network, such as a mobile phone. It is unrelated to the mobile subscription (identified by the SIM). The format of the IMEI is defined by 3GPP, and a database of allocated IMEIs maintained by the GSMA | `imei` | `mobile_phone_identifier` | +| IMEISV | IMEI with additional Software Version. The software version numbers get updated as the OS on the mobile device is updated, so this number is not constant. The IMEI can be derived from the IMEISV, but not vice-versa | `imei_sv` | `mobile_phone_identifier_with_sv` | +| TAC | Type Allocation Code - an 8 digit identifier for the make, model and revision number of a particular physical mobile device. This identifier forms part of the full IMEI and IMEISV. | `tac` | `mobile_phone_type_allocation_code` | From ab1f68324a375110782590295aa067638853e27c Mon Sep 17 00:00:00 2001 From: PEDRO DIEZ GARCIA Date: Thu, 23 Mar 2023 23:55:50 +0100 Subject: [PATCH 08/14] alignment_carrier_billing_concepts --- Commonalities/documentation/Glossary.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Commonalities/documentation/Glossary.md b/Commonalities/documentation/Glossary.md index 49ecc8f8..3d26c6bd 100644 --- a/Commonalities/documentation/Glossary.md +++ b/Commonalities/documentation/Glossary.md @@ -6,8 +6,8 @@ | Server Identifier | Identifier for an application server | AsId |server_identifier | | External Id | Mobile network operator provided identifier | ExternalId |? | | Carrier Billing (a.k.a. Direct Carrier Billing) | An online payment process which allows users to make purchases by charging payments against OB Billing Systems, accordingly to the user's configuration in the OB. In a common usage in the industry, the payment is processed on current account balance or charged on next bill generated for this line | N/A | N/A | -| Purchase | The action of acquiring a (set of) good(s)/service(s). Order fulfilment is not triggered from this request as it relies on merchant's responsibility | purchase_id | purchase_identifier | -| Payment | The process of paying for a (set of) good(s)/service(s) | paymentId | payment_identifier | +| Purchase | The action of acquiring a (set of) good(s)/service(s). Order fulfilment is not triggered from this request as it relies on merchant's responsibility | purchaseId | `purchase_identifier` | +| Payment | The process of paying for a (set of) good(s)/service(s) | paymentId | `payment_identifier` | | 1-STEP Payment | Payment process performed in one phase (i.e. one action), that involves all the OB Carrier Billing Systems checking and trigger the charging request against Billing Systems | N/A | N/A | | 2-STEP Payment | Payment process performed in two phases (i.e. two actions). First action deals with payment preparation request to guarantee the reservation of the involved amount. Second action is an explicit confirmation or cancellation of the payment by the user. Any payment not confirmed/cancelled by a given user is discarded after some time in order to avoid inconsistency in the billing systems | N/A | N/A | | IP Address | An single internet protocol address, specified using either "dotted-decimal" format (for IPv4) or IETF 5952 format (for IPv6). The source ip address is the ip address of the message sender, and the destination ip address is the ip address of the recipient. The description will make it clear which is required. | `IP` | `ip_address` `source_ip_address` `destination_ip_address` | From f8d1e11fd4c35d5d31d1e992346803729627ecbb Mon Sep 17 00:00:00 2001 From: PEDRO DIEZ GARCIA Date: Thu, 23 Mar 2023 23:59:12 +0100 Subject: [PATCH 09/14] minor_fix_carrier_billing_concepts --- Commonalities/documentation/Glossary.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Commonalities/documentation/Glossary.md b/Commonalities/documentation/Glossary.md index 3d26c6bd..be524746 100644 --- a/Commonalities/documentation/Glossary.md +++ b/Commonalities/documentation/Glossary.md @@ -6,8 +6,8 @@ | Server Identifier | Identifier for an application server | AsId |server_identifier | | External Id | Mobile network operator provided identifier | ExternalId |? | | Carrier Billing (a.k.a. Direct Carrier Billing) | An online payment process which allows users to make purchases by charging payments against OB Billing Systems, accordingly to the user's configuration in the OB. In a common usage in the industry, the payment is processed on current account balance or charged on next bill generated for this line | N/A | N/A | -| Purchase | The action of acquiring a (set of) good(s)/service(s). Order fulfilment is not triggered from this request as it relies on merchant's responsibility | purchaseId | `purchase_identifier` | -| Payment | The process of paying for a (set of) good(s)/service(s) | paymentId | `payment_identifier` | +| Purchase | The action of acquiring a (set of) good(s)/service(s). Order fulfilment is not triggered from this request as it relies on merchant's responsibility | `purchaseId` | `purchase_identifier` | +| Payment | The process of paying for a (set of) good(s)/service(s) | `paymentId` | `payment_identifier` | | 1-STEP Payment | Payment process performed in one phase (i.e. one action), that involves all the OB Carrier Billing Systems checking and trigger the charging request against Billing Systems | N/A | N/A | | 2-STEP Payment | Payment process performed in two phases (i.e. two actions). First action deals with payment preparation request to guarantee the reservation of the involved amount. Second action is an explicit confirmation or cancellation of the payment by the user. Any payment not confirmed/cancelled by a given user is discarded after some time in order to avoid inconsistency in the billing systems | N/A | N/A | | IP Address | An single internet protocol address, specified using either "dotted-decimal" format (for IPv4) or IETF 5952 format (for IPv6). The source ip address is the ip address of the message sender, and the destination ip address is the ip address of the recipient. The description will make it clear which is required. | `IP` | `ip_address` `source_ip_address` `destination_ip_address` | From 18a2b1d9ed5fd90eadc234d848c201ccdf1a83e1 Mon Sep 17 00:00:00 2001 From: Shilpa Padgaonkar <77152136+shilpa-padgaonkar@users.noreply.github.com> Date: Wed, 29 Mar 2023 14:11:56 +0200 Subject: [PATCH 10/14] Consolidaton part1 for glossary --- Commonalities/documentation/Glossary.md | 30 ++++++++++++------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/Commonalities/documentation/Glossary.md b/Commonalities/documentation/Glossary.md index be524746..9f563845 100644 --- a/Commonalities/documentation/Glossary.md +++ b/Commonalities/documentation/Glossary.md @@ -2,20 +2,19 @@ | Term | Description | Usage in API (Parameter/Field) | Alternative developer-friendly terms | | ------------ | ----------- | ----------- | ----------- | -| Device Identifier | Identifier for a device | UeId | device_identifier | -| Server Identifier | Identifier for an application server | AsId |server_identifier | -| External Id | Mobile network operator provided identifier | ExternalId |? | -| Carrier Billing (a.k.a. Direct Carrier Billing) | An online payment process which allows users to make purchases by charging payments against OB Billing Systems, accordingly to the user's configuration in the OB. In a common usage in the industry, the payment is processed on current account balance or charged on next bill generated for this line | N/A | N/A | -| Purchase | The action of acquiring a (set of) good(s)/service(s). Order fulfilment is not triggered from this request as it relies on merchant's responsibility | `purchaseId` | `purchase_identifier` | -| Payment | The process of paying for a (set of) good(s)/service(s) | `paymentId` | `payment_identifier` | -| 1-STEP Payment | Payment process performed in one phase (i.e. one action), that involves all the OB Carrier Billing Systems checking and trigger the charging request against Billing Systems | N/A | N/A | -| 2-STEP Payment | Payment process performed in two phases (i.e. two actions). First action deals with payment preparation request to guarantee the reservation of the involved amount. Second action is an explicit confirmation or cancellation of the payment by the user. Any payment not confirmed/cancelled by a given user is discarded after some time in order to avoid inconsistency in the billing systems | N/A | N/A | -| IP Address | An single internet protocol address, specified using either "dotted-decimal" format (for IPv4) or IETF 5952 format (for IPv6). The source ip address is the ip address of the message sender, and the destination ip address is the ip address of the recipient. The description will make it clear which is required. | `IP` | `ip_address` `source_ip_address` `destination_ip_address` | -| Port | A 16 bit number (in the range 0 - 65535) used by the TCP (IETF RFC 9293) and UDP (IETF RFC 768) protocols to identify different applications flows and services. The source port is the port alloacted to the message sender, and the destination port is the port allocated to the recipient. The description will make it clear which is required. | `Port` | `port` `source_port` `destination_port` | -| Anonymised Subscriber Identifier | A secure, pseudonymized token derived from a hashed/encrypted pseudonymous internal identity linked to a user’s network subscription. This token will allow the API caller to recognize a user without revealing any directly identifiable personal data and thereby enable them to optimize the delivery of online display advertising and perform site/app optimization. | `anonymised_subscriber_identifier` | | -| IMEI | The International Mobile Equipment Identity is a fixed unique neumberic identifier for the physical device connected to a mobile network, such as a mobile phone. It is unrelated to the mobile subscription (identified by the SIM). The format of the IMEI is defined by 3GPP, and a database of allocated IMEIs maintained by the GSMA | `imei` | `mobile_phone_identifier` | -| IMEISV | IMEI with additional Software Version. The software version numbers get updated as the OS on the mobile device is updated, so this number is not constant. The IMEI can be derived from the IMEISV, but not vice-versa | `imei_sv` | `mobile_phone_identifier_with_sv` | -| TAC | Type Allocation Code - an 8 digit identifier for the make, model and revision number of a particular physical mobile device. This identifier forms part of the full IMEI and IMEISV. | `tac` | `mobile_phone_type_allocation_code` | +| **Device** | End-user equipment able to connect to a mobile network. Examples of devices include smartphones or IoT sensors/actuators.  | device | | | +| **Application Server** | A server hosting backend applications to deliver some business logic to clients. | applicationServer | | | +| **Phone Number** |A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard. | phoneNumber | | | +| **Network Access Identifier** | networkAccessIdentifier | A public identifier addressing a subscription in a mobile network. In 3GPP terminology, it corresponds to the GPSI formatted with the External Identifier ({Local Identifier}@{Domain Identifier}). Unlike the telephone number, the network access identifier is not subjected to portability ruling in force, and is individually managed by each operator.  | | | +| **IP v4 Address** | Identifier of a node in a network using Internet Protocol version 4 (IPv4). IPv4 uses 32-bit addresses, which are insufficient to allocate unique addresses to all current devices. In order to mitigate this, network operators use Network Address Translation (NAT), mapping a private IP address space to a public one. | ipv4Address | | | +| **IP v6 Address** | | ipv6Address | | | | | +| **Carrier Billing** (a.k.a. Direct Carrier Billing) | An online payment process which allows users to make purchases by charging payments against OB Billing Systems, accordingly to the user's configuration in the OB. In a common usage in the industry, the payment is processed on current account balance or charged on next bill generated for this line | N/A | N/A | +| **Purchase** | The action of acquiring a (set of) good(s)/service(s). Order fulfilment is not triggered from this request as it relies on merchant's responsibility |purchaseId | purchase_identifier | +| **Payment** | The process of paying for a (set of) good(s)/service(s) | paymentId | payment_identifier | +| **1-STEP Payment** | Payment process performed in one phase (i.e. one action), that involves all the OB Carrier Billing Systems checking and trigger the charging request against Billing Systems | N/A | N/A | +| **2-STEP Payment** | Payment process performed in two phases (i.e. two actions). First action deals with payment preparation request to guarantee the reservation of the involved amount. Second action is an explicit confirmation or cancellation of the payment by the user. Any payment not confirmed/cancelled by a given user is discarded after some time in order to avoid inconsistency in the billing systems | N/A | N/A | +| **IP Address** | An single internet protocol address, specified using either "dotted-decimal" format (for IPv4) or IETF 5952 format (for IPv6). The source ip address is the ip address of the message sender, and the destination ip address is the ip address of the recipient. The description will make it clear which is required. | IP | ip_address source_ip_address destination_ip_address | +| **Port** | A 16 bit number (in the range 0 - 65535) used by the TCP (IETF RFC 9293) and UDP (IETF RFC 768) protocols to identify different applications flows and services. The source port is the port alloacted to the message sender, and the destination port is the port allocated to the recipient. The description will make it clear which is required. | Port | port source_port destination_port | @@ -27,4 +26,5 @@ -#### Note: The above entries are just samples provided from the commonalities. We propose the individual subprojects to contribute the concrete terms in the document as deemed fit. If the usage in an API is already using a developer friendly term, the last column can be left blank. + +#### Note: If the usage in an API is already using a developer friendly term, the last column can be left blank. From 15a3cc9ed1fbeebe98aa6792b27423bf46458e6e Mon Sep 17 00:00:00 2001 From: Shilpa Padgaonkar <77152136+shilpa-padgaonkar@users.noreply.github.com> Date: Wed, 29 Mar 2023 14:18:21 +0200 Subject: [PATCH 11/14] consolidation part2 --- Commonalities/documentation/Glossary.md | 1 + 1 file changed, 1 insertion(+) diff --git a/Commonalities/documentation/Glossary.md b/Commonalities/documentation/Glossary.md index 9f563845..03e365c8 100644 --- a/Commonalities/documentation/Glossary.md +++ b/Commonalities/documentation/Glossary.md @@ -15,6 +15,7 @@ | **2-STEP Payment** | Payment process performed in two phases (i.e. two actions). First action deals with payment preparation request to guarantee the reservation of the involved amount. Second action is an explicit confirmation or cancellation of the payment by the user. Any payment not confirmed/cancelled by a given user is discarded after some time in order to avoid inconsistency in the billing systems | N/A | N/A | | **IP Address** | An single internet protocol address, specified using either "dotted-decimal" format (for IPv4) or IETF 5952 format (for IPv6). The source ip address is the ip address of the message sender, and the destination ip address is the ip address of the recipient. The description will make it clear which is required. | IP | ip_address source_ip_address destination_ip_address | | **Port** | A 16 bit number (in the range 0 - 65535) used by the TCP (IETF RFC 9293) and UDP (IETF RFC 768) protocols to identify different applications flows and services. The source port is the port alloacted to the message sender, and the destination port is the port allocated to the recipient. The description will make it clear which is required. | Port | port source_port destination_port | +| **Service Class** | A statement of the required QoS characteristics of a traffic aggregate. Conceptually, a service class refers to applications with similar characteristics and performance requirements. Each service class is mapped to a DSCP value according to RFC4594 guidelines. The DSCP value is used to classify the target home device's traffic so that it can be treated accordingly (i.e. to meet its QoS needs). |serviceClass | | From 60baa928023007e8877dd92b1564f083261f8bc5 Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Wed, 29 Mar 2023 16:32:55 +0200 Subject: [PATCH 12/14] Update Glossary.md Changes in Network Access Identifier, IP, Port; added Event Type --- Commonalities/documentation/Glossary.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/Commonalities/documentation/Glossary.md b/Commonalities/documentation/Glossary.md index 03e365c8..c3953ef0 100644 --- a/Commonalities/documentation/Glossary.md +++ b/Commonalities/documentation/Glossary.md @@ -5,7 +5,7 @@ | **Device** | End-user equipment able to connect to a mobile network. Examples of devices include smartphones or IoT sensors/actuators.  | device | | | | **Application Server** | A server hosting backend applications to deliver some business logic to clients. | applicationServer | | | | **Phone Number** |A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard. | phoneNumber | | | -| **Network Access Identifier** | networkAccessIdentifier | A public identifier addressing a subscription in a mobile network. In 3GPP terminology, it corresponds to the GPSI formatted with the External Identifier ({Local Identifier}@{Domain Identifier}). Unlike the telephone number, the network access identifier is not subjected to portability ruling in force, and is individually managed by each operator.  | | | +| **Network Access Identifier** | A public identifier addressing a subscription in a mobile network. In 3GPP terminology, it corresponds to the GPSI formatted with the External Identifier ({Local Identifier}@{Domain Identifier}). Unlike the telephone number, the network access identifier is not subjected to portability ruling in force, and is individually managed by each operator.| networkAccessIdentifier | | | | **IP v4 Address** | Identifier of a node in a network using Internet Protocol version 4 (IPv4). IPv4 uses 32-bit addresses, which are insufficient to allocate unique addresses to all current devices. In order to mitigate this, network operators use Network Address Translation (NAT), mapping a private IP address space to a public one. | ipv4Address | | | | **IP v6 Address** | | ipv6Address | | | | | | **Carrier Billing** (a.k.a. Direct Carrier Billing) | An online payment process which allows users to make purchases by charging payments against OB Billing Systems, accordingly to the user's configuration in the OB. In a common usage in the industry, the payment is processed on current account balance or charged on next bill generated for this line | N/A | N/A | @@ -13,9 +13,11 @@ | **Payment** | The process of paying for a (set of) good(s)/service(s) | paymentId | payment_identifier | | **1-STEP Payment** | Payment process performed in one phase (i.e. one action), that involves all the OB Carrier Billing Systems checking and trigger the charging request against Billing Systems | N/A | N/A | | **2-STEP Payment** | Payment process performed in two phases (i.e. two actions). First action deals with payment preparation request to guarantee the reservation of the involved amount. Second action is an explicit confirmation or cancellation of the payment by the user. Any payment not confirmed/cancelled by a given user is discarded after some time in order to avoid inconsistency in the billing systems | N/A | N/A | -| **IP Address** | An single internet protocol address, specified using either "dotted-decimal" format (for IPv4) or IETF 5952 format (for IPv6). The source ip address is the ip address of the message sender, and the destination ip address is the ip address of the recipient. The description will make it clear which is required. | IP | ip_address source_ip_address destination_ip_address | -| **Port** | A 16 bit number (in the range 0 - 65535) used by the TCP (IETF RFC 9293) and UDP (IETF RFC 768) protocols to identify different applications flows and services. The source port is the port alloacted to the message sender, and the destination port is the port allocated to the recipient. The description will make it clear which is required. | Port | port source_port destination_port | +| **IP Address** | An single internet protocol address, specified using either "dotted-decimal" format (for IPv4) or IETF 5952 format (for IPv6). The source ip address is the ip address of the message sender, and the destination ip address is the ip address of the recipient. The description will make it clear which is required. | ip | ip_address source_ip_address destination_ip_address | +| **Port** | A 16 bit number (in the range 0 - 65535) used by the TCP (IETF RFC 9293) and UDP (IETF RFC 768) protocols to identify different applications flows and services. The source port is the port alloacted to the message sender, and the destination port is the port allocated to the recipient. The description will make it clear which is required. | port | port source_port destination_port | | **Service Class** | A statement of the required QoS characteristics of a traffic aggregate. Conceptually, a service class refers to applications with similar characteristics and performance requirements. Each service class is mapped to a DSCP value according to RFC4594 guidelines. The DSCP value is used to classify the target home device's traffic so that it can be treated accordingly (i.e. to meet its QoS needs). |serviceClass | | +| **Event Type** | Type of event subscribed for notifications. More details and parameter definitions are included in chapter 12 of API DEsign guidelines | eventType| | + From b2a1b3c8cd0d9fa5fcae1804d9f4c5de4d3e605f Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Wed, 29 Mar 2023 16:33:52 +0200 Subject: [PATCH 13/14] Update Glossary.md Typos. --- Commonalities/documentation/Glossary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Commonalities/documentation/Glossary.md b/Commonalities/documentation/Glossary.md index c3953ef0..d3271e3d 100644 --- a/Commonalities/documentation/Glossary.md +++ b/Commonalities/documentation/Glossary.md @@ -16,7 +16,7 @@ | **IP Address** | An single internet protocol address, specified using either "dotted-decimal" format (for IPv4) or IETF 5952 format (for IPv6). The source ip address is the ip address of the message sender, and the destination ip address is the ip address of the recipient. The description will make it clear which is required. | ip | ip_address source_ip_address destination_ip_address | | **Port** | A 16 bit number (in the range 0 - 65535) used by the TCP (IETF RFC 9293) and UDP (IETF RFC 768) protocols to identify different applications flows and services. The source port is the port alloacted to the message sender, and the destination port is the port allocated to the recipient. The description will make it clear which is required. | port | port source_port destination_port | | **Service Class** | A statement of the required QoS characteristics of a traffic aggregate. Conceptually, a service class refers to applications with similar characteristics and performance requirements. Each service class is mapped to a DSCP value according to RFC4594 guidelines. The DSCP value is used to classify the target home device's traffic so that it can be treated accordingly (i.e. to meet its QoS needs). |serviceClass | | -| **Event Type** | Type of event subscribed for notifications. More details and parameter definitions are included in chapter 12 of API DEsign guidelines | eventType| | +| **Event Type** | Type of event subscribed for notifications. More details and parameter definitions are included in chapter 12 of API Design guidelines. | eventType| | From 03c78f5e9170c8d6c71179b5f00cfe15fb39d211 Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Wed, 29 Mar 2023 16:43:23 +0200 Subject: [PATCH 14/14] Update Glossary.md Alternative terms changed to camelCase. --- Commonalities/documentation/Glossary.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Commonalities/documentation/Glossary.md b/Commonalities/documentation/Glossary.md index d3271e3d..65845d54 100644 --- a/Commonalities/documentation/Glossary.md +++ b/Commonalities/documentation/Glossary.md @@ -9,12 +9,12 @@ | **IP v4 Address** | Identifier of a node in a network using Internet Protocol version 4 (IPv4). IPv4 uses 32-bit addresses, which are insufficient to allocate unique addresses to all current devices. In order to mitigate this, network operators use Network Address Translation (NAT), mapping a private IP address space to a public one. | ipv4Address | | | | **IP v6 Address** | | ipv6Address | | | | | | **Carrier Billing** (a.k.a. Direct Carrier Billing) | An online payment process which allows users to make purchases by charging payments against OB Billing Systems, accordingly to the user's configuration in the OB. In a common usage in the industry, the payment is processed on current account balance or charged on next bill generated for this line | N/A | N/A | -| **Purchase** | The action of acquiring a (set of) good(s)/service(s). Order fulfilment is not triggered from this request as it relies on merchant's responsibility |purchaseId | purchase_identifier | -| **Payment** | The process of paying for a (set of) good(s)/service(s) | paymentId | payment_identifier | +| **Purchase** | The action of acquiring a (set of) good(s)/service(s). Order fulfilment is not triggered from this request as it relies on merchant's responsibility |purchaseId | purchaseIdentifier | +| **Payment** | The process of paying for a (set of) good(s)/service(s) | paymentId | paymentIdentifier | | **1-STEP Payment** | Payment process performed in one phase (i.e. one action), that involves all the OB Carrier Billing Systems checking and trigger the charging request against Billing Systems | N/A | N/A | | **2-STEP Payment** | Payment process performed in two phases (i.e. two actions). First action deals with payment preparation request to guarantee the reservation of the involved amount. Second action is an explicit confirmation or cancellation of the payment by the user. Any payment not confirmed/cancelled by a given user is discarded after some time in order to avoid inconsistency in the billing systems | N/A | N/A | -| **IP Address** | An single internet protocol address, specified using either "dotted-decimal" format (for IPv4) or IETF 5952 format (for IPv6). The source ip address is the ip address of the message sender, and the destination ip address is the ip address of the recipient. The description will make it clear which is required. | ip | ip_address source_ip_address destination_ip_address | -| **Port** | A 16 bit number (in the range 0 - 65535) used by the TCP (IETF RFC 9293) and UDP (IETF RFC 768) protocols to identify different applications flows and services. The source port is the port alloacted to the message sender, and the destination port is the port allocated to the recipient. The description will make it clear which is required. | port | port source_port destination_port | +| **IP Address** | An single internet protocol address, specified using either "dotted-decimal" format (for IPv4) or IETF 5952 format (for IPv6). The source ip address is the ip address of the message sender, and the destination ip address is the ip address of the recipient. The description will make it clear which is required. | ip | ipAddress sourceIpAddress destinationIpAddress | +| **Port** | A 16 bit number (in the range 0 - 65535) used by the TCP (IETF RFC 9293) and UDP (IETF RFC 768) protocols to identify different applications flows and services. The source port is the port alloacted to the message sender, and the destination port is the port allocated to the recipient. The description will make it clear which is required. | port | sourcePort destinationPort | | **Service Class** | A statement of the required QoS characteristics of a traffic aggregate. Conceptually, a service class refers to applications with similar characteristics and performance requirements. Each service class is mapped to a DSCP value according to RFC4594 guidelines. The DSCP value is used to classify the target home device's traffic so that it can be treated accordingly (i.e. to meet its QoS needs). |serviceClass | | | **Event Type** | Type of event subscribed for notifications. More details and parameter definitions are included in chapter 12 of API Design guidelines. | eventType| |