+
+
+
+
+
+
+
+
+# ApplicationEndpointDiscovery
+
+Sandbox API Repository to describe, develop, document, and test the ApplicationEndpointDiscovery Service API(s) within the Sub Project [Edge Cloud](https://lf-camaraproject.atlassian.net/wiki/x/IwEpBQ).
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/AQAtC)
+
+## Scope
+
+* Service API(s) “ApplicationEndpointDiscovery” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * Discover the optimal application endpoint(s) that a given end-user's device can connect to.
+* Describe, develop, document, and test the API(s)
+* Started: July 2022 (in [EdgeCloud](https://github.com/camaraproject/EdgeCloud) repository)
+
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r1.2](https://github.com/camaraproject/ApplicationEndpointDiscovery/releases/tag/r1.2) (Fall25), with the following API versions:
+ * **application-endpoint-discovery v0.1.0**
+ [[YAML]](https://github.com/camaraproject/ApplicationEndpointDiscovery/blob/r1.2/code/API_definitions/application-endpoint-discovery.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ApplicationEndpointDiscovery/r1.2/code/API_definitions/application-endpoint-discovery.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ApplicationEndpointDiscovery/r1.2/code/API_definitions/application-endpoint-discovery.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/ApplicationEndpointDiscovery/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/ApplicationEndpointDiscovery/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/ApplicationEndpointDiscovery/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings are held virtually
+ * Schedule: Bi-weekly on Tuesdays 14:00 - 15:00 UTC
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/91868502920?password=a9ec9dff-ea92-4216-b0a1-ce152f49170f)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/8Tve)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list 
+
+
+
+
+
+
+
+
+# ApplicationEndpointRegistration
+
+Sandbox API Repository to describe, develop, document, and test the ApplicationEndpointRegistration Service API(s) within the Sub Project [Edge Cloud](https://lf-camaraproject.atlassian.net/wiki/x/IwEpBQ).
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/AQAsC)
+
+## Scope
+
+* Service API(s) “ApplicationEndpointRegistration” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * register the endpoints of an application which is deployed across various Edge Cloud Zones
+* Describe, develop, document, and test the API(s)
+* Started: July 2022 (in [EdgeCloud](https://github.com/camaraproject/EdgeCloud) repository)
+
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r1.2](https://github.com/camaraproject/ApplicationEndpointRegistration/releases/tag/r1.2) (Fall25), with the following API versions:
+ * **application-endpoint-registration v0.1.0**
+ [[YAML]](https://github.com/camaraproject/ApplicationEndpointRegistration/blob/r1.2/code/API_definitions/application-endpoint-registration.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ApplicationEndpointRegistration/r1.2/code/API_definitions/application-endpoint-registration.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ApplicationEndpointRegistration/r1.2/code/API_definitions/application-endpoint-registration.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/ApplicationEndpointRegistration/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/ApplicationEndpointRegistration/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/ApplicationEndpointRegistration/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings are held virtually
+ * Schedule: Bi-weekly on Tuesdays 14:00 - 15:00 UTC
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/91868502920?password=a9ec9dff-ea92-4216-b0a1-ce152f49170f)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/8Tve)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list 
+
+
+
+
+
+
+
+
+# ApplicationProfiles
+
+Sandbox API Repository to describe, develop, document, and test the ApplicationProfiles Service API(s) within the context of [ConnectivityInsights](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14561833/ConnectivityInsights)
+
+* API Repository [Wiki page](https://lf-camaraproject.atlassian.net/wiki/x/mgGaBQ)
+
+## Scope
+
+* Service API(s) “ApplicationProfiles” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * Application profiles allows application developers to share all the information about their application which would be relevant for network CAMARA APIs related decision making.
+* Describe, develop, document, and test the API(s)
+* Started: October 2024 (within ConnectivityInsights, own repository since March 2025)
+
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r1.2](https://github.com/camaraproject/ApplicationProfiles/releases/tag/r1.2) (Fall25), with the following API versions:
+ * **application-profiles v0.5.0**
+ [[YAML]](https://github.com/camaraproject/ApplicationProfiles/blob/r1.2/code/API_definitions/application-profiles.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ApplicationProfiles/r1.2/code/API_definitions/application-profiles.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ApplicationProfiles/r1.2/code/API_definitions/application-profiles.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/ApplicationProfiles/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/ApplicationProfiles/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/ApplicationProfiles/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings are held virtually together with ConnectivityInsights
+ * Schedule: Bi-weekly on Wednesday at 15:00 UTC
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/92345695827?password=35dff2b2-058d-44de-bd7e-67d08c9e9f9d)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/vzve)
+* Mailing List
+
+ * Subscribe / Unsubscribe to the mailing list 
+
+
+
+
+
+
+
+
+# BlockchainPublicAddress
+
+Sandbox API Repository to describe, develop, document, and test the BlockchainPublicAddress Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/KDHe)
+
+## Scope
+* Service APIs for “Blockchain Public Address” (see APIBacklog.md)
+* It provides the API consumer with the ability to:
+ * Blockchain Public Address API:
+ * Manage a Blockchain Public Address associated to a phone number, i.e. to retrieve the blockchain public address(es) and to bind/unbind a Blockchain Public Address. The Blockchain Public Address is utilized as Decentralized Identifier (DID). With the proposed API, API providers offer API consumers the following capability: pairing phone number with Blockchain Public Address whenever this 3rd party wants to offer its customers a way to make transactions more easily based on the phone number instead of the Blockchain Public Address.
+ * Optional binding enforcement procedure, ensuring both `phoneNumber` and `blockchainPublicAddress` belongs to the same owner (i.e. person), within binding process by means of the checking of provided `nonce` and `signature` fields. To generate `nonce` below mentioned Blockchain Public Address Validation API has been designed, and `signature` generation is an off-chain process.
+ * Blockchain Public Address Validation API:
+ * Manage generation of a nonce (one-time challenge) to be used in binding enforcemnet procedure.
+* Describe, develop, document and test the APIs (with 1-2 Telcos)
+* Started: June 2023
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r2.2](https://github.com/camaraproject/BlockchainPublicAddress/releases/tag/r2.2) (Fall25), with the following API versions:
+ * **blockchain-public-address-validation v0.1.0**
+ [[YAML]](https://github.com/camaraproject/BlockchainPublicAddress/blob/r2.2/code/API_definitions/blockchain-public-address-validation.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/BlockchainPublicAddress/r2.2/code/API_definitions/blockchain-public-address-validation.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/BlockchainPublicAddress/r2.2/code/API_definitions/blockchain-public-address-validation.yaml)
+ * **blockchain-public-address v0.3.0**
+ [[YAML]](https://github.com/camaraproject/BlockchainPublicAddress/blob/r2.2/code/API_definitions/blockchain-public-address.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/BlockchainPublicAddress/r2.2/code/API_definitions/blockchain-public-address.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/BlockchainPublicAddress/r2.2/code/API_definitions/blockchain-public-address.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/BlockchainPublicAddress/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/BlockchainPublicAddress/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/BlockchainPublicAddress/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings
+ * [Registration/Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/99023344259?password=cb995600-56ee-48a2-ade1-607bb10487df)
+ * Schedule: Bi-weekly on Thursdays, 13:00-14:00 CET/CEST (12:00 UTC, 11:00 UTC during European DST)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/thDe).
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project 
+
+
+
+
+
+
+
+
+# CallForwardingSignal
+
+Incubating API Repository to evolve and maintain the definitions and documentation of CallForwardingSignal Service API within the Sub Project [Call Forwarding Signal](https://lf-camaraproject.atlassian.net/wiki/x/IIAfBQ).
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/HADe)
+
+## Scope
+* Service APIs for “CallForwardingSignal” (see APIBacklog.md)
+* It provides the API consumer with the ability to:
+ * retrieve information about the status of the Call Forwarding Service on a specific phone number.
+ * avoid fraud leveraging the Call Forwarding Service.
+ * The main scope of the Call Forwarding Signal API is anti fraud to avoid fraudsters to use the Call Forwarding Service to carry on a scam. Other use cases are anyway supported by the Call Forwarding Signal API that also provides additional endpoints to detect the general Call Forwarding Service settings.
+* Describe, develop, document and test the API
+* Started: February 2024
+* Incubating stage since: February 2025
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r3.3](https://github.com/camaraproject/CallForwardingSignal/releases/tag/r3.3) (Fall25), with the following API versions:
+ * **call-forwarding-signal v0.4.0**
+ [[YAML]](https://github.com/camaraproject/CallForwardingSignal/blob/r3.3/code/API_definitions/call-forwarding-signal.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/r3.3/code/API_definitions/call-forwarding-signal.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/r3.3/code/API_definitions/call-forwarding-signal.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/CallForwardingSignal/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/CallForwardingSignal/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/CallForwardingSignal/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings are held virtually
+ * Schedule: Monday 15h-16 CET, usually every two weeks. For the next meetings information, have a look on the [API Wiki Page](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14549020/CallForwardingSignal).
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/96706226837?password=2d113354-bf97-4441-8d6d-9fd0ae69f2d1)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14574452/CallForwardingSignal+Minutes?atlOrigin=eyJpIjoiNjc1Mzc3ZWIwNGI4NGRhMmE2YjBkMGFjNmFjMTNiZDUiLCJwIjoiYyJ9)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list 
+
+
+
+
+
+
+
+
+# CapabilitiesAndRuntimeRestrictions
+
+Sandbox API Repository to describe, develop, document, and test the CapabilitiesAndRuntimeRestrictions Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/6YAjAw)
+
+## Scope
+
+* Service APIs for “CapabilitiesAndRuntimeRestrictions” (see APIBacklog.md)
+* The CAMARA Runtime Restrictions API allows API consumers to understand and adapt to environment-specific differences in how CAMARA APIs are implemented. It provides details on what is supported, what is temporarily unavailable, and any other limitations that might affect how you call and consume those APIs. This API provides that information about other CAMARA APIs.
+* The API provides the API consumer with the ability to:
+ * Discover Capabilities and Constraints
+ * Stay updated on changes
+ * Adapt your requests Automatically
+* Describe, develop, document, and test the APIs
+* Started: November 2024
+
+
+
+
+## Release Information
+
+The repository has no (pre)releases yet, work in progress is within the main branch.
+
+
+## Contributing
+* Meetings are held virtually
+ * Schedule: Tuesdays 1400-1500 UTC, every two weeks.
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/96678356438?password=706020d3-07bc-4d90-a0d5-1d6b94452a53)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/6YAjAw)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project 
+
+
+
+
+
+
+
+
+# CarrierBillingCheckOut
+
+Sandbox API Repository to describe, develop, document, and test the CarrierBillingCheckOut Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/CDDe)
+
+## Scope
+* Service APIs for “CarrierBillingCheckOut” (see APIBacklog.md)
+* It provides the API consumer with the ability to:
+ * Trigger carrier billing payment request (in one or two steps), which is a process that allows API consumers to make purchases by charging payments against Telco Operator Billing Systems.
+ * Follow up of payment, by means of query endpoints to get information about a list of payments or a specific payment.
+ * Trigger carrier billing refund request, which is a process that allows API consumers to ask for a `total` or `partial` return of the amount associated to a previous performed payment.
+ * Follow up of refund, by means of query endpoints to get information about a list of refunds or a specific refund.
+ * NOTE: The scope of these APIs should be limited (at least at a first stage) to 4G and 5G.
+* Describe, develop, document and test the APIs (with 1-2 Telcos)
+* Started: October 2022
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r3.2](https://github.com/camaraproject/CarrierBillingCheckOut/releases/tag/r3.2) (Fall25), with the following API versions:
+ * **carrier-billing-refund v0.3.0**
+ [[YAML]](https://github.com/camaraproject/CarrierBillingCheckOut/blob/r3.2/code/API_definitions/carrier-billing-refund.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r3.2/code/API_definitions/carrier-billing-refund.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r3.2/code/API_definitions/carrier-billing-refund.yaml)
+ * **carrier-billing v0.5.0**
+ [[YAML]](https://github.com/camaraproject/CarrierBillingCheckOut/blob/r3.2/code/API_definitions/carrier-billing.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r3.2/code/API_definitions/carrier-billing.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r3.2/code/API_definitions/carrier-billing.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/CarrierBillingCheckOut/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/CarrierBillingCheckOut/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/CarrierBillingCheckOut/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings are held virtually
+ * Schedule: Bi-Weekly, Wednesdays 13:00 - 14:00 UTC
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/96513497117?password=ac26d34b-87d2-4d78-aa47-4de1ca14c882)
+ * Minutes: Access [Meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/CDDe)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project 
+
+#### 4.2.1 API attributes
+
+
+Attribute definition
+
+**Payment Class description:**
+
+ **Name** | **Description** | **Comment** |
+| -------- | --------- | ----------- |
+| endUserId | Identify the mobile account to be charged - in general mobile number is provided | Mandatory attribute in POST request |
+| clientCorrelator | Provided by the requester - Uniquely identifies this create charge request | Optionally valued by requester |
+| paymentAmount | See PaymentAmount class table description| Mandatory attribute in POST request |
+| referenceCode | Merchant generated payment reference to uniquely identify the request, for example the purchase or order identifier | Mandatory attribute in POST request |
+| transactionOperationStatus | Specifies the payment status (example: Processing, Denied, Reserved, Succeeded, Cancelled) | Must be valued by server side (not in POST request) |
+| resourceURL | URI of the created resource (same as in the Location header) | Only valued (optionally) by server side (not in POST request) |
+| serverReferenceCode | Reference to the charge or refund, provided by the server, and meaningful to the server’s backend system for the purpose of reconciliation | Only valued (optionally) by server side (not in POST request) |
+| paymentCreationDate | Date when the payment is created in server data base. This is a technically information | Only valued (optionally) by server side (not in POST request) |
+| paymentDate | Date when the payment is effectively performed. This is a business information. | Only valued (optionally) by server side (not in POST request) |
+| notificationUrl | Allows asynchronous delivery of purchase related events | Optionally valued by requester - if used, customer needs to have a notification endpoint |
+| notificationAuthToken | Authentification token for callback API (if provided) | Optionally valued by requester |
+
+**PaymentAccount class description:**
+
+2 classes are defined:
+
+ChargingInformation:
+
+ **Name** | **Description** | **Comment** |
+| -------- | --------- | ----------- |
+| amount | Amount to be charged or reserved (number) | Mandatory attribute in POST request |
+| currency | Currency identifier as defined in [ISO4217] | Mandatory attribute in POST request |
+| description | Description text to be used for information and billing text | Mandatory attribute in POST request|
+
+
+ChargingMetaData
+
+ **Name** | **Description** | **Comment** |
+| -------- | --------- | ----------- |
+| onBehalfOf | Allows aggregators/partners to specify the actual payee | Optionally valued by requester |
+| purchaseCategoryCode | Allows aggregators/partners to specify the actual payee | Optionally valued by requester |
+| channel | Channel where the order occurred | Optionally valued by requester |
+| isTaxIncluded | if true, the amount is tax included, if false the amount is provided without tax. In both case, taxAmount could be valued to provide tax amount.| Optionally valued by requester |
+| taxAmount | The tax amount charged by the merchant if the charge has tax already included (number). This also provides an indicator to the downstream billing system | Optionally valued by requester |
+| serviceId | Identifier of service related to the payment | Optionally valued by requester |
+| productId | Identifier of product related to the payment | Optionally valued by requester |
+
+**Payment State engine**
+
+Follow schema provides information about the payment state engine (state description & transition)
+
+
+
+
+### 4.3 Endpoint Definitions
+
+Following table defines API endpoints of exposed REST based for Carrier Billing Payment API management operations.
+
+| **Endpoint** | **Operation** | **Description** |
+| -------- | --------- | ----------- |
+| POST
+
+
+
+
+
+
+
+
+# ClickToDial
+
+Sandbox API Repository to describe, develop, document, and test the ClickToDial Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [Click To Dial](https://lf-camaraproject.atlassian.net/wiki/x/3DHe)
+
+## Scope
+* Service APIs for “Click-To-Dial”
+* It provides the API consumer with the ability to:
+ * establish a voice call between a caller and callee
+ * terminate an active call
+ * retrieve the recording of a call (if available)
+* Describe, develop, document and test the APIs
+* Started: September 2023
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> This repository has only pre-release versions available yet. Pre-releases are for testing and may change before public release.
+
+* The latest pre-release is [r1.2](https://github.com/camaraproject/ClickToDial/releases/tag/r1.2) (release candidate), with the following API versions:
+ * **click-to-dial 0.1.0-rc.1**
+ [[YAML]](https://github.com/camaraproject/ClickToDial/blob/r1.2/code/API_definitions/click-to-dial.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ClickToDial/r1.2/code/API_definitions/click-to-dial.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ClickToDial/r1.2/code/API_definitions/click-to-dial.yaml)
+
+* For changes see [CHANGELOG](https://github.com/camaraproject/ClickToDial/tree/main/CHANGELOG)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings are held virtually
+ * Schedule: Bi-weekly (odd weeks), Wednesday, 3 PM CET/CEST (13:00 UTC,21:00 Beijing)
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/96843390032?password=1153dd0f-f8c8-4d3b-9962-d9685444d145)
+ * Minutes: Access [Meeting minutes](https://wiki.camaraproject.org/display/CAM/ClickToDial)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project 
+
+
+
+
+
+
+
+
+# ConnectedNetworkType
+
+Sandbox API Repository to describe, develop, document, and test the ConnectedNetworkType Service API(s) within the Sub Project [Device Status](https://lf-camaraproject.atlassian.net/wiki/x/6wApBQ).
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/AQD1Bg)
+
+## Scope
+
+* Service API(s) “ConnectedNetworkType” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * query the the mobile technology of the network that the device is connected to
+ * receive notifications when the connected network type has changed
+* Describe, develop, document, and test the API(s)
+* Started: June 2024 (within [DeviceStatus](https://github.com/camaraproject/DeviceStatus) repository)
+
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r1.2](https://github.com/camaraproject/ConnectedNetworkType/releases/tag/r1.2) (Fall25), with the following API versions:
+ * **connected-network-type-subscriptions v0.2.0**
+ [[YAML]](https://github.com/camaraproject/ConnectedNetworkType/blob/r1.2/code/API_definitions/connected-network-type-subscriptions.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectedNetworkType/r1.2/code/API_definitions/connected-network-type-subscriptions.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ConnectedNetworkType/r1.2/code/API_definitions/connected-network-type-subscriptions.yaml)
+ * **connected-network-type v0.2.0**
+ [[YAML]](https://github.com/camaraproject/ConnectedNetworkType/blob/r1.2/code/API_definitions/connected-network-type.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectedNetworkType/r1.2/code/API_definitions/connected-network-type.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ConnectedNetworkType/r1.2/code/API_definitions/connected-network-type.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/ConnectedNetworkType/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/ConnectedNetworkType/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/ConnectedNetworkType/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings are held virtually
+
+ * Schedule: Bi-weekly on Wednesday, 09:00 UTC
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/93413850406?password=3aeb0f1b-d9f9-42c5-91d8-3d2b20421ef1)
+ * Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/fzLe)
+
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list 
+
+
+
+
+
+
+
+
+# ConnectivityInsights
+
+Sandbox API Repository to describe, develop, document, and test the ConnectivityInsights Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/KTLe)
+
+## Scope
+* Service APIs for “Connectivity Insights” (see APIBacklog.md)
+* It provides the API consumer with the ability to:
+ * share key details about their applications that are relevant for network-related decisions across various CAMARA APIs.
+ * gain visibility into network quality, allowing them to
+check if their application's network requirements can be met for a given user session. Based on the API’s response, developers can make informed decisions - like requesting a network boost through CAMARA Quality on Demand API or adjusting application settings (e.g. adjust video resolution) to ensure the best possible user experience.
+ * enables application developers to receive continuous updates
+about network quality through event notifications.
+ * NOTE: The scope of these APIs should be limited (at least at a first stage) to 4G and 5G.
+* Describe, develop, document and test the APIs (with 1-2 Telcos)
+* Started: November 2023
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r3.2](https://github.com/camaraproject/ConnectivityInsights/releases/tag/r3.2) (Fall25), with the following API versions:
+ * **connectivity-insights-subscriptions v0.6.0**
+ [[YAML]](https://github.com/camaraproject/ConnectivityInsights/blob/r3.2/code/API_definitions/connectivity-insights-subscriptions.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r3.2/code/API_definitions/connectivity-insights-subscriptions.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r3.2/code/API_definitions/connectivity-insights-subscriptions.yaml)
+ * **connectivity-insights v0.6.0**
+ [[YAML]](https://github.com/camaraproject/ConnectivityInsights/blob/r3.2/code/API_definitions/connectivity-insights.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r3.2/code/API_definitions/connectivity-insights.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r3.2/code/API_definitions/connectivity-insights.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/ConnectivityInsights/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/ConnectivityInsights/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/ConnectivityInsights/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/92345695827?password=35dff2b2-058d-44de-bd7e-67d08c9e9f9d)
+ * Schedule: Bi-weekly on Wednesday at 1500UTC
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/vTve)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project 
+
+
+
+
+
+
+
+
+# ConsentInfo
+
+Sandbox API Repository to describe, develop, document, and test the ConsentInfo API(s) within the Working Group [IdentityAndConsentManagement](https://lf-camaraproject.atlassian.net/wiki/x/ZzDe)
+
+* API Repository [Wiki page](https://lf-camaraproject.atlassian.net/wiki/x/NICeBQ)
+
+
+## Scope
+
+* Service APIs for “ConsentInfo" (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * **Check the validity of data processing**: The API returns `statusValidForProcessing`, a boolean flag that indicates whether the requested data processing is currently permitted (`true`) or not (`false`).
+ * **Understand why processing is not allowed**: If data processing is not permitted, the response includes a `statusReason` field to explain why.
+ * **Retrieve a Capture URL (if requested)**: If the status is not valid because user action is required, and the API Consumer sets `requestCaptureUrl` to `true`, the API will return a `captureUrl` field that can be presented to the User. This URL directs them to the API Provider's secure Consent capture channel, where they can provide or renew their Consent.
+
+ Importantly, this API does NOT delegate Consent capture to the API Consumer but rather empowers the API Consumer to present the API Provider's Consent capture URL at the most opportune time and place. The actual Consent capture occurs within the API Provider's secure environment, ensuring the User's authentication with the API Provider.
+* Describe, develop, document, and test the API(s)
+* Started: March 2025
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* The latest public release is [r2.3](https://github.com/camaraproject/ConsentInfo/releases/tag/r2.3), with the following API versions:
+ * **consent-info 0.2.0**
+ [[YAML]](https://github.com/camaraproject/ConsentInfo/blob/r2.3/code/API_definitions/consent-info.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConsentInfo/r2.3/code/API_definitions/consent-info.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ConsentInfo/r2.3/code/API_definitions/consent-info.yaml)
+
+* The latest public release is always available here: https://github.com/camaraproject/ConsentInfo/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/ConsentInfo/releases
+* For changes see [CHANGELOG](https://github.com/camaraproject/ConsentInfo/tree/main/CHANGELOG)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings of the working group are held virtually
+ * Schedule: Every 2 weeks on Wednesdays at 14:00 UTC (IdentityAndConsentManagement Working Group meeting)
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/94629188836?password=278b4c8a-f370-43bf-bac1-b30a39f169f3)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/lE7e)
+
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list 
+
+
+
+
+
+
+
+
+# ConsentManagement
+
+Sandbox API Repository to describe, develop, document, and test the ConsentManagement Service API(s) within the Working Group [Identity And Consent Management](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14561383/Identity+Consent+Management).
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/WgDDH)
+
+## Scope
+
+* Service API(s) “ConsentManagement” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * **Create Consent**: Allows API Consumers to create a new Consent for a User, specifying the requested scope(s) and Purpose. The API Consumer must provide the necessary information to capture the User's Consent.
+ * **Update Consent**: Enables API Consumers to update an existing Consent and change its status.
+ * **Retrieve Consent Information**: Allows API Consumers to retrieve information about existing Consents for a User based on specified scope(s) and Purpose. This operation can also return the Consent texts presented to the User during the Consent Capture process if requested.
+
+ It is important to note that the API Provider remains fully responsible for Consent storage, auditing and transparency. Access to this functionality is restricted to trusted API Consumers in accordance with the API Provider's policy. This API only applies to scenarios involving the legal basis of Consent. Scenarios involving a different legal basis for data processing are excluded and would be handled by the API Provider through non-delegated mechanisms.
+* Describe, develop, document, and test the API(s)
+* Started: December 2025
+
+
+
+
+
+## Release Information
+
+The repository has no (pre)releases yet, work in progress is within the main branch.
+
+
+
+## Contributing
+
+* Meetings are held virtually
+
+ * Schedule: Every 2 weeks on Wednesdays at 14:00 UTC (IdentityAndConsentManagement Working Group meeting)
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/94629188836?password=278b4c8a-f370-43bf-bac1-b30a39f169f3)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/lE7e)
+ * Subscribe / Unsubscribe to the mailing list 
+
+
+
+
+
+
+
+
+# CustomerInsights
+
+Sandbox API Repository to describe, develop, document, and test the CustomerInsights Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/owBuAQ)
+
+## Scope
+
+* Service APIs for “CustomerInsights”
+* The API provides the customer with the ability to:
+ * Provides a risk index (a.k.a. Scoring) based on the individual's profile owned by a Telco Operator.
+ * So far two scoring scales are defined within the current proposal (GaugeMetric, VeritasIndex).
+* Describe, develop, document, and test the APIs
+* Started: October 2024
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r2.2](https://github.com/camaraproject/CustomerInsights/releases/tag/r2.2) (Fall25), with the following API versions:
+ * **customer-insights v0.2.0**
+ [[YAML]](https://github.com/camaraproject/CustomerInsights/blob/r2.2/code/API_definitions/customer-insights.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CustomerInsights/r2.2/code/API_definitions/customer-insights.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/CustomerInsights/r2.2/code/API_definitions/customer-insights.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/CustomerInsights/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/CustomerInsights/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/CustomerInsights/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings are held virtually
+ * Schedule: Bi-Weekly on Thursdays at 14:00 UTC
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/95737002367?password=034d9b74-a944-4def-ae30-0f93802430a5)
+ * Minutes: Access [[meeting minutes]](https://lf-camaraproject.atlassian.net/wiki/x/XIBuAQ)
+* Mailing List
+
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project 
+
+
+
+
+
+
+
+
+# DedicatedNetworks
+
+Sandbox API Repository to describe, develop, document, and test the DedicatedNetworks Service API(s) within the Sub Project [Connectivity Quality Management](https://lf-camaraproject.atlassian.net/wiki/x/hAClB).
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/XIArAQ)
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/OICGAQ)
+
+For background on Dedicated Networks concepts and workflows, see the [General Description](documentation/API_documentation/DedicatedNetworks_GeneralDescription.md).
+
+## Scope
+
+* Service APIs for DedicatedNetworks (see [APIBacklog.md](https://github.com/camaraproject/APIBacklog/blob/main/documentation/APIbacklog.md))
+* The API provides the API Consumer with the ability to:
+ * request/modify/delete a (logical) Dedicated Network for API consumers.
+ * A Dedicated Network offers
+ * specific connectivity performance (e.g. speed/ latency)
+ * during a specific time duration (e.g. one hour) and
+ * at specific locations (e.g. the area of a festival)
+ * A Dedicated Network may be ensured by an SLA.
+ * API consumers are able to manage access to this dedicated network for specific devices.
+* Describe, develop, document, and test the APIs
+* Started: October 2024
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r1.2](https://github.com/camaraproject/DedicatedNetworks/releases/tag/r1.2) (Fall25), with the following API versions:
+ * **dedicated-network-accesses v0.1.0**
+ [[YAML]](https://github.com/camaraproject/DedicatedNetworks/blob/r1.2/code/API_definitions/dedicated-network-accesses.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network-accesses.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network-accesses.yaml)
+ * **dedicated-network-profiles v0.1.0**
+ [[YAML]](https://github.com/camaraproject/DedicatedNetworks/blob/r1.2/code/API_definitions/dedicated-network-profiles.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network-profiles.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network-profiles.yaml)
+ * **dedicated-network v0.1.0**
+ [[YAML]](https://github.com/camaraproject/DedicatedNetworks/blob/r1.2/code/API_definitions/dedicated-network.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/DedicatedNetworks/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/DedicatedNetworks/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/DedicatedNetworks/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings are held virtually
+ * Schedule: bi-weekly, Mondays, 10 AM CET (09:00 UTC). For date/time of the next meeting, see previous meeting minutes
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/94505909302?password=67b9a175-154f-4fe1-986d-0b825227a95b)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/l/cp/S3hQ1AFG)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project 
+
+
+
+
+
+
+
+
+# DeviceAuthenticity
+
+Sandbox API Repository to describe, develop, document, and test the DeviceAuthenticity Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/czLe)
+
+## Scope
+
+* Service API(s) “DeviceAuthenticity” (see APIBacklog.md)
+* The API provides the API consumer with the ability to:
+ * Determine whether a given device associated with the provided device identifier is subject to any restrictions or risk flags.
+ * Provide a clear overall status describing the device’s condition.
+* Describe, develop, document, and test the API(s)
+* Started: **December 2025**
+
+
+
+
+
+## Release Information
+
+The repository has no (pre)releases yet, work in progress is within the main branch.
+
+
+## Contributing
+
+* Meetings are held virtually together with the DeviceIdentifier API team
+
+ * Schedule: First Friday of each month at 09:00 UTC
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/96981252767?password=fc957607-cc06-450f-b80a-229bb6a88c39)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/yjve)
+* Mailing List (of DeviceIdentifier)
+ * Subscribe / Unsubscribe to the mailing list 
+
+
+
+
+
+
+
+
+# DeviceDataVolume
+
+Sandbox API Repository to describe, develop, document, and test the DeviceDataVolume APIs within the Sub Project [DeviceStatus](https://lf-camaraproject.atlassian.net/wiki/x/6wApBQ) of CAMARA
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/PoCaBQ)
+
+## Scope
+
+* Service APIs “Device Data Volume” and "Device Data Volume Subscriptions" (see [APIBacklog.md](https://github.com/camaraproject/APIBacklog/blob/main/documentation/APIbacklog.md))
+* The service APIs provide the customer with the ability to:
+ * get detailed insights into the customer's data usage status
+ * get alerts when the customer's data usage status changes
+* Describe, develop, document, and test the service APIs
+* Started: August 2024
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r1.3](https://github.com/camaraproject/DeviceDataVolume/releases/tag/r1.3) (Fall25), with the following API versions:
+ * **device-data-volume-subscriptions v0.1.0**
+ [[YAML]](https://github.com/camaraproject/DeviceDataVolume/blob/r1.3/code/API_definitions/device-data-volume-subscriptions.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.3/code/API_definitions/device-data-volume-subscriptions.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.3/code/API_definitions/device-data-volume-subscriptions.yaml)
+ * **device-data-volume v0.1.0**
+ [[YAML]](https://github.com/camaraproject/DeviceDataVolume/blob/r1.3/code/API_definitions/device-data-volume.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.3/code/API_definitions/device-data-volume.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.3/code/API_definitions/device-data-volume.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/DeviceDataVolume/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/DeviceDataVolume/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/DeviceDataVolume/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings for the DeviceStatus Sub Project are held virtually
+ * Bi-weekly on Wednesday, 09:00 UTC
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/93413850406?password=3aeb0f1b-d9f9-42c5-91d8-3d2b20421ef1)
+ * Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/fzLe)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project 
+
+
+
+
+
+
+
+
+# DeviceIdentifier
+
+Sandbox API Repository to describe, develop, document, and test the DeviceIdentifier Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/czLe)
+
+## Scope
+
+* Service API “DeviceIdentifier” (see [APIBacklog](https://github.com/camaraproject/APIBacklog/blob/main/documentation/APIbacklog.md))
+* The API provides the API consumer with the ability to:
+ * Retrieve the current identity (IMEI) of the mobile device being used by a given mobile subscriber
+ * Retrieve the type (manufacturer and model) of the mobile device being used by a given mobile subscriber
+* Describe, develop, document, and test the API
+* Started: October 2022
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r2.2](https://github.com/camaraproject/DeviceIdentifier/releases/tag/r2.2) (Fall25), with the following API versions:
+ * **device-identifier v0.3.0**
+ [[YAML]](https://github.com/camaraproject/DeviceIdentifier/blob/r2.2/code/API_definitions/device-identifier.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceIdentifier/r2.2/code/API_definitions/device-identifier.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceIdentifier/r2.2/code/API_definitions/device-identifier.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/DeviceIdentifier/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/DeviceIdentifier/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/DeviceIdentifier/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings are held virtually
+ * Schedule: First Friday of each month at 15:00 UTC via Linux Foundation Zoom service
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/96981252767?password=fc957607-cc06-450f-b80a-229bb6a88c39)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14564298/DeviceIdentifier+Meeting+Minutes)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list [https://lists.camaraproject.org/g/sp-dvi](https://lists.camaraproject.org/g/sp-dvi) .
+ * A message to the community of this Sub Project can be sent using [sp-dvi@lists.camaraproject.org](mailto:sp-dvi@lists.camaraproject.org).
diff --git a/marked/DeviceIdentifier/code/API_definitions/device-identifier/raw.md b/marked/DeviceIdentifier/code/API_definitions/device-identifier/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..56d04493ddd2c94faac9f443c46a10a32328cc6c
--- /dev/null
+++ b/marked/DeviceIdentifier/code/API_definitions/device-identifier/raw.md
@@ -0,0 +1,869 @@
+# device-identifier
+
+```yaml
+openapi: 3.0.3
+info:
+ title: Device Identifier
+ version: wip
+ description: |
+ # Summary
+
+ The Mobile Device Identifier API returns details of the physical mobile device currently being used by a specified mobile subscriber. The following information can be returned:
+ - A unique network identifier for the specific device itself (IMEI SV and IMEI)
+ - A pseudonymised network identifier for the specific device itself (Pairwise Pseudonymous Identifier)
+ - A network identifier for the device make and model (IMEI Type Allocation Code)
+ - Device manufacturer name and model
+
+ This information can be useful in a number of scenarios, such as the following:
+ - For insurance purposes, to automatically identify a device that a customer wishes to insure
+ - For security / fraud reasons, to establish that a customer is not using a device they claim to have broken or lost
+ - For service delivery reasons, to optimise content for a particular device or OS type
+
+ # Introduction
+
+ Mobile devices are allocated a unique identifier by the manufacturer, known as the International Mobile Equipment Identity, or IMEI. The current software version (SV) of the device can be appended to this, in which case the identifier is known as the IMEI SV. This identifier is signalled to the mobile network when the device connects, both to confirm that the device is not blocked, and also allow device dependent network configurations to be implemented.
+
+ The IMEI is a 15 digit integer, and the IMEI SV is a 16 digit integer:
+ - The first 8 digits are known as the Type Allocation Code (TAC), and identify the manufacturer and model of the device
+ - The following 6 digits are the serial number of the device for that TAC
+ - For IMEI, the remaining digit is a check digit
+ - For IMEI SV, the remaining two digits are the software version
+
+ TACs are issued and managed by the GSMA, and can be queried using the [GSMA IMEI database](https://www.gsma.com/aboutus/workinggroups/terminal-steering-group/imei-database).
+
+ The mobile network associates this device identifier with the mobile subscription currently using the device. The mobile subscription is defined by the Subscriber Identity Module (SIM) currently active in the mobile device. This may be a removable SIM or an eSIM. In either case, it is possible for the association between the device identifier and subscription to change - for example, when a physical SIM is transferred to another mobile device.
+
+ 
+
+ The Device Identifier API allows the API consumer to obtain the IMEI and associated parameters for a specified mobile subscription identifier or equivalent. The mobile subscription can be identified using one or more of the following subscription identifiers:
+ - the subscription phone number (also known as MSISDN)
+ - the subscription network access identifier, which is a domain specific identifier typically allocated to devices that do not require voice / SMS connectivity
+ - the current IP address and port alloacted to the device, which must be an IPv6 or public IPv4 address
+
+ The API can be called by an API consumer to establish an identifier for the physical device currently being used by the mobile subscription. The information returned will depend upon the consent that the end user (i.e. mobile subscription owner) has given for that information to be provided to the API consumer. For example, if the end user has not consented to any information about their device being given, then the API consumer will receive an error in response to their request. Otherwise, the information that the end user has consented to being given will be returned.
+
+ # Relevant terms and definitions
+
+ ### Device Identifier API service endpoint
+ The URL pointing to the RESTful resource of the Device Identifier API.
+
+ ### Identifier for the mobile subscription
+ At least one identifier for the mobile subscription from the following four options:
+ - Phone number (i.e. MSISDN)
+ - Network Access Identifier assigned by the mobile network operator for the device
+ - IPv6 address
+ - IPv4 address
+
+ ### Identifier for the physical mobile device
+ The IMEI or IMEISV of the physical mobile device
+
+ ### Pairwise Pseudonymous Identifier
+ An identifier that has been pseudonymised such that the resulting pseudonymous identifier is unique to but persistent for a given API consumer
+
+ # API functionality
+
+ The API defines three service endpoints:
+
+ - `POST /retrieve-identifier` to get details about the specific device being used by a given mobile subscriber, including IMEI / IMEISV and the type of device
+ - `POST /retrieve-type` to get details only about the type (i.e. manufacturer and model) of device being used by a given mobile subscriber
+ - `POST /retrieve-ppid` to get a pseudonymised identifier for the specific device being used by a given mobile subscriber
+
+ To call any of these endpoints, the API consumer must first obtain a valid access token from the token endpoint, which is then passed as an Authorization header. When a 2-legged access token is used, the API consumer must also pass at least one of the available mobile subscription identifiers in the body of the request.
+
+ If the request is valid, the API response is a JSON object containing the data that the end user has consented to sharing with the API consumer.
+ - When calling endpoint `retrieve-identifier`, the response will always contain `imei`
+ - When calling endpoint `retrieve-type`, the response will always contain `tac`
+ - When calling endpoint `retrieve-ppid`, the response will always contain `ppid`
+ - Responses will also always contain a `lastChecked` field, indicating when the information provided was last confirmed to be correct
+ - Other response parameters are implementation dependent, and thus optional
+
+ An example of a JSON response object is as follows:
+ ```
+ {
+ "lastChecked": "2024-02-20T10:41:38.657Z",
+ "imeisv": "49015420323751800",
+ "imei": "4901542032375181",
+ "tac": "49015420",
+ "model": "3110",
+ "manufacturer": "Nokia"
+ }
+ ```
+
+ ## Error handling
+
+ Errors may be returned for the following reasons. Note that this list is not exhaustive.
+
+ `401 UNAUTHENTICATED`:
+ - The access token is not a valid access token for the API provider
+ - The access token was valid but has now expired
+
+ `400 INVALID_ARGUMENT`:
+ - The API request is not compliant with this OAS definition
+
+ `400 OUT_OF_RANGE`:
+ - A parameter value in the API request is outwith the range documented in this OAS definition for that parameter
+
+ `404 IDENTIFIER_NOT_FOUND`:
+ - The device identified by the `device` object in the request is not managed by the API provider
+
+ `403 PERMISSION_DENIED`:
+ - The access token does not have the required scope for the endpoint being called
+ - The end user has not consented to the API consumer getting access to the device identifier information (2-legged access token only)
+
+ `422 SERVICE_NOT_APPLICABLE`:
+ - A device identifier cannot be provided for the identified device. For example, the phone number might identify a landline.
+
+ `422 UNSUPPORTED_IDENTIFIER`:
+ - A parameter provided in the `device` object is not supported by this implementation (e.g. `networkAccessIdentifier`)
+
+ `422 MISSING_IDENTIFIER`:
+ `422 UNNECESSARY_IDENTIFIER`:
+ - See the section "Identifying the device from the access token" below
+
+ `429 QUOTA_EXCEEDED`:
+ - The API consumer has used up the quota of API requests that they were allocated for this API
+
+ `429 TOO_MANY_REQUESTS`:
+ - The rate at which the API consumer is sending requests has exceeded that allowed by the API provider. Try again later.
+
+ ### Additional CAMARA error responses
+
+ The list of error codes in this API specification is not exhaustive. Therefore the API specification may not document some non-mandatory error statuses as indicated in `CAMARA API Design Guide`.
+
+ Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version.
+
+ As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API.
+
+ # Further info and support
+
+ ## Authorization and authentication
+
+ The "Camara Security and Interoperability Profile" provides details of how an API consumer requests an access token. Please refer to Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the profile.
+
+ The specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst also being subject to the prevailing legal framework dictated by local legislation.
+
+ In cases where personal data is processed by the API and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design.
+
+ ## Identifying the device from the access token
+
+ This API requires the API consumer to identify a device as the subject of the API as follows:
+ - When the API is invoked using a two-legged access token, the subject will be identified from the optional `device` object, which therefore MUST be provided.
+
+ - When a three-legged access token is used however, this optional identifier MUST NOT be provided, as the subject will be uniquely identified from the access token.
+
+ This approach simplifies API usage for API consumers using a three-legged access token to invoke the API by relying on the information that is associated with the access token and was identified during the authentication process.
+
+ ### Error handling:
+ - If the subject cannot be identified from the access token and the optional `device` object is not included in the request, then the server will return an error with the `422 MISSING_IDENTIFIER` error code.
+
+ - If the subject can be identified from the access token and the optional `device` object is also included in the request, then the server will return an error with the `422 UNNECESSARY_IDENTIFIER` error code. This will be the case even if the same device is identified by these two methods, as the server is unable to make this comparison.
+
+ ## Multi-SIM scenario handling
+
+ In scenarios where a main phone number is shared between multiple devices, each of which has its own individual "secondary" phone number (e.g. connectivity plans that let you share your airtime and data allowances with a smartwatch or eSIM-enabled tablet), the phone number passed by the API consumer will be treated as the secondary phone number, and hence the identifier returned will be that of the single device associated with that phone number (e.g. smartphone, smartwatch, or eSIM-enabled tablet).
+
+ In such scenarios, the "primary" device is usually allocated the same main and secondary phone numbers, and hence providing the main phone number to the API will return the identity of the primary device (usually the smartphone) and not any associated devices.
+
+ (FAQs will be added in a later version of the documentation)
+
+ license:
+ name: Apache 2.0
+ url: https://www.apache.org/licenses/LICENSE-2.0.html
+ x-camara-commonalities: 0.6
+
+externalDocs:
+ description: Product documentation at CAMARA
+ url: https://github.com/camaraproject/DeviceIdentifier
+
+servers:
+ - url: "{apiRoot}/device-identifier/vwip"
+ variables:
+ apiRoot:
+ default: http://localhost:9091
+ description: API root, defined by the service provider, e.g. `api.example.com` or `api.example.com/somepath`
+
+tags:
+ - name: Get Device Identifiers
+ description: Retrieve details about the device being used by a mobile subscriber
+
+paths:
+ "/retrieve-identifier":
+ post:
+ summary: Get details about the specific device being used by a given mobile subscriber
+ description: Get details about the specific device being used by a given mobile subscriber
+ operationId: retrieveIdentifier
+ tags:
+ - Get Device Identifiers
+ security:
+ - openId:
+ - device-identifier:retrieve-identifier
+ parameters:
+ - $ref: "#/components/parameters/x-correlator"
+
+ requestBody:
+ description: Parameters to create a new session
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/RequestBody"
+ examples:
+ Identify Device By 3-Legged Access Token:
+ $ref: '#/components/examples/IdentifyDeviceBy3LeggedToken'
+ Identify Device By Phone Number:
+ $ref: '#/components/examples/IdentifyDeviceByPhoneNumber'
+ Identify Device By IP Address:
+ $ref: '#/components/examples/IdentifyDeviceByIPAddress'
+ Identify Device By Multiple Identifiers:
+ $ref: '#/components/examples/IdentifyDeviceByMultipleIdentifiers'
+
+ responses:
+ "200":
+ $ref: '#/components/responses/200RetrieveIdentifier'
+ "400":
+ $ref: '#/components/responses/400BadRequest'
+ "401":
+ $ref: '#/components/responses/401Unauthorized'
+ "403":
+ $ref: '#/components/responses/403Forbidden'
+ "404":
+ $ref: '#/components/responses/404NotFound'
+ "422":
+ $ref: '#/components/responses/422UnprocessableContent'
+ "429":
+ $ref: '#/components/responses/429TooManyRequests'
+
+ "/retrieve-type":
+ post:
+ summary: Get details about the type of device being used by a given mobile subscriber
+ description: Get details about the type of device being used by a given mobile subscriber
+ operationId: retrieveType
+ tags:
+ - Get Device Identifiers
+ security:
+ - openId:
+ - device-identifier:retrieve-type
+ parameters:
+ - $ref: "#/components/parameters/x-correlator"
+
+ requestBody:
+ description: Parameters to create a new session
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/RequestBody"
+ examples:
+ Identify Device By 3-Legged Access Token:
+ $ref: '#/components/examples/IdentifyDeviceBy3LeggedToken'
+ Identify Device By Phone Number:
+ $ref: '#/components/examples/IdentifyDeviceByPhoneNumber'
+ Identify Device By IP Address:
+ $ref: '#/components/examples/IdentifyDeviceByIPAddress'
+ Identify Device By Multiple Identifiers:
+ $ref: '#/components/examples/IdentifyDeviceByMultipleIdentifiers'
+
+ responses:
+ "200":
+ $ref: '#/components/responses/200RetrieveType'
+ "400":
+ $ref: '#/components/responses/400BadRequest'
+ "401":
+ $ref: '#/components/responses/401Unauthorized'
+ "403":
+ $ref: '#/components/responses/403Forbidden'
+ "404":
+ $ref: '#/components/responses/404NotFound'
+ "422":
+ $ref: '#/components/responses/422UnprocessableContent'
+ "429":
+ $ref: '#/components/responses/429TooManyRequests'
+
+ "/retrieve-ppid":
+ post:
+ summary: Get a pseudonymous identifier for device being used by a given mobile subscriber
+ description: Get a pseudonymous identifier for device being used by a given mobile subscriber
+ operationId: retrievePPID
+ tags:
+ - Get Device Identifiers
+ security:
+ - openId:
+ - device-identifier:retrieve-ppid
+ parameters:
+ - $ref: "#/components/parameters/x-correlator"
+
+ requestBody:
+ description: Parameters to identify the mobile subscription when a 2-legged access token is being used
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/RequestBody"
+ examples:
+ Identify Device By 3-Legged Access Token:
+ $ref: '#/components/examples/IdentifyDeviceBy3LeggedToken'
+ Identify Device By Phone Number:
+ $ref: '#/components/examples/IdentifyDeviceByPhoneNumber'
+ Identify Device By IP Address:
+ $ref: '#/components/examples/IdentifyDeviceByIPAddress'
+ Identify Device By Multiple Identifiers:
+ $ref: '#/components/examples/IdentifyDeviceByMultipleIdentifiers'
+
+ responses:
+ "200":
+ $ref: '#/components/responses/200RetrievePPID'
+ "400":
+ $ref: '#/components/responses/400BadRequest'
+ "401":
+ $ref: '#/components/responses/401Unauthorized'
+ "403":
+ $ref: '#/components/responses/403Forbidden'
+ "404":
+ $ref: '#/components/responses/404NotFound'
+ "422":
+ $ref: '#/components/responses/422UnprocessableContent'
+ "429":
+ $ref: '#/components/responses/429TooManyRequests'
+
+components:
+ securitySchemes:
+ openId:
+ description: Common security scheme for all CAMARA APIs
+ type: openIdConnect
+ openIdConnectUrl: https://example.com/.well-known/openid-configuration
+
+ parameters:
+ x-correlator:
+ name: x-correlator
+ in: header
+ description: Correlation id for the different services
+ schema:
+ $ref: "#/components/schemas/XCorrelator"
+
+ headers:
+ X-Correlator:
+ description: Correlation id for the different services
+ required: false
+ schema:
+ $ref: "#/components/schemas/XCorrelator"
+
+ responses:
+ 200RetrieveIdentifier:
+ description: An device identifier has been found for the specified subscriber
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ required:
+ - lastChecked
+ - imei
+ allOf:
+ - $ref: "#/components/schemas/CommonResponseBody"
+ - $ref: "#/components/schemas/DeviceIdentifier"
+ - $ref: "#/components/schemas/DeviceType"
+ examples:
+ Successful Identifier Retrieval:
+ description: Device identifier has been successfully retrieved when the device subscription was identified by a 3-legged access token or single device subscription identifier
+ value:
+ lastChecked: "2024-02-20T10:41:38.657Z"
+ imeisv: "49015420323751800"
+ imei: "4901542032375181"
+ tac: "49015420"
+ model: "3110"
+ manufacturer: "Nokia"
+ Successful Identifier Retrieval With Device Disambiguation:
+ description: Device identifier has been successfully retrieved when a 2-legged access token and multiple device subscription identifiers were provided
+ value:
+ device:
+ phoneNumber: "+123456789"
+ lastChecked: "2024-02-20T10:41:38.657Z"
+ imeisv: "49015420323751800"
+ imei: "4901542032375181"
+ tac: "49015420"
+ model: "3110"
+ manufacturer: "Nokia"
+
+ 200RetrieveType:
+ description: A device identifier has been found for the specified subscriber
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ required:
+ - lastChecked
+ - tac
+ allOf:
+ - $ref: "#/components/schemas/CommonResponseBody"
+ - $ref: "#/components/schemas/DeviceType"
+ examples:
+ Successful Type Retrieval:
+ description: Device type has been successfully retrieved when the device subcsription was identified by a 3-legged access token or single device subscription identifier
+ value:
+ lastChecked: "2024-02-20T10:41:38.657Z"
+ tac: "49015420"
+ model: "3110"
+ manufacturer: "Nokia"
+ Successful Type Retrieval With Device Disambiguation:
+ description: Device type has been successfully retrieved when a 2-legged access token and multiple device subscription identifiers were provided
+ value:
+ device:
+ phoneNumber: "+123456789"
+ lastChecked: "2024-02-20T10:41:38.657Z"
+ tac: "49015420"
+ model: "3110"
+ manufacturer: "Nokia"
+
+ 200RetrievePPID:
+ description: A pseudonymous device identifier has been found for the specified mobile subscriber
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ required:
+ - lastChecked
+ - ppid
+ allOf:
+ - $ref: "#/components/schemas/CommonResponseBody"
+ - $ref: "#/components/schemas/DevicePPID"
+ examples:
+ Successful PPID Retrieval:
+ description: Device PPID has been successfully retrieved when the device subcsription was identified by a 3-legged access token or single device subscription identifier
+ value:
+ lastChecked: "2024-02-20T10:41:38.657Z"
+ ppid: "b083f65ccdad365d7489fff24b6d5074b30c12b6d81db3404d25964ffd908813"
+ Successful PPID Retrieval With Device Disambiguation:
+ description: Device PPID has been successfully retrieved when a 2-legged access token and multiple device subscription identifiers were provided
+ value:
+ device:
+ phoneNumber: "+123456789"
+ lastChecked: "2024-02-20T10:41:38.657Z"
+ ppid: "b083f65ccdad365d7489fff24b6d5074b30c12b6d81db3404d25964ffd908813"
+
+ 400BadRequest:
+ description: Bad Request
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 400
+ code:
+ enum:
+ - INVALID_ARGUMENT
+ - OUT_OF_RANGE
+ examples:
+ Insufficient Parameters:
+ description: Sufficient parameters must be provided to allow the target UE to be identified
+ value:
+ status: 400
+ code: INVALID_ARGUMENT
+ message: "At least one of phoneNumber, networkAccessIdentifier, ipv4Address and ipv6Address must be specified"
+ Inconsistent Device Properties:
+ description: Device parameters provided identify different devices
+ value:
+ status: 400
+ code: INVALID_ARGUMENT
+ message: "Multiple inconsistent device parameters specified"
+ Invalid Network Access Identifier:
+ value:
+ status: 400
+ code: INVALID_ARGUMENT
+ message: "Invalid format: networkAccessIdentifier"
+ Invalid Phone Number:
+ value:
+ status: 400
+ code: INVALID_ARGUMENT
+ message: "Invalid format: phoneNumber"
+ Invalid IPv4 Address:
+ value:
+ status: 400
+ code: INVALID_ARGUMENT
+ message: "Invalid format: ipv4Address"
+ Invalid IPv6 Address:
+ value:
+ status: 400
+ code: INVALID_ARGUMENT
+ message: "Invalid format: ipv6Address"
+ Invalid Port Value:
+ value:
+ status: 400
+ code: OUT_OF_RANGE
+ message: "Invalid value: ipv4Address.publicPort"
+
+ 401Unauthorized:
+ description: Unauthorized
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 401
+ code:
+ enum:
+ - UNAUTHENTICATED
+ examples:
+ Unauthenticated Request:
+ description: Request cannot be authenticated and a new authentication is required
+ value:
+ status: 401
+ code: UNAUTHENTICATED
+ message: Request not authenticated due to missing, invalid, or expired credentials. A new authentication is required.
+
+ 403Forbidden:
+ description: Forbidden
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 403
+ code:
+ enum:
+ - PERMISSION_DENIED
+ examples:
+ Permision Denied:
+ description: Permission denied. OAuth2 token access does not have the required scope or when the user fails operational security
+ value:
+ status: 403
+ code: PERMISSION_DENIED
+ message: Client does not have sufficient permissions to perform this action.
+
+ 404NotFound:
+ description: Not found
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 404
+ code:
+ enum:
+ - IDENTIFIER_NOT_FOUND
+ examples:
+ Device Cannot Be Found:
+ description: The provided identifier cannot be matched to a device known to the API provider
+ value:
+ status: 404
+ code: IDENTIFIER_NOT_FOUND
+ message: The provided identifier cannot be matched to a device.
+
+ 422UnprocessableContent:
+ description: Unprocessable Content
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 422
+ code:
+ enum:
+ - SERVICE_NOT_APPLICABLE
+ - MISSING_IDENTIFIER
+ - UNSUPPORTED_IDENTIFIER
+ - UNNECESSARY_IDENTIFIER
+ examples:
+ Service Not Applicable For Device:
+ description: The service is not applicable for the identified device
+ value:
+ status: 422
+ code: SERVICE_NOT_APPLICABLE
+ message: The service is not applicable for the identified device.
+ Unsupported Identifier:
+ description: None of the provided identifiers is supported by the implementation
+ value:
+ status: 422
+ code: UNSUPPORTED_IDENTIFIER
+ message: None of the provided identifiers is supported by the implementation.
+ Unnecessary Identifier:
+ description: An explicit identifier has been provided for the device when this is already identified by the access token
+ value:
+ status: 422
+ code: UNNECESSARY_IDENTIFIER
+ message: An explicit identifier has been provided for the device when this is already identified by the access token
+ Missing Identifier:
+ description: An identifier is not included in the request and the device cannot be identified from the 2-legged access token
+ value:
+ status: 422
+ code: MISSING_IDENTIFIER
+ message: An identifier is not included in the request and the device cannot be identified from the 2-legged access token
+
+ 429TooManyRequests:
+ description: Too Many Requests
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 429
+ code:
+ enum:
+ - QUOTA_EXCEEDED
+ - TOO_MANY_REQUESTS
+ examples:
+ Too Many Requests:
+ description: Access to the API has been temporarily blocked due to quota or spike arrest limits being reached
+ value:
+ status: 429
+ code: TOO_MANY_REQUESTS
+ message: Rate limit reached
+ Quota Exceeded:
+ description: Request is rejected due to exceeding a business quota limit
+ value:
+ status: 429
+ code: QUOTA_EXCEEDED
+ message: Out of resource quota
+
+ schemas:
+ CommonResponseBody:
+ description: |
+ Common parameters to be included in all responses
+ properties:
+ device:
+ description: The device subscription identifier that was used to identify the device whose identifier is being returned. If this property is not present, then the device subscription identifier specified in the request was used.
+ allOf:
+ - $ref: "#/components/schemas/DeviceResponse"
+ - example: {"phoneNumber": "+123456789"}
+ lastChecked:
+ description: |
+ Date and time that the information was last confirmed by the mobile operator to be correct. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
+ type: string
+ format: date-time
+ example: "2024-02-20T10:41:38.657Z"
+
+ DeviceIdentifier:
+ description: |
+ The individual physical mobile device identifier, as expressed by the IMEI and IMEISV
+ type: object
+ properties:
+ imeisv:
+ type: string
+ description: IMEISV of the device
+ example: "49015420323751800"
+ imei:
+ type: string
+ description: IMEI of the device
+ example: "4901542032375181"
+
+ DeviceType:
+ description: |
+ The physical device type, as expressed by Type Approval Code, manufacturer name and model name
+ type: object
+ properties:
+ tac:
+ type: string
+ description: IMEI TAC of the device
+ example: "49015420"
+ model:
+ type: string
+ description: Model of the device
+ example: "3110"
+ manufacturer:
+ type: string
+ description: Manufacturer of the device
+ example: "Nokia"
+
+ DevicePPID:
+ description: |
+ The individual physical mobile device identifier, expressed as a PPID (Pairwise Pseudonymous Identifier)
+ type: object
+ properties:
+ ppid:
+ type: string
+ description: A PPID for the identified physical device
+ example: "b083f65ccdad365d7489fff24b6d5074b30c12b6d81db3404d25964ffd908813"
+
+ Device:
+ description: |
+ End-user equipment able to connect to a mobile network. Examples of devices include smartphones or IoT sensors/actuators.
+ The developer can choose to provide the below specified device identifiers:
+ * `ipv4Address`
+ * `ipv6Address`
+ * `phoneNumber`
+ * `networkAccessIdentifier`
+ NOTE 1: The MNO might support only a subset of these options. The API invoker can provide multiple identifiers to be compatible across different MNOs. In this case the identifiers MUST belong to the same device.
+ NOTE 2: For the current Commonalities release, we are enforcing that the networkAccessIdentifier is only part of the schema for future-proofing, and CAMARA does not currently allow its use. After the CAMARA meta-release work is concluded and the relevant issues are resolved, its use will need to be explicitly documented in the guidelines.
+ type: object
+ properties:
+ phoneNumber:
+ $ref: "#/components/schemas/PhoneNumber"
+ networkAccessIdentifier:
+ $ref: "#/components/schemas/NetworkAccessIdentifier"
+ ipv4Address:
+ $ref: "#/components/schemas/DeviceIpv4Addr"
+ ipv6Address:
+ $ref: "#/components/schemas/DeviceIpv6Address"
+ minProperties: 1
+
+ DeviceResponse:
+ description: |
+ An identifier for the end-user equipment able to connect to the network that the response refers to. This parameter is only returned when the API consumer includes the `device` parameter in their request (i.e. they are using a two-legged access token), and is relevant when more than one device identifier is specified, as only one of those device identifiers is allowed in the response.
+
+ If the API consumer provides more than one device identifier in their request, the API provider must return a single identifier which is the one they are using to fulfil the request, even if the identifiers do not match the same device. API provider does not perform any logic to validate/correlate that the indicated device identifiers match the same device. No error should be returned if the identifiers are otherwise valid to prevent API consumers correlating different identifiers with a given end user.
+
+ allOf:
+ - $ref: "#/components/schemas/Device"
+ - maxProperties: 1
+
+ DeviceIpv4Addr:
+ type: object
+ description: |
+ The device should be identified by either the public (observed) IP address and port as seen by the application server, or the private (local) and any public (observed) IP addresses in use by the device (this information can be obtained by various means, for example from some DNS servers).
+
+ If the allocated and observed IP addresses are the same (i.e. NAT is not in use) then the same address should be specified for both publicAddress and privateAddress.
+
+ If NAT64 is in use, the device should be identified by its publicAddress and publicPort, or separately by its allocated IPv6 address (field ipv6Address of the Device object)
+
+ In all cases, publicAddress must be specified, along with at least one of either privateAddress or publicPort, dependent upon which is known. In general, mobile devices cannot be identified by their public IPv4 address alone.
+ properties:
+ publicAddress:
+ $ref: "#/components/schemas/SingleIpv4Addr"
+ privateAddress:
+ $ref: "#/components/schemas/SingleIpv4Addr"
+ publicPort:
+ $ref: "#/components/schemas/Port"
+ anyOf:
+ - required: [publicAddress, privateAddress]
+ - required: [publicAddress, publicPort]
+ example:
+ {
+ "publicAddress": "84.125.93.10",
+ "publicPort": 59765
+ }
+
+ ErrorInfo:
+ type: object
+ required:
+ - status
+ - code
+ - message
+ properties:
+ status:
+ type: integer
+ description: HTTP response status code
+ code:
+ type: string
+ description: A human-readable code to describe the error
+ message:
+ type: string
+ description: A human-readable description of what the event represents
+
+ NetworkAccessIdentifier:
+ description: 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.
+ type: string
+ example: "123456789@example.com"
+
+ PhoneNumber:
+ description: 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, prefixed with '+'.
+ type: string
+ pattern: '^\+[1-9][0-9]{4,14}$'
+ example: "+123456789"
+
+ Port:
+ description: TCP or UDP port number
+ type: integer
+ minimum: 0
+ maximum: 65535
+
+ RequestBody:
+ description: Common request body to allow optional Device object to be passed
+ type: object
+ properties:
+ device:
+ $ref: "#/components/schemas/Device"
+
+ SingleIpv4Addr:
+ description: A single IPv4 address with no subnet mask
+ type: string
+ format: ipv4
+ example: "84.125.93.10"
+
+ DeviceIpv6Address:
+ description: |
+ The device should be identified by the observed IPv6 address, or by any single IPv6 address from within the subnet allocated to the device (e.g. adding ::0 to the /64 prefix).
+ type: string
+ format: ipv6
+ example: 2001:db8:85a3:8d3:1319:8a2e:370:7344
+
+ XCorrelator:
+ type: string
+ pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
+ example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
+
+ examples:
+ IdentifyDeviceBy3LeggedToken:
+ description: Empty JSON when device is identified by access token
+ value:
+ {}
+
+ IdentifyDeviceByPhoneNumber:
+ description: Identifying device by phone number
+ value:
+ device:
+ phoneNumber: "+123456789"
+
+ IdentifyDeviceByIPAddress:
+ description: Identifying device by IP address
+ value:
+ device:
+ ipv4Address:
+ publicAddress: "84.125.93.10"
+ publicPort: 59765
+
+ IdentifyDeviceByMultipleIdentifiers:
+ description: Identifying device by multiple device identifiers
+ value:
+ device:
+ phoneNumber: "+123456789"
+ ipv4Address:
+ publicAddress: "84.125.93.10"
+ publicPort: 59765
+ networkAccessIdentifier: "123456789@example.com"
+```
diff --git a/marked/DeviceIdentifier/documentation/API_documentation/Device_Identifier_User_Story/raw.md b/marked/DeviceIdentifier/documentation/API_documentation/Device_Identifier_User_Story/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..f338610321009ab95b21476000246949a30d0448
--- /dev/null
+++ b/marked/DeviceIdentifier/documentation/API_documentation/Device_Identifier_User_Story/raw.md
@@ -0,0 +1,44 @@
+# Device Identifier API User Story
+
+| **Item** | **Details** |
+| ---- | ------- |
+| ***Summary*** | As an application developer belonging to an enterprise, I want my application server to be able to request the identity of the mobile device (represented by the IMEI) currently being used by a given mobile network subscriber (identified by MSISDN, IP address or, when supported by network operators, a Network Access Identifier). Optionally, I'd like to know the make and model of that device. |
+| ***Roles, Actors and Scope*** | **Roles:** Customer:User
+
+
+
+
+
+
+
+
+# DeviceLocation
+
+Incubating API Repository to evolve and maintain the definitions and documentation of DeviceLocation Service API(s) within the Sub Project [Device Location](https://lf-camaraproject.atlassian.net/wiki/x/wgApBQ)
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/GDLe)
+
+## Scope
+* Service APIs for “Device Location” (see APIBacklog.md)
+* The APIs provide the API consumer with the ability to:
+ * verify the location of a device (location-verification).
+ * retrieve the location of a device (location-retrieval).
+ * subscribe and receive notifications about a device entering or leaving certain location (geofencing-subscriptions).
+ * NOTE: The scope of these APIs is limited (at least at a first stage) to 4G and 5G.
+* Describe, develop, document and test the APIs (with 1-2 Telcos)
+* Started: July 2022
+* Incubating stage since: February 2025
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r3.2](https://github.com/camaraproject/DeviceLocation/releases/tag/r3.2) (Fall25), with the following API versions:
+ * **geofencing-subscriptions v0.5.0**
+ [[YAML]](https://github.com/camaraproject/DeviceLocation/blob/r3.2/code/API_definitions/geofencing-subscriptions.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/code/API_definitions/geofencing-subscriptions.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/code/API_definitions/geofencing-subscriptions.yaml)
+ * **location-retrieval v0.5.0**
+ [[YAML]](https://github.com/camaraproject/DeviceLocation/blob/r3.2/code/API_definitions/location-retrieval.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/code/API_definitions/location-retrieval.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/code/API_definitions/location-retrieval.yaml)
+ * **location-verification v3.0.0**
+ [[YAML]](https://github.com/camaraproject/DeviceLocation/blob/r3.2/code/API_definitions/location-verification.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/code/API_definitions/location-verification.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/code/API_definitions/location-verification.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/DeviceLocation/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/DeviceLocation/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/DeviceLocation/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings are held virtually
+ - Schedule: bi-weekly (odd weeks), Tuesday, 8:00 AM UTC (9:00 CET/10:00 CEST)
+ - Meeting link: [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/91878854906?password=7e620a89-fcb5-4d2d-927a-17e3a0d1d28e)
+* Mailing list:
+ - To subscribe / unsubscribe to the mailing list of this Sub Project, please visit + +* [Issue #52](https://github.com/camaraproject/DeviceLocation/issues/52). Review doc/guidelines about units + - OK for doc enhancement + - Need to check if we are using meter or kilometer. **@Jose to open poll** +
+ +* Adopt [decision in Commonalities](https://github.com/camaraproject/WorkingGroups/issues/164) about keeping API documentation as part of the spec + - **@José will make it but after subscription is closed (and implemented)** +
+ +## Other questions during meeting + +* Question about checking CAMARA API compliance ? + - There is no formal certification process right now --> nobody will check the code + - CAMARA is about the interface not the code to provide it --> Implementation has to align on the swagger definition. + - Example of issue on compliance: how to have a common behavior for MatchRate compute - there will be interpretation by implementation. + - Good topic for discussion in Commonalities --> Need an issue. +
+ +* Comment about Partial answer + - Partial means the location match is no complete - but there will not additional response. This is not related to HTTP code 206. +
+ +* Discussion about event subscription + - Geofencing probably will be in Check Location + - But we can imagine other subscription to get directly location (every 30 minutes for example). In this case in will be the Get location API. Right now we do not have requested for this later. +
+ +* Question about authorization + - Several ways are defined but will be depending on local regulations + - Will be discussed case per case between consumer and provider + - This is beyond scope of this team +
+ +* **Next call is on May 23th.** diff --git a/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-05-23/raw.md b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-05-23/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..89f348ab608468641eed43aee9bf27e382c64734 --- /dev/null +++ b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-05-23/raw.md @@ -0,0 +1,103 @@ +# CAMARA DeviceLocation meeting - 2023-05-23 + +*May 23rd, 2023* + +## Attendees + +* Akos Hunyadi (DT) +* Amit Ahuja (Etisalat) +* Hacene Sali (Etisalat) +* Joachim Dahlgren (Ericsson) +* José Luis Urien Pinedo (Telefónica) +* Mohammad Sahid Khan () +* Rafal Artych (DT) +* Ravi Shekhar (ravishek) +* Syed Iqbal Hussain +* Tuan Tran (Broadpeak) +* 若山 敏康 () + + +QoD minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + +### Alignment with guidelines + +* [Issue #15](https://github.com/camaraproject/DeviceLocation/issues/15), related to [Issue #12](https://github.com/camaraproject/DeviceLocation/issues/12) + +* New model for `ueId`/`device` defined in [QualityOnDemand](https://github.com/camaraproject/QualityOnDemand), including new model for IPv4Address. Already merged + +* **@jlurien will make a PR for this** Still pending + +### Subscription for Location Area + +* [Issue #18](https://github.com/camaraproject/DeviceLocation/issues/18), [PR #49](https://github.com/camaraproject/DeviceLocation/pull/49) + +* Discussed in [Commonalities](https://github.com/camaraproject/WorkingGroups/issues/156) + - Ludovic updated the guidelines accordingly. Now waiting for the merge in Commonalities, pending on discussion for Guidelines versioning. + +* **PR once agreed (Ludovic)** -> Pending, Ludovic updated by email that he's ok with versioning proposal. + +### New API to provide raw location + +* [Issue #40](https://github.com/camaraproject/DeviceLocation/issues/40), [PR #55](https://github.com/camaraproject/DeviceLocation/pull/55) + - Also [Issue #43](https://github.com/camaraproject/DeviceLocation/issues/43) may be related -> **@ukkaps to clarify** + +* Agreed to have a separate API from the current one + - Proposal to move current one to a new basePath, e.g. `device-location-verification`, and leave `device-location` to this new one + - **@jlurien to open issue to discuss new name** + +* Review PR by Ludovic + - Discussion about modelling endpoint as POST vs GET in [Commonalities Issue #212](https://github.com/camaraproject/WorkingGroups/issues/212) + - Seems there is consensus about using POST for use cases like this one + - Opinions, further comments on the PR? + - **@Ludovic Ludovic will modify the spec** | + +### Add new parameter `maxAge` + +* [Issue #34](https://github.com/camaraproject/DeviceLocation/issues/34), [PR #53](https://github.com/camaraproject/DeviceLocation/pull/53) + +* Some comments on the issue, no comments on PR + +* **@all, please provide comments to PR** + +### Consolidate documentation into spec + +* Adopt [decision in Commonalities](https://github.com/camaraproject/WorkingGroups/issues/164) about keeping API documentation as part of the spec + +* **@José will make it but after subscription is closed (and implemented)** -> Pending + +### Units for radius + +* [Issue #52](https://github.com/camaraproject/DeviceLocation/issues/52). Review doc/guidelines about units + - OK for doc enhancement + - Need to check if we are using meter or kilometer. + +* **@Jose to open new issue** + +### Postal Code Area + +* [Issue #39](https://github.com/camaraproject/DeviceLocation/issues/39), [PR #47](https://github.com/camaraproject/DeviceLocation/pull/47) + +* Proposal by TEF to add Postal Codes as new type of area, lack of support from other partners about the business case + +* TEF keeps the PR on hold + +## AOB + +* Some questions about general topics of CAMARA, not directly related to Device Location. Pointing to the right place to raise that questions. + +* DT ask for time planning for new Release. Agreed to open an issue with tentative scope and roadmap, as they did in QoD. **AP on @jlurien** + +* Joachim comments about what is expected behaviour when requested accuracy is more restrictive that the one that network is able to satisfy. + - Current proposal is not clear about that + - **Joachim to open issue** + +
+ +**Next call is on June 6th.** diff --git a/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-06-06/raw.md b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-06-06/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..4bcc538bfef957e3a0764fb306705dc93664deeb --- /dev/null +++ b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-06-06/raw.md @@ -0,0 +1,135 @@ +# CAMARA DeviceLocation meeting - 2023-06-06 + +*June 6th, 2023* + +## Attendees + +* Akos Hunyadi (DT) +* Asad Imran Aslam +* Cetin Alpaycetin (Vodafone) +* Joachim Dahlgren (Ericsson) +* Jorge Garcia Hospital (TEF) +* José Luis Urien Pinedo (TEF) +* Ludovic Robert (Orange) +* Rafal Artych (DT) +* Ravi Shekar +* Sébastien Synold (Intersec) +* Shyamal Patabendige +* Toshi Wakayama (KDDI) +* Udaka Kappagoda (Axiata) + +QoD minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Introduction to new members: Sébastien & Cetin +* Open issues and PRs +* Any other business + +## Open issues and PRs + +### Alignment with guidelines + +* [Issue #15](https://github.com/camaraproject/DeviceLocation/issues/15), related to [Issue #12](https://github.com/camaraproject/DeviceLocation/issues/12) + +* New model for `ueId`/`device` defined in [QualityOnDemand](https://github.com/camaraproject/QualityOnDemand), including new model for IPv4Address. + +* New PR #61 [https://github.com/camaraproject/DeviceLocation/pull/61]. Reviewed by Orange +* **Merge planned June 7th EOB if no blocking comment** + +### Subscription for Location Area + +* [Issue #18](https://github.com/camaraproject/DeviceLocation/issues/18), [PR #49](https://github.com/camaraproject/DeviceLocation/pull/49) + +* Discussed in [Commonalities](https://github.com/camaraproject/WorkingGroups/issues/156) + - New model now consolidated in Guidelines. + - New [PR in QoD](https://github.com/camaraproject/QualityOnDemand/pull/155) with a similar alignment to guidelines. It could be taken as example. + +* [PR #49](https://github.com/camaraproject/DeviceLocation/pull/49) by @maxl2287 (DT) needs to be adapted. * **DT will continue the crafting work** + +* Need discussion if Geo fence should be separated from check location operation as distinct model/business case could be provided. + - **Ludovic will create an issue to capture team feedback.** + + +### New API to provide raw location + +* [Issue #40](https://github.com/camaraproject/DeviceLocation/issues/40), [PR #55](https://github.com/camaraproject/DeviceLocation/pull/55) + +* Agreed to have a separate API from the current one + - Proposal to move current one to a new basePath, e.g. `device-location-verification`, and leave `device-location` to this new one + - Issue [#59](https://github.com/camaraproject/DeviceLocation/issues/59). **To discuss during meeting** + +* Review PR by Ludovic + - Discussion about modelling endpoint as POST vs GET in [Commonalities Issue #212](https://github.com/camaraproject/WorkingGroups/issues/212) + - Seems there is consensus about using POST for use cases like this one + - Some comments and fixes in PR. + - Discussion in meeting about link with consent in particular when the location requested is for IoT - there is an Identity & Consent Management project where discussion occurs + +* **Merge planned June 7th EOB if no blocking comment.** + +### Add new parameter `maxAge` + +* [Issue #34](https://github.com/camaraproject/DeviceLocation/issues/34), [PR #53](https://github.com/camaraproject/DeviceLocation/pull/53) + +* Some comments on the issue, no comments on PR + +* **@all, please provide comments to PR** + - Need additional work to be completed as it is not 100% clear + +### Consolidate documentation into spec + +* Adopt [decision in Commonalities](https://github.com/camaraproject/WorkingGroups/issues/164) about keeping API documentation as part of the spec + +* **@José will make it but after subscription is closed (and implemented)** +* **@Ludovic will make for the 'raw' location API** + +### Units for radius + +* [Issue #52](https://github.com/camaraproject/DeviceLocation/issues/52). Review doc/guidelines about units + - OK for doc enhancement + - Need to check if we are using meter or kilometer. + +* [Issue #60](https://github.com/camaraproject/DeviceLocation/issues/60) + - Discuss during meeting: Depending on the back end - glmc (meter accuracy) or nef - the accuracy is very different + +* **Ask for team to provide comments in issue** + +### Behaviour when requesting too high precision + +* [Issue #58](https://github.com/camaraproject/DeviceLocation/issues/58) about what is expected behaviour when requested accuracy is more restrictive that the one that network is able to satisfy. + - No comments so far + - Discuss during meeting: We need to provide a hint that the precision request is (definitely) too fine for API provider + +* **Ask for team to provide comments in issue** + +### Roadmap for Release v0.2 + +* We have to decide in Commonalities how to communicate roadmap for multiple API project. +* Our roadmap could be: + - Release in June featuring + - For check location: + - Rename location to location-verification (issue 59) + - Align device model (PR 61) + - Add documentation in the OAS + - For raw location: + - Provide v0.1 + - With documentation integrated in the OAS + - Release in August + - Adding location subscription/notification for checking location + +### Postal Code Area + +* [Issue #39](https://github.com/camaraproject/DeviceLocation/issues/39), [PR #47](https://github.com/camaraproject/DeviceLocation/pull/47) + +* Proposal by TEF to add Postal Codes as new type of area, lack of support from other partners about the business case + +* TEF keeps the PR on hold. + +* **TEF will move discussion to business track in GSMA (@Jorge)** + +## AOB + + +
+ +**Next call is on June 20th.** diff --git a/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-06-20/raw.md b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-06-20/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..ad85c1a171fe8065762f72eb1f51de24ea2d6ec7 --- /dev/null +++ b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-06-20/raw.md @@ -0,0 +1,140 @@ +# CAMARA DeviceLocation meeting - 2023-06-20 + +*June 20th, 2023* + +## Attendees + +* Akos Hunyadi (DT) +* Cetin Alpaycetin (Vodafone) +* Fernando Prado Cabrillo (TEF) +* Joachim Dahlgren (Ericsson) +* Jorge Garcia Hospital (TEF) +* José Luis Urien Pinedo (TEF) +* Ludovic Robert (Orange) +* Rafal Artych (DT) +* Sébastien Synold (Intersec) +* Toshi Wakayama (KDDI) + +QoD minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + +### Alignment with guidelines + +* [Issue #15](https://github.com/camaraproject/DeviceLocation/issues/15) closed. +* [PR #61](https://github.com/camaraproject/DeviceLocation/pull/61) merged. + + +### Subscription for Location Area + +* [Issue #18](https://github.com/camaraproject/DeviceLocation/issues/18), [PR #49](https://github.com/camaraproject/DeviceLocation/pull/49) + - To be aligned with Commonalities + - **DT will continue the crafting work** + +* [Issue #64](https://github.com/camaraproject/DeviceLocation/issues/64): Discussion if Geo fence should be separated from check location operation as distinct model/business case could be provided. + - **Team Decision**: We will have 2 APIS - Ludovic will comment issue & close it. + - Current Device location verification will stay only with one operation + - PR #49 should be close + - Need a discussion about the name + + +### New API to provide raw location + +* [Issue #40](https://github.com/camaraproject/DeviceLocation/issues/40), [PR #55](https://github.com/camaraproject/DeviceLocation/pull/55) + +* Agreed to have a separate API from the current one + - [Issue #59](https://github.com/camaraproject/DeviceLocation/issues/59), [PR #66](https://github.com/camaraproject/DeviceLocation/pull/66) + - `device-location-verification` or `location-verification`: **Team Decision**: remove device prefix + +* Review PR by Ludovic + - **Team Decision**: need to switch to meter, related to [Issue #60](https://github.com/camaraproject/DeviceLocation/issues/60) + - Discussion on age of location: + - Depends on the UC. If we do not provide age of location we need to have a global rule about retrieval delay + +* **Team Decision**: Regarding the date related parameters + - `lastLocationTime` in the response mandatory + - `maxAge` will be optional in the request + +* Documentation will be handled in a second PR for raw location + +* Another API could be to have a history API but data are not obviously available from network. If needed, it is a separate use case. + + +### Add new parameter `maxAge` + +* [Issue #34](https://github.com/camaraproject/DeviceLocation/issues/34), [PR #53](https://github.com/camaraproject/DeviceLocation/pull/53) + +* Some comments on the issue, no comments on PR + +* **Team Decision** Regarding the date related parameters: + - `lastLocationTime` in the response mandatory + - `maxAge` will be optional in the request + - Add explicit information of maxAge about the fact that its concerns only the last location + - `maxAge` will be in second with a minimum of 60. + +* [PR #53](https://github.com/camaraproject/DeviceLocation/pull/53) will be aligned. @José will comment +* @Ludovic will align raw location API + + +### Consolidate documentation into spec + +* Adopt [decision in Commonalities](https://github.com/camaraproject/WorkingGroups/issues/164) about keeping API documentation as part of the spec + +* **@José will make it but after subscription is closed (and implemented)** -> Pending +* **@Ludovic will make for the 'raw' location API**, separate PR after [PR #55](https://github.com/camaraproject/DeviceLocation/pull/55) + +### Units for radius + +* [Issue #60](https://github.com/camaraproject/DeviceLocation/issues/60) + - Discuss during meeting: Depending on the back end - glmc (meter accuracy) or nef - the accuracy is very different + +* **Team decision**: Move to meters + +### Behaviour when requesting too high precision + +* [Issue #58](https://github.com/camaraproject/DeviceLocation/issues/58) about what is expected behaviour when requested accuracy is more restrictive that the one that network is able to satisfy. + - No comments so far + - Discuss during meeting: We need to provide a hint that the precision request is (definitely) too fine for API provider + +* **Ask for team to provide comments in issue** + - Need to check how current system manage when the accuracy is to small - always False? + - Need additional discussion + + +### Roadmap for Release v0.2 + +* We have to decide in Commonalities how to communicate roadmap for multiple API project. +* Our roadmap could be: + - Release in June featuring + - For check location: + - Rename location to location-verification (issue 59) -> PR + - ~~Align device model (PR 61)~~ + - Add documentation in the OAS -> Pending PR + - For raw location: + - Provide v0.1 + - With documentation integrated in the OAS + - Release in August + - Adding location subscription/notification for checking location + +* From roadmap perspective we are on track for API definition - for the documentation it could be probably delivered in July. + +### Postal Code Area + +* [Issue #39](https://github.com/camaraproject/DeviceLocation/issues/39), [PR #47](https://github.com/camaraproject/DeviceLocation/pull/47) + +* Proposal by TEF to add Postal Codes as new type of area, lack of support from other partners about the business case + +* TEF has moved discussion to business track in GSMA. Any update? + - Not yet, @Jorge provides update on business track. + +## AOB + + +
+ +**Next call is on July 4th.** diff --git a/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-07-04/raw.md b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-07-04/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..10429c55e382e911da2e2dda08e8c5b69d444673 --- /dev/null +++ b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-07-04/raw.md @@ -0,0 +1,145 @@ +# CAMARA DeviceLocation meeting - 2023-07-04 + +*July 4th, 2023* + +## Attendees + +* Akos Hunyadi (DT) +* Cetin Alpaycetin (Vodafone) +* Fernando Prado Cabrillo (TEF) +* Joachim Dahlgren (Ericsson) +* Jorge Garcia Hospital (TEF) +* José Luis Urien Pinedo (TEF) +* Ludovic Robert (Orange) +* Ravi Shekhar () +* Sébastien Synold (Intersec) +* Toshi Wakayama (KDDI) + +QoD minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + + +### Subscription for Location Area + +* [Issue #18](https://github.com/camaraproject/DeviceLocation/issues/18), [PR #49](https://github.com/camaraproject/DeviceLocation/pull/49) + - PR #49 should be close, new PR to be created + - **DT will open new PR soon** + +* [Issue #69](https://github.com/camaraproject/DeviceLocation/issues/69): Proposal for new name + - Orange preference for `location-verification-subscription` + - Keep open to get more opinions + + +### New API to provide raw location + +* [Issue #40](https://github.com/camaraproject/DeviceLocation/issues/40), [PR #55](https://github.com/camaraproject/DeviceLocation/pull/55) + +* Review PR by @Orange: + - Switched to meters + - Added `maxAge` (optional) to request + - Added `lastLocationTime` (required) to response + - Documentation will be handled in a second PR for raw location + +* Almost ready - Ludovic will integrate José requests this week +* Align Area model with Location verification with allOf + + +### Add new parameter `maxAge` + +* [Issue #34](https://github.com/camaraproject/DeviceLocation/issues/34), [PR #53](https://github.com/camaraproject/DeviceLocation/pull/53) + +* Agreed: + - `lastLocationTime` in the response mandatory + - `maxAge` will be optional in the request + - Add explicit information of maxAge about the fact that its concerns only the last location + - `maxAge` will be in second with a minimum of 60. + +* Comments in [PR #53](https://github.com/camaraproject/DeviceLocation/pull/53). It must be rebased, or close this and new PR + - ** @DT will discuss with the team how to process (rebase or new PR) ** +* Applied to [PR #55](https://github.com/camaraproject/DeviceLocation/pull/55) + + +### Consolidate documentation into spec + +* Adopt [decision in Commonalities](https://github.com/camaraproject/WorkingGroups/issues/164) about keeping API documentation as part of the spec + +* New [PR #71](https://github.com/camaraproject/DeviceLocation/pull/71), + - **ready to be merged** + + +### Units for radius + +* [Issue #60](https://github.com/camaraproject/DeviceLocation/issues/60) + - Decided to move to meters. + - Pending new PR -> @TEF will do it, just converting to meters + +* Decide on new limits. Now, they are 2km to 200 km + - Discussion to set minimum to 1 km + - Privacy needs to be considered if we are too precise. + - Probably better for now to keep 2 km. + - Question from Joachim Dahlgren about correlation between precision vs consent required + - Question from Cetin about the max - Do we really need to set to 200 km explicitly + - We can remove it probably? + - ** AP: Open an Issue to discuss this. ** + + +### Behaviour when requesting too high precision + +* [Issue #58](https://github.com/camaraproject/DeviceLocation/issues/58) about what is expected behaviour when requested accuracy is more restrictive that the one that network is able to satisfy. + - No new comments + - From previous meeting: We need to provide a hint that the precision request is (definitely) too fine for API provider, need to check how current system manage when the accuracy is to small - always False? + +* To be discussed during meeting. + - ** @TEF will provide examples about 'Partial' UC ** + - We need to align on the formula to calculate the 'matchRate' for PARTIAL answer + + +### Align Area to new model for inheritance vs polymorphism + +* [Issue #72](https://github.com/camaraproject/DeviceLocation/issues/72) + - ** @TEF will open new PR ** + + +### Roadmap for Release v0.2 + +* We have to decide in Commonalities how to communicate roadmap for multiple API project. +* Our roadmap could be: + - Release in July featuring + - For check location: + - ~~Rename location to location-verification (issue 59)~~ + - ~~Align device model (PR 61)~~ + - Add documentation in the OAS -> PR to be merged + - For raw location: + - Provide v0.1 -> PR to be merged + - With documentation integrated in the OAS -> Pending PR + - Release in August / September (depending on holidays): + - Adding location subscription/notification for checking location + +* From roadmap perspective we are on track for API definition - for the documentation it could be probably delivered in July. + + +### Postal Code Area + +* [Issue #39](https://github.com/camaraproject/DeviceLocation/issues/39), [PR #47](https://github.com/camaraproject/DeviceLocation/pull/47) + +* Proposal by TEF to add Postal Codes as new type of area, lack of support from other partners about the business case + +* New request from GSMA to add administrative code (like postal code) + - How we will manage case where implementation did not provide all location type?, Discovery?, Error? + +* **@TEF: add a new issue and close this one.** + + +## AOB + +* Add a file for summer presence (Ludovic will do) + +
+ +**Next call is on July 18th.** diff --git a/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-07-18/raw.md b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-07-18/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..28e17386853ed14336e786c4d63de0dc937e1824 --- /dev/null +++ b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-07-18/raw.md @@ -0,0 +1,148 @@ +# CAMARA DeviceLocation meeting - 2023-07-18 + +*July 18th, 2023* + +## Attendees + +* Akos Hunyadi (DT) +* Cetin Alpaycetin (Vodafone) +* Fernando Prado Cabrillo (TEF) +* Joachim Dahlgren (Ericsson) +* José Luis Urien Pinedo (TEF) +* Ludovic Robert (Orange) +* Rafal Artych (DT) +* Sébastien Synold (Intersec) +* Toshi Wakayama (KDDI) + + +QoD minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + + +### Subscription for Location Area + +* [Issue #18](https://github.com/camaraproject/DeviceLocation/issues/18), [PR #74](https://github.com/camaraproject/DeviceLocation/pull/74) + - Old PR #49 was close, new PR created + - Many comments, most resolved. Ongoing discussions in Commonalities may affect this PR. + - Probably better to **stick to current design** and then adjust later. + - DT team keeps the design aligned with Device Status API. + - Ludovic Robert will make a review of his previous comments to close resolved one + + +* [Issue #69](https://github.com/camaraproject/DeviceLocation/issues/69): Proposal for new name + - Orange preference for `location-verification-subscription`, Ericsson preference for `geofencing` + - Joachim Dahlgren provided rational for geofencing instead of location-verification-subscription as we can have a second location subscription feature for geotracking. + - DT as owner of this API will consider this naming proposal and get back to the team (Akos Hunyadi) + - Looking for team feedback + + + +### New API to provide raw location + +* [Issue #40](https://github.com/camaraproject/DeviceLocation/issues/40), [PR #55](https://github.com/camaraproject/DeviceLocation/pull/55) + - Most comments resolved + - José Luis Urien Pinedo will make a final review + - Ludovic will work on the documentation only once PR#55 has been merged to avoid + + +### Add new parameter `maxAge` + +* [Issue #34](https://github.com/camaraproject/DeviceLocation/issues/34), [PR #53](https://github.com/camaraproject/DeviceLocation/pull/53) + +* Agreed: + - `lastLocationTime` in the response mandatory + - `maxAge` will be optional in the request + - Add explicit information of maxAge about the fact that its concerns only the last location + - `maxAge` will be in second with a minimum of 60. + +* Comments in [PR #53](https://github.com/camaraproject/DeviceLocation/pull/53). It must be rebased, or close this and new PR + - ** @DT will discuss with the team how to process (rebase or new PR) ** -> José will check but the rebase has probably been already done +* Applied to [PR #55](https://github.com/camaraproject/DeviceLocation/pull/55) + + +### Behaviour when requesting too high precision + +* [Issue #58](https://github.com/camaraproject/DeviceLocation/issues/58) about what is expected behaviour when requested accuracy is more restrictive that the one that network is able to satisfy. + - No new comments + - From previous meeting: We need to provide a hint that the precision request is (definitely) too fine for API provider, need to check how current system manage when the accuracy is to small - always False? + +* To be discussed during meeting. + - ** @TEF will provide examples about 'Partial' UC ** -> Some internal discussions, José will post some material to illustrate the problem; + - We need to align on the formula to calculate the 'matchRate' for PARTIAL answer + + +### Roadmap for Release v0.2 + +* We have to decide in Commonalities how to communicate roadmap for multiple API project. +* Our roadmap could be: + - Release in July featuring + - For check location: -> ready for 0.2 + - ~~Rename location to location-verification (issue 59)~~ + - ~~Align device model (PR 61)~~ + - ~~Add documentation in the OAS~~ + - For raw location: + - Provide v0.1 -> ready to be merged - documentation will be tackled in a separate PR + - With documentation integrated in the OAS -> Pending PR + - Release in August / September (depending on holidays): + - Adding location subscription/notification for checking location + +* From roadmap perspective we are on track for API definition - for the documentation it could be probably delivered in July. + + +### Postal Code Area + +* [Issue #39](https://github.com/camaraproject/DeviceLocation/issues/39), [PR #47](https://github.com/camaraproject/DeviceLocation/pull/47) + +* Proposal by TEF to add Postal Codes as new type of area, lack of support from other partners about the business case + +* New request from GSMA to add administrative code (like postal code) + - How we will manage case where implementation did not provide all location type?, Discovery?, Error? + +* **@TEF: add a new issue and close this one.** -> Pending + +* Discussion on how to handle the 'diversity' of the 'geo' code that we can have in a given country. + +* How a developer will know the 'type' of area managed by a telco + - José mentioned discussion about TMF Catalog API (as operate API) - As a discovery feature. + - An error scenario must be defined in CAMARA if the area type requested is not supported by the telco + + +## Test Cases + +* New [Issue #80](https://github.com/camaraproject/DeviceLocation/issues/80) + +* Wait for other working group & commonalities agreement alignment + +* Discussion about use of Gherkin + specific implementation + - Gherkin file should (must?) be provided + - Specific language implementation file could be provided but as part of implementation contribution + + +## Accuracy Levels for Device Location APIs + +* New [Issue #78](https://github.com/camaraproject/DeviceLocation/issues/78) + - Discuss if we need this functionality + +* José/Ludovic not sure about the relevance of the problem with current technology as we're not able to provide 'fine-grain' location. + +* Joachim raised that if we have this capabilities to provide coarse vs fine we'll have a consent issue that cannot be at 'global' api level but dependent on the accuracy + + +## Summer 2023 presence + +* New [PR #75](https://github.com/camaraproject/DeviceLocation/pull/75) + - Only Ludovic added this presence + +* Keep Aug 1st - José will host. +* Skip Aug 15th …. except of someone volunteer to host it + + +
+ +**Next call is on August 1st** diff --git a/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-08-01/raw.md b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-08-01/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..64712ebf201289f4dbcba5cb454e75433cc71064 --- /dev/null +++ b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-08-01/raw.md @@ -0,0 +1,100 @@ +# CAMARA DeviceLocation meeting - 2023-08-01 + +*August 1st, 2023* + +## Attendees + +* Abhisek Das (Infosys) +* Akos Hunyadi (DT) +* Cetin Alpaycetin (Vodafone) +* Fernando Prado Cabrillo (TEF) +* Javier Carro (TEF) +* Jorge Garcia Hospital (TEF) +* José Luis Urien Pinedo (TEF) +* Rafal Artych (DT) +* Toshi Wakayama (KDDI) +* Tuan Tran (Broadpeak) + +QoD minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + + +### Geofencing v0.1-wip (Subscription for Location Area) + +* [Issue #18](https://github.com/camaraproject/DeviceLocation/issues/18), [PR #74](https://github.com/camaraproject/DeviceLocation/pull/74) + - Old PR #49 was close, new PR created + - Comments addressed, ready for final approval + +* [Issue #69](https://github.com/camaraproject/DeviceLocation/issues/69): Proposal for new name + - `geofencing` got consensus as name, PR updated, issue closed + + +### New API to provide raw location, v0.1-wip + +* [Issue #40](https://github.com/camaraproject/DeviceLocation/issues/40), [PR #55](https://github.com/camaraproject/DeviceLocation/pull/55) + - Reviewed, has 2 approvals. Ready to be merged + - Ludovic will work on the documentation only once PR#55 has been merged to avoid + + +### Behaviour when requesting too high precision + +* [Issue #58](https://github.com/camaraproject/DeviceLocation/issues/58) about what is expected behaviour when requested accuracy is more restrictive that the one that network is able to satisfy. + +* New [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85) + - TEF provided a doc with a proposal and use cases for the implementation of 'Partial' and matchRate + - Discussion during meeting. Issue to be updated: + - Akos commented that the ratio may not be enough and maybe we should add some text or rational. + - Cetin thinks that it makes sense to return a low percent since it is caused by a bad behaviour of the network. + - Telefónica agrees but raise the problem with Product team approach and how the quality of the product is perceived. + - We will see the possibility to split the partial values into different values as proposed by Jose and Akos. + +### Roadmap for Release v0.2 + +* New [Issue #84](https://github.com/camaraproject/DeviceLocation/issues/84) to unify naming for POST operations + - Current one: POST /verifications + POST /retrieve-location + - Decide on POST /verify-location + POST /retrieve-location, or simpler: POST /verify + POST /retrieve + - **Agreed to change paths to POST /verify + POST /retrieve** + +* We have to decide in Commonalities how to communicate roadmap for multiple API project. + +* Our roadmap could be: + - Release in August featuring + - For location-verification: -> ready for 0.2 + - For location: + - Provide v0.1 -> ready to be merged - documentation will be tackled in a separate PR + - For geofencing: + - Provide v0.1 -> ready to be merged - documentation will be tackled in a separate PR + - Release in late August / September (depending on holidays): + + +### Postal Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track, closing old [Issue #39](https://github.com/camaraproject/DeviceLocation/issues/39). [PR #47](https://github.com/camaraproject/DeviceLocation/pull/47) to be closed when new one is created. + +* Some initial comments, we can start discussion but this requirement will be in the scope of future releases. + - How to handle the 'diversity' of the 'geo' code that we can have in a given country. + - How to discover what is implemented by each provider. + - Error scenario must be defined in CAMARA if the area type requested is not supported by the telco + +* Requirement to be covered by future releases, we keep discussion open in issue. + + +## Summer 2023 presence + +* Decided to skip Aug 15th + + +## AOB + +* Akos raises the Commonalities Issue regarding CloudEvents and how it will affect the Geofencing API. + - From Telefónica, another colleague is working on the issue and will update Commonalities in the next days. + +
+ +**Next call is on August 29th** diff --git a/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-08-29/raw.md b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-08-29/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..8507a08cc6a87d819eda0667246983636308cb18 --- /dev/null +++ b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-08-29/raw.md @@ -0,0 +1,86 @@ +# CAMARA DeviceLocation meeting - 2023-08-29 + +*August 29th, 2023* + +## Attendees + +* Cetin Alpaycetin (Vodafone) +* Joachim Dahlgren (Ericsson) +* Jorge Garcia Hospital (TEF) +* José Luis Urien Pinedo (TEF) +* Ludovic Robert (Orange) +* Rafal Artych (DT) +* Vidhi Mehta (Comviva) + + +QoD minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + + +### Location Retrieval, v0.1-wip (Get raw location) + +* [Issue #40](https://github.com/camaraproject/DeviceLocation/issues/40), [PR #55](https://github.com/camaraproject/DeviceLocation/pull/55) + - Official name to be location-retrieval + - Reviewed, has 2 approvals. Decided to merge! + - Ludovic will work on the documentation only once PR#55 has been merged + + +### Geofencing v0.1-wip (Subscription for Location Area) + +* [Issue #18](https://github.com/camaraproject/DeviceLocation/issues/18), [PR #74](https://github.com/camaraproject/DeviceLocation/pull/74) + - Ludovic provided feedback on notification discussion in Commonalities, progress & plan: + - Have a specific swagger for generic notification + - Format for this dedicated notification swagger --> probably use Cloud Event structure + - Use of callbacks clause in the API swagger to describe API notification + - Issue API Design for "Resource-based subscription", [Commonalities Issue #44](https://github.com/camaraproject/Commonalities/issues/44) is the good place to follow progress + - Some comments still pending + - Probably for next meeting we can align Geofencing with commonalities + - Close to be merged as v0.1.0-wip, inline doc to be added later + + +### Roadmap to Release v0.2 + +* The proposed process for a version is to have a version x.y-wip then x.y-rc and then finally released as x.y. This pattern is used in QoD. +* Align the Device Location API with the security schema as described in Unify specification of `securitySchemes`, `security` and scopes, [Commonalities Issue #53](https://github.com/camaraproject/Commonalities/issues/53) +* Next steps: + - Create v0.2-rc for location-verification, updating Changelog and Release notes. + - Add location-retrieval v0.1.0-wip + - Add geofencing v0.1.0-wip, if aligned with Commonalities + - Give a couple of weeks for final testing and comments + - Approve a release after next meeting + + +### Behaviour when requesting too high precision + +* [Issue #58](https://github.com/camaraproject/DeviceLocation/issues/58) about what is expected behaviour when requested accuracy is more restrictive that the one that network is able to satisfy. +* New [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85) + - TEF provided a doc with a proposal and use cases for the implementation of 'Partial' and matchRate + - Further discussion needed. Orange team will make a review. + +### Administrative Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track + - Old [PR #47](https://github.com/camaraproject/DeviceLocation/pull/47) to be closed when new one is created. +* No new comments since last meeting, same questions/doubts: + - How to handle the 'diversity' of the 'geo' code that we can have in a given country. + - How to discover what is implemented by each provider. + - Error scenario must be defined in CAMARA if the area type requested is not supported by the telco. +* Discussion during the meeting: + - These questions could have a larger magnitude than this Device location API and should also infuse in Commonalities + - Adding Open Gateway product in the discussion could make sense as this OPGW could probably restrict a CAMARA API capability + - Discussion on the 'critical mass' to introduce API or API capability within one country. + + + +## AOB +N/A + +
+ +**Next call is on September 12th** diff --git a/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-09-12/raw.md b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-09-12/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..2a5e1e69ba17f8cbced91f5c79672bf14fbe52c5 --- /dev/null +++ b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-09-12/raw.md @@ -0,0 +1,93 @@ +# CAMARA DeviceLocation meeting - 2023-09-12 + +*September 12th, 2023* + +## Attendees + +* Akos Hunyadi (DT) +* Fernando Prado Cabrillo (TEF) +* Javier Carro (TEF) +* Joachim Dahlgren (Ericsson) +* José Luis Urien Pinedo (TEF) +* Ludovic Robert (Orange) +* Rafal Artych (DT) +* Toshi Wakayama (KDDI) + + +QoD minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + + +### Location Retrieval, v0.1-wip (Get raw location) + +* [Issue #40](https://github.com/camaraproject/DeviceLocation/issues/40), [PR #55](https://github.com/camaraproject/DeviceLocation/pull/55) + - Merged but any comment are welcome + - Joachim: Maybe we should consider to send back other area than circle. +This is only in the response -> **@Joachim will raise an issue** + +### Geofencing v0.1-wip (Subscription for Location Area) + +* [Issue #18](https://github.com/camaraproject/DeviceLocation/issues/18), [PR #74](https://github.com/camaraproject/DeviceLocation/pull/74) + - Notification pattern is still in progress in Commonalities to accommodate use of [CloudEvents](https://github.com/camaraproject/Commonalities/pull/56) -> Once the model close in Commonalities should be quick to craft the API. + + +### Roadmap to Release v0.2 + +* The proposed process for a version is to have a version x.y-wip then x.y-rc and then finally released as x.y. This pattern is used in QoD. + +* Align the Device Location API with the security schema as described in Unify specification of `securitySchemes`, `security` and scopes, [Commonalities Issue #53](https://github.com/camaraproject/Commonalities/issues/53), [PR #57](https://github.com/camaraproject/Commonalities/pull/57) + - PR still not merged, we should wait until Commonalities are approved. + +* Next steps: + - Then create v0.2-rc for location-verification, updating Changelog and Release notes. + - Add location-retrieval v0.1.0-wip + - Add geofencing v0.1.0-wip, after discussion in Commonalities is closed. + +* Joachim asked the question about consistence between the release name and the API name. + - Perhaps we can have a name for a family release + - Good topic to release in Commonalities -> **@Ludovic will raise an issue in Commonalities** + +### Behaviour when requesting too high precision + +* [Issue #58](https://github.com/camaraproject/DeviceLocation/issues/58) about what is expected behaviour when requested accuracy is more restrictive that the one that network is able to satisfy. + +* New [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85) + - TEF provided a doc with a proposal and use cases for the implementation of 'Partial' and matchRate + +* Discussion during meeting: + - Ludovic provided comment on José document + - The first point is to be aligned on the matchRate formulae. + - Both TEF & Orange feedbacks are that most of the result will be false or partial but very few chance to get True result. + - The problem is more significant if we allow 'small' scope (minimum radius) + - Good to keep in open + - **@Ludovic will fix the comment - should be matchRate no maxRate** + - Joachim: other alternative will be to answer the True/False but also the location + - This is not easy for Privacy issue + - We have the 'other' API to trigger this. + - Javier look on Ludovic proposal: could have worst result but in same time current approach did not cover all the case. + - After discussion seems that the team direction is to work on the PARTIAL answer and differentiate depending on the situation (see José document UC 3 & 4 for example). The PARTIAL answer could be completed with additional information + - **Think about improving PARTIAL information for next version** + +### Administrative Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track + - Old [PR #47](https://github.com/camaraproject/DeviceLocation/pull/47) closed. + +* No new comments since last meeting, **no update or discussion during meeting**. Previous questions/doubts: + - How to handle the 'diversity' of the 'geo' code that we can have in a given country. + - How to discover what is implemented by each provider. + - Error scenario must be defined in CAMARA if the area type requested is not supported by the telco. + + +## AOB +N/A + +
+ +**Next call is on September 26th** diff --git a/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-09-26/raw.md b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-09-26/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..cef665e1ed331171602e8540994ca96a5a60f1e9 --- /dev/null +++ b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-09-26/raw.md @@ -0,0 +1,104 @@ +# CAMARA DeviceLocation meeting - 2023-09-26 + +*September 26th, 2023* + +## Attendees + +* José Luis Urien (TEF) +* Nicholas Venezia (centillion.ai) +* Cetin Alpaycetin (Vodafone) +* Joachim Dahlgren (Ericsson) +* Akos Hunyadi (DT) +* Ludovic Robert (Orange) +* Rafal Artych (DT) +* Jorge Garcia Hospital (TEF) +* Javier Carro Calador (TEF) + + +Device Location minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + + +### Geofencing v0.1-wip (Subscription for Location Area) + +* [Issue #18](https://github.com/camaraproject/DeviceLocation/issues/18), [PR #74](https://github.com/camaraproject/DeviceLocation/pull/74) + - Notification pattern is still in progress in Commonalities to accommodate use of [CloudEvents](https://github.com/camaraproject/Commonalities/pull/56) -> Once the model close in Commonalities should be quick to craft the API. + - Discuss progress in commonalities but close to be merged + - José is OK and wait Pedro return to validate + - Shilpa validated + - Objective is to have the API ready for review for next meeting. + + +### New: Location retrieval - Allow additional area types in the response + +* [Issue #94](https://github.com/camaraproject/DeviceLocation/issues/94) + - Other possible areas other than circle + - Discuss which ones make sense: Polygon, Ellipse/EllipsoidArc, Areas including altitude? + - Positive feedback from Telefonica in particular for polygon in a first step. Orange shares this feedback for Polygon. + - José raised the point about multi-polygon + - Joachin mentionned used of GMLC + - **[question]** Question on how getting the altitude. + - **[action]** Check how the network how the polygon is described (set of points) and then we can craft the P/R to improve the API with this new feature. + + +### Roadmap to Release v0.2 + +* The proposed process for a version is to have a version x.y-wip then x.y-rc and then finally released as x.y. This pattern is used in QoD. + +* Align the Device Location API with the security schema as described in Unify specification of `securitySchemes`, `security` and scopes, [Commonalities Issue #53](https://github.com/camaraproject/Commonalities/issues/53), [PR #57](https://github.com/camaraproject/Commonalities/pull/57) + - [Draft PR #95](https://github.com/camaraproject/DeviceLocation/pull/95) for location-verification, changing securitySchemes to openIdConnect. Waiting for resolution in Commonalities and Identity and Consent Management WGs. + +* Next steps: + - Then create v0.2-rc for location-verification, updating Changelog and Release notes. + - Add location-retrieval v0.1.0-wip + - Add geofencing v0.1.0-wip, after discussion in Commonalities is closed. + +* Naming of the Release + - Issue opened in [Commonalities Issue #60](https://github.com/camaraproject/Commonalities/issues/60) + - Proposal to use date format, such as Release 2023-09, but no agreement so far. + - **[action]** José will check how this release management for a family is done within Edge API + - **[decision]** Without formal decision we will use the date & lead the path + +### Behaviour when requesting too high precision + +* [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85), related to [Issue #58](https://github.com/camaraproject/DeviceLocation/issues/58) + - TEF provided a doc with a proposal and use cases for the implementation of 'Partial' and matchRate + +* Discussion during previous meeting: + - Need to align on the matchRate formulae. + - Problem with current proposal is that result will be false or partial but very few chance to get True result. The problem is more significant if we allow small areas as input. + - After discussion seems that the team direction is to work on the PARTIAL answer and differentiate depending on the situation (see José document UC 3 & 4 for example). The PARTIAL answer could be completed with additional information + - **Think about improving PARTIAL information for next version** + - Joachim had an internal review of the document - we have to write a document to explain how the matchRate is calculated. + - Discussion on the consent but probably not difference between retrieval & verification. + - The problem we have here for Location Verification will be also very significant for future geofencing API. + - Probably we need to have more maturity on this with some real implementation + - Nicholas Venezia provides feedback on how the Device location API is used within a podcast app to provide targeted ad. Nicholas demonstrated utilisation of location data. + +### Administrative Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track + - Old [PR #47](https://github.com/camaraproject/DeviceLocation/pull/47) closed. + - Javier shared a proposal on this topic. + - **[Question]** How to map postal code to geolocation/coordinate? + - depending on the country - could be provided by local regulations + - Javier will share the proposal in the GIT. + +* No new comments or progress since last meeting, **no update or discussion during meeting**. Previous questions/doubts: + - How to handle the 'diversity' of the 'geo' code that we can have in a given country. + - How to discover what is implemented by each provider. + - Error scenario must be defined in CAMARA if the area type requested is not supported by the telco. + + +## AOB +N/A + +
+ +**Next call is on October 10th** diff --git a/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-10-10/raw.md b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-10-10/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..ca0b836d3a83f517f93395f4b0d2a24bcc068eb6 --- /dev/null +++ b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-10-10/raw.md @@ -0,0 +1,114 @@ +# CAMARA DeviceLocation meeting - 2023-10-10 + +*October 10th, 2023* + +## Attendees + +* José Luis Urien (Telefonica) +* Foo Ming Hui (Singtel) +* Cetin Alpaycetin (Vodafone) +* Joachim Dahlgreen (Ericsson) +* Rafal Artych (DT) +* Akos Hunyadi (DT) +* Sébastien Synold (Intersec) +* Ludovic Robert (Orange) +* Fernando Prado Cabrillo (Telefonica) +* Jorge Garcia Hospital (Telefonica) +* Javier Carro Calador (Telefonica) + + +Device Location minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + + +### Geofencing v0.1-wip (Subscription for Location Area) + +* [Issue #18](https://github.com/camaraproject/DeviceLocation/issues/18), [PR #74](https://github.com/camaraproject/DeviceLocation/pull/74) + - New model based on CloudEvents are now approved + - PR proposed by DT https://github.com/camaraproject/DeviceLocation/pull/98 before the meeting. + - Ludovic raised the point about the event granularity - José shared the point and also expected 2 event types. + - Akos questionned if we need maxRate in this API. + - Cetin explained that in Vodafone implementation the cell id is used as an input. This will need API consumer to 'know' the cell which is a 'technical' information. + - [action] PR#74 could be close and point to PR#98 + + +### New: Location retrieval - Allow additional area types in the response + +* [Issue #94](https://github.com/camaraproject/DeviceLocation/issues/94) + - Other possible areas other than circle + - Discuss which ones make sense: Polygon, Ellipse/EllipsoidArc, Areas including altitude? + - Some comments on issue: + - OK to add polygon? + - Others? + + - José provided a feedback about TS29.572 review + - Limit to max 15 points could be challenged + - [action] Need PR for adding polygon as it is obvious. + - Need additional thinking for other area type + - Ludovic: What about adding the cell id ? + - José: It could be a way to discover the cell id but perhaps we could have a dedicated endpoint. + - [action] Worth to open an issue for this and think about it. + - Joachim : Need to verify if telco are willing to share this information. José: Perhaps using an alias could be an alternative. + - Discussion to be continued. + + +### Roadmap to Release v0.2 + +* The proposed process for a version is to have a version x.y-wip then x.y-rc and then finally released as x.y. This pattern is used in QoD. + +* Align the Device Location API with the security schema as described in Unify specification of `securitySchemes`, `security` and scopes, [Commonalities Issue #53](https://github.com/camaraproject/Commonalities/issues/53), [PR #57](https://github.com/camaraproject/Commonalities/pull/57) + - [PR #95](https://github.com/camaraproject/DeviceLocation/pull/95) for location-verification, changing securitySchemes to openIdConnect. Waiting for resolution in Commonalities and Identity and Consent Management WGs. + - Some approvals, can we merge? + - [Decision] Yes + - Joachim questionned about OIDC flows use-able. + - José/Ludovic answered that the proposal allow flexibilty by splitting the API yaml from the managed authorization for the API. This solution did not restriction authorization flow. In order to simplify adoption authorization flow must be constitent within one country + - [Action] : check for Device-location-retrieval and if not aligned to be tackled in next version. + +* Next steps: + - Then create v0.2-rc for location-verification, updating Changelog and Release notes. + - Add location-retrieval v0.1.0-wip + - Add geofencing v0.1.0-wip, after discussion in Commonalities is closed. + - geofencing has to be aligned with CloudEvents + +* Naming of the Release + - Issue opened in [Commonalities Issue #60](https://github.com/camaraproject/Commonalities/issues/60) + - Proposal to use date format, such as Release 2023-09, but no agreement so far. + - EdgeCloud API using v1, v2 ... + - What name should we choose? + - [Decision] Let's wait for next TSC outcome. + +### Behaviour when requesting too high precision + +* [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85) + - TEF provided a doc with a proposal and use cases for the implementation of 'Partial' and matchRate + +* No new comments +* Need a better name for Partial (Javier will work on it) + +### Administrative Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track + - Old [PR #47](https://github.com/camaraproject/DeviceLocation/pull/47) closed. + - Javier shared a proposal on this topic. + - **[Question]** How to map postal code to geolocation/coordinate? + - depending on the country - could be provided by local regulations + - [Action] Javier will share the proposal in the GIT. + +* No new comments or progress since last meeting, **no update or discussion during meeting**. Previous questions/doubts: + - How to handle the 'diversity' of the 'geo' code that we can have in a given country. + - How to discover what is implemented by each provider. + - Error scenario must be defined in CAMARA if the area type requested is not supported by the telco. + + +## AOB +N/A + +
+ +**Next call is on October 24th** diff --git a/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-10-24/raw.md b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-10-24/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..3a0b9ea44e10409efa08221406f85e95e18a8d34 --- /dev/null +++ b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-10-24/raw.md @@ -0,0 +1,118 @@ +# CAMARA DeviceLocation meeting - 2023-10-24 + +*October 24th, 2023* + +## Attendees + +[x] José Luis Urien (Telefonica) +[] Foo Ming Hui (Singtel) +[x] Cetin Alpaycetin (Vodafone) +[x] Joachim Dahlgreen (Ericsson) +[x] Rafal Artych (DT) +[x] Akos Hunyadi (DT) +[] Sébastien Synold (Intersec) +[x] Ludovic Robert (Orange) +[x] Fernando Prado Cabrillo (Telefonica) +[] Jorge Garcia Hospital (Telefonica) +[] Javier Carro Calador (Telefonica) +[x] Ramesh Shanmugasundaram +[x] Amit Ajuha +[x] Parichaya Shrivastava + + +Device Location minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + + +## Open issues and PRs + + +### Geofencing v0.1-wip (Subscription for Location Area) + +* [Issue #18](https://github.com/camaraproject/DeviceLocation/issues/18), [PR #74](https://github.com/camaraproject/DeviceLocation/pull/74) + - Review last comments in PR + - Good progress - few comments left: + * Basepath should be enum and not default - Issue in Commonalities raised by José + * Move to openId for security schema + * Adding data in termination event + * Safer to include the information in the event body + + - Ludovic will update the commonalities on subscription/event after first usage in Device location, Device status & Sim Swap. + - Joachim raised the point about adding other area type --> will be done in future PR. + + +### New: Location retrieval - Allow additional area types in the response + +* [Issue #94](https://github.com/camaraproject/DeviceLocation/issues/94) + - Review last [PR #100](https://github.com/camaraproject/DeviceLocation/pull/100) adding polygon + - PR ready: + - limit to 15: OK for the team. + - [action] for Ludovic: + - Add precision about close shape in the documentation for polygon. This is not required to provide twiwe a point. + - Align with security schema (discussed in TSC but not finalized in the documentation) + - Align with basepath with an enum + + +### Roadmap to Release v0.2 + +* The proposed process for a version is to have a version x.y-wip then x.y-rc and then finally released as x.y. This pattern is used in QoD. + +* Align the Device Location API with the security schema as described in Unify specification of `securitySchemes`, `security` and scopes, [Commonalities Issue #53](https://github.com/camaraproject/Commonalities/issues/53), [PR #57](https://github.com/camaraproject/Commonalities/pull/57) + - [PR #95](https://github.com/camaraproject/DeviceLocation/pull/95) for location-verification, already merged after discussion in TSC. + - Apply the same to location-retrieval and geofencing? + +* Naming of the Release + - Issue opened in [Commonalities Issue #60](https://github.com/camaraproject/Commonalities/issues/60) + - Review discussion in TSC and agree on a name + - Discussed in TSC: + - DT will write a proposal on managing the proposal both for the API yaml(s) and family + - Have a global release for all CAMARA API for MWC 2024 + + +* Release content: + - location-verification v0.2-rc + - location-retrieval v0.1.0-wip + - geofencing v0.1.0-wip + - Changelog and Release notes. + +Points discussed: +* All this yaml will be under **0.2** family +* [action] For location-verification, José will fix the basepath with enum instead of default. + + +### Behaviour when requesting too high precision + +* [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85) + - TEF provided a doc with a proposal and use cases for the implementation of 'Partial' and matchRate + +* New comments in Github from Joachim + * 3 scenarios illustrated + * [action] Review this comment. + +### Administrative Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track + - New [document uploaded by TEF](https://github.com/camaraproject/DeviceLocation/files/12856149/AdminCode.Proposal.-.Draft_20230926.docx) with a proposal +* [action] Review this document. + +## AOB + +**Discussion on 3-legs pattern** raised by Joachim + * What is the third leg ? Is it always the flow going to the responsible 'party' for 'consent' grant? + * Let's take the example of a connected dog collar - The 'consent' should be provided by the user of the application tracking the dog. + * This management of the responsible 'party' for 'consent' grant is managed in the Authorization Server (AS). The AS for a given request for a device, a purpose and a data clain, compute the legal base and 'execute' it. Depending on the legal base there is not always a interaction with the responsible 'party' for 'consent' grant. + * Do we need to explictly provides in the request the device identifier as we can have it in the 'first leg'? + * This is relevant for some UC but we have UC where the Device A could trigger location request for another device. + * We mentioned the documentation provided in Identity&Consent management WG. + * We probably need to mention/point/refer this documentation in device location family API - We need to discuss how this information could be provided. + * The discussion will continue in following calls and depending on the work progress in Identity&Consent management WG. + +José will share the information to join the **Slack** + +
+ +**Next call is on November 7th** diff --git a/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-11-07/raw.md b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-11-07/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..2a3e5f2b017e5c8f50feeb867ccd68660a360ca3 --- /dev/null +++ b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-11-07/raw.md @@ -0,0 +1,93 @@ +# CAMARA DeviceLocation meeting - 2023-11-07 + +*November 7th, 2023* + +## Attendees + +- José Luis Urien (TEF) +- Joachim Dahlgreen (Ericsson) +- Jayant Nagaraj (Shabodi) +- Cetin Alpaycetin (Vodafone) +- Akos Hunyadi (DT) +- Nicholas Venezia (Centillion) +- Fernando Prado Cabrillo (TEF) +- Rafal Artych (DT) +- Ludovic Robert (Orange) +- Jorge Garcia Hospital (TEF) +- Javier Carro Calador (TEF) + +Device Location minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + +### Review Release Candidate v0.2 + +* Review [location-verification.yaml v0.2 Release Candidate](https://github.com/camaraproject/DeviceLocation/pull/104) + - The proposed process for a version is to have a version x.y-wip then x.y-rc and then finally released as x.y. This pattern is used in QoD. + - Doc updated + - basePath fixed in URL + - Examples updated + - Decide what to do with IPV6 pattern + - José triggered an isue in QoD to discuss IPV6 format and then will align. José suggests to remove pattern if not fully correct (As of now this pattern did nort work for some subnet mask definition) + - We are waiting for QoD outcome on this point. + - Joachim suggested to raise an issue in Commonalitiesa we have to align this in every API as this is a generic topic + - Akos explained that we can merge even as rc because it is valid to still update rc + +* Review new README and CHANGELOG + - [PR #106](https://github.com/camaraproject/DeviceLocation/pull/106) + - Inspired by model in QoD + - *Links will work after branch for Release-0.2.0 is created* + - Discussion on versinning name and use of wip & rc suffix + - Location-Verification is in Alpha version + - Discussion if location-retrieval should be also in Alpha version. + - Geofencing shouldn't stay in pre-Alpha as there are not open issue (_note that pre-alpha is not a defined state_). Joachim explained that for him if it's wip then we do no code it (which is a fair argument to move geofencing to rc) + +* Release content: + - location-verification v0.2-rc + - location-retrieval v0.1.0-wip -> Do we keep -wip? + - We should create also a rc and align with current work for location verification. + - Decision: should be promoted to v0.1-rc + - **Ludovic (for Orange) will create a PR** + - geofencing v0.1.0-wip -> Do we keep -wip? + - Decision: should be promoted v0.1-rc + - **Max (for DT) will create a PR** + - Changelog and Release notes. + - **José asked the team to take a close look on PR#106 as this is what the external public will see.** + + - Akos suggests to create an issue for tracking and the 3 PR will refer this one. + +### New Issues + +* security and scopes for the Device Location API [#105](https://github.com/camaraproject/DeviceLocation/issues/105) + * --> Probably good to rout to identity & consent management project + +### Open discussions + +#### Behaviour when requesting too high precision + +_Not enough time to discuss_ + +* [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85) + - TEF provided a doc with a proposal and use cases for the implementation of 'Partial' and matchRate + +* New comments in Github from Joachim + * 3 scenarios illustrated + * [action] Review this comment. + +#### Administrative Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track + - New [document uploaded by TEF](https://github.com/camaraproject/DeviceLocation/files/12856149/AdminCode.Proposal.-.Draft_20230926.docx) with a proposal +* [action] Review this document. + +## AOB + + +
+ +**Next call is on November 21th** diff --git a/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-11-21/raw.md b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-11-21/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..d544f30966ff1701cd49ea95b4beca000b1c09e8 --- /dev/null +++ b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-11-21/raw.md @@ -0,0 +1,114 @@ +# CAMARA DeviceLocation meeting - 2023-11-21 + +*November 21st, 2023* + +## Attendees + +- José Luis Urien (TEF) +- Javier Carro Calador (TEF) +- Nicholas Venezia (Centillion) +- Ben Thomas (Vodafone) +- Foo Ming Hui (SingTel) +- Cetin Alpaycetin (Vodafone) +- Akos Hunyadi (DT) +- Jorge Garcia Hospital (TEF) +- Ludovic Robert (Orange) +- Fernando Prado Cabrillo (TEF) +- Sébastien Synold (Intersec) +- Rafal Artych (DT) +- Surajj Jaggernath (Vodacom) + + +Device Location minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + +### Review Release Candidate v0.2 + +* Review latest comments in ongoing PRs for APIs, and decide if ready to be merged: + - [location-verification.yaml v0.2 Release Candidate](https://github.com/camaraproject/DeviceLocation/pull/104) + - Point about Ipv6 still open in QoD (will be valid for all three APIs) + - Description comment from Cetin to be considered + - [location-retrieval.yaml v0.1 Release Candidate](https://github.com/camaraproject/DeviceLocation/pull/114) + - Error: Status & Code are 'normative' - message are open to modification by implementation + - [geofencing.yaml v0.1 Release Candidate](https://github.com/camaraproject/DeviceLocation/pull/116) + - Rafal proposed to align Notification source example list accordingly to the guidelines + +We're still in line to release before the end of the year. + - Resolve pending comments and merge current PRs as -rc + - Open testing and feedback period for RC versions + + We need also to align with the new working group about release management + + First training Nov 21th + Rafal, Ludovic and José will attend + + +* Review latest comments in PR for README and CHANGELOG, and decide if ready to be merged: + - [Release Notes](https://github.com/camaraproject/DeviceLocation/pull/106) + - *Links will work after branch for Release-0.2.0 is created* + +### Review other Issues and PRs + +* [Add Test Definition for location Retrieval #119](https://github.com/camaraproject/DeviceLocation/pull/119/files) + - Discussed during meeting + - To be discussed in Commonalities here: https://github.com/camaraproject/Commonalities/issues/94 + + - The team needs to be involved in this work + - Agreed to use Gherkin must we should have an alignement on the formal aspect + +* [Adjust IP Adresses device in device to use single IP adresses](https://github.com/camaraproject/DeviceLocation/issues/117) + - To be aligned with ongoing discussion and [PR in QoD](https://github.com/camaraproject/QualityOnDemand/pull/237) + +* [Geofencing API - Add "format: uri" to notificationUrl](https://github.com/camaraproject/DeviceLocation/issues/118) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/93) + +* [Geofencing API - Adding capability to manage max number of notification](https://github.com/camaraproject/DeviceLocation/issues/111) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/90) + +* [Geofencing API - Semantic error](https://github.com/camaraproject/DeviceLocation/issues/109) + - Solved & closed + +* [security and scopes for the Device Location API](https://github.com/camaraproject/DeviceLocation/issues/105) + - Discuss during meeting + +### Open discussions + +#### Behaviour when requesting too high precision + +* [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85) + - TEF provided a doc with a proposal and use cases for the implementation of 'Partial' and matchRate + +* New comments in Github from Joachim + * 3 scenarios illustrated + * [action] Review this comment. + +**[Decision]** Proposal is to use the formula defined in the Word document by Telefonica Team. + API documentation will be updated --> Add a document and have a link in each yaml to refer it. Telefonica will craft this document. + +#### Administrative Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track + - New [document uploaded by TEF](https://github.com/camaraproject/DeviceLocation/files/12856149/AdminCode.Proposal.-.Draft_20230926.docx) with a proposal +* [action] Review this document. + + - Question from José if we need to keep this function in a same API or in a distinct one. + - This feature is not top priority right now but will be discused next year. + +Question about API certification from Ludovic + - Location retrieval is a good candidate + - topic links to the Test definition + - Let's wait for test definition outcomes and then we will assess use of this asset for certification purpose. + +## AOB + + +
+ +**Next call is on December 5th** + José will be off - Fernando & Ludovic will host the call. diff --git a/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-12-05/raw.md b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-12-05/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..796197949823bd118be06cf8ef5961187c316c20 --- /dev/null +++ b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-12-05/raw.md @@ -0,0 +1,113 @@ +# CAMARA DeviceLocation meeting - 2023-12-5 + +*December 5th, 2023* + +## Attendees + + +- Ludovic Robert (Orange) +- Fernando Prado Cabrillo (TEF) +- Foo Ming Hui (SingTel) +- Cetin Alpaycetin (Vodafone) +- Akos Hunyadi (DT) +- Javier Carro (TEF) +- Rafal Artych (DT) +- Joachim Dahlgreen (Ericsson) +- Sönke Peters (Vodafone) +- Surajj Jaggernath (Vodacom) + + +Device Location minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs + * No new issue for last 2 weeks + * Cleaning for old issues +* Any other business + +## Open issues and PRs + +### Review Release Candidate v0.2 + +* Review latest comments in ongoing PRs for APIs, and decide if ready to be merged: + - [location-verification.yaml v0.2 Release Candidate](https://github.com/camaraproject/DeviceLocation/pull/104) + - Point about Ipv6 solved + - Description comments from Cetin considered + - Precision on date time accordingly to the commonalities guidelines + - MERGED during the meeting + - [location-retrieval.yaml v0.1 Release Candidate](https://github.com/camaraproject/DeviceLocation/pull/114) + - Point about Ipv6 solved (complete alignment with verification device structure) + - Ready to review + - [geofencing.yaml v0.1 Release Candidate](https://github.com/camaraproject/DeviceLocation/pull/116) + - Rafal aligned Notification source example list accordingly to the guidelines + - Alignment with IP v6 to be done. + - Akos will align ip addresses and device model as has been done with location retrieval and location verification + - Typo found in "expiresAt" subscription info. Akos will fix. + + +* Review latest comments in PR for README and CHANGELOG, and decide if ready to be merged: + - [Release Notes](https://github.com/camaraproject/DeviceLocation/pull/106) + - *Links will work after branch for Release-0.2.0 is created* + - No new comment since last meeting + +### Review other Issues and PRs + +* [Add Test Definition for location Retrieval #119](https://github.com/camaraproject/DeviceLocation/pull/119/files) + - Link with Commonalities here: https://github.com/camaraproject/Commonalities/issues/94 + - No progress + +* [Adjust IP Adresses device in device to use single IP adresses](https://github.com/camaraproject/DeviceLocation/issues/117) + - Aligned with ongoing discussion and [PR in QoD](https://github.com/camaraproject/QualityOnDemand/pull/237) + - Done for Location retrieval & location verification + - To be done for geofencing + +* [Geofencing API - Add "format: uri" to notificationUrl](https://github.com/camaraproject/DeviceLocation/issues/118) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/93) + - still open + +* [Geofencing API - Adding capability to manage max number of notification](https://github.com/camaraproject/DeviceLocation/issues/111) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/90) + - still open - no progress + +* [security and scopes for the Device Location API](https://github.com/camaraproject/DeviceLocation/issues/105) + - Ludovic answered. + +* [Documentation Updated](https://github.com/camaraproject/DeviceLocation/issues/102) + - part of https://github.com/camaraproject/DeviceLocation/pull/104 + +### Open discussions + +#### Behaviour when requesting too high precision + +* [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85) + - TEF provided a doc with a proposal and use cases for the implementation of 'Partial' and matchRate + - During previous meeting we agreed to use the formula defined in the Word document. + - Descriptions regarding partials and matchRate has been added in location-verification yaml + - As requested by Joachim, issue will remain open until TEF uploads the document with more detail or the information is added to an API_documentation file to keep in the repo for future references. + + +### Cleaning - issues closed +* [Does DeviceLocation itself really need to define all ways to identify a User equipment identifier](https://github.com/camaraproject/DeviceLocation/issues/51) - Tackled with https://github.com/camaraproject/DeviceLocation/issues/117 + +* [Include locationType as a request parameter](https://github.com/camaraproject/DeviceLocation/issues/43) - Request for Office/work location (most latched site/location in the day time) & Home location (most latched site/location in the night time). Managed in separate API request. + - Issue closed - Tackled with https://github.com/camaraproject/WorkingGroups/issues/336 + + [Accuracy Levels for Device Location APIs](https://github.com/camaraproject/DeviceLocation/issues/78) - nu update since July 31st José request for clarification to the issuer. + - Issue closed as there have been no updates in 3 months + +#### Administrative Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track + - New [document uploaded by TEF](https://github.com/camaraproject/DeviceLocation/files/12856149/AdminCode.Proposal.-.Draft_20230926.docx) with a proposal +* [action] Review this document. + - Not progress but during last call we agreed that this feature is not top priority right now but will be discussed next year. + + + +## AOB + + +
+ +**Next call is on December 19th** diff --git a/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-12-19/raw.md b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-12-19/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..daba3b6487159fec6d5e4da51fc71414f8343038 --- /dev/null +++ b/marked/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-12-19/raw.md @@ -0,0 +1,117 @@ +# CAMARA DeviceLocation meeting - 2023-12-19 + +*December 19th, 2023* + +## Attendees +José Luis Urien Pinedo (Telefonica) +Ludovic Robert (Orange) +Surajj Jaggernath (Vodacom) +Cetin Alpaycetin (Vodafone) +Joachim Dahlgren (Ericsson) +Akos Hunyadi (DT) +Ravi Shekhar +Javier Carro Calabor (Telefonica) + + +Device Location minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + +### Review Release Candidate v0.2 + +* Review latest comments in ongoing PRs for APIs, and decide if ready to be merged: + - [location-verification.yaml v0.2 Release Candidate](https://github.com/camaraproject/DeviceLocation/blob/main/code/API_definitions/location-verification.yaml) + - Already merged + - Minor fix merged: [Fix MaxAge type](https://github.com/camaraproject/DeviceLocation/pull/126) + - Any further comment/bug found? + - [location-retrieval.yaml v0.1 Release Candidate](https://github.com/camaraproject/DeviceLocation/pull/114) + - PR approved + - Merged + - [geofencing.yaml v0.1 Release Candidate](https://github.com/camaraproject/DeviceLocation/pull/116) + - PR approved + - Merged + +* Review latest comments in PR for README and CHANGELOG, and decide if ready to be merged: + - [Release Notes](https://github.com/camaraproject/DeviceLocation/pull/106) + - *Links will work after branch for Release-0.2.0 is created* + - No new comment since last meeting + - José will take a last look and merge this PR. + +### Review other Issues and PRs + +#### New + +* [Implement use of linting rule set for Device Location API](https://github.com/camaraproject/DeviceLocation/issues/125) + - José tested locally for location verification + - José plans to do same for the other APIs + - No major issue identified (only warning). + +* [Geofencing API - Defining a standard behavior for first event](https://github.com/camaraproject/DeviceLocation/issues/124) + - Relevant question for possible enhancement. To be discussed. + - José took a look on google API implementation and they have a new input parameter to let client decide if she/he decide to get an event at subscription time. This is relevant only for entered area event. + - We can introduce a `initialTriggerAreaEntered` boolean - if it is true then a notification is sent if the mobile is within the area. + - Akos said that we can send the notification in every case (not requiring this attribute) + - Joachim raises the point about how we can distinct the fact that the device was already in the area vs it just entered in for this first event. + - A combination with Location retrieval could be also documented. Ludovic says that it can work except if the device just entered at subscription time. + - **We need to open an issue to discuss** about the compute rule for geofencing area match. We solved this for device verification API (for `matchRate`) but here this is different as it is dynamic. + - Recommendation to continue the discussion on the issue. + +#### From previous meeting + +* [Add Test Definition for location Retrieval #119](https://github.com/camaraproject/DeviceLocation/pull/119/files) + - Link with Commonalities here: https://github.com/camaraproject/Commonalities/issues/94 + - No progress + - DT Team has provided comment + - TEF team will also provide comments + - Discussion should continue in Commonalities + +* [Adjust IP Adresses device in device to use single IP adresses](https://github.com/camaraproject/DeviceLocation/issues/117) + - Already done, to be closed when merged + - **Closed** with PR merging. + +* [Geofencing API - Add "format: uri" to notificationUrl](https://github.com/camaraproject/DeviceLocation/issues/118) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/93) + - still open + +* [Geofencing API - Adding capability to manage max number of notification](https://github.com/camaraproject/DeviceLocation/issues/111) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/90) + - still open - no progress + +* [security and scopes for the Device Location API](https://github.com/camaraproject/DeviceLocation/issues/105) + - Ludovic answered. + - **Closed** + +* [Documentation Updated](https://github.com/camaraproject/DeviceLocation/issues/102) + - part of https://github.com/camaraproject/DeviceLocation/pull/104 + - **Closed** with PR merging. + +### Open discussions + +#### Behaviour when requesting too high precision + +* [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85) + - TEF provided a doc with a proposal and use cases for the implementation of 'Partial' and matchRate + - During previous meeting we agreed to use the formula defined in the Word document. + - Descriptions regarding partials and matchRate has been added in location-verification yaml + - As requested by Joachim, issue will remain open until TEF uploads the document with more detail or the information is added to an API_documentation file to keep in the repo for future references. + + +#### Administrative Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track + - New [document uploaded by TEF](https://github.com/camaraproject/DeviceLocation/files/12856149/AdminCode.Proposal.-.Draft_20230926.docx) with a proposal +* [action] Review this document. + - Not progress but during last call we agreed that this feature is not top priority right now but will be discussed next year. + + +## AOB + +- Next call will be **January 16th, 2024** + +
+ diff --git a/marked/DeviceLocation/documentation/MeetingMinutes/MoM-2024-01-16/raw.md b/marked/DeviceLocation/documentation/MeetingMinutes/MoM-2024-01-16/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..6e42b4374fd6d997a2320c95e4fa460bfc1b94ae --- /dev/null +++ b/marked/DeviceLocation/documentation/MeetingMinutes/MoM-2024-01-16/raw.md @@ -0,0 +1,126 @@ +# CAMARA DeviceLocation meeting - 2024-01-16 + +*January 16th, 2024* + +## Attendees + +José Luis Urien Pinedo (Telefonica) +Joachim Dahlgren (Ericsson) +Akos Hunyadi (DT) +Cetin Alpaycetin (Vodafone) +Javier Carro Calador (Telefonica) +Ludovic Robert (Orange) +Nicholas Venezia (Centillion) +Jorge Garcia Hospital (Telefonica) +Foo Ming Hui (Singtel) +Fernando Prado Cabrillo (Tlefonica) + + + +Device Location minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + +### Review v0.2-rc2 + +- Release Candidate was created in [branch](https://github.com/camaraproject/DeviceLocation/tree/release-0.2.0-rc) +- Error detected after releasing, with enum values for Area, [already fixed](https://github.com/camaraproject/DeviceLocation/issues/131) +- [Prepare RC2](https://github.com/camaraproject/DeviceLocation/pull/134) PR already merged +- New errors reported, to be fixed in RC2: + - [Correct YAML examples to use upper case enum of areaType](https://github.com/camaraproject/DeviceLocation/issues/136) + - Create PR with fix + + - [Fix format for attribute lastLocationTime in location retrieval](https://github.com/camaraproject/DeviceLocation/issues/137) + - Create PR with fix + + - [Rename in the OAS SubscriptionEventType to NotificationEventType](https://github.com/camaraproject/DeviceLocation/issues/139) + - Create PR to change schema names + +- Create RC2 branch and release tag + - Ludovic will do for both API + - No change for the version in the yaml + +### Review other Issues and PRs + +#### New + + - [Geofencing API - Add Subscription type 'area-left-or-entered' to subscribe to both event in one time](https://github.com/camaraproject/DeviceLocation/issues/138) + - Review comments + - José answers in the PR + - Joachim agreed on the fact that make sense to have one event type both for left & entered + - Akos: The UC is clear - how we solve it + - One approach is to allow to subscribe to an array of event type + - Discussed in the past but adding an array of notification type will add a layer of complexity to manage a subscription + - Could be a problem if the server is not able to manago one kind of event type. + - **Keep it open to let the discussion open.** + - José will also check with development team + - Having both 'event' in one notification type could have an impact on the server managing the event + + - [Revise Description to Meet GDPR Compliance - REMOVAL OF " Location-based advertising" in Documentation](https://github.com/camaraproject/DeviceLocation/issues/135) + - Review comments + - Nicholas will propose a better wording for this sentence + - Could be integrated in rc2 + + - [Define guidelines for geofencing implementation](https://github.com/camaraproject/DeviceLocation/issues/133) + - Review comments + - Need more review from the team + - Correlation with issue [Geofencing API - Defining a standard behavior for first event](https://github.com/camaraproject/DeviceLocation/issues/124) + - **keep the discussion open** + +#### Ongoing + +* [Add Test Definition for location Retrieval #119](https://github.com/camaraproject/DeviceLocation/pull/119/files) + - Link with Commonalities here: https://github.com/camaraproject/Commonalities/issues/94 + - Review PR status + - Proposal to use this one as the 'model sample' for Commonalities + - **Keep in open but need to be prioritized** + +* [Implement use of linting rule set for Device Location API](https://github.com/camaraproject/DeviceLocation/issues/125) + - Next steps + - Integrate the linting in our CI as for QoD + - As codeowner we did not have the right to add it. + - José will comment and ping Markus & Rafal to ask them how we can move forward. + +* [Geofencing API - Defining a standard behavior for first event](https://github.com/camaraproject/DeviceLocation/issues/124) + - Review comments, next steps + - Probably same thing must be done for area left. + - Akos & Ludovic have UC where it could be necessary. + - Nicholas mentionned also ad-based UC (ad in a podcast location-based for example) where we want to control the time when the ad should be triggered for a device + +* [Geofencing API - Add "format: uri" to notificationUrl](https://github.com/camaraproject/DeviceLocation/issues/118) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/93) + - still open in Commonalities + +* [Geofencing API - Adding capability to manage max number of notification](https://github.com/camaraproject/DeviceLocation/issues/111) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/90) + - still open - no progress in Commonalities + + +### Open discussions + +#### Administrative Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track + - New [document uploaded by TEF](https://github.com/camaraproject/DeviceLocation/files/12856149/AdminCode.Proposal.-.Draft_20230926.docx) with a proposal +* [action] Review this document. + - Not progress but during last call we agreed that this feature is not top priority right now but will be discussed next year. + - Probably to keep it close with the (future) work for User Device count + - We can probably add our Area schemas in Commonalities + + +#### Behaviour when requesting too high precision + +* [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85) + - As requested by Joachim, issue will remain open until TEF uploads the document with more detail or the information is added to an API_documentation file to keep in the repo for future references. + +## AOB + +- Next call will be **January 30th, 2024** + +
+ diff --git a/marked/DeviceLocation/documentation/MeetingMinutes/MoM-2024-01-30/raw.md b/marked/DeviceLocation/documentation/MeetingMinutes/MoM-2024-01-30/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..27e01f9979ed39d0c68b85d90f6ec528d3d39b2c --- /dev/null +++ b/marked/DeviceLocation/documentation/MeetingMinutes/MoM-2024-01-30/raw.md @@ -0,0 +1,100 @@ +# CAMARA DeviceLocation meeting - 2024-01-30 + +*January 30th, 2024* + +## Attendees + +* Cetin Alpaycetin (Vodafone) +* Fernando Prado Cabrillo (Telefonica) +* Joachim Dahlgren (Ericsson) +* José Luis Urien Pinedo (Telefonica) +* Rafal Artych (DT) + +Device Location minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + +### Review v0.2-rc2 + +- [PR](https://github.com/camaraproject/DeviceLocation/pull/142) with fixes to: + - [Correct YAML examples to use upper case enum of areaType](https://github.com/camaraproject/DeviceLocation/issues/136) + - [Fix format for attribute lastLocationTime in location retrieval](https://github.com/camaraproject/DeviceLocation/issues/137) + - [Rename in the OAS SubscriptionEventType to NotificationEventType](https://github.com/camaraproject/DeviceLocation/issues/139) + - [Revise Description to Meet GDPR Compliance - REMOVAL OF " Location-based advertising" in Documentation](https://github.com/camaraproject/DeviceLocation/issues/135) + +- AP: Give one more day for review, merge and create RC2 + +### Review other Issues and PRs + +#### New + + - [Geofencing - Adding a value in Termination Reason value enum](https://github.com/camaraproject/DeviceLocation/issues/141) + - Review comments. Cetin agrees with Ludovic's comment. + - AP: We'lll wait for Commonalities to add it to Geofencing. + +#### Ongoing + +* [Add Test Definition for location Retrieval #119](https://github.com/camaraproject/DeviceLocation/pull/119/files) + - Link with Commonalities here: https://github.com/camaraproject/Commonalities/issues/94 + - Review PR status and new comments + - AP: Telefónica will provide a proposal updating a few aspects of Ludovic's proposal after checking with internal QA team. + +* [Geofencing API - Add Subscription type 'area-left-or-entered' to subscribe to both event in one time](https://github.com/camaraproject/DeviceLocation/issues/138) + - Review new comments + - AP: Get more opinions. + +* [Define guidelines for geofencing implementation](https://github.com/camaraproject/DeviceLocation/issues/133) + - Review new comments. + - AP: Get more opinions. + +* [Geofencing API - Adding capability to manage max number of notification](https://github.com/camaraproject/DeviceLocation/issues/111) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/90) + - still open - Review new comments + - AP: Wait for outcome in Commonalities + +* [Implement use of linting rule set for Device Location API](https://github.com/camaraproject/DeviceLocation/issues/125) + - José asked Markus & Rafal how we can move forward. + - Rafal explains that process will be: + - Merge PR in commonalities with the initial ruleset as an artifact. + - Possibly a discussion in TSC about how to add it in each WG in a common way. + - AP: We'll wait for the process. In the meantime we are able to test it locally and provide feedback before integrating. + +* [Geofencing API - Defining a standard behavior for first event](https://github.com/camaraproject/DeviceLocation/issues/124) + - No new comments + - AP: We are at a point where we can create a PR. Jose will ping Akos in case he wants to create the PR, otherwise Jose will create it to move the discussion to the PR. + +* [Geofencing API - Add "format: uri" to notificationUrl](https://github.com/camaraproject/DeviceLocation/issues/118) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/93) + - still open in Commonalities. No new comments. + - AP: Ping in the issue to reactivate the discussion + +### Open discussions + +- No new comments since last meeting. We keep these discussions on hold. + +#### Administrative Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track + - New [document uploaded by TEF](https://github.com/camaraproject/DeviceLocation/files/12856149/AdminCode.Proposal.-.Draft_20230926.docx) with a proposal +* [action] Review this document. + - Not progress but during last call we agreed that this feature is not top priority right now but will be discussed next year. + - Probably to keep it close with the (future) work for User Device count + - We can probably add our Area schemas in Commonalities + + +#### Behaviour when requesting too high precision + +* [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85) + - As requested by Joachim, issue will remain open until TEF uploads the document with more detail or the information is added to an API_documentation file to keep in the repo for future references. + +## AOB + +- Next call will be **February 13th, 2024** + +
+ diff --git a/marked/DeviceLocation/documentation/MeetingMinutes/MoM-2024-02-13/raw.md b/marked/DeviceLocation/documentation/MeetingMinutes/MoM-2024-02-13/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..8f2504ef9c8ee65fbb6c850c333628e16e987540 --- /dev/null +++ b/marked/DeviceLocation/documentation/MeetingMinutes/MoM-2024-02-13/raw.md @@ -0,0 +1,143 @@ +# CAMARA DeviceLocation meeting - 2024-02-13 + +*February 13th, 2024* + +## Attendees + +* José Luis Urien (Telefonica) +* Akos Hunyadi (DT) +* Cetin Alpaycetin (Vodafone) +* Fernando Prado Cabrillo (Telefonica) +* Ludovic Robert (Orange) +* Rafal Artych (DT) +* Javier Caaro Calabor (Telefonica) + +Device Location minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + +### Review v0.2.0-rc3 + +- [PR](https://github.com/camaraproject/DeviceLocation/pull/150) with fixes to: + - [fix: correct $ref for SubscriptionEventType in geofencing](https://github.com/camaraproject/DeviceLocation/pull/149) + - Some other fixes and enhancements detected by linter (locally) + +- Give some time review, merge and create RC3 +- If nothing else is detected, then create release-0.2.0 + +Discussed during meeting: +Action: Team has to review the PR. We have to work offline to release the API before the MWC. +Minor typo fixes (on subscription) +Feedback on Linting tool run + + +### Review other Issues and PRs + +#### Ongoing + +* [Add Test Definition for location Retrieval #119](https://github.com/camaraproject/DeviceLocation/pull/119/files) + - Link with Commonalities here: https://github.com/camaraproject/Commonalities/issues/94 + - Review PR status and new comments + - AP: Telefónica will provide a proposal updating a few aspects of Ludovic's proposal after checking with internal QA team. -> Still pending + +Discussed during meeting: +- José explained that first we need to provide variable(s) + - First then 'given' to prepare this/these variable(s) + - Then the result with the expected responses + - +Additionnal step oculd be used (ad hoc for specific operation) +- GSMA will test this files as an input for Conformance & using Postman. +- José will contribut to commonalities for guidelines for Test Definition + - Ludovic agreed on José proposal and will adapt the Device location retrieval file once José made his proposal. + + +* [Geofencing - Adding a value in Termination Reason value enum](https://github.com/camaraproject/DeviceLocation/issues/141) + - Positive feedback + - How to proceed? Create PR and share with Commonalities or the open issue in Commonalities? + +Discussed during meeting: +- Ludovic will create an Issue in Commonalities. + + +* [Geofencing API - Add Subscription type 'area-left-or-entered' to subscribe to both event in one time](https://github.com/camaraproject/DeviceLocation/issues/138) + - No new comments + - Discuss next steps in meeting + +Discussed during meeting: +- we went through the proposal on the issue as 4 options are described +- We keep it open for discussion +- Alignement with device status was discussed. + + +* [Define guidelines for geofencing implementation](https://github.com/camaraproject/DeviceLocation/issues/133) + - No new comments. + - Discuss next steps in meeting + + Discussed during meeting: + - no progress - need team review + +* [Geofencing API - Adding capability to manage max number of notification](https://github.com/camaraproject/DeviceLocation/issues/111) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/90) + - New [PR](https://github.com/camaraproject/Commonalities/pull/131) + - Review status + +Discussed during meeting: +- in final step in commonalities - soon to be applied + +* [Implement use of linting rule set for Device Location API](https://github.com/camaraproject/DeviceLocation/issues/125) + - Tested locally before creating RC3 + - Review status in Commonalities + +Discussed during meeting: +- Rafal provided a briefting of the situation + - Still in discussion in commonalities + - Question to TSC if each projet has to be independant for applying the lintening. + - else José will apply the CI in our project + +* [Geofencing API - Defining a standard behavior for first event](https://github.com/camaraproject/DeviceLocation/issues/124) + - Moved to Commonalities [Issue 140](https://github.com/camaraproject/Commonalities/issues/140) + - No comments + +Discussed during meeting: +- No comments + +* [Geofencing API - Add "format: uri" to notificationUrl](https://github.com/camaraproject/DeviceLocation/issues/118) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/93) + - Recent comment to reactivate the discussion + +Discussed during meeting: +- Team has to provide comment +- Rafal mentionned another issue about duration + + +### Open discussions + +- No new comments since last meeting. + + +#### Administrative Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track + - New [document uploaded by TEF](https://github.com/camaraproject/DeviceLocation/files/12856149/AdminCode.Proposal.-.Draft_20230926.docx) with a proposal +* [action] Review this document. + - Not progress but during last call we agreed that this feature is not top priority right now but will be discussed next year. + - Probably to keep it close with the (future) work for User Device count + - We can probably add our Area schemas in Commonalities + +This item should be reopen after MWC. + +#### Behaviour when requesting too high precision + +* [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85) + - As requested by Joachim, issue will remain open until TEF uploads the document with more detail or the information is added to an API_documentation file to keep in the repo for future references. + +## AOB + +- Discuss if we keep next call for February 27th, 2024, as it is the MWC week. + - We keep it + +
diff --git a/marked/DeviceLocation/documentation/MeetingMinutes/MoM-2024-02-27/raw.md b/marked/DeviceLocation/documentation/MeetingMinutes/MoM-2024-02-27/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..4a88d14db0d528406a293a81b7a1e9e5170ce0c1 --- /dev/null +++ b/marked/DeviceLocation/documentation/MeetingMinutes/MoM-2024-02-27/raw.md @@ -0,0 +1,115 @@ +# CAMARA DeviceLocation meeting - 2024-02-27 + +*February 27th, 2024* + +## Attendees + +* José Luis Urien (Telefonica) +* Akos Hunyadi (DT) +* Cetin Alpaycetin (Vodafone) +* Rafal Artych (DT) +* Javier Caaro Calabor (Telefonica) +* Foo Ming Hu (Singtel) + +Device Location minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + +### Release 0.2.0 + + +- No new comments or bugs reported for [RC3](https://github.com/camaraproject/DeviceLocation/issues/155) + +- Discuss release approval + - **Agreed to release 0.2.0** + - AP @Jose: Create PR and make adjustments in Github. Remove RCs from Changelog if possible. + +### Review other Issues and PRs + +No new comments or progress on the ongoing issues and PRs + +#### Ongoing + +* [Add Test Definition for location Retrieval #119](https://github.com/camaraproject/DeviceLocation/pull/119/files) + - Link with Commonalities here: https://github.com/camaraproject/Commonalities/issues/94 + - Review PR status and new comments + - AP: Telefónica will provide a proposal updating a few aspects of Ludovic's proposal after checking with internal QA team. + - Update by Jose, but still pending + + +* [Geofencing - Adding a value in Termination Reason value enum](https://github.com/camaraproject/DeviceLocation/issues/141) + + AP from previous meeting: + - Ludovic will create an Issue in Commonalities. -> Pending, double check with Ludovic + - Related issues in [DeviceStatus](https://github.com/camaraproject/DeviceStatus/issues/117) and QoD + + +* [Geofencing API - Add Subscription type 'area-left-or-entered' to subscribe to both event in one time](https://github.com/camaraproject/DeviceLocation/issues/138) + + Discussed during previous meeting: + - Alignement with device status was discussed. + + - No specific issue created so far in Commonalities, but mentioned in [issue](https://github.com/camaraproject/Commonalities/issues/140) about CloudEvents Subscription format. + - This is not an urgent issue as functionality can be covered with current events, so we may wait until discussions in Commonalities advance. + + +* [Define guidelines for geofencing implementation](https://github.com/camaraproject/DeviceLocation/issues/133) + - No new comments. + - Connected with [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85). A document with implementation guideline should cover this also. + + +* [Geofencing API - Adding capability to manage max number of notification](https://github.com/camaraproject/DeviceLocation/issues/111) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/90) + - New [PR](https://github.com/camaraproject/Commonalities/pull/131) -> Still nor merged but seems to have all LGTM. AP: Double check with Ludovic + +* [Implement use of linting rule set for Device Location API](https://github.com/camaraproject/DeviceLocation/issues/125) + - Tested locally before creating RC3 + - Review status in [Commonalities](https://github.com/camaraproject/Commonalities/issues/142) + - AP @Rafal to propose a PR adding linting to our subproject CI + +* [Geofencing API - Defining a standard behavior for first event](https://github.com/camaraproject/DeviceLocation/issues/124) + - Moved to Commonalities [Issue 140](https://github.com/camaraproject/Commonalities/issues/140) + - No comments in the issue in the last 2 weeks + - Discussed during the meeting if we should wait for Commonalities for a common format, or add parameters in our current model nad adapt later to approved guidelines. + - As we are starting cycle for a new release, we can wait for the moment. Eventually, if we are about to release something new and commonalities are not agreed, we can tale the lead. + +* [Geofencing API - Add "format: uri" to notificationUrl](https://github.com/camaraproject/DeviceLocation/issues/118) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/93) + - No comments in the last 2 weeks + - Wait for outcome + +### Open discussions + +- No new comments since last meeting. + +#### Administrative Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track + - [Document uploaded by TEF](https://github.com/camaraproject/DeviceLocation/files/12856149/AdminCode.Proposal.-.Draft_20230926.docx) with a proposal. + + This item should be reopen after MWC. + + - We should discussed approach on this for next release. Should we incorporate this to current operations, should we split this functionality to new endpoints or even separate APIs? + +#### Behaviour when requesting too high precision + +* [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85) + - As requested by Joachim, issue will remain open until TEF uploads the document with more detail or the information is added to an API_documentation file to keep in the repo for future references. + +## AOB + + - Joachim asked for plans or roadmap for R1.0 + - Jose commented that there is still no roadmap or time frame agreed for v1.0, but release plan for R1.0 should be agreed at CAMARA project level. + - At WG level we may discuss the content for next release, being 0.x or 1.x. So far we only have the requirement for Administrative Codes, but others may come from GSMA product track + +
+ +- Next call will be on **March 12th, 2024** + +
+ diff --git a/marked/DeviceLocation/documentation/MeetingMinutes/MoM-2024-03-12/raw.md b/marked/DeviceLocation/documentation/MeetingMinutes/MoM-2024-03-12/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..69507db2f5345c39f90572611dc337c0af265fa9 --- /dev/null +++ b/marked/DeviceLocation/documentation/MeetingMinutes/MoM-2024-03-12/raw.md @@ -0,0 +1,138 @@ +# CAMARA DeviceLocation meeting - 2024-03-12 + +*March 12th, 2024* + +## Attendees + +* José Luis Urien (Telefonica) +* Joachim Dahlgren (Ericsson) +* Cetin Alpaycetin (Vodafone) +* Akos Hunyadi (DT) +* Javier Carro Calabor (Telefonica) +* Katrina Griese (Vodafone) +* Ludovic Robert (Orange) +* Alexander Boraczynski (Vodafone) +* Fernando Prado Cabrillo (Telefonica) +* Rafal Artych (DT) +* Surajj Jaggernath (Vodacom) +* Toyeeb Rehman (GSMA) + +Device Location minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + + +> [!IMPORTANT] +> [Release 0.2.0](https://github.com/camaraproject/DeviceLocation/releases/tag/v0.2.0) official!! +> +> New merges to be consolidated towards next -wip versions + + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + +### New + +#### Corrections + +* [[location-verification] Precise the description when matchRate needs to be set for PARTIAL-results](https://github.com/camaraproject/DeviceLocation/issues/158) + - Fixed in [PR 159](https://github.com/camaraproject/DeviceLocation/pull/159) + - Merged during the meeting. + +* [Add x-correlator as specified in the guideline](https://github.com/camaraproject/DeviceLocation/issues/160) + - PR to be created + - [Action] Ludovic will do + +* [subscriptionExpireTime is declared as "required" in the subscription-ends - note, but is optional currently](https://github.com/camaraproject/DeviceLocation/issues/161) +* Fixed along with old issue [Geofencing API - Adding capability to manage max number of notification](https://github.com/camaraproject/DeviceLocation/issues/111) + - Fixed in [PR 163](https://github.com/camaraproject/DeviceLocation/pull/163) + - Merged during the meeting + +* [[Geofencing]: Invalid area example for POST /subscriptions](https://github.com/camaraproject/DeviceLocation/issues/164) + - Fixed in [PR 165](https://github.com/camaraproject/DeviceLocation/pull/165) + -Merged during the meeting + +* [Remove API from info.title](https://github.com/camaraproject/DeviceLocation/issues/169) + - Remove API from the title + - [Action] José will create the PR + - Could be part of the linter rule but not yet + - action to standardize the info object + +#### Documentation + +* [Should 501 NOT_IMPLEMENTED be returned for unimplemented DeviceLocation APIs?](https://github.com/camaraproject/DeviceLocation/issues/168) + - Question related to the conformance + - Team agreed with José & Cetin comments + - Toyeeb aggreed + - Issue closed + + +#### Ongoing + +* [Implement use of linting rule set for Device Location API](https://github.com/camaraproject/DeviceLocation/issues/125) + - New PRs: [Introducing corrections for yamllint](https://github.com/camaraproject/DeviceLocation/pull/166) and [Adding configuration for Github Actions with linting ruleset](https://github.com/camaraproject/DeviceLocation/pull/167) + - PR#166 Rafal will regenerate the linter & once done the PR will be merge + - PR#167: to be merged after #166 + - Can be done offline + +* [Add Test Definition for location Retrieval #119](https://github.com/camaraproject/DeviceLocation/pull/119/files) + - New issue in Commonalities to discuss [Enhancement of the Testing Guidelines](https://github.com/camaraproject/Commonalities/issues/158) by TEF + - [Action] José propose to make an example to illustrate his proposal + - [Action] Toyeeb to check with GSMA conformance + +* [Geofencing - Adding a value in Termination Reason value enum](https://github.com/camaraproject/DeviceLocation/issues/141) + - Ludovic will create an Issue in Commonalities. -> Pending, double check with Ludovic + - [Action] Yes Ludovic will create the PR in Commponalities + - Related issues in [DeviceStatus](https://github.com/camaraproject/DeviceStatus/issues/117) and QoD + +* [Geofencing API - Add Subscription type 'area-left-or-entered' to subscribe to both event in one time](https://github.com/camaraproject/DeviceLocation/issues/138) + - New issue in Commonalities [Subscription-Issue2: Allow event consumers to subscribe to more than one event types with a single subscription](https://github.com/camaraproject/Commonalities/issues/154) + - Waiting for Commonalities outcomes + +* [Geofencing API - Defining a standard behavior for first event](https://github.com/camaraproject/DeviceLocation/issues/124) + - Moved to Commonalities [Issue 140](https://github.com/camaraproject/Commonalities/issues/140) + - No comments in the issue in the last 2 weeks + - Waiting for Commonalities outcomes + +* [Define guidelines for geofencing implementation](https://github.com/camaraproject/DeviceLocation/issues/133) + - No new comments. + - [Action] We need more comments from the team + - Connected with [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85). A document with implementation guideline should cover this also. + +* [Geofencing API - Add "format: uri" to notificationUrl](https://github.com/camaraproject/DeviceLocation/issues/118) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/93) + - No comments in the last 2 weeks + - Wait for outcome + +### Long term discussions + +#### Administrative Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track + - [Document uploaded by TEF](https://github.com/camaraproject/DeviceLocation/files/12856149/AdminCode.Proposal.-.Draft_20230926.docx) with a proposal. + + This item should be reopen after MWC. + + - We should discussed approach on this for next release. Should we incorporate this to current operations, should we split this functionality to new endpoints or even separate APIs? + - Need to be discussed + - Ludovic preference is for a separate API as for example in France this is not a request. + - For Javier this is not a top priority for Telefonica as of now. + - More generally probably we need to have feedback loop with GSMA team about API work (and review the priority as focus could change) + - Perhaps a point to be share in TSC. + +#### Behaviour when requesting too high precision + +* [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85) + - As requested by Joachim, issue will remain open until TEF uploads the document with more detail or the information is added to an API_documentation file to keep in the repo for future references. + - Joachim: Should be also aligned/synchronysed with Geofencing + +## AOB + +
+ +- Next call will be on **March 26th, 2024** +- Easter week, but we keep the meeting + +
diff --git a/marked/DeviceLocation/documentation/SupportingDocuments/README/raw.md b/marked/DeviceLocation/documentation/SupportingDocuments/README/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..37aa0ff405bf918d942905c10a0f435fd46c8ffd
--- /dev/null
+++ b/marked/DeviceLocation/documentation/SupportingDocuments/README/raw.md
@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.
diff --git a/marked/DeviceMediaStreamingRate/README/raw.md b/marked/DeviceMediaStreamingRate/README/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..ff5ed06db5a18506635b936411088e633a177a8a
--- /dev/null
+++ b/marked/DeviceMediaStreamingRate/README/raw.md
@@ -0,0 +1,41 @@
+
+
+
public | stable
public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
+| 1 | API definition | M | M | M | M | Y | [device-reachability-status.yaml](/code/API_definitions/device-reachability-status.yaml) |
+| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3) |
+| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3) |
+| 4 | API versioning convention applied | M | M | M | M | Y | |
+| 5 | API documentation | M | M | M | M | Y | inline in YAML |
+| 6 | User stories | O | O | O | M | Y | [device-reachability-status-User-Story.md](/documentation/API_documentation/device-reachability-status-User-Story.md) |
+| 7 | Basic API test cases & documentation | O | M | M | M | Y | [device-reachability-status.feature](/code/Test_definitions/device-reachability-status.feature) |
+| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [device-reachability-status.feature](/code/Test_definitions/device-reachability-status.feature) |
+| 9 | Test result statement | O | O | O | M | Y | See [here](https://github.com/camaraproject/DeviceReachabilityStatus/issues/44) |
+| 10 | API release numbering convention applied | M | M | M | M | Y | |
+| 11 | Change log updated | M | M | M | M | Y | [CHANGELOG.md](/CHANGELOG.md) |
+| 12 | Previous public release was certified | O | O | O | M | Y | See (1) |
+| 13 | API description (for marketing) | O | O | M | M | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/x/2wHWB) |
+
+(1) GSMA certified implementations of previous version by multiple operators (source: https://open-gateway.gsma.com/map as of 2025-03-11)
+
+Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.
+
+The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine).
diff --git a/marked/DeviceReachabilityStatus/documentation/API_documentation/device-reachability-status-User-Story/raw.md b/marked/DeviceReachabilityStatus/documentation/API_documentation/device-reachability-status-User-Story/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..758aff37e7ae4b095315df5d4d329f6d413a133c
--- /dev/null
+++ b/marked/DeviceReachabilityStatus/documentation/API_documentation/device-reachability-status-User-Story/raw.md
@@ -0,0 +1,20 @@
+# Device Reachability Status User Story
+
+| Item | Description | Support Qualifier |
+|---------------------------|-------------|-------------------|
+| Summary | As an enterprise application developer, I want to query the reachability status of a user's device, so that I can determine whether the device is reachable via SMS, data (mobile internet), or both, enabling better communication or service management decisions based on real-time device availability. | M |
+| Roles, Actor(s) and scope | **Roles:** Customer:Developer
**Actors:** Application service providers (ASP), hyperscalers, application developers.
**Scope:** Order To Activate (OTA) - Get connectivity status of a device | M |
+| NF Requirements | - | O |
+| Pre-conditions | - The customer:developer has been successfully onboarded to the API platform of the service provider
- The customer application has requested and received an access token with the required scope for the API | M |
+| Begins when | The customer application server makes a POST request to retrieve the reachability status of a user's device | M |
+| Ends when | The service provider returns the reachability status of the device with a timestamp when the status information was updated. In case of the device is reachable, additionally, the type of the connectivity (data, sms or both) is returned as well. | |
+| Post-conditions | - | M |
+| Exceptions | Several exceptions might occur during the API operations:
- Unauthorized: Invalid credentials (e.g., expired access token).
- Incorrect input data (e.g., malformed phone number).
- Not found: The phone number is not associated with a CSP customer account | M |
+
+# Linking a user story to API design
+
+Once we have the user story, the next step is to clarify the **data journey** in the context of the target and source systems we are integrating:
+- Think about triggers for workflows: how and when does data need to be moved between the application and the service?
+- Think about dependencies of data objects: does the data in underlying objects need to be regularly kept in sync with another system?
+- Think about any parameters the user might need to configure or change. This is particularly important when building self-serve integrations for non-technical end users.
+- Think about privacy by design: does any data represent sensitive information, and how can this be safely shared/stored according to regulation (e.g., anonymisation, tokenisation, zero-trust principles)
diff --git a/marked/DeviceReachabilityStatus/documentation/API_documentation/device-reachability-status-subscriptions-API-Readiness-Checklist/raw.md b/marked/DeviceReachabilityStatus/documentation/API_documentation/device-reachability-status-subscriptions-API-Readiness-Checklist/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..404147a358c391def01bb844c5783e9cab8779cf
--- /dev/null
+++ b/marked/DeviceReachabilityStatus/documentation/API_documentation/device-reachability-status-subscriptions-API-Readiness-Checklist/raw.md
@@ -0,0 +1,23 @@
+# API Readiness Checklist
+
+Checklist for device-reachability-status-subscriptions 0.8.0 in r1.2
+
+| Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
+| 1 | API definition | M | M | M | M | Y | [device-reachability-status-subscriptions.yaml](/code/API_definitions/device-reachability-status-subscriptions.yaml) |
+| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3) |
+| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3) |
+| 4 | API versioning convention applied | M | M | M | M | Y | |
+| 5 | API documentation | M | M | M | M | Y | inline in YAML |
+| 6 | User stories | O | O | O | M | N | |
+| 7 | Basic API test cases & documentation | O | M | M | M | Y | [device-reachability-status-subscriptions.feature](/code/Test_definitions/device-reachability-status-subscriptions.feature) |
+| 8 | Enhanced API test cases & documentation | O | O | O | M | N | |
+| 9 | Test result statement | O | O | O | M | N | |
+| 10 | API release numbering convention applied | M | M | M | M | Y | |
+| 11 | Change log updated | M | M | M | M | Y | [CHANGELOG.md](/CHANGELOG.md) |
+| 12 | Previous public release was certified | O | O | O | M | N | |
+| 13 | API description (for marketing) | O | O | M | M | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/x/JAFmBQ) |
+
+Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.
+
+The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine).
diff --git a/marked/DeviceReachabilityStatus/documentation/SupportingDocuments/README/raw.md b/marked/DeviceReachabilityStatus/documentation/SupportingDocuments/README/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..37aa0ff405bf918d942905c10a0f435fd46c8ffd
--- /dev/null
+++ b/marked/DeviceReachabilityStatus/documentation/SupportingDocuments/README/raw.md
@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.
diff --git a/marked/DeviceRoamingStatus/README/raw.md b/marked/DeviceRoamingStatus/README/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..edbaef5fb6fa4b97612d64ea354110c90234ade1
--- /dev/null
+++ b/marked/DeviceRoamingStatus/README/raw.md
@@ -0,0 +1,61 @@
+
+
public | stable
public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
+| 1 | API definition | M | M | M | M | Y | [device-roaming-status.yaml](/code/API_definitions/device-roaming-status.yaml) |
+| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3) |
+| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3) |
+| 4 | API versioning convention applied | M | M | M | M | Y | |
+| 5 | API documentation | M | M | M | M | Y | inline in YAML |
+| 6 | User stories | O | O | O | M | Y | [device-roaming-status-User-Story.md](/documentation/API_documentation/device-roaming-status-User-Story.md) |
+| 7 | Basic API test cases & documentation | O | M | M | M | Y | [device-roaming-status.feature](/code/Test_definitions/device-roaming-status.feature) |
+| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [device-roaming-status.feature](/code/Test_definitions/device-roaming-status.feature) |
+| 9 | Test result statement | O | O | O | M | Y | See [here](https://github.com/camaraproject/DeviceRoamingStatus/issues/46) |
+| 10 | API release numbering convention applied | M | M | M | M | Y | |
+| 11 | Change log updated | M | M | M | M | Y | [CHANGELOG.md](/CHANGELOG.md) |
+| 12 | Previous public release was certified | O | O | O | M | Y | See (1) |
+| 13 | API description (for marketing) | O | O | M | M | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/x/vYBmBQ) |
+
+(1) GSMA certified implementations of previous version by multiple operators (source: https://open-gateway.gsma.com/map as of 2025-03-11)
+
+Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.
+
+The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine).
diff --git a/marked/DeviceRoamingStatus/documentation/API_documentation/device-roaming-status-User-Story/raw.md b/marked/DeviceRoamingStatus/documentation/API_documentation/device-roaming-status-User-Story/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..f3c0c1c784bcaafac2854b02da435e58b848f969
--- /dev/null
+++ b/marked/DeviceRoamingStatus/documentation/API_documentation/device-roaming-status-User-Story/raw.md
@@ -0,0 +1,21 @@
+# Device Roaming Status User Story
+
+| Item | Description | Support Qualifier |
+|---------------------------|-------------|-------------------|
+| Summary | As an enterprise application developer, I want to query the roaming status of a user's device, so that I can determine whether a device is in a foreign network and in which country it is located. This API can be used to identify fraud, ensure regulatory compliance, or enforce territorial restrictions on video and audio content. | M |
+| Roles, Actor(s) and scope | **Roles:** Customer:Developer
**Actors:** Application service providers (ASP), hyperscalers, application developers.
**Scope:** Order To Activate (OTA) - Get roaming status of a device | M |
+| NF Requirements | - | O |
+| Pre-conditions | - The customer:developer has been successfully onboarded to the API platform of the service provider
- The customer application has requested and received an access token with the required scope for the API | M |
+| Begins when | The customer application server makes a POST request to retrieve the roaming status of a user's device | M |
+| Ends when | The service provider returns the roaming status of the device with a timestamp when the status information was updated. In case of a roaming situation also the roaming country name and code shall be returned. | |
+| Post-conditions | - | M |
+| Exceptions | Several exceptions might occur during the API operations:
- Unauthorized: Invalid credentials (e.g., expired access token).
- Incorrect input data (e.g., malformed phone number).
- Not found: The phone number is not associated with a CSP customer account | M |
+
+# Linking a user story to API design
+
+Once we have the user story, the next step is to clarify the **data journey** in the context of the target and source systems we are integrating:
+- Think about triggers for workflows: how and when does data need to be moved between the application and the service?
+- Think about dependencies of data objects: does the data in underlying objects need to be regularly kept in sync with another system?
+- Think about any parameters the user might need to configure or change. This is particularly important when building self-serve integrations for non-technical end users.
+- Think about privacy by design: does any data represent sensitive information, and how can this be safely shared/stored according to regulation (e.g., anonymisation, tokenisation, zero-trust principles)
+
diff --git a/marked/DeviceRoamingStatus/documentation/API_documentation/device-roaming-status-subscriptions-API-Readiness-Checklist/raw.md b/marked/DeviceRoamingStatus/documentation/API_documentation/device-roaming-status-subscriptions-API-Readiness-Checklist/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..c1eba010a9db4632f18d6fcccf21abd92b526bcc
--- /dev/null
+++ b/marked/DeviceRoamingStatus/documentation/API_documentation/device-roaming-status-subscriptions-API-Readiness-Checklist/raw.md
@@ -0,0 +1,23 @@
+# API Readiness Checklist
+
+Checklist for device-roaming-status-subscriptions 0.8.0 in r1.2
+
+| Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
+| 1 | API definition | M | M | M | M | Y | [device-roaming-status-subscriptions.yaml](/code/API_definitions/device-roaming-status-subscriptions.yaml) |
+| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3) |
+| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3) |
+| 4 | API versioning convention applied | M | M | M | M | Y | |
+| 5 | API documentation | M | M | M | M | Y | inline in YAML |
+| 6 | User stories | O | O | O | M | N | |
+| 7 | Basic API test cases & documentation | O | M | M | M | Y | [device-roaming-status-subscriptions.feature](/code/Test_definitions/device-roaming-status-subscriptions.feature) |
+| 8 | Enhanced API test cases & documentation | O | O | O | M | N | |
+| 9 | Test result statement | O | O | O | M | N | |
+| 10 | API release numbering convention applied | M | M | M | M | Y | |
+| 11 | Change log updated | M | M | M | M | Y | [CHANGELOG.md](/CHANGELOG.md) |
+| 12 | Previous public release was certified | O | O | O | M | N | |
+| 13 | API description (for marketing) | O | O | M | M | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/x/D4FlBQ) |
+
+Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.
+
+The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine).
diff --git a/marked/DeviceRoamingStatus/documentation/SupportingDocuments/README/raw.md b/marked/DeviceRoamingStatus/documentation/SupportingDocuments/README/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..37aa0ff405bf918d942905c10a0f435fd46c8ffd
--- /dev/null
+++ b/marked/DeviceRoamingStatus/documentation/SupportingDocuments/README/raw.md
@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.
diff --git a/marked/DeviceStatus/README/raw.md b/marked/DeviceStatus/README/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..4948d61fc35a8432e5de7ced5fe70b1abeb11fe2
--- /dev/null
+++ b/marked/DeviceStatus/README/raw.md
@@ -0,0 +1,82 @@
+
+
public | stable
public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
+| 1 | API definition | M | M | M | M | Y | [/code/API_definitions/connected-network-type.yaml](/code/API_definitions/connected-network-type.yaml) |
+| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r2.3](https://github.com/camaraproject/Commonalities/releases/tag/r2.3) |
+| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r2.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r2.3) |
+| 4 | API versioning convention applied | M | M | M | M | Y | |
+| 5 | API documentation | M | M | M | M | Y | inline in YAML |
+| 6 | User stories | O | O | O | M | N | |
+| 7 | Basic API test cases & documentation | O | M | M | M | Y | [/code/Test_definitions/connected-network-type.feature](/code/Test_definitions/connected-network-type.feature) |
+| 8 | Enhanced API test cases & documentation | O | O | O | M | N | |
+| 9 | Test result statement | O | O | O | M | N | |
+| 10 | API release numbering convention applied | M | M | M | M | Y | |
+| 11 | Change log updated | M | M | M | M | Y | [/CHANGELOG.md](/CHANGELOG.md) |
+| 12 | Previous public release was certified | O | O | O | M | N | |
+
+Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.
+
+The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine).
diff --git a/marked/DeviceStatus/documentation/API_documentation/connected-network-type-subscriptions-API-Readiness-Checklist/raw.md b/marked/DeviceStatus/documentation/API_documentation/connected-network-type-subscriptions-API-Readiness-Checklist/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..7941985feae81e60a6b098d35f3c5e39fa55e476
--- /dev/null
+++ b/marked/DeviceStatus/documentation/API_documentation/connected-network-type-subscriptions-API-Readiness-Checklist/raw.md
@@ -0,0 +1,22 @@
+# API Readiness Checklist
+
+Checklist for connected-network-type-subscriptions 0.1.0 in r2.2.
+
+| Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
+| 1 | API definition | M | M | M | M | Y | [/code/API_definitions/connected-network-type-subscriptions.yaml](/code/API_definitions/connected-network-type-subscriptions.yaml) |
+| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r2.3](https://github.com/camaraproject/Commonalities/releases/tag/r2.3) |
+| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r2.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r2.3) |
+| 4 | API versioning convention applied | M | M | M | M | Y | |
+| 5 | API documentation | M | M | M | M | Y | inline in YAML |
+| 6 | User stories | O | O | O | M | N | |
+| 7 | Basic API test cases & documentation | O | M | M | M | Y | [/code/Test_definitions/connected-network-type-subscriptions.feature](/code/Test_definitions/connected-network-type-subscriptions.feature) |
+| 8 | Enhanced API test cases & documentation | O | O | O | M | N | |
+| 9 | Test result statement | O | O | O | M | N | |
+| 10 | API release numbering convention applied | M | M | M | M | Y | |
+| 11 | Change log updated | M | M | M | M | Y | [/CHANGELOG.md](/CHANGELOG.md) |
+| 12 | Previous public release was certified | O | O | O | M | N | |
+
+Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.
+
+The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine).
diff --git a/marked/DeviceStatus/documentation/API_documentation/device-reachability-status-API-Readiness-Checklist/raw.md b/marked/DeviceStatus/documentation/API_documentation/device-reachability-status-API-Readiness-Checklist/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..48efe46000be381a58d0524da9c1cc91ccd9fa28
--- /dev/null
+++ b/marked/DeviceStatus/documentation/API_documentation/device-reachability-status-API-Readiness-Checklist/raw.md
@@ -0,0 +1,24 @@
+# API Readiness Checklist
+
+Checklist for device-reachability-status 1.0.0 in r2.2.
+
+| Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
+| 1 | API definition | M | M | M | M | Y | [/code/API_definitions/device-reachability-status.yaml](/code/API_definitions/device-reachability-status.yaml) |
+| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r2.3](https://github.com/camaraproject/Commonalities/releases/tag/r2.3) |
+| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r2.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r2.3) |
+| 4 | API versioning convention applied | M | M | M | M | Y | |
+| 5 | API documentation | M | M | M | M | Y | inline in YAML |
+| 6 | User stories | O | O | O | M | Y | [/documentation/API_documentation/device-reachability-status-User-Story.md](/documentation/API_documentation/device-reachability-status-User-Story.md) |
+| 7 | Basic API test cases & documentation | O | M | M | M | Y | [/code/Test_definitions/device-reachability-status.feature](/code/Test_definitions/device-reachability-status.feature) |
+| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [/code/Test_definitions/device-reachability-status.feature](/code/Test_definitions/device-reachability-status.feature) |
+| 9 | Test result statement | O | O | O | M | Y | [see issue #258](https://github.com/camaraproject/DeviceStatus/issues/258) |
+| 10 | API release numbering convention applied | M | M | M | M | Y | |
+| 11 | Change log updated | M | M | M | M | Y | [/CHANGELOG.md](/CHANGELOG.md) |
+| 12 | Previous public release was certified | O | O | O | M | Y | see (1) |
+
+(1) GSMA certified implementations of previous version by multiple operators (source: https://open-gateway.gsma.com/map as of 2025-03-11)
+
+Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.
+
+The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine).
diff --git a/marked/DeviceStatus/documentation/API_documentation/device-reachability-status-User-Story/raw.md b/marked/DeviceStatus/documentation/API_documentation/device-reachability-status-User-Story/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..758aff37e7ae4b095315df5d4d329f6d413a133c
--- /dev/null
+++ b/marked/DeviceStatus/documentation/API_documentation/device-reachability-status-User-Story/raw.md
@@ -0,0 +1,20 @@
+# Device Reachability Status User Story
+
+| Item | Description | Support Qualifier |
+|---------------------------|-------------|-------------------|
+| Summary | As an enterprise application developer, I want to query the reachability status of a user's device, so that I can determine whether the device is reachable via SMS, data (mobile internet), or both, enabling better communication or service management decisions based on real-time device availability. | M |
+| Roles, Actor(s) and scope | **Roles:** Customer:Developer
**Actors:** Application service providers (ASP), hyperscalers, application developers.
**Scope:** Order To Activate (OTA) - Get connectivity status of a device | M |
+| NF Requirements | - | O |
+| Pre-conditions | - The customer:developer has been successfully onboarded to the API platform of the service provider
- The customer application has requested and received an access token with the required scope for the API | M |
+| Begins when | The customer application server makes a POST request to retrieve the reachability status of a user's device | M |
+| Ends when | The service provider returns the reachability status of the device with a timestamp when the status information was updated. In case of the device is reachable, additionally, the type of the connectivity (data, sms or both) is returned as well. | |
+| Post-conditions | - | M |
+| Exceptions | Several exceptions might occur during the API operations:
- Unauthorized: Invalid credentials (e.g., expired access token).
- Incorrect input data (e.g., malformed phone number).
- Not found: The phone number is not associated with a CSP customer account | M |
+
+# Linking a user story to API design
+
+Once we have the user story, the next step is to clarify the **data journey** in the context of the target and source systems we are integrating:
+- Think about triggers for workflows: how and when does data need to be moved between the application and the service?
+- Think about dependencies of data objects: does the data in underlying objects need to be regularly kept in sync with another system?
+- Think about any parameters the user might need to configure or change. This is particularly important when building self-serve integrations for non-technical end users.
+- Think about privacy by design: does any data represent sensitive information, and how can this be safely shared/stored according to regulation (e.g., anonymisation, tokenisation, zero-trust principles)
diff --git a/marked/DeviceStatus/documentation/API_documentation/device-reachability-status-subscriptions-API-Readiness-Checklist/raw.md b/marked/DeviceStatus/documentation/API_documentation/device-reachability-status-subscriptions-API-Readiness-Checklist/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..afbe8302bbae5e88a7453a712b8f1376eddbf976
--- /dev/null
+++ b/marked/DeviceStatus/documentation/API_documentation/device-reachability-status-subscriptions-API-Readiness-Checklist/raw.md
@@ -0,0 +1,22 @@
+# API Readiness Checklist
+
+Checklist for device-reachability-status-subscriptions 0.7.0 in r2.2.
+
+| Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
+| 1 | API definition | M | M | M | M | Y | [/code/API_definitions/device-reachability-status-subscriptions.yaml](/code/API_definitions/device-reachability-status-subscriptions.yaml) |
+| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r2.3](https://github.com/camaraproject/Commonalities/releases/tag/r2.3) |
+| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r2.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r2.3) |
+| 4 | API versioning convention applied | M | M | M | M | Y | |
+| 5 | API documentation | M | M | M | M | Y | inline in YAML |
+| 6 | User stories | O | O | O | M | N | |
+| 7 | Basic API test cases & documentation | O | M | M | M | Y | [/code/Test_definitions/device-reachability-status-subscriptions.feature](/code/Test_definitions/device-reachability-status-subscriptions.feature) |
+| 8 | Enhanced API test cases & documentation | O | O | O | M | N | |
+| 9 | Test result statement | O | O | O | M | N | |
+| 10 | API release numbering convention applied | M | M | M | M | Y | |
+| 11 | Change log updated | M | M | M | M | Y | [/CHANGELOG.md](/CHANGELOG.md) |
+| 12 | Previous public release was certified | O | O | O | M | N | |
+
+Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.
+
+The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine).
diff --git a/marked/DeviceStatus/documentation/API_documentation/device-roaming-status-API-Readiness-Checklist/raw.md b/marked/DeviceStatus/documentation/API_documentation/device-roaming-status-API-Readiness-Checklist/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..db31fcd77b97184d9aaea134c91eecaec34a7897
--- /dev/null
+++ b/marked/DeviceStatus/documentation/API_documentation/device-roaming-status-API-Readiness-Checklist/raw.md
@@ -0,0 +1,24 @@
+# API Readiness Checklist
+
+Checklist for device-roaming-status 1.0.0 in r2.2.
+
+| Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
+| 1 | API definition | M | M | M | M | Y | [/code/API_definitions/device-roaming-status.yaml](/code/API_definitions/device-roaming-status.yaml) |
+| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r2.3](https://github.com/camaraproject/Commonalities/releases/tag/r2.3) |
+| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r2.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r2.3) |
+| 4 | API versioning convention applied | M | M | M | M | Y | |
+| 5 | API documentation | M | M | M | M | Y | inline in YAML |
+| 6 | User stories | O | O | O | M | Y | [/documentation/API_documentation/device-roaming-status-User-Story.md](/documentation/API_documentation/device-roaming-status-User-Story.md) |
+| 7 | Basic API test cases & documentation | O | M | M | M | Y | [/code/Test_definitions/device-roaming-status.feature](/code/Test_definitions/device-roaming-status.feature) |
+| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [/code/Test_definitions/device-roaming-status.feature](/code/Test_definitions/device-roaming-status.feature) |
+| 9 | Test result statement | O | O | O | M | Y | [see issue #258](https://github.com/camaraproject/DeviceStatus/issues/258) |
+| 10 | API release numbering convention applied | M | M | M | M | Y | |
+| 11 | Change log updated | M | M | M | M | Y | [/CHANGELOG.md](/CHANGELOG.md) |
+| 12 | Previous public release was certified | O | O | O | M | Y | see (1) |
+
+(1) GSMA certified implementations of previous version by multiple operators (source: https://open-gateway.gsma.com/map as of 2025-03-11)
+
+Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.
+
+The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine).
diff --git a/marked/DeviceStatus/documentation/API_documentation/device-roaming-status-User-Story/raw.md b/marked/DeviceStatus/documentation/API_documentation/device-roaming-status-User-Story/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..f3c0c1c784bcaafac2854b02da435e58b848f969
--- /dev/null
+++ b/marked/DeviceStatus/documentation/API_documentation/device-roaming-status-User-Story/raw.md
@@ -0,0 +1,21 @@
+# Device Roaming Status User Story
+
+| Item | Description | Support Qualifier |
+|---------------------------|-------------|-------------------|
+| Summary | As an enterprise application developer, I want to query the roaming status of a user's device, so that I can determine whether a device is in a foreign network and in which country it is located. This API can be used to identify fraud, ensure regulatory compliance, or enforce territorial restrictions on video and audio content. | M |
+| Roles, Actor(s) and scope | **Roles:** Customer:Developer
**Actors:** Application service providers (ASP), hyperscalers, application developers.
**Scope:** Order To Activate (OTA) - Get roaming status of a device | M |
+| NF Requirements | - | O |
+| Pre-conditions | - The customer:developer has been successfully onboarded to the API platform of the service provider
- The customer application has requested and received an access token with the required scope for the API | M |
+| Begins when | The customer application server makes a POST request to retrieve the roaming status of a user's device | M |
+| Ends when | The service provider returns the roaming status of the device with a timestamp when the status information was updated. In case of a roaming situation also the roaming country name and code shall be returned. | |
+| Post-conditions | - | M |
+| Exceptions | Several exceptions might occur during the API operations:
- Unauthorized: Invalid credentials (e.g., expired access token).
- Incorrect input data (e.g., malformed phone number).
- Not found: The phone number is not associated with a CSP customer account | M |
+
+# Linking a user story to API design
+
+Once we have the user story, the next step is to clarify the **data journey** in the context of the target and source systems we are integrating:
+- Think about triggers for workflows: how and when does data need to be moved between the application and the service?
+- Think about dependencies of data objects: does the data in underlying objects need to be regularly kept in sync with another system?
+- Think about any parameters the user might need to configure or change. This is particularly important when building self-serve integrations for non-technical end users.
+- Think about privacy by design: does any data represent sensitive information, and how can this be safely shared/stored according to regulation (e.g., anonymisation, tokenisation, zero-trust principles)
+
diff --git a/marked/DeviceStatus/documentation/API_documentation/device-roaming-status-subscriptions-API-Readiness-Checklist/raw.md b/marked/DeviceStatus/documentation/API_documentation/device-roaming-status-subscriptions-API-Readiness-Checklist/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..853d62e4bafb80b3fc98144e9f5b61a4ab0a731f
--- /dev/null
+++ b/marked/DeviceStatus/documentation/API_documentation/device-roaming-status-subscriptions-API-Readiness-Checklist/raw.md
@@ -0,0 +1,22 @@
+# API Readiness Checklist
+
+Checklist for device-roaming-status-subscriptions 0.7.0 in r2.2.
+
+| Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
+| 1 | API definition | M | M | M | M | Y | [/code/API_definitions/device-roaming-status-subscriptions.yaml](/code/API_definitions/device-roaming-status-subscriptions.yaml) |
+| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r2.3](https://github.com/camaraproject/Commonalities/releases/tag/r2.3) |
+| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r2.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r2.3) |
+| 4 | API versioning convention applied | M | M | M | M | Y | |
+| 5 | API documentation | M | M | M | M | Y | inline in YAML |
+| 6 | User stories | O | O | O | M | N | |
+| 7 | Basic API test cases & documentation | O | M | M | M | Y | [/code/Test_definitions/device-roaming-status-subscriptions.feature](/code/Test_definitions/device-roaming-status-subscriptions.feature) |
+| 8 | Enhanced API test cases & documentation | O | O | O | M | N | |
+| 9 | Test result statement | O | O | O | M | N | |
+| 10 | API release numbering convention applied | M | M | M | M | Y | |
+| 11 | Change log updated | M | M | M | M | Y | [/CHANGELOG.md](/CHANGELOG.md) |
+| 12 | Previous public release was certified | O | O | O | M | N | |
+
+Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.
+
+The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine).
diff --git a/marked/DeviceStatus/documentation/API_documentation/resources/README/raw.md b/marked/DeviceStatus/documentation/API_documentation/resources/README/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..37aa0ff405bf918d942905c10a0f435fd46c8ffd
--- /dev/null
+++ b/marked/DeviceStatus/documentation/API_documentation/resources/README/raw.md
@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.
diff --git a/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-03-29/raw.md b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-03-29/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..cb014a56be8ed6a708bea354d0206e4688404fad
--- /dev/null
+++ b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-03-29/raw.md
@@ -0,0 +1,48 @@
+# Camara DeviceStatus meeting - MOM-2023-03-29
+
+*March 29th, 2023*
+
+## Attendees
+
+* Akos Hunyadi (Deutsche Telekom)
+* Eric Murray (Vodafone)
+* Joachim Dahlgreen (Ericsson)
+* Mona Mokhber (Telefonica)
+* Rafal Artych (Deutsche Telekom)
+* Robert Ludivic (Orange)
+* Sachin Kumar (Vodafone)
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open issues
+* Open PRs
+* AOB
+
+
+### Open issues:
+
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34)
+ - rewrite the issue to one time request
+ - start discussion
+* [#24 Tag version 0.2.0](https://github.com/camaraproject/DeviceStatus/issues/24)
+ - 0.2.0 release branch is created but it should be protected => this issue can be closed
+* [#17 Subscription Mode with new Eventtypes](https://github.com/camaraproject/DeviceStatus/issues/17)
+ - related to the PR about subscriptions: https://github.com/camaraproject/WorkingGroups/pull/173 . This issue should be discussed or modified after its approval.
+* [#15 Update commonalities glossary with subproject relevant terms](https://github.com/camaraproject/DeviceStatus/issues/15)
+ - update with camelcase names (Rafal)
+* [#14 Align error message with structure defined in the guideline](https://github.com/camaraproject/DeviceStatus/issues/14)
+ - Mona creates the PR, target 0.5.0-wip
+
+### Open PRs
+* [#33 Update MAINTAINERS.MD](https://github.com/camaraproject/DeviceStatus/pull/33)
+ - needs owner review
+* [#31 Adding notification/subscription for Device Status](https://github.com/camaraproject/DeviceStatus/pull/31)
+ - on hold
+
+## AOB
+* Create 0.4.0 release branch (Akos)
+* Further releases should be developed as proposed in Commonalities, using -wip in the version name during development of the next release
+
+* Next call will be on 12.04.2023 11:00 CET
diff --git a/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-04-12/raw.md b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-04-12/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..7f60c600dbe24d20495add8580d2a8018ffb2774
--- /dev/null
+++ b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-04-12/raw.md
@@ -0,0 +1,47 @@
+# Camara DeviceStatus meeting - MOM-2023-04-12
+
+*April 12th, 2023*
+
+## Attendees
+
+* Akos Hunyadi (Deutsche Telekom)
+* Eric Murray (Vodafone)
+* Gareth Williams (GSMA)
+* Joachim Dahlgreen (Ericsson)
+* Jorge Garcia Hospital (Telefonica)
+* Ludovic Robert (Orange)
+* Mona Mokhber (Telefonica)
+* Murat Karabulut (Deutsche Telekom)
+* Rafal Artych (Deutsche Telekom)
+* Sachin Kumar (Vodafone)
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open issues
+* Open PRs
+* AOB
+
+
+### Open issues:
+
+* [#37 Create release 0.4.0](https://github.com/camaraproject/DeviceStatus/issues/37)
+ - Eric will create the release
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34)
+ - start discussion
+* [#24 Tag version 0.2.0](https://github.com/camaraproject/DeviceStatus/issues/24)
+ - 0.2.0 release branch is created but it should be protected => this issue can be closed
+ - codeowners have no rights for branch protection (Akos will contact Herbert about it)
+* [#17 Subscription Mode with new Eventtypes](https://github.com/camaraproject/DeviceStatus/issues/17)
+ - related to the PR about subscriptions: https://github.com/camaraproject/WorkingGroups/pull/173 . This issue should be discussed or modified after its approval.
+* [#14 Align error message with structure defined in the guideline](https://github.com/camaraproject/DeviceStatus/issues/14)
+
+### Open PRs
+* [#35 Errors definition alignment with guidelines](https://github.com/camaraproject/DeviceStatus/pull/35)
+ - additional approvals required
+* [#31 Adding notification/subscription for Device Status](https://github.com/camaraproject/DeviceStatus/pull/31)
+ - on hold
+
+## AOB
+* Next call will be on 26.04.2023 11:00 CET
diff --git a/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-06-21/raw.md b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-06-21/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..b7fba646612ca3e770810d05fd4f2d934db3bd58
--- /dev/null
+++ b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-06-21/raw.md
@@ -0,0 +1,44 @@
+# Camara DeviceStatus meeting - MOM-2023-06-21
+
+*June 21st, 2023*
+
+## Attendees
+
+* Akos Hunyadi (Deutsche Telekom)
+* Eric Murray (Vodafone)
+* Joachim Dahlgreen (Ericsson)
+* Jorge Garcia Hospital (Telefonica)
+* Ludovic Robert (Orange)
+* Rafal Artych (Deutsche Telekom)
+* Sachin Kumar (Vodafone)
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open issues
+* Open PRs
+* AOB
+
+
+### Open issues:
+
+* [#52 Harmonize device object with QoD API](https://github.com/camaraproject/DeviceStatus/issues/52)
+Will be fixed in [PR31](https://github.com/camaraproject/DeviceStatus/pull/31)
+
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34)
+Open issue: which type of connectivity is needed.
+Input from Jorge: GSMA is already working on the use cases, which possible should be considered in CAMARA also. Decision: we wait until next DeviceStatus call.
+
+* [#17 Subscription Mode with new Eventtypes](https://github.com/camaraproject/DeviceStatus/issues/17)
+[PR31](https://github.com/camaraproject/DeviceStatus/pull/31) is open
+
+### Open PRs
+* [#31 Adding notification/subscription for Device Status](https://github.com/camaraproject/DeviceStatus/pull/31)
+
+
+## AOB
+* Create API roadmap draft => Akos
+* Create Issue for documentation => Akos
+
+* Next call will be on 05.07.2023 11:00 CET
diff --git a/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-07-05/raw.md b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-07-05/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..b7f65105ea05dd5c08dd10cd9d2811d6adcff09e
--- /dev/null
+++ b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-07-05/raw.md
@@ -0,0 +1,56 @@
+# Camara DeviceStatus meeting - MOM-2023-07-05
+
+*July 5th, 2023*
+
+## Attendees
+
+* Akos Hunyadi (Deutsche Telekom)
+* Eric Murray (Vodafone)
+* Fernando Prado Cabrillo (Telefonica)
+* Joachim Dahlgreen (Ericsson)
+* Jorge Garcia Hospital (Telefonica)
+* Ludovic Robert (Orange)
+* Mona Mokhber (Telefonica)
+
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open issues
+* Open PRs
+* API Roadmap
+* AOB
+
+
+## Open issues:
+
+* [#57 Add documentation into API definition](https://github.com/camaraproject/DeviceStatus/issues/57)
+
+* [#52 Harmonize device object with QoD API](https://github.com/camaraproject/DeviceStatus/issues/52)
+Will be fixed in [PR31](https://github.com/camaraproject/DeviceStatus/pull/31)
+
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34)
+No input from GSMA available. The PR can be created, based on the discussions.
+
+* [#17 Subscription Mode with new Eventtypes](https://github.com/camaraproject/DeviceStatus/issues/17)
+[PR31](https://github.com/camaraproject/DeviceStatus/pull/31) is open
+
+## Open PRs
+* [#31 Adding notification/subscription for Device Status](https://github.com/camaraproject/DeviceStatus/pull/31)
+
+## API Roadmap
+### Release 0.5.0
+* July-August 2023
+* [#57 Add documentation into API definition](https://github.com/camaraproject/DeviceStatus/issues/57)
+* [#52 Harmonize device object with QoD API](https://github.com/camaraproject/DeviceStatus/issues/52)
+* [#17 Subscription Mode with new Eventtypes](https://github.com/camaraproject/DeviceStatus/issues/17) /
+[PR#31](https://github.com/camaraproject/DeviceStatus/pull/31)
+
+### Release 0.6.0
+* September-Oktober 2023
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34)
+
+## AOB
+
+* Next call will be on 19.07.2023 11:00 CET
diff --git a/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-07-19/raw.md b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-07-19/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..45562413ccd2fe01f316d5fa79326e8673167e54
--- /dev/null
+++ b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-07-19/raw.md
@@ -0,0 +1,64 @@
+# Camara DeviceStatus meeting - MOM-2023-07-19
+
+*July 19th, 2023*
+
+## Attendees
+
+* Akos Hunyadi (Deutsche Telekom)
+* Eric Murray (Vodafone)
+* Fernando Prado Cabrillo (Telefonica)
+* Joachim Dahlgreen (Ericsson)
+* Ludovic Robert (Orange)
+* Masaharu Hattori (KDDI)
+* Mona Mokhber (Telefonica)
+* Rafal Artych (Deutsche Telekom)
+
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open issues
+* Open PRs
+* API Roadmap
+* AOB
+
+
+## Open issues:
+
+* [#57 Add documentation into API definition](https://github.com/camaraproject/DeviceStatus/issues/57)
+ [PR65](https://github.com/camaraproject/DeviceStatus/pull/65) is open.
+
+* [#52 Harmonize device object with QoD API](https://github.com/camaraproject/DeviceStatus/issues/52)
+Has been fixed by [PR31](https://github.com/camaraproject/DeviceStatus/pull/31), the issue can be closed.
+
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34)
+No input from GSMA available. The PR can be created, based on the discussions.
+
+* [#17 Subscription Mode with new Eventtypes](https://github.com/camaraproject/DeviceStatus/issues/17)
+[PR31](https://github.com/camaraproject/DeviceStatus/pull/31) is closed, the issue can be closed too.
+
+## Open PRs
+* [#65 Add documentation](https://github.com/camaraproject/DeviceStatus/pull/65)
+ The goal is to merge the PR by the end of CW29.
+
+## API Roadmap
+### Release 0.5.0
+* July-August 2023
+* [#65 Add documentation](https://github.com/camaraproject/DeviceStatus/pull/65)
+* [~~#52 Harmonize device object with QoD API~~](https://github.com/camaraproject/DeviceStatus/issues/52)
+* [~~#31 Adding notification/subscription for Device Status~~](https://github.com/camaraproject/DeviceStatus/pull/31)
+* After [PR#65](https://github.com/camaraproject/DeviceStatus/pull/65) has been merged, the release can be created (Eric).
+
+### Release 0.6.0
+* September-Oktober 2023
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34)
+
+## AOB
+
+* New issue: How to handle mandatory and optional features of each API
+ * Definition of minimum implementation of a Camara API
+ * How can a provider inform the ASP/aggregator about not implemented features in advance of the API call?
+ * An issue in commonalities should be created
+* Next call will be on 02.08.2023 11:00 CET
+
diff --git a/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-09-13/raw.md b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-09-13/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..7af8acfc0eb81832a52775f394595b853e5a5678
--- /dev/null
+++ b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-09-13/raw.md
@@ -0,0 +1,72 @@
+ # Camara DeviceStatus meeting - MOM-2023-09-13
+
+*September 13th, 2023*
+
+## Attendees
+
+* Akos Hunyadi (Deutsche Telekom)
+* Eric Murray (Vodafone)
+* Fernando Prado Cabrillo (Telefonica)
+* Joachim Dahlgreen (Ericsson)
+* Ludovic Robert (Orange)
+* Prashant Sidana (E&)
+* Rafal Artych (Deutsche Telekom)
+* Sachin Kumar (Vodafone)
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open issues
+* Open PRs
+* API Roadmap
+* AOB
+
+
+## Open issues:
+
+* [#71 Release plan&content](https://github.com/camaraproject/DeviceStatus/issues/71)
+The upcoming releases were agreed as described below.
+
+* [#70 Info required : API understanding](https://github.com/camaraproject/DeviceStatus/issues/70)
+The issue can be closed.
+
+* [#57 Add documentation into API definition](https://github.com/camaraproject/DeviceStatus/issues/57)
+ [PR65](https://github.com/camaraproject/DeviceStatus/pull/65) is open.
+
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34)
+[PR69](https://github.com/camaraproject/DeviceStatus/pull/69) is open.
+
+* [#17 Subscription Mode with new Eventtypes](https://github.com/camaraproject/DeviceStatus/issues/17)
+[PR31](https://github.com/camaraproject/DeviceStatus/pull/31) introduced a generic subscription endpoint.
+Currently with the roaming status types, but it can be extended, when e.g. connectivity status info is added to the API.
+
+## Open PRs
+* [#69 add /connectivity - endpoint to check the network status of a device](https://github.com/camaraproject/DeviceStatus/pull/69)
+
+* [#65 Add documentation](https://github.com/camaraproject/DeviceStatus/pull/65)
+ The PR should be adapted when CloudEvents will be introduced => status delayed.
+
+## API Roadmap
+
+### Release 0.5.0
+* September-October 2023
+* The release is delayed because of the planned switch to CloudEvents.
+* [~~#52 Harmonize device object with QoD API~~](https://github.com/camaraproject/DeviceStatus/issues/52)
+* [~~#31 Adding notification/subscription for Device Status~~](https://github.com/camaraproject/DeviceStatus/pull/31)
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34)
+* [#65 Add documentation](https://github.com/camaraproject/DeviceStatus/pull/65)
+
+
+## AOB
+
+* New issue: How to handle mandatory and optional features of each API
+ * Definition of minimum implementation of a Camara API
+ * How can a provider inform the ASP/aggregator about not implemented features in advance of the API call?
+ * An issue in commonalities should be created (Prashant)
+* New issue: Change notifications to be based on CloudEvents
+ The issue is linked to the related issues/PRs in Commonalities (add links).
+ The issue should also add missing event types for connectivity status. (after [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34) has been merged.)
+
+* Next call will be on 27.09.2023 11:00 CET
+
diff --git a/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-09-27/raw.md b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-09-27/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..a42761942ceb36ca88b75216685d128d0b2f0d77
--- /dev/null
+++ b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-09-27/raw.md
@@ -0,0 +1,70 @@
+ # Camara DeviceStatus meeting - MOM-2023-09-27
+
+*September 27th, 2023*
+
+## Attendees
+
+* Akos Hunyadi (Deutsche Telekom)
+* Eric Murray (Vodafone)
+* Fernando Prado Cabrillo (Telefonica)
+* Jorge Garcia Hospital (Telefonica)
+* Joachim Dahlgreen (Ericsson)
+* Ludovic Robert (Orange)
+* Rafal Artych (Deutsche Telekom)
+* Sachin Kumar (Vodafone)
+
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open issues
+* Open PRs
+* API Roadmap
+* AOB
+
+
+## Open issues:
+* [#74 Align event-subscriptions with updated design guidelines based on CloudEvents](https://github.com/camaraproject/DeviceStatus/issues/74)
+ [PR75](https://github.com/camaraproject/DeviceStatus/pull/75) is open.
+
+* [#71 Release plan&content](https://github.com/camaraproject/DeviceStatus/issues/71)
+The upcoming releases were agreed as described below. This issue can be closed.
+
+* [#70 Info required : API understanding](https://github.com/camaraproject/DeviceStatus/issues/70)
+The issue can be closed.
+
+* [#57 Add documentation into API definition](https://github.com/camaraproject/DeviceStatus/issues/57)
+ [PR75](https://github.com/camaraproject/DeviceStatus/pull/75) is open.
+
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34)
+[PR69](https://github.com/camaraproject/DeviceStatus/pull/69) is open.
+
+* [#17 Subscription Mode with new Eventtypes](https://github.com/camaraproject/DeviceStatus/issues/17)
+[PR31](https://github.com/camaraproject/DeviceStatus/pull/31) introduced a generic subscription endpoint.
+Currently with the roaming status types, but it can be extended, when e.g. connectivity status info is added to the API.
+
+## Open PRs
+* [#69 add /connectivity - endpoint to check the network status of a device](https://github.com/camaraproject/DeviceStatus/pull/69)
+Update the PR with connectivity-events based on CloudEvents. Based on [PR75](https://github.com/camaraproject/DeviceStatus/pull/75).
+
+* [#75 Added Notification management aligned with CloudEvents format](https://github.com/camaraproject/DeviceStatus/pull/75)
+
+## API Roadmap
+
+### Release 0.5.0
+* September-October 2023
+* The release is delayed because of switching to CloudEvents.
+* [~~#52 Harmonize device object with QoD API~~](https://github.com/camaraproject/DeviceStatus/issues/52)
+* [~~#31 Adding notification/subscription for Device Status~~](https://github.com/camaraproject/DeviceStatus/pull/31)
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34) => [PR69](https://github.com/camaraproject/DeviceStatus/pull/69)
+* [#74 Align event-subscriptions with updated design guidelines based on CloudEvents](https://github.com/camaraproject/DeviceStatus/issues/74) => [PR75](https://github.com/camaraproject/DeviceStatus/pull/75)
+* [#57 Add documentation into API definition](https://github.com/camaraproject/DeviceStatus/issues/57) => [PR75](https://github.com/camaraproject/DeviceStatus/pull/75)
+### Release 0.6.0
+* November-December 2023
+* OIDC
+
+## AOB
+* New issue to align with DG about security => Replace Client Credentials with OIDC (based on commonalities [PR57](https://github.com/camaraproject/Commonalities/pull/57))
+* Next call will be on 11.10.2023 11:00 CET
+
diff --git a/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-10-11/raw.md b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-10-11/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..9fce1782c4bca593dde9cfb65dc125f388d63927
--- /dev/null
+++ b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-10-11/raw.md
@@ -0,0 +1,71 @@
+# Camara DeviceStatus meeting - MOM-2023-10-11
+
+*October 11th, 2023*
+
+## Attendees
+
+* Akos Hunyadi (Deutsche Telekom)
+* Eric Murray (Vodafone)
+* Fernando Prado Cabrillo (Telefonica)
+* Joachim Dahlgreen (Ericsson)
+* Ludovic Robert (Orange)
+* Noel Wirzius (Deutsche Telekom)
+* Prashant Sidana (E&)
+* Rafal Artych (Deutsche Telekom)
+* Sachin Kumar (Vodafone)
+
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open issues
+* Open PRs
+* API Roadmap
+* AOB
+
+
+## Open issues:
+* [#74 Align event-subscriptions with updated design guidelines based on CloudEvents](https://github.com/camaraproject/DeviceStatus/issues/74)
+ [PR75](https://github.com/camaraproject/DeviceStatus/pull/75) is open.
+
+* [#71 Release plan&content](https://github.com/camaraproject/DeviceStatus/issues/71)
+The upcoming releases were agreed as described below. This issue can be closed.
+
+* [#70 Info required : API understanding](https://github.com/camaraproject/DeviceStatus/issues/70)
+The issue can be closed.
+
+* [#57 Add documentation into API definition](https://github.com/camaraproject/DeviceStatus/issues/57)
+ [PR75](https://github.com/camaraproject/DeviceStatus/pull/75) is open.
+
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34)
+[PR69](https://github.com/camaraproject/DeviceStatus/pull/69) is open.
+
+* [#17 Subscription Mode with new Eventtypes](https://github.com/camaraproject/DeviceStatus/issues/17)
+[PR31](https://github.com/camaraproject/DeviceStatus/pull/31) introduced a generic subscription endpoint.
+Currently with the roaming status types, but it can be extended, when e.g. connectivity status info is added to the API.
+
+## Open PRs
+* [#69 add /connectivity - endpoint to check the network status of a device](https://github.com/camaraproject/DeviceStatus/pull/69)
+Update the PR with connectivity-events based on CloudEvents. Depending on [PR75](https://github.com/camaraproject/DeviceStatus/pull/75).
+
+* [#75 Added Notification management aligned with CloudEvents format](https://github.com/camaraproject/DeviceStatus/pull/75)
+Reviews are requested.
+
+## API Roadmap
+
+### Release 0.5.0
+* September-October 2023
+* The release is delayed because of switching to CloudEvents.
+* [~~#52 Harmonize device object with QoD API~~](https://github.com/camaraproject/DeviceStatus/issues/52)
+* [~~#31 Adding notification/subscription for Device Status~~](https://github.com/camaraproject/DeviceStatus/pull/31)
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34) => [PR69](https://github.com/camaraproject/DeviceStatus/pull/69)
+* [#74 Align event-subscriptions with updated design guidelines based on CloudEvents](https://github.com/camaraproject/DeviceStatus/issues/74) => [PR75](https://github.com/camaraproject/DeviceStatus/pull/75)
+* [#57 Add documentation into API definition](https://github.com/camaraproject/DeviceStatus/issues/57) => [PR75](https://github.com/camaraproject/DeviceStatus/pull/75)
+### Release 0.6.0
+* November-December 2023
+* OIDC
+
+## AOB
+* New issue to align with DG about security => Replace Client Credentials with OIDC (based on commonalities [PR57](https://github.com/camaraproject/Commonalities/pull/57))
+* Next call will be on 25.10.2023 11:00 CET
diff --git a/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-10-25/raw.md b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-10-25/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..168cb500a0bf65384dbd0239bfb69c713e549161
--- /dev/null
+++ b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-10-25/raw.md
@@ -0,0 +1,65 @@
+# Camara DeviceStatus meeting - MOM-2023-10-25
+
+*October 25th, 2023*
+
+## Attendees
+
+* Akos Hunyadi (Deutsche Telekom)
+* Fernando Prado Cabrillo (Telefonica)
+* Joachim Dahlgreen (Ericsson)
+* Ludovic Robert (Orange)
+* Ming Hui Foo (Singtel)
+* Rafal Artych (Deutsche Telekom)
+* Sachin Kumar (Vodafone)
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open issues
+* Open PRs
+* API Roadmap
+* AOB
+
+
+## Open issues:
+* [#74 Align event-subscriptions with updated design guidelines based on CloudEvents](https://github.com/camaraproject/DeviceStatus/issues/74)
+ [PR75](https://github.com/camaraproject/DeviceStatus/pull/75) is open.
+
+* [#70 Info required : API understanding](https://github.com/camaraproject/DeviceStatus/issues/70)
+The issue can be closed.
+
+* [#57 Add documentation into API definition](https://github.com/camaraproject/DeviceStatus/issues/57)
+ [PR75](https://github.com/camaraproject/DeviceStatus/pull/75) is open.
+
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34)
+[PR69](https://github.com/camaraproject/DeviceStatus/pull/69) is open.
+
+* [#17 Subscription Mode with new Eventtypes](https://github.com/camaraproject/DeviceStatus/issues/17)
+[PR31](https://github.com/camaraproject/DeviceStatus/pull/31) introduced a generic subscription endpoint.
+Currently with the roaming status types, but it can be extended, when e.g. connectivity status info is added to the API.
+
+## Open PRs
+* [#69 add /connectivity - endpoint to check the network status of a device](https://github.com/camaraproject/DeviceStatus/pull/69)
+Update the PR with connectivity-events based on CloudEvents. Depending on [PR75](https://github.com/camaraproject/DeviceStatus/pull/75).
+
+* [#75 Added Notification management aligned with CloudEvents format](https://github.com/camaraproject/DeviceStatus/pull/75)
+Reviews are requested.
+
+## API Roadmap
+
+### Release 0.5.0
+* September-October 2023
+* [~~#52 Harmonize device object with QoD API~~](https://github.com/camaraproject/DeviceStatus/issues/52)
+* [~~#31 Adding notification/subscription for Device Status~~](https://github.com/camaraproject/DeviceStatus/pull/31)
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34) => [PR69](https://github.com/camaraproject/DeviceStatus/pull/69)
+* [#74 Align event-subscriptions with updated design guidelines based on CloudEvents](https://github.com/camaraproject/DeviceStatus/issues/74) => [PR75](https://github.com/camaraproject/DeviceStatus/pull/75)
+* [#57 Add documentation into API definition](https://github.com/camaraproject/DeviceStatus/issues/57) => [PR75](https://github.com/camaraproject/DeviceStatus/pull/75)
+* After merging all PRs the first Releasecandidate should be created
+### Release 0.6.0
+* November-December 2023
+* OIDC
+
+## AOB
+* New issue to align with DG about security => Replace Client Credentials with OIDC (based on commonalities [PR57](https://github.com/camaraproject/Commonalities/pull/57))
+* Next call will be on 08.11.2023 11:00 CET
diff --git a/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-11-08/raw.md b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-11-08/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..1519f983a343046cdb63f670f0e3fe3f77ec0275
--- /dev/null
+++ b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-11-08/raw.md
@@ -0,0 +1,54 @@
+# Camara DeviceStatus meeting - MOM-2023-11-08
+
+*November 8th, 2023*
+
+## Attendees
+
+* Akos Hunyadi (Deutsche Telekom)
+* Fernando Prado Cabrillo (Telefonica)
+* Joachim Dahlgreen (Ericsson)
+* Ludovic Robert (Orange)
+* Rafal Artych (Deutsche Telekom)
+* Sachin Kumar (Vodafone)
+* Sebastian Köller (Vodafone)
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open issues
+* Open PRs
+* API Roadmap
+* AOB
+
+
+## Open issues:
+
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34)
+[PR69](https://github.com/camaraproject/DeviceStatus/pull/69) is open.
+
+* [#17 Subscription Mode with new Eventtypes](https://github.com/camaraproject/DeviceStatus/issues/17)
+[PR31](https://github.com/camaraproject/DeviceStatus/pull/31) introduced a generic subscription endpoint.
+[PR69](https://github.com/camaraproject/DeviceStatus/pull/69) extends the API with connectivity related events.
+
+## Open PRs
+* [#69 add /connectivity - endpoint to check the network status of a device](https://github.com/camaraproject/DeviceStatus/pull/69)
+Update the PR with connectivity-events based on CloudEvents. Status: open for reviews.
+
+## API Roadmap
+
+### Release 0.5.0
+* November 2023
+* [~~#52 Harmonize device object with QoD API~~](https://github.com/camaraproject/DeviceStatus/issues/52)
+* [~~#31 Adding notification/subscription for Device Status~~](https://github.com/camaraproject/DeviceStatus/pull/31)
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34) => [PR69](https://github.com/camaraproject/DeviceStatus/pull/69)
+* [~~#74 Align event-subscriptions with updated design guidelines based on CloudEvents~~](https://github.com/camaraproject/DeviceStatus/issues/74)
+* [~~#57 Add documentation into API definition~~](https://github.com/camaraproject/DeviceStatus/issues/57)
+* After merging all PRs the first Releasecandidate should be created
+### Release 0.6.0
+* Q1 2024
+* OIDC
+
+## AOB
+* New issue to align with DG about security => Replace Client Credentials with OIDC (based on commonalities [PR57](https://github.com/camaraproject/Commonalities/pull/57))
+* Next call will be on 22.11.2023 11:00 CET
diff --git a/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-11-22/raw.md b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-11-22/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..bc41d2f51dbd5c592e5965051ab3ed11cc3f044b
--- /dev/null
+++ b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-11-22/raw.md
@@ -0,0 +1,51 @@
+# Camara DeviceStatus meeting - MOM-2023-11-22
+
+*November 22nd, 2023*
+
+## Attendees
+
+* Akos Hunyadi (Deutsche Telekom)
+* Fernando Prado Cabrillo (Telefonica)
+* Ludovic Robert (Orange)
+* Ming Hui Foo (Singtel)
+* Rafal Artych (Deutsche Telekom)
+* Sachin Kumar (Vodafone)
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open issues
+* Open PRs
+* API Roadmap
+* AOB
+
+
+## Open issues:
+* [#82 Create release candidate 0.5.0](https://github.com/camaraproject/DeviceStatus/issues/82)
+ A PR should be created.
+
+* [#81 enhance v0.4.1 to follow latest CAMARA guidelines](https://github.com/camaraproject/DeviceStatus/issues/81)
+
+* [#17 Subscription Mode with new Eventtypes](https://github.com/camaraproject/DeviceStatus/issues/17)
+Almost all requirements have been implemented (except support for multiple devices), the issue should be closed.
+
+
+## Open PRs
+*
+
+## API Roadmap
+
+### Release 0.5.0
+* Planned release date: January 2024
+* Status: the planned release content has been merged, the first release candidate should be created.
+* Release content:
+ * [~~#52 Harmonize device object with QoD API~~](https://github.com/camaraproject/DeviceStatus/issues/52)
+ * [~~#31 Adding notification/subscription for Device Status~~](https://github.com/camaraproject/DeviceStatus/pull/31)
+ * [~~#34 New Endtype Connectivity~~](https://github.com/camaraproject/DeviceStatus/issues/34) => [PR69](https://github.com/camaraproject/DeviceStatus/pull/69)
+ * [~~#74 Align event-subscriptions with updated design guidelines based on CloudEvents~~](https://github.com/camaraproject/DeviceStatus/issues/74)
+ * [~~#57 Add documentation into API definition~~](https://github.com/camaraproject/DeviceStatus/issues/57)
+ * [#82 Create release candidate 0.5.0](https://github.com/camaraproject/DeviceStatus/issues/82)
+
+## AOB
+* Next call will be on 06.12.2023 11:00 CET
diff --git a/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-12-06/raw.md b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-12-06/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..a59b9d488349f0b162bfa84c8d1c1a9994f2598f
--- /dev/null
+++ b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2023-12-06/raw.md
@@ -0,0 +1,58 @@
+# Camara DeviceStatus meeting - MOM-2023-12-06
+
+*December 6th, 2023*
+
+## Attendees
+
+* Akos Hunyadi (Deutsche Telekom)
+* Ludovic Robert (Orange)
+* Ming Hui Foo (Singtel)
+* Rafal Artych (Deutsche Telekom)
+* Sachin Kumar (Vodafone)
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open issues
+* Open PRs
+* Open Discussions
+* API Roadmap
+* AOB
+
+
+## Open issues:
+* [#84 Minor corrections in Subscription model before release](https://github.com/camaraproject/DeviceStatus/issues/84)
+ We agreed, that the issue can be implemented as proposed.
+
+* [#82 Create release candidate 0.5.0](https://github.com/camaraproject/DeviceStatus/issues/82)
+PR is open.
+
+* [#81 enhance v0.4.1 to follow latest CAMARA guidelines](https://github.com/camaraproject/DeviceStatus/issues/81)
+
+* [#17 Subscription Mode with new Eventtypes](https://github.com/camaraproject/DeviceStatus/issues/17)
+Almost all requirements have been implemented (except support for multiple devices), the issue should be closed.
+
+## Open PRs
+* [#87 Create release candidate 0.5.0-rc](https://github.com/camaraproject/DeviceStatus/pull/87)
+The PR is blocked by [#84 Minor corrections in Subscription model before release](https://github.com/camaraproject/DeviceStatus/issues/84)
+
+## Open discussions
+*
+
+## API Roadmap
+
+### Release 0.5.0
+* Planned release date: January 2024
+* Status: the planned release content has been merged, the first release candidate should be created.
+* Release content:
+ * [~~#52 Harmonize device object with QoD API~~](https://github.com/camaraproject/DeviceStatus/issues/52)
+ * [~~#31 Adding notification/subscription for Device Status~~](https://github.com/camaraproject/DeviceStatus/pull/31)
+ * [~~#34 New Endtype Connectivity~~](https://github.com/camaraproject/DeviceStatus/issues/34) => [PR69](https://github.com/camaraproject/DeviceStatus/pull/69)
+ * [~~#74 Align event-subscriptions with updated design guidelines based on CloudEvents~~](https://github.com/camaraproject/DeviceStatus/issues/74)
+ * [~~#57 Add documentation into API definition~~](https://github.com/camaraproject/DeviceStatus/issues/57)
+ * [#84 Minor corrections in Subscription model before release](https://github.com/camaraproject/DeviceStatus/issues/84)
+ * [#82 Create release candidate 0.5.0](https://github.com/camaraproject/DeviceStatus/issues/82) => [PR#87](https://github.com/camaraproject/DeviceStatus/pull/87)
+
+## AOB
+* Next call will be on 20.12.2023 11:00 CET - However, when the 0.5.0-rc could be created earlier then this call should be skipped.
diff --git a/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2024-01-17/raw.md b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2024-01-17/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..23e1d3de11c0fe1fe333f9a3fff5b7b90a35e1ba
--- /dev/null
+++ b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2024-01-17/raw.md
@@ -0,0 +1,67 @@
+# Camara DeviceStatus meeting - MOM-2024-01-17
+
+*January 17th, 2024*
+
+## Attendees
+
+* Aishwarya Javkhedkar (Comviva)
+* Akos Hunyadi (Deutsche Telekom)
+* Fernando Prado Cabrillo (Telefonica)
+* Joachim Dahlgren (Ericsson)
+* Ludovic Robert (Orange)
+* Ming Hui Foo (Singtel)
+* Sachin Kumar (Vodafone)
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open issues
+* Open PRs
+* Open Discussions
+* API Roadmap
+* AOB
+
+
+## Open issues:
+* [#97 Update response codes to string, following other CAMARA APIs](https://github.com/camaraproject/DeviceStatus/issues/97)
+ The corresponding PR is open: [#95 Corrections resolving linting errors](https://github.com/camaraproject/DeviceStatus/pull/95)
+
+* [#96 Path update per Design Guideline](https://github.com/camaraproject/DeviceStatus/issues/96)
+The issue should be implemented after releasing the 0.5.0.
+
+* [#94 Corrections needed to resolve linting errors](https://github.com/camaraproject/DeviceStatus/issues/94)
+ The corresponding PR is open: [#95 Corrections resolving linting errors](https://github.com/camaraproject/DeviceStatus/pull/95)
+
+## Open PRs
+* [#95 Corrections resolving linting errors](https://github.com/camaraproject/DeviceStatus/pull/95)
+ The PR is ready to be merged.
+
+## Open discussions
+* [#98 Roaming Status - AgeOfInformation (or last_updated_timestamp)](https://github.com/camaraproject/DeviceStatus/discussions/98)
+ It should be converted to an issue to continue the discussion there.
+* [#89 Multi-Operator Demo Test Discussion](https://github.com/camaraproject/DeviceStatus/discussions/89)
+* [#72 CAMARA Compliant: Expose all end points](https://github.com/camaraproject/DeviceStatus/discussions/72)
+* [#48 Need support](https://github.com/camaraproject/DeviceStatus/discussions/48)
+
+## API Roadmap
+
+### Release 0.5.0
+* Planned release date: January 2024
+* Status: the release candidate 0.5.0-rc has been created. If no more bugs or findings in the 0.5.0-rc will be reported in the next 2 weeks, then the official release 0.5.0 can be created (no rc2 is necessary).
+* Release content 0.5.0-rc:
+ * [~~#52 Harmonize device object with QoD API~~](https://github.com/camaraproject/DeviceStatus/issues/52)
+ * [~~#31 Adding notification/subscription for Device Status~~](https://github.com/camaraproject/DeviceStatus/pull/31)
+ * [~~#34 New Endtype Connectivity~~](https://github.com/camaraproject/DeviceStatus/issues/34) => [PR69](https://github.com/camaraproject/DeviceStatus/pull/69)
+ * [~~#74 Align event-subscriptions with updated design guidelines based on CloudEvents~~](https://github.com/camaraproject/DeviceStatus/issues/74)
+ * [~~#57 Add documentation into API definition~~](https://github.com/camaraproject/DeviceStatus/issues/57)
+ * [~~#84 Minor corrections in Subscription model before release~~](https://github.com/camaraproject/DeviceStatus/issues/84)
+ * [~~#82 Create release candidate 0.5.0~~](https://github.com/camaraproject/DeviceStatus/issues/82) => [PR#87](https://github.com/camaraproject/DeviceStatus/pull/87)
+* Release content 0.5.0:
+ * [#95 Corrections resolving linting errors](https://github.com/camaraproject/DeviceStatus/pull/95)
+ * New issue&PR to prepare the release
+
+## AOB
+* Next call will be on 14.02.2024 11:00 CET
+* Since the API is already in a mature status, a v1.0.0 should be targeted. => Create an issue to discuss about the process and the necessary to-do's.
+* An issue for creation of the necessary feature file for testing should be created too.
diff --git a/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2024-02-14/raw.md b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2024-02-14/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..830c6cec9e7d9c9a878b2db516937154ad3a2de1
--- /dev/null
+++ b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2024-02-14/raw.md
@@ -0,0 +1,82 @@
+# Camara DeviceStatus meeting - MOM-2024-02-14
+
+*February 14th, 2024*
+
+## Attendees
+
+* Akos Hunyadi (Deutsche Telekom)
+* Fernando Prado Cabrillo (Telefonica)
+* Jorge Garcia Hospital (Telefonica)
+* Ludovic Robert (Orange)
+* Rafal Artych (Deutsche Telekom)
+* Sachin Kumar (Vodafone)
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open PRs
+* Open Issues
+* Open Discussions
+* API Roadmap
+* AOB
+
+
+## Open PRs
+* [#111 Update device-status.yaml](https://github.com/camaraproject/DeviceStatus/pull/111)
+ * Renaming the POST endpoints according to the design guidelines. No discussion, can be merged after approvals.
+
+* [#109 fix: add missing "subscriptionId" in "RoamingStatus"-data for CloudEvent](https://github.com/camaraproject/DeviceStatus/pull/109)
+ * No discussion, can be merged after approvals.
+
+* [#108 feat: use simple String for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/pull/108)
+ * The enums for event-types include dots which causes problems at the code generation (Java) at DT.
+ * Additional feedback from dev teams would be helpful to priotize the issue.
+ * A possible change in the design guideline could be a solution.
+ * The PR has been marked as draft until an agreed solution is ellaborated.
+
+## Open issues:
+
+* [#110 Request for Addition of "last_updated_timestamp" Field in CAMARA DeviceStatus API](https://github.com/camaraproject/DeviceStatus/issues/110)
+ * The name should correlate with similar properties at other APIs
+ * Is the information on 3GPP available at all?
+
+* [#107 Use simple string for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/issues/107)
+ * The corresponding PR is open: [#108 feat: use simple String for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/pull/108)
+
+* [#104 Include x-correlator heade](https://github.com/camaraproject/DeviceStatus/issues/104)
+ * No discussion, a PR should be created.
+
+* [#102 Clarify API readiness status for v1.0.0](https://github.com/camaraproject/DeviceStatus/issues/102)
+
+* [#97 Update response codes to string, following other CAMARA APIs](https://github.com/camaraproject/DeviceStatus/issues/97)
+ * The corresponding PR is open: [#95 Corrections resolving linting errors](https://github.com/camaraproject/DeviceStatus/pull/95)
+
+* [#96 Path update per Design Guideline](https://github.com/camaraproject/DeviceStatus/issues/96)
+ * The corresponding PR is open: [#111 Update device-status.yaml](https://github.com/camaraproject/DeviceStatus/pull/111)
+
+
+
+## Open discussions
+* [#105 v0.5.0 - Difference between "subscriptionExpireTime" & "expiresAt" in "SubscriptionInfo"](https://github.com/camaraproject/DeviceStatus/discussions/105)
+* [#100 Granularity of the Test Definition feature file](https://github.com/camaraproject/DeviceStatus/discussions/100)
+* [#98 Roaming Status - AgeOfInformation (or last_updated_timestamp)](https://github.com/camaraproject/DeviceStatus/discussions/98)
+ * An issue [#110 Request for Addition of "last_updated_timestamp" Field in CAMARA DeviceStatus API](https://github.com/camaraproject/DeviceStatus/issues/110) has been created, the discussion can be closed.
+* [#89 Multi-Operator Demo Test Discussion](https://github.com/camaraproject/DeviceStatus/discussions/89)
+* [#72 CAMARA Compliant: Expose all end points](https://github.com/camaraproject/DeviceStatus/discussions/72)
+* [#48 Need support](https://github.com/camaraproject/DeviceStatus/discussions/48)
+
+## API Roadmap
+
+### Release 0.5.0
+* Status: release created on 31.01.2024
+
+### Release 0.6.0
+* Planned release date: tbd
+* Status: wip
+* Content:
+
+
+## AOB
+* Next call will be on 28.02.2024 11:00 CET
+* An issue for creation of the necessary feature file for testing should be created too.
diff --git a/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2024-02-28/raw.md b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2024-02-28/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..17d7db55aa2a664986d77fb227338f75807093e5
--- /dev/null
+++ b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2024-02-28/raw.md
@@ -0,0 +1,88 @@
+# Camara DeviceStatus meeting - MOM-2024-02-28
+
+*February 28th, 2024*
+
+## Attendees
+
+* Akos Hunyadi (Deutsche Telekom)
+* Fernando Prado Cabrillo (Telefonica)
+* Joachim Dahlgren (Ericsson)
+* Rafal Artych (Deutsche Telekom)
+* Sachin Kumar (Vodafone)
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open PRs
+* Open Issues
+* Open Discussions
+* API Roadmap
+* AOB
+
+
+## Open PRs
+* [#112 include x-correlator and fix typo in 400 error code](https://github.com/camaraproject/DeviceStatus/pull/112)
+ * No discussion
+ * Reviews are missing.
+
+* [#111 Update device-status.yaml](https://github.com/camaraproject/DeviceStatus/pull/111)
+ * Renaming the POST endpoints according to the design guidelines.
+ * No discussion, can be merged after approvals.
+
+* [#109 fix: add missing "subscriptionId" in "RoamingStatus"-data for CloudEvent](https://github.com/camaraproject/DeviceStatus/pull/109)
+ * No discussion, can be merged after approvals.
+
+* [#108 feat: use simple String for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/pull/108)
+ * The enums for event-types include dots which causes problems at the code generation (Java) at DT.
+ * Additional feedback from dev teams would be helpful to priotize the issue.
+ * A possible change in the design guideline could be a solution.
+ * The PR has been marked as draft until an agreed solution is ellaborated.
+
+## Open issues:
+
+* [#117 Send a CloudEvent when DELETE /subscriptions/{subscriptionId}](https://github.com/camaraproject/DeviceStatus/issues/117)
+ * Same issue exists in Device Location
+ * Should be addressed in Commonalities
+
+* [#116 subscriptionExpireTime is declared as "required" in the subscription-ends - note, but is optional currently](https://github.com/camaraproject/DeviceStatus/issues/116)
+
+* [#115 /Connectivity API there is no indication for which particular subscriber event (DATA/SMS)](https://github.com/camaraproject/DeviceStatus/issues/115)
+
+* [#110 Request for Addition of "last_updated_timestamp" Field in CAMARA DeviceStatus API](https://github.com/camaraproject/DeviceStatus/issues/110)
+ * The name should correlate with similar properties at other APIs
+
+* [#107 Use simple string for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/issues/107)
+ * The corresponding PR is open: [#108 feat: use simple String for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/pull/108)
+
+* [#104 Include x-correlator heade](https://github.com/camaraproject/DeviceStatus/issues/104)
+ * The corresponding PR is open: [#112 include x-correlator and fix typo in 400 error code](https://github.com/camaraproject/DeviceStatus/pull/112)
+
+* [#102 Clarify API readiness status for v1.0.0](https://github.com/camaraproject/DeviceStatus/issues/102)
+
+* [#96 Path update per Design Guideline](https://github.com/camaraproject/DeviceStatus/issues/96)
+ * The corresponding PR is open: [#111 Update device-status.yaml](https://github.com/camaraproject/DeviceStatus/pull/111)
+
+
+
+## Open discussions
+* **[#114 Test Data : Device Status](https://github.com/camaraproject/DeviceStatus/discussions/114)**
+* [#100 Granularity of the Test Definition feature file](https://github.com/camaraproject/DeviceStatus/discussions/100)
+* [#89 Multi-Operator Demo Test Discussion](https://github.com/camaraproject/DeviceStatus/discussions/89)
+* [#72 CAMARA Compliant: Expose all end points](https://github.com/camaraproject/DeviceStatus/discussions/72)
+* [#48 Need support](https://github.com/camaraproject/DeviceStatus/discussions/48)
+
+## API Roadmap
+
+### Release 0.5.0
+* Status: release created on 31.01.2024
+
+### Release 0.6.0
+* Planned release date: tbd
+* Status: wip
+* Content: A proposal for the content should be created (Ákos)
+
+
+## AOB
+* Next call will be on 13.03.2024 11:00 CET
+* An issue for creation of the necessary feature file for testing should be created.
diff --git a/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2024-03-13/raw.md b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2024-03-13/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..54e5bfdd3dcccff1376ab0ffbcbcf8a997541475
--- /dev/null
+++ b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2024-03-13/raw.md
@@ -0,0 +1,112 @@
+# Camara DeviceStatus meeting - MOM-2024-03-13
+
+*March 13th, 2024*
+
+## Attendees
+
+* Aishwarya Javkhedkar (Comviva)
+* Akos Hunyadi (Deutsche Telekom)
+* Fernando Prado Cabrillo (Telefonica)
+* Joachim Dahlgren (Ericsson)
+* Ludovic Robert (Orange)
+* Maximilian Laue (Deutsche Telekom)
+* Quanain Meghjee (Vonage)
+* Rafal Artych (Deutsche Telekom)
+* Sachin Kumar (Vodafone)
+* Toyeeb Rehmann (GSMA)
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open PRs
+* Open Issues
+* Open Discussions
+* API Roadmap
+* AOB
+
+
+## Open PRs
+
+* [#127 Updated in-line documentation for Roaming to clarify that country information can optionally be returned in the response](https://github.com/camaraproject/DeviceStatus/pull/127)
+
+* [#123 Adding configuration for Github Actions with linting ruleset](https://github.com/camaraproject/DeviceStatus/pull/123)
+ * No discussion
+ * Reviews are missing.
+
+* [#121 feat: add termination reason when subscription deleted](https://github.com/camaraproject/DeviceStatus/pull/121)
+ * Should be first clarified in Commonalities: camaraproject/Commonalities#153
+
+* [#112 include x-correlator and fix typo in 400 error code](https://github.com/camaraproject/DeviceStatus/pull/112)
+ * No discussion
+ * Reviews are missing.
+ * The fix for the typo should be covered in a separate PR.
+
+* [#111 Update device-status.yaml](https://github.com/camaraproject/DeviceStatus/pull/111)
+ * The PR has been merged accidentally, but then the change has been reverted. This PR should be merged after the bugfix release v0.5.1 has been created.
+ * A new PR should be opened.
+
+* [#108 feat: use simple String for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/pull/108)
+ * The enums for event-types include dots which causes problems at the code generation (Java) at DT.
+ * Additional feedback from dev teams would be helpful to priotize the issue.
+ * A possible change in the design guideline could be a solution.
+ * The PR has been marked as draft until an agreed solution is ellaborated.
+ * An issue in Commonalities has been opened camaraproject/DeviceLocation#149
+
+## Open issues:
+
+* [#125 Separate endpoints into different APIs](https://github.com/camaraproject/DeviceStatus/pull/125)
+ * Split the current API into 4 different APIs
+
+* [#124 When roaming status is true, is it mandatory to return both countryCode and countryName?](https://github.com/camaraproject/DeviceStatus/issues/124)
+
+* [#122 Bugfix release v0.5.1](https://github.com/camaraproject/DeviceStatus/issues/122)
+
+* [#119 How can a provider inform the ASP/aggregator about not implemented features in advance of the API call](https://github.com/camaraproject/DeviceStatus/issues/119)
+
+* [#117 Send a CloudEvent when DELETE /subscriptions/{subscriptionId}](https://github.com/camaraproject/DeviceStatus/issues/117)
+ * The corresponding PR is open: [#121 feat: add termination reason when subscription deleted](https://github.com/camaraproject/DeviceStatus/pull/121)
+
+* [#115 /Connectivity API there is no indication for which particular subscriber event (DATA/SMS)](https://github.com/camaraproject/DeviceStatus/issues/115)
+
+* [#110 Request for Addition of "last_updated_timestamp" Field in CAMARA DeviceStatus API](https://github.com/camaraproject/DeviceStatus/issues/110)
+ * The name should correlate with similar properties at other APIs
+
+* [#107 Use simple string for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/issues/107)
+ * The corresponding PR is open: [#108 feat: use simple String for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/pull/108)
+
+* [#104 Include x-correlator heade](https://github.com/camaraproject/DeviceStatus/issues/104)
+ * The corresponding PR is open: [#112 include x-correlator and fix typo in 400 error code](https://github.com/camaraproject/DeviceStatus/pull/112)
+
+* [#102 Clarify API readiness status for v1.0.0](https://github.com/camaraproject/DeviceStatus/issues/102)
+
+* [#96 Path update per Design Guideline](https://github.com/camaraproject/DeviceStatus/issues/96)
+ * A new PR should be created see [#111 Update device-status.yaml](https://github.com/camaraproject/DeviceStatus/pull/111)
+
+
+
+## Open discussions
+* [#114 Test Data : Device Status](https://github.com/camaraproject/DeviceStatus/discussions/114)
+* [#100 Granularity of the Test Definition feature file](https://github.com/camaraproject/DeviceStatus/discussions/100)
+* [#89 Multi-Operator Demo Test Discussion](https://github.com/camaraproject/DeviceStatus/discussions/89)
+* [#72 CAMARA Compliant: Expose all end points](https://github.com/camaraproject/DeviceStatus/discussions/72)
+* [#48 Need support](https://github.com/camaraproject/DeviceStatus/discussions/48)
+
+## API Roadmap
+
+### Release 0.5.x
+* The release v0.5.0 was created on 31.01.2024
+* The bugfix release 0.5.1 is planned [#122 Bugfix release v0.5.1](https://github.com/camaraproject/DeviceStatus/issues/122)
+
+### Release 0.6.0
+* Planned release date: tbd
+* Content:
+ * [#96 Path update per Design Guideline](https://github.com/camaraproject/DeviceStatus/issues/96)
+ * [#112 include x-correlator and fix typo in 400 error code](https://github.com/camaraproject/DeviceStatus/pull/112)
+ * [#123 Adding configuration for Github Actions with linting ruleset](https://github.com/camaraproject/DeviceStatus/pull/123)
+ * ?? [#125 Separate endpoints into different APIs](https://github.com/camaraproject/DeviceStatus/pull/125)
+
+
+## AOB
+* Next call will be on 27.03.2024 11:00 CET
+* An issue for creation of the necessary feature file for testing should be created.
diff --git a/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2024-03-27/raw.md b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2024-03-27/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..7dc58049f62c4484256969748616baed58fc4235
--- /dev/null
+++ b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-2024-03-27/raw.md
@@ -0,0 +1,117 @@
+# Camara DeviceStatus meeting - MOM-2024-03-27
+
+*March 27th, 2024*
+
+## Attendees
+
+* Aishwarya Javkhedkar (Comviva)
+* Ankita ()
+* Akos Hunyadi (Deutsche Telekom)
+* Fernando Prado Cabrillo (Telefonica)
+* Joachim Dahlgren (Ericsson)
+* Quanain Meghjee (Vonage)
+* Sachin Kumar (Vodafone)
+
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open PRs
+* Open Issues
+* Open Discussions
+* API Roadmap
+* AOB
+
+
+## Open PRs
+
+* [#131 Update device-status.yaml](https://github.com/camaraproject/DeviceStatus/pull/131)
+ * PR was recreated after accedentally merging too early
+ * Planned release v0.6.0
+
+* [#129 fix: change INVALID_INPUT for INVALID_ARGUMENT according to guidelines](https://github.com/camaraproject/DeviceStatus/pull/129)
+ * Review in progress
+ * Planned release v0.5.1
+
+* [#127 Updated in-line documentation for Roaming to clarify that country information can optionally be returned in the response](https://github.com/camaraproject/DeviceStatus/pull/127)
+ * Review in progress
+ * Planned release v0.5.1
+
+* [#123 Adding configuration for Github Actions with linting ruleset](https://github.com/camaraproject/DeviceStatus/pull/123)
+ * No discussion
+ * Reviews are missing.
+
+* [#121 feat: add termination reason when subscription deleted](https://github.com/camaraproject/DeviceStatus/pull/121)
+ * Should be first clarified in Commonalities: camaraproject/Commonalities#153
+
+* [#112 include x-correlator and fix typo in 400 error code](https://github.com/camaraproject/DeviceStatus/pull/112)
+ * No discussion
+ * Reviews are missing.
+ * Planned release v0.6.0
+
+* [#108 feat: use simple String for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/pull/108)
+ * The enums for event-types include dots which causes problems at the code generation (Java) at DT.
+ * Additional feedback from dev teams would be helpful to priotize the issue.
+ * A possible change in the design guideline could be a solution.
+ * The PR has been marked as draft until an agreed solution is ellaborated.
+ * An issue in Commonalities has been opened camaraproject/DeviceLocation#149
+
+## Open issues:
+
+* [#130 What should the API return if more than one device identifier is sent and they don't belong to the same device?](https://github.com/camaraproject/DeviceStatus/pull/130)
+
+* [#125 Separate endpoints into different APIs](https://github.com/camaraproject/DeviceStatus/pull/125)
+ * Split the current API into 4 different APIs
+
+* [#124 When roaming status is true, is it mandatory to return both countryCode and countryName?](https://github.com/camaraproject/DeviceStatus/issues/124)
+
+* [#122 Bugfix release v0.5.1](https://github.com/camaraproject/DeviceStatus/issues/122)
+
+* [#119 How can a provider inform the ASP/aggregator about not implemented features in advance of the API call](https://github.com/camaraproject/DeviceStatus/issues/119)
+
+* [#117 Send a CloudEvent when DELETE /subscriptions/{subscriptionId}](https://github.com/camaraproject/DeviceStatus/issues/117)
+ * The corresponding PR is open: [#121 feat: add termination reason when subscription deleted](https://github.com/camaraproject/DeviceStatus/pull/121)
+
+* [#115 /Connectivity API there is no indication for which particular subscriber event (DATA/SMS)](https://github.com/camaraproject/DeviceStatus/issues/115)
+
+* [#110 Request for Addition of "last_updated_timestamp" Field in CAMARA DeviceStatus API](https://github.com/camaraproject/DeviceStatus/issues/110)
+ * The name should correlate with similar properties at other APIs
+
+* [#107 Use simple string for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/issues/107)
+ * The corresponding PR is open: [#108 feat: use simple String for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/pull/108)
+
+* [#104 Include x-correlator heade](https://github.com/camaraproject/DeviceStatus/issues/104)
+ * The corresponding PR is open: [#112 include x-correlator and fix typo in 400 error code](https://github.com/camaraproject/DeviceStatus/pull/112)
+
+* [#102 Clarify API readiness status for v1.0.0](https://github.com/camaraproject/DeviceStatus/issues/102)
+
+* [#96 Path update per Design Guideline](https://github.com/camaraproject/DeviceStatus/issues/96)
+ * The corresponding PR is open: [#131 Update device-status.yaml](https://github.com/camaraproject/DeviceStatus/pull/131)
+
+
+
+## Open discussions
+* [#114 Test Data : Device Status](https://github.com/camaraproject/DeviceStatus/discussions/114)
+* [#100 Granularity of the Test Definition feature file](https://github.com/camaraproject/DeviceStatus/discussions/100)
+* [#89 Multi-Operator Demo Test Discussion](https://github.com/camaraproject/DeviceStatus/discussions/89)
+* [#72 CAMARA Compliant: Expose all end points](https://github.com/camaraproject/DeviceStatus/discussions/72)
+* [#48 Need support](https://github.com/camaraproject/DeviceStatus/discussions/48)
+
+## API Roadmap
+
+### Release 0.5.x
+* The release v0.5.0 was created on 31.01.2024
+* The bugfix release 0.5.1 is planned [#122 Bugfix release v0.5.1](https://github.com/camaraproject/DeviceStatus/issues/122)
+
+### Release 0.6.0
+* Planned release date: tbd
+* Content:
+ * [#131 Update device-status.yaml](https://github.com/camaraproject/DeviceStatus/pull/131)
+ * [#112 include x-correlator and fix typo in 400 error code](https://github.com/camaraproject/DeviceStatus/pull/112)
+ * [#123 Adding configuration for Github Actions with linting ruleset](https://github.com/camaraproject/DeviceStatus/pull/123)
+ * ?? [#125 Separate endpoints into different APIs](https://github.com/camaraproject/DeviceStatus/pull/125)
+
+
+## AOB
+* Next call will be on 10.04.2024 11:00 CET
diff --git a/marked/DeviceStatus/documentation/MeetingMinutes/MoM-DST-2022-12-12/raw.md b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-DST-2022-12-12/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..292abcb6cb43294991d033fcce65c7257d4a4a8c
--- /dev/null
+++ b/marked/DeviceStatus/documentation/MeetingMinutes/MoM-DST-2022-12-12/raw.md
@@ -0,0 +1,35 @@
+# Meeting Minutes: Device Status WG
+## Date: 12th December 2022
+## Attendees
+- Eric Murray / Vodafone
+- Sachin Kumar / Vodafone
+- Ludovic Robert / Orange
+- Joachim Dahlgren / Ericsson
+- Mona Mokhber / Telefonica
+## Pull Requests
+- PR #8: Add documentation / DT
+
+ It was agreed that:
+ - Final reviews of this PR should be undertaken this week
+ - Any comments to be raised by end of Friday 16th December, otherwise it will be approved
+- PR #9: v0.3.0 based on Telefónica proposal / Telefonica
+
+ It was agreed that:
+ - Outstanding issues / PRs in the Commonalities WG ([PR #68](https://github.com/camaraproject/WorkingGroups/pull/68), [Issue #101](https://github.com/camaraproject/WorkingGroups/issues/101), [Issue #105](https://github.com/camaraproject/WorkingGroups/issues/105)) need to be closed before this proposal can be progressed
+ - A separate API per status type (in this case, roaming status) was the best approach, and new APIs should be introduced for additional statuses (e.g. device connectivity state)
+ - If additional roaming status information was to be added (e.g. visited country, or PLMN ID), this should be implemented as additional paths to support different client access rights via scopes
+## Issues
+- Issue #6: Issues, branches, pull requests - cleaning up
+ - Issue closed
+- Issue #7: Meetings ?
+ - Agreed to keep open until Noel has scheduled ongoing bi-weekly meetings
+- Issue #2: Roaming Status API Proposal
+ - This was the original issue raised in the Commonalities WG, and now transferred to Device Status WG
+ - Agreed to revisit once PR #9 is resolved
+ - Link to original proposal is broken. Eric to copy over original proposal to Device Status WG and fix link.
+- Issue #10: Telefonica proposal post MWC
+ - Issue raised to introduce PR #9 (discussed above). Can be used to raise questions about the proposal.
+## Discussions
+- None
+## AOB
+- Ongoing meetings to be scheduled by Noel. Anyone wishing to join should subscribe to the [mailing list](https://lists.camaraproject.org/g/sp-dst).
diff --git a/marked/DeviceStatus/documentation/MeetingMinutes/README/raw.md b/marked/DeviceStatus/documentation/MeetingMinutes/README/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..37aa0ff405bf918d942905c10a0f435fd46c8ffd
--- /dev/null
+++ b/marked/DeviceStatus/documentation/MeetingMinutes/README/raw.md
@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.
diff --git a/marked/DeviceStatus/documentation/SupportingDocuments/README/raw.md b/marked/DeviceStatus/documentation/SupportingDocuments/README/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..37aa0ff405bf918d942905c10a0f435fd46c8ffd
--- /dev/null
+++ b/marked/DeviceStatus/documentation/SupportingDocuments/README/raw.md
@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.
diff --git a/marked/DeviceStatus/documentation/SupportingDocuments/Roaming_API_Proposal_-_Vodafone/raw.md b/marked/DeviceStatus/documentation/SupportingDocuments/Roaming_API_Proposal_-_Vodafone/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..a554ea03c63cbd4153d4cc64229aacd9adfde012
--- /dev/null
+++ b/marked/DeviceStatus/documentation/SupportingDocuments/Roaming_API_Proposal_-_Vodafone/raw.md
@@ -0,0 +1,31 @@
+# Roaming Status API
+Device (i.e. UE) status indications are an important family of APIs where the API consumer is not the device itself. One status indication that has several use cases is the roaming status of the device. Roaming in this context is defined as being connected to a network other than the subscriber's home network, and so would include national roaming (where allowed) in addition to international roaming.
+
+For example, such information could be useful in the following scenarios:
+- For regulatory reasons, where a customer may need to be within a certain jurisdication, or outwith others, in order for transactions to be authorised
+- For security / fraud reasons, to establish that a customer is located where they claim to be
+- For service delivery reasons, to ensure that the customer has access to particular services, and will not incur roaming charges in accessing them
+
+### Inputs
+- The target UE whose roaming status is required should be explicitly identified by its GPSI (MSISDN or External Identifier). It is not expected that the UE itself will call this API, and hence OIDC will not identify the target UE.
+- When a boolean indication of whether or not a UE is in a specific country, the ISO country code for that country must be provided
+
+
+### Outputs
+It is proposed that a roaming status API is able to provide the following information to API consumers:
+- A boolean indicator of roaming state (i.e. roaming / not roaming)
+- if roaming, an indicator of whether that is national or international roaming (i.e. does the ISO country code for the home MCC equal that of the visited MCC or not)
+- The ISO country code corresponding to the MCC of the network the device is currently connected to or, where the MCC does not have a corresponding ISO country code, the MCC itself
+- The full PLMN of the network that the device is currently connected to (MCC + MNC)
+- A boolean indicator of whether a device is in a specified country (specified by ISO country code)
+
+### Notifications
+It should be possible for the API caller to be notified of any change in roaming status
+
+## Implementation
+UE roaming status information can be obtained either directly from the HSS, or via the SCEF/NEF "ROAMING_STATUS" monitoring capability
+
+## Notes
+- API consumers would be able to access all or only some of this information, depending on their level of authorisation
+- Some lucky countries (e.g. UK, USA, India, China) have multiple MCCs, hence care must be taken when deciding roaming status on the basis of the visited network MCC
+- A very few MCCs are shared between multiple countries (specifically, countries with different ISO country codes - for example, French DROMs or British Crown Dependencies). In these cases, the ISO country code needs to be determined from the full visited network PLMN.
diff --git a/marked/DeviceStatus/documentation/SupportingDocuments/decision-support-1-or-2-apis/raw.md b/marked/DeviceStatus/documentation/SupportingDocuments/decision-support-1-or-2-apis/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..87bc364f1931f591185a692c8e1eeb2cd0d83687
--- /dev/null
+++ b/marked/DeviceStatus/documentation/SupportingDocuments/decision-support-1-or-2-apis/raw.md
@@ -0,0 +1,136 @@
+# Decision supporting document for the discussion 1 or 2(n) APIs
+
+## Current situation
+The device-status API has 1 endpoint: /roaming.
+There is a need to add new functionalities. At first 2 new endpoints: to get the connectivity status and to subscribe for status-events.
+Later other functionalities will follow.
+
+### Option 1
+Logically related endpoints are generally within 1 API, with 1 basepath. In special cases (e.g. compliance) splitting is possible.
+Example:
+{apiRoot}/device-status/v0/roaming
+{apiRoot}/device-status/v0/connectivity
+{apiRoot}/device-status/v0/subscriptions
+
+### Option 2
+Each device status subtype is handled in a separate API with different basepaths building an API-family.
+Example:
+API #1
+{apiRoot}/device-roaming-status/v0/roaming
+{apiRoot}/device-roaming-status/v0/subscriptions
+
+API #2
+{apiRoot}/device-connectivity-status/v0/connectivity
+{apiRoot}/device-connectivity-status/v0/subscriptions
+
+
+## Criterias
+
+### 1. API usage - client view
+
+Aspects of finding and using the API(s) for a specific use case of a client.
+
+**Separate basepath**
+
+Pros:
+- For a use case with a single area of interest (e.g. only roaming status is needed) a specific small API might be easier to be found and used
+
+Cons:
+- For more complex use cases many device status-APIs are needed (find, subscribe, integrate, etc.)
+
+
+**Common basepath**
+
+Pros:
+- For a use case with multiple areas of interest or the intention to extend the usage later a combined API with all device status related information is more comfortable
+- Only one API onboarding
+- In this very specific context, the 2 functions are very close.
+
+Cons:
+- If only one specific status is needed, then it might take longer to find the right information
+
+
+### 2. Service development and operation - provider view
+Aspects of the service implementation, testing, and operation on the provider side.
+
+**Separate basepath**
+
+Pros:
+- Independent implementation and testing of the different status functionalities
+- Fine-grade billing, scaling and monitoring is possible (however more effort)
+
+Cons:
+- Extra effort is needed to prevent doubled code
+- More overhead on developing and operating multiple services
+
+**Common basepath**
+
+Pros:
+- Efficient development (especially when all status information can be gathered from the same southbound service)
+- Model generation performed once
+
+Cons:
+- If different southbound services are used the service gets more complex
+- It might lead to partial implementations when there is an interest in some of the use cases and not the others
+
+
+### 3. API maintenance & releasing - Camara view
+Aspects of maintenance (add, delete, change functionality) and releasing (versioning, release planning, etc.)
+
+**Separate basepath**
+
+Pros:
+- A simple service is easier to maintain and release
+- Version changes are tightly related to the API functionality
+
+Cons:
+- The overall effort (discussions, YAML work, etc.) for the API family is higher
+- Additional synchronization within the API family is necessary (using common types could help)
+
+**Common basepath**
+
+Pros:
+- Bigger releases with higher value
+- Easy to add a new endpoint to an existing API
+
+Cons:
+- Longer release cycles (more content, more discussions)
+- Introducing changes/updates in one of the endpoints will result a version change affecting other unrelated endpoints (specially when they are not backward compatible)
+
+
+### 4. Harmonization - technical view
+Aspects of industry best practice, generic design guidelines and harmonization with other Camara APIs.
+
+**Some examples**
+- 3GPP APIs are simple on the path level (collection and collection\\
+
public | stable
public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
+| 1 | API definition | M | M | M | M | Y | [link](code/API_definitions/device-swap.yaml) |
+| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3) |
+| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3) |
+| 4 | API versioning convention applied | M | M | M | M | Y | v1.0.0 |
+| 5 | API documentation | M | M | M | M | Y | Embedded documentation into API spec - [link](/code/API_definitions/device-swap.yaml) |
+| 6 | User stories | O | O | O | M | Y | [check](/documentation/API_documentation/device-swap_check_User_Story.md) [retrieve](/documentation/API_documentation/device-swap_retrieve_User_Story.md) |
+| 7 | Basic API test cases & documentation | O | M | M | M | Y | [check](/code/Test_definitions/device-swap-checkDeviceSwap.feature) [retrieve](/code/Test_definitions/device-swap-retrieveDeviceSwapDate.feature) |
+| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [check](/code/Test_definitions/device-swap-checkDeviceSwap.feature) [retrieve](/code/Test_definitions/device-swap-retrieveDeviceSwapDate.feature) |
+| 9 | Test result statement | O | O | O | M | N | See issue [#68](https://github.com/camaraproject/DeviceSwap/issues/68) |
+| 10 | API release numbering convention applied | M | M | M | M | Y | r3.2 |
+| 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) |
+| 12 | Previous public release was certified | O | O | O | M | N | |
+| 13 | API description (for marketing) | O | O | M | M | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/81166764/DeviceSwap+API+description) |
+
+(*) If you encounter issues with the provided test files (.feature), please create an issue in the API Sub-Project to signal these issues so they can be fixed in a patch release.
+
+To fill the checklist:
+- in the line above the table, replace the api-name, api-version and the rx.y by their actual values for the current API version and release.
+- in the Status column, put "Y" (yes) if the release asset is available or fulfilled in the current release, a "N" (no) or a "tbd". Example use of "tbd" is in case an alpha or release-candidate API version does not yet provide all mandatory assets for the release.
+- in the Reference information column, provide the relative links (from the API repository home folder) to the release asset once available, the applicable release numbers (not versions) of Commonalities and ICM, and any other relevant links or information.
+- For the point 12: The Reference information comment shall reference a note (e.g. "see (1)") under the checklist table to be added that states the certified company(s) as can be found on the following link: [GSMA Open Gateway Portal](https://open-gateway.gsma.com/).
+
+Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.
+
+The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine).
diff --git a/marked/DeviceSwap/documentation/API_documentation/device-swap_check_User_Story/raw.md b/marked/DeviceSwap/documentation/API_documentation/device-swap_check_User_Story/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..f12e722d015d84f933b41a5a56dc1ee4891f8483
--- /dev/null
+++ b/marked/DeviceSwap/documentation/API_documentation/device-swap_check_User_Story/raw.md
@@ -0,0 +1,11 @@
+# Device Swap Check API User Story
+
+
+| **Item** | **Details** |
+| ---- | ------- |
+| ***Summary*** | As an enterprise application developer, I want to check if a device swap has occurred within a specified period for a user's mobile number so that I can enhance security measures against account takeover fraud. |
+| ***Actors and Scope*** | **Actors:** Application service provider (ASP), ASP:User, ASP: BusinessManager, ASP:Administrator, Channel Partner, End-User, Communication Service Provider (CSP).
**Scope:**
- Checks if a device swap has occurred within a specified period for a given phone number. |
+| ***Pre-conditions*** |The preconditions are listed below:
**Ends when:** The CSP's Device Swap server responds indicating whether a Device Swap has been performed within the specified period. |
+| ***Post-conditions*** | The ASP:User could continue offering its service to the End-User with the confirmation of the validity of the End-User's line, based on the Device Swap information. |
+| ***Exceptions*** | Several exceptions might occur during the Device Swap API operations
- Unauthorized: Not valid credentials (e.g., use of already expired access token).
- Invalid input: Not valid input data to invoke operation (e.g., improperly formatted phone number).|
diff --git a/marked/DeviceSwap/documentation/API_documentation/device-swap_retrieve_User_Story/raw.md b/marked/DeviceSwap/documentation/API_documentation/device-swap_retrieve_User_Story/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..a18bf4803581da30f88b9947dec79aa720347ab9
--- /dev/null
+++ b/marked/DeviceSwap/documentation/API_documentation/device-swap_retrieve_User_Story/raw.md
@@ -0,0 +1,11 @@
+# Device Swap Retrieve API User Story
+
+
+| **Item** | **Details** |
+| ---- | ------- |
+| ***Summary*** | As an enterprise application developer, I want to verify the last device swap date for a user's mobile number so that I can enhance security measures against account takeover fraud. |
+|***Actors and Scope*** | **Actors:** Application service provider (ASP), ASP:User, ASP: BusinessManager, ASP:Administrator, Channel Partner, End-User, Communication Service Provider (CSP).
**Scope:**
- Retrieves the timestamp of the last device swap event for a given phone number. |
+| ***Pre-conditions*** |The preconditions are listed below:
|
+| Logistics | All | 1. In order to be able to continue this substream despite of vacations etc. the group agreed to appoint Kevin (VDF/5GFF) as Co-Lead with Thomas (EdgeXR) for this substream.
**Ends when:** The CSP's Device Swap server responds with the timestamp of the last device swap event, or the first SIM installation date if no device swap has occurred. |
+| ***Post-conditions*** | The ASP:User could continue offering its service to the End-User with the confirmation of the validity of the End-User's line, based on the Device Swap information. |
+| ***Exceptions*** | Several exceptions might occur during the Device Swap API operations
- Unauthorized: Not valid credentials (e.g., use of already expired access token).
- Invalid input: Not valid input data to invoke operation (e.g., improperly formatted phone number).
- Not able to provide: Legal restrictions or data retention policies preventing the retrieval of the requested information.|
diff --git a/marked/DeviceSwap/documentation/MeetingMinutes/README/raw.md b/marked/DeviceSwap/documentation/MeetingMinutes/README/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..37aa0ff405bf918d942905c10a0f435fd46c8ffd
--- /dev/null
+++ b/marked/DeviceSwap/documentation/MeetingMinutes/README/raw.md
@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.
diff --git a/marked/DeviceSwap/documentation/SupportingDocuments/README/raw.md b/marked/DeviceSwap/documentation/SupportingDocuments/README/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..37aa0ff405bf918d942905c10a0f435fd46c8ffd
--- /dev/null
+++ b/marked/DeviceSwap/documentation/SupportingDocuments/README/raw.md
@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.
diff --git a/marked/DeviceVisitLocation/README/raw.md b/marked/DeviceVisitLocation/README/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..aaa3adb3a315d888a9c0bf9615b9b1272e6558b9
--- /dev/null
+++ b/marked/DeviceVisitLocation/README/raw.md
@@ -0,0 +1,41 @@
+
+
+
+
to operator network
+ Note over AP,OP: PRE App developer registered,
authenticated and authorised
+ AP->>OP: GET /edge-cloud-zone
+ OP->>AP: Returns the information about the Edge cloud zones (edgeCloudZoneInfo)
+ alt app has a local mapping of server endpoints to Edge Cloud Zones
+ AP->>OP: POST /app Information about app to be instantiate(appManifest)
+ OP->>AP: Returns the identificator of the submitted app (appId)
+ AP->>OP: GET /app?appId=UUID Information about app(appId) to be instantiate(appManifest)
+ OP->>AP: Returns the information requested (appManifest)
+ AP->>OP: DELETE /app (appId) Delete app for a given appId (Manifest and any related information)
+ OP->>AP: Request accepted
+ AP->>OP:POST /app Instantiate application (appId) in a determinated Edge Cloud Zone(edgeCloudZoneId)
+ OP->>EIP: Instantiate instance in a determinated Edge Cloud Zone(edgeCloudZoneId)
+ EIP->>OP: Application instantiated
+ OP->>AP:Returns the appInstance created
+ AP->>OP: GET /app (appId) /Instance?appID=UUID Information about app(appId) instantiated (appInstanceInfo)
+ OP->>AP: Returns the application instance information
+ AP->>OP: DELETE /app (appId) DELETE Running instance for a given appId.
+ alt delete only the instance related with the appId
+ OP->>EIP: Delete instance
+ EIP->>OP: Instance deleted
+ OP->>AP: Application instance deleted
+ end
+ end
+```
+
+
+
+
diff --git a/marked/EdgeCloud/documentation/MeetingMinutes/2022/MOM_-_2020816/raw.md b/marked/EdgeCloud/documentation/MeetingMinutes/2022/MOM_-_2020816/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..f25734744d5e5f7b4fd641c963321fa1d64c94dc
--- /dev/null
+++ b/marked/EdgeCloud/documentation/MeetingMinutes/2022/MOM_-_2020816/raw.md
@@ -0,0 +1,36 @@
+# MOM - 2020816
+
+**Date:** 16-July-2022
+
+## Attendees
+
+* Andrew Wajs (Scenera)
+* Christoph Neumann (Broadpeak)
+* Alexandru Ciinaru (Orange)
+* Deepak Gunjal (Capgemini)
+* Brett Hill (5GFF)
+* Landon Cox (MSFT)
+* Mark Cornall (GSMA)
+* Toshiyasu Wakayama (KDDI)
+* Jesse Bijl – (EdgeXR)
+* Thomas Vits – (EdgeXR)
+* Jon Gainsley – (EdgeXR)
+* Mahesh Chapalamadugu – (5GFF)
+* Raghuram Parvataneni - (5GFF)
+* Syed Rehman – (5GFF)
+* Kevin Smith (5GFF)
+* Urvika
+* David Ferreira Antoniello (TEF)
+* Aurelia Martinez Guerra (TEF)
+
+## Goals
+
+Go through last MoM action items Identify additional tasks, prepare upcoming ones
+
+| Item | Who | Description |
+| ---- | --- | ----------- |
+| EdgeXR API proposal | EdgeXR | EdgeXR generated 2 API pull requests for thisgroup: *App APIs* [#26](https://github.com/camaraproject/EdgeCloud/pull/26) and *App session and Discovery APIs* [#27](https://github.com/camaraproject/EdgeCloud/pull/27). Jon Gainsley made a general overview of each one. During the session, the possibility of sharing the call flow or sequence diagram of the APIs was requested. EdgeXR will fetch this information and share it. |
+| Comment - Pull Request [#21](https://github.com/camaraproject/EdgeCloud/pull/21) | 5GFF | [#21](https://github.com/camaraproject/EdgeCloud/pull/26) - Create EdgeCloudApi\_v0.0.5. yaml: Added a list of API questions today in the pull request. An additional specific session is proposed to discuss the points and questions. It was asked who would be interested in participating, the invitation will be sent to all participants. |
+| Comment - Pull Request [#24](https://github.com/camaraproject/EdgeCloud/pull/24) | 5GFF | [#24 - UNI API](https://github.com/camaraproject/EdgeCloud/pull/26): Comments from 5GFF about removing or not the UNI API in this CAMERA group. Mahesh gives first feedback indicating that it will not be very easy for non-Telco users to use the API. This argument is complemented with additional points in the pull request. On the part of Telefonica, it is internally evaluating to have an answer as soon as possible. If necessary, a specific session can be established to discuss this point. Kevin explained that the term 'UNI' is specifically defined in public GSMA materials as requiring a client SDK/middleware ('User Client') on the client UE; and that 5GFF does not require that User Client. 5GFF API allows an application in the UE to call HTTP(S) operator-hosted APIs directly without requiring any additional SDK to be on the UE. |
+| Draft Proposal for contributions and approval process in WG - Pull request by DT - [#20](https://github.com/camaraproject/EdgeCloud/pull/26) | DT | It is proposed to work with different subbranches. During the last two weeks, no comments have been received on what was proposed by DT, so it is assumed that all the members of this group agree with this proposal. The next step will be to move the 5GFF contribution to a sub-branch and work on different branches in order to push the proposal to the master branch for approval. In parallel, the way to work to validate the 3 current proposals (MEC Contribution, 5GFF Contribution and EdgeXR Contribution) will be having technical meetings to discuss each point and have the final decision. EdgeXR is interested in managing and organizing these activities. The proposal is that Thomas Vits prepare and elaborate a first proposal for the next technical meeting during the next 2 weeks and have a status in the next bi-weekly session. Different technical activities will be worked on in parallel. |
+| Next steps | EdgeXR & TEF | Telefonica and EdgeXR will discuss the next steps to follow will be discussed, beginning with the analysis with the superposition of each proposal and, as a second step, defining the Action Points to have the Edge Cloud API family with all the required functionalities, the discussion of adding or not the UNI API to the Edge Cloud API family |
diff --git a/marked/EdgeCloud/documentation/MeetingMinutes/2022/MOM_-_20220719/raw.md b/marked/EdgeCloud/documentation/MeetingMinutes/2022/MOM_-_20220719/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..f15a18c2f547f73b10cdf6f4d0f69e824783b4ef
--- /dev/null
+++ b/marked/EdgeCloud/documentation/MeetingMinutes/2022/MOM_-_20220719/raw.md
@@ -0,0 +1,43 @@
+## APMeting Information
+
+**Date:** 19-July-2022
+
+## Attendees
+
+*
+* Andrew Wajs (Scenera)
+* Babu Narayan (Nabstract)
+* Christoph Neumann (Broadpeak)
+* Alexandru Ciinaru (Orange)
+* Tuan Tran (Broadpeak)
+* Deepak Gunjal (Capgemini)
+* Brett Hill (5GFF)
+* Kevin Smith (5GFF)
+* Larry Homer (Intel)
+* Landon Cox (MSFT)
+* Sylvain Morel (Orange)
+* Raffaele Passannanti (TIM)
+* Fabrizio Moggio (TIM)
+* Tom van Pelt (GSMA)
+* Toshiyasu Wakayama (KDDI)
+* Yamina Kelm (DT)
+* Shilpa Padgaonkar (DT)
+* Eric Murray (Vodafone)
+* Jesse Bijl
+* Thomas Vits
+* Aurelia Martinez Guerra (TEF)
+* David Ferreira Antoniello (TEF)
+* Cristina Santana (TEF)
+* José Antonio Ordoñez (TEF)
+
+## Goals
+
+Go through last MoM action items Identify additional tasks, prepare upcoming ones
+
+| Item | Who | Description |
+| ---- | --- | ----------- |
+| API Deployment | Capgemini & TEF | TheYAML Swagger associated with the APIs proposed and created by Orange, DT,Capgemini and Telefonica was presented and detailed. It is the initial ideathat is presented as a starting point to be complemented, edited and reviewedby the participants. |
+| Edge API Family proposal | Capgemini & TEF | An analysis realizedby Telefonica associated with the 5GFF APIs and the Deployment APIs, and thepossible relationship between them, was presented.
https://github.com/camaraproject/EdgeCloud/blob/main/documentation/Presentation/EdgeXR\_forCAMARAEdgeCloudWG\_20220719.pdf |
+| EdgeXR Presentation | EdgeXR | Thomas Vitsintroduces EdgeXR and indicates that they want to support and be part of thedevelopment of the CAMARA APIs, taking advantage of the experience gainedduring the MobiledgeX stage. The presentation is included.
https://github.com/camaraproject/EdgeCloud/blob/main/documentation/Presentation/EdgeXR\_forCAMARAEdgeCloudWG\_20220719.pdf |
+| | | |
+| | | |
diff --git a/marked/EdgeCloud/documentation/MeetingMinutes/2022/MOM_-_20220802/raw.md b/marked/EdgeCloud/documentation/MeetingMinutes/2022/MOM_-_20220802/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..e1b33eba91e69e3bb58be635a54f1b5bae2376f9
--- /dev/null
+++ b/marked/EdgeCloud/documentation/MeetingMinutes/2022/MOM_-_20220802/raw.md
@@ -0,0 +1,41 @@
+## AP Meting Information
+
+Date: 02 –August - 2022
+
+## Attendees
+
+* Andrew Wajs (Scenera)
+* Alexandru Ciinaru (Orange)
+* Tuan Tran (Broadpeak)
+* Deepak Gunjal (Capgemini)
+* Brett Hill (5GFF)
+* Larry Homer (Intel)
+* Tom van Pelt (GSMA)
+* Toshiyasu Wakayama (KDDI)
+* Yamina Kelm (DT)
+* Shilpa Padgaonkar (DT)
+* Thomas Vits (EdgeXR)
+* Emil Zhang
+* Kevin Xu
+* Mahesh Chapalamadugu (5GFF)
+* Mark Cornall (GSMA)
+* Urvika
+* Larry Horner (Intel)
+* Vaibhav Mehta (Nabstract)
+* Alexandre Harmand (TEF)
+* David Ferreira Antoniello (TEF)
+* Aurelia Martinez Guerra (TEF
+
+
+
+## Goals
+
+Go through last MoM action items Identify additional tasks, prepare upcoming ones
+
+| Item | Who | Description |
+| ---- | --- | ----------- |
+| #21 API Deployment | Capgemini & TEF | Telefónica in collaboration with Capgemini, uploaded to GitHub as a “pull request” the Edge Deployment API (EdgeCloudApi\_v0.0.5.yaml - [https://github.com/camaraproject/EdgeCloud/pull/21](https://github.com/camaraproject/EdgeCloud/pull/21)
In this YAML it includes the 4 APIs proposed in the first meeting:
Participants can review it and give any additional comments. |
+| Edge API Family proposal | EdgeXR | The objective of Telefonica and Capgemini was to have for this meeting a first proposal about the analysis of the parameters to join the 5GFF APIs (Discovery) with the new APIs that were uploaded today (focused on the deployment of the APIs). It was not possible to have it for this week. Two options are proposed:
Thomas Vits (of EdgeXR) offers to collaborate with this point as another candidate. The objetive is to have a first proposal for the next meeting. |
+| #20 Proposal for contributions and approval process in WG | DT | DT has a "pull request" about the proposal for the Contribution and Approval process of this working group.
[https://github.com/camaraproject/EdgeCloud/pull/20](https://github.com/camaraproject/EdgeCloud/pull/20)
Shipa Padgaonkar presents the proposal located on the CAMARA GitHub.
It is important that everyone review and validate this proposal to make this way of working official.
This "pull request" will be maintained until Friday 08/12, if there are no additional comments, it will be validated.
It is important that everyone review and validate this proposal to make this way of working official. |
+| #25 Draft proposalEdge Cloud GitHub repository Organization | Capgemini & TEF | Deepak,from Capgemini, in conjunction with Telefónica, presented a draft with 3 options for organizing the Edge Cloud GitHub repository. https://github.com/camaraproject/EdgeCloud/pull/25 Initially, during the meeting,some of the participants indicated that option 1 could be the most appropriate.In any case, the presentation is attached and, in case of having additionalcomments, it is established as a deadline to receive them until Friday 08/12. |
+| #24 UNI API | Capgemini & TEF | Telefonica& Capgemini open a discussion about the Edge Cloud API Family scope.
This EdgeCloud API Family must include the Edge Discover UNI API, or no?
Telefonicaand Capgemini performed a first analysis of Pro and Cons.
Deepakpresented this first analysis.
[https://github.com/camaraproject/EdgeCloud/pull/24](https://github.com/camaraproject/EdgeCloud/pull/24)
It isnecessary that the participants can establish if it is important for CAMARA todefine this UNI APIs or must be 3GPP.
Theproposal will remain open for the next two weeks, until the next meeting, toestablish a conclusion.. |
diff --git a/marked/EdgeCloud/documentation/MeetingMinutes/2022/MOM_-_20220827/raw.md b/marked/EdgeCloud/documentation/MeetingMinutes/2022/MOM_-_20220827/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..88506d26783ba9ba55124e578a01356eea96bd3e
--- /dev/null
+++ b/marked/EdgeCloud/documentation/MeetingMinutes/2022/MOM_-_20220827/raw.md
@@ -0,0 +1,40 @@
+# OM - 20220827
+
+Sun, Sep 4, 2022 8:19 AM
+
+## **Attendees**
+
+* Andrew Wajs – (Scenera)
+* Christoph Neumann – (Broadpeak)
+* Tim Epkes -
+* Prashant Goswami –
+* Deepak Gunjal – (Capgemini)
+* Brett Hill – (Telstra - 5GFF)
+* Kevin Smith – (Vodafone – 5GFF)
+* Landon Cox – (MSFT)
+* Mahesh Chapalamadugu - (Verizon – 5GFF)
+* Sylvain Morel - (Orange)
+* Fabrizio Moggio - (TIM)
+* Raffaele Passannanti - (TIM)
+* Raghuram Parvataneni - (Telstras – 5GFF)
+* Syed Rehman - (Verizon – 5GFF)
+* Thomas Vits - (EdgeXR)
+* Tom van Pelt - (GSMA)
+* Toshiyasu Wakayama (KDDI)
+* Urvika
+* Alexandre Harmand - (TEF)
+* José Antonio Ordoñez - (TEF)
+* David
+* Ferreira Antoniello - (TEF)
+* Aurelia Martínez Guerra - (TEF)
+
+## Goals
+
+Go through last MoM action items Identify additional tasks, prepare upcoming ones
+
+| Item | Who | Description |
+| ---- | --- | ----------- |
+| CAMRA - Roles | TEF | Markus has defined the differentroles in each CAMARA group in order to be clear about which members will makenew contributions, which members will validate these contributions, etc. This activity has been developed in parallel during these last two weeks and has dedicated part of the time.
The toles are:
|
+| Edge Cloud API family | EdgeXR | Analysis of the different contributions to the API (5GFF, OPAG, EdgeX
R, New DT contribution). This activity is assigned to a new group in order to analyze all the contributions, define which APIs we must have in this Edge Cloud family, analyze the different APIs to align them with the proposal.
In the last session, the EdgeXR team was established as responsible for organizing this small group and starting the activities.
Thomas presented the next steps: Have a Kick-off meeting to start working on the activities. A link is attached for those who want to participate and indicate the best option according to availability: ([https://doodle.com/meeting/participate/id/dBLrAQna](https://doodle.com/meeting/participate/id/dBLrAQna)).
It is necessary to include in the analyzes of this group the pull request about the questions, doubts and comments of each proposal. For this, it is proposed as the first point on the agenda of the first session to resolve all doubts and questions. |
+| ***Comment - Pull Request #24*** | All | #24 - UNI API: There are different options for this API: Should this API be included in CAMERA? Should 3GPP be used to define this UNI API? Should a part of the API be defined in CAMERA and a part in 3GPP? It is proposed to start a small group to discuss this topic, align and share status in these bi-weekly sessions. It is important to fix this issue, whether or not UNI API is part of the Edge Cloud group, as soon as possible.
Deepak (Capgemini) is goin to arrange a short group that is going to have as objetive aligne possiions in this isue |
+| Traffic Influence API | TIM | Fabrizio Moggio (TIM) opened a new discussion about the Traffic Influence API. He proposes to work on this API in EdgeCloug grou and that this new API be part og thi Edge Clud API family.
It was proposed to Fabrizio in the session that a point be opened in the Backlog group with all the details. This group will decide if it is better to create a new group in CAMARA specifically for Traffic Influence or if this functionality is part of one of the currently available groups. |
\ No newline at end of file
diff --git a/marked/EdgeCloud/documentation/MeetingMinutes/2022/MOM_Convergence_-_202209160/raw.md b/marked/EdgeCloud/documentation/MeetingMinutes/2022/MOM_Convergence_-_202209160/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..e41129213e0d255557ab22f38a2d89e8d2286ec7
--- /dev/null
+++ b/marked/EdgeCloud/documentation/MeetingMinutes/2022/MOM_Convergence_-_202209160/raw.md
@@ -0,0 +1,28 @@
+# Meeting Minutes Convergence Substream - 20220916
+
+Fri, Sep 16, 2022 17:00 PM
+
+## **Attendees**
+
+* Andrew Wajs(Scenera)
+* Deepak Gunjal (Capgemini)
+* Kevin Smith (Vodafone – 5GFF)
+* Mahesh Chapalamadugu (Verizon - 5GFF)
+* Syed Rehman (Verizon - 5GFF)
+* Thomas Vits (EdgeXR)
+* Lev Shvarts (EdgeXR)
+* Alexandre Harmand (TEF)
+* Rebecca Odenwaelder (Deutsche Telekom)
+* Marc Cornall (GSMA)
+* Alexandru Ciinaru (Orange)
+* Toshiyasu Wakayama (KDDI)
+
+## Kickoff disucssion
+
+This call was to initiate the activity of the convergence substream.
+
+| Item | Who | Description |
+| ---- | --- | ----------- |
+| Substream Objectives and way of working| All | EdgeXR provided a suggestion on the objectives of this substream, below the aligned outcome after discussion
1. Situation: The EdgeCloud Project in CAMARA received already 3 API contributions (from 5GFF, Capgemini, EdgeXR) potentially addressing similar or same functionalities exposing edge cloud services
2. Challenge: (Assumption) The goal in CAMARA is to have single API set for a given developer intent (on a specific abstraction layer). <- This was a point of discussion whether that assumption actually holds true or whether different APIs could be feasible for the same intent. No final conclusion taken at this point.
3. Solution: Original proposal was to work on the assessment of the current/coming contributions but after discussion we concluded that the initial step to enable this would be to create an aligned taxonomy/terminology. This will ensure that we have the right vocabulary to actually do this assesment acknowledging that background of the distributions is diverse with having different taxonomy in mind.
2. Group agreed on a bi-weekly meeting cadence; as we have participants from literally all timezones we agreed to shift timeslots every 2 meetings to the next timzone (e.g. by around 8 hours)
3. Agreement that all discussions / documents shall be strictly happen in git|
+| Establish aligned Taxonomy| All | As agreed in the initial disucssion the first step is to establish an aligned taxonomy. It was suggested to use the OPG definitions as a basis and then iterate on it in git to come to a consensus. Once good enough (to be agreed by the group when this milestone is hit) the next step (i.e. making an assesment of the scope of the different contributions using that taxonomy) can be initiated. Deepak, Thomas and Mahesh volunteered to get the intitial commit going. |
diff --git a/marked/EdgeCloud/documentation/MeetingMinutes/2024/EdgeCloud_MeetingMinuteslinksFromDecember2023/raw.md b/marked/EdgeCloud/documentation/MeetingMinutes/2024/EdgeCloud_MeetingMinuteslinksFromDecember2023/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..b1b08b47063c1346500778d6b382adeefa9f2f2b
--- /dev/null
+++ b/marked/EdgeCloud/documentation/MeetingMinutes/2024/EdgeCloud_MeetingMinuteslinksFromDecember2023/raw.md
@@ -0,0 +1,24 @@
+# Edgecloud - Meetings Minutes
+
+Meeting minutes are kept from December 2023 in https://wiki.camaraproject.org/display/CAM/Edge+Cloud, please refer to that page to follow last updates.
+
+## December 2023
+
+12/12/2024
+
+https://wiki.camaraproject.org/display/CAM/2023-12-12%3A+SP-EDC+Minutes
+
+19/12/2024
+
+https://wiki.camaraproject.org/display/CAM/2023-12-19%3A+SP-EDC+Minutes
+
+## January 2024
+
+09/01/2024
+
+https://wiki.camaraproject.org/display/CAM/2024-01-09%3A+SP-EDC+Minutes
+
+23/01/2024
+
+https://wiki.camaraproject.org/display/CAM/2024-01-23%3A+SP-EDC+Minutes
+
diff --git a/marked/EdgeCloud/documentation/MeetingMinutes/README/raw.md b/marked/EdgeCloud/documentation/MeetingMinutes/README/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..6819528982aec840a577b116c176f418ccfb8249
--- /dev/null
+++ b/marked/EdgeCloud/documentation/MeetingMinutes/README/raw.md
@@ -0,0 +1,5 @@
+# Minutes archive
+
+From December 2023 the meeting minutes of EdgeCloud calls are within the CAMARA Wiki at [https://wiki.camaraproject.org/display/CAM/Edge+Cloud](https://wiki.camaraproject.org/display/CAM/Edge+Cloud)
+
+Meeting minutes before December 2023 are here in the repository.
diff --git a/marked/EdgeCloud/documentation/SupportingDocuments/API_Documentation/README/raw.md b/marked/EdgeCloud/documentation/SupportingDocuments/API_Documentation/README/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..d4517609b5bc58d467d0f2af4d499e98b8a41b47
--- /dev/null
+++ b/marked/EdgeCloud/documentation/SupportingDocuments/API_Documentation/README/raw.md
@@ -0,0 +1,3 @@
+# EdgeCloud – API\_Documentation
+
+In this folder will be all the documents about the Edge Cloud API Family
\ No newline at end of file
diff --git a/marked/EdgeCloud/documentation/SupportingDocuments/API_Documentation/User_Stories/EdgeApplicationManagement_User_Story/raw.md b/marked/EdgeCloud/documentation/SupportingDocuments/API_Documentation/User_Stories/EdgeApplicationManagement_User_Story/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..15b6925edce28713978947aa089cb0335ae81544
--- /dev/null
+++ b/marked/EdgeCloud/documentation/SupportingDocuments/API_Documentation/User_Stories/EdgeApplicationManagement_User_Story/raw.md
@@ -0,0 +1,60 @@
+## Actors, Roles, and Scope
+| Actor | Role | Scope |
+|-------|------|-------|
+|Application Provider (AP) |API Consumer | API Requester |
+|Edge Service Provider (ESP)|Edge Cloud Provider|API Publisher |
+|MNO|Communications Service Provider|API Publisher |
+|User Client(UC)|API Consumer|API Requester |
+
+Note: the role of Edge Service Provider may be played by different entities, for example: MNOs, Hyperscalers, etc
+
+
+
+| Item | Description | Support Qualifier |
+|----|----|----|
+|Summary|Network operators offers a Multi-access Edge Computing platform in a given territory with several levels of abstraction being the Edge Cloud Zone the lowest one. Network operators offers a service through EdgeCloud APIs that permits application providers to deploy instances of an application in one or several Edge Cloud Zones, and to Applications Users the posibility to chose the most appropriate Edge Cloud Zone available at a given moment| M |
+|Pre-conditions|The AP has a resource usage agreement with the Operator Platform| M |
+|Begins when|The Application Provider (AP) invokes the Edge Application Management API to submit an application with references to obtain all needed data for their instantiation (container images or VM images and manifests describing required resources by an application)| M |
+|Step 1|The ESP stores the app information and returns an Id for reference (terminates with a notification to the AP if error)| M |
+|Step 2|The Application Provider (AP) request information of currently available Edge Cloud Zones and their status | M|
+|Step 3|The MNO provides the availables Edge Cloud Zones where the AP could instantiate the Application| M |
+|Step 4|The AP instantiates the application in one Edge Cloud Zone or in Severals| M|
+|Step 5|The ESP response to the AP appInstance created| M |
+|Step 6|The AP may request updated information of existing app instances of a given app. Possible status for app instantiation includes "ready" also information for endpoint info is provided for the app instance| O |
+|Step 7|App instance may provide service for end users | O |
+|Step 8|The AP request termination of one app instance (optionally all app instances in a given region) | M |
+|Step 9|The ESP validates the request (terminates with a notification to the UE if content is not valid e.g. given appId does not exist)| M|
+|Step 10|The ESP responds to the AP and starts the termination of the app instance, moving its status to terminating| M|
+|Ends when|The UC connects to the EAS| M |
+
+
+
+
+## Flow
+```mermaid
+sequenceDiagram
+ participant AP
+ participant MNO
+ participant ESP(Operator/Hyperscaler)
+
+ Note over AP,MNO: PRE App on device attached
to operator network
+ Note over AP,MNO: PRE App developer registered,
authenticated and authorised
+ Note over MNO,MNO: Edge Application Management API
+ AP->>ESP(Operator/Hyperscaler): POST/ AP Invokes Edge Application Management API to submit an application with references to obtain all needed data for their instantiation(appManifest)
+ ESP(Operator/Hyperscaler)->>AP: The Operator stores the app information and returns an Id for reference(appId)
+ alt app has a local mapping of server endpoints to Edge Cloud Zones
+ AP->>MNO: GET/edge-cloud-zones AP request information about available Edge cloud zones
+ MNO->>AP: Returns the name of the available Edge cloud zones for the Application
+ AP->>ESP(Operator/Hyperscaler):POST/ The AP request to instantiate the App in one or several Edge Clod Zones(Deployment).
+ ESP(Operator/Hyperscaler)->>AP:Returns the appInstance created
+ AP->>MNO: GET /app (appId) Information about app(appId) instantiated
+ MNO->>AP: Returns the application instance information
+ AP->>MNO: DELETE /app (appId) DELETE Running instance for a given appId.
+ alt delete only the instance related with the appId
+ MNO->>ESP(Operator/Hyperscaler): Delete instance
+ ESP(Operator/Hyperscaler)->>MNO: Instance deleted
+ MNO->>AP: Application instance deleted
+ end
+ end
+```
+
diff --git a/marked/EdgeCloud/documentation/SupportingDocuments/API_Documentation/unotes/unotes_meta/raw.md b/marked/EdgeCloud/documentation/SupportingDocuments/API_Documentation/unotes/unotes_meta/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..9bdf134d912e97ae783b3cba0c9b5c1200d7dd4a
--- /dev/null
+++ b/marked/EdgeCloud/documentation/SupportingDocuments/API_Documentation/unotes/unotes_meta/raw.md
@@ -0,0 +1,12 @@
+# unotes_meta
+
+```json
+{
+ "name": "",
+ "isOrdered": true,
+ "folders": {},
+ "files": {
+ "README": 0
+ }
+}
+```
diff --git a/marked/EdgeCloud/documentation/SupportingDocuments/EdgeCloud-Intents-and-API-Mapping-Harmonisation/raw.md b/marked/EdgeCloud/documentation/SupportingDocuments/EdgeCloud-Intents-and-API-Mapping-Harmonisation/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..9d8dc5a06b81ce744e54f6bc4780d87b886361e7
--- /dev/null
+++ b/marked/EdgeCloud/documentation/SupportingDocuments/EdgeCloud-Intents-and-API-Mapping-Harmonisation/raw.md
@@ -0,0 +1,183 @@
+# Edge Cloud Intents and API Mapping – Harmonisation Document
+
+_This document is based on the [CAMARA Commonalities template for User Stories](https://github.com/camaraproject/Commonalities/blob/main/documentation/Userstory-template.md) and references ITU-T Cloud Reference Architecture roles._
+
+---
+
+## 1. Summary
+
+This document provides a harmonised view of **EdgeCloud Intents** and their corresponding **CAMARA APIs**, consolidating the functional flow across discovery, deployment, runtime, and termination stages of the **Edge Cloud lifecycle**.
+
+The purpose is to bridge earlier MEC & Deployment API proposals with the current **CAMARA Edge Cloud family of APIs**, ensuring a unified lifecycle from **Zone discovery** to **Application endpoint registration and discovery**.
+
+---
+
+## 2. Objectives
+
+- To define the **intents** supporting the lifecycle of Edge-hosted applications.
+- To map these intents to existing and emerging **CAMARA APIs**.
+- To support interoperability between **Operator Platforms** and **Application Providers**.
+- To prepare the foundation for future harmonisation across **Edge, Application Management, and Network APIs** (e.g., Traffic Influence).
+
+---
+
+## 3. Roles, Actors, and Scope
+
+| Actor | Role | Scope |
+|-------|------|-------|
+| Application Provider (AP) | API Consumer | API requester, deploys applications and manages instances. |
+| Operator Platform (OP) | Edge Cloud Provider | API publisher, orchestrates resources and exposes APIs. |
+| Edge Infrastructure Provider (EIP) | Edge Cloud Provider | Hosts and manages the physical/virtual infrastructure. |
+| End User (UE) | Service Consumer | Interacts with applications hosted at the edge. |
+
+> Note: Edge Cloud Provider may be the Operator or a Hyperscaler.
+
+---
+
+## 4. EdgeCloud Lifecycle Intents Overview
+
+| **Intent ID** | **Intent Name** | **Purpose / Description** | **Mapped CAMARA API / Status** |
+|---------------|----------------|----------------------------|--------------------------------|
+| **Intent 1** | Discover EdgeCloud Zones | Discover the closest Edge Cloud Zone to a user device based purely on network topology (shortest network path). | `Simple Edge Discovery API` |
+| **Intent 2** | List Available Regions / Capabilities | Discover the best Edge Cloud Zone for an application, considering compute, storage, and network performance requirements beyond distance. | Planned extension of Optimal Edge Discovery |
+| **Intent 3** | Retrieve Zone Information | Obtain metadata, KPIs, and current resource availability of a specific Edge Cloud Zone. | `Simple Edge Discovery API` |
+| **Intent 4** | Filter / Select Preferred Zones | Apply filters (latency, region) for optimal zone selection. | Planned enhancement within Optimal Edge Discovery |
+| **Intent 5** | Register / Onboard Application | Upload manifests, metadata, and container images. | `Edge Cloud Lifecycle Management API` |
+| **Intent 6** | Validate Application Metadata | Validate manifests and dependencies before deployment. | Partially covered by Lifecycle Management |
+| **Intent 7** | Instantiate Application | Deploy application instances in selected Edge Zones. | `Edge Cloud Lifecycle Management API` |
+| **Intent 8** | Scale Application Instance | Adjust resources dynamically (horizontal/vertical). | Future – EdgeCloud Scaling API (proposed) |
+| **Intent 9** | Register Application Endpoints | Register deployed app endpoints (URLs, ports, zones). | `Application Endpoint Registration API` |
+| **Intent 10** | Update Endpoint Metadata | Modify endpoint details (status, performance). | Within `Application Endpoint Registration API` |
+| **Intent 11** | Discover Optimal Application Endpoints | Find best endpoint for a device based on latency or policy. | `Application Endpoint Discovery API` |
+| **Intent 12** | Client-Side Endpoint Selection | Allow clients to select among multiple available endpoints. | Optional behaviour of Endpoint Discovery |
+| **Intent 13** | Influence Network Traffic | Apply routing rules for premium users or optimisation. | `Traffic Influence API` |
+| **Intent 14** | Configure Network Policies | Manage slicing/routing preferences for traffic flows. | Evolution of Traffic Influence |
+| **Intent 15** | Monitor Application Performance | Retrieve runtime telemetry: latency, usage, etc. | SessionInsights API |
+| **Intent 16** | Retrieve Edge Metrics / Zone Health | Query Edge Zone health and operational metrics. | Under discussion – EdgeCloud Monitoring API |
+| **Intent 17** | Automate Policy or Scaling Actions | Enable closed-loop orchestration and scaling triggers. | Future – Edge Orchestration Intent API |
+| **Intent 18** | Terminate Application | Decommission instances and release resources. | `Edge Cloud Lifecycle Management API` |
+| **Intent 19** | Deregister Application Endpoints | Remove obsolete endpoints from registry. | `Application Endpoint Registration API` |
+| **Intent 20** | Audit and Logging | Track API operations, logs, and service usage. | Commonalities Cross-API Logging proposal |
+| **Intent 21** | Federated Edge Discovery | Discover edge zones from partner operators/hyperscalers. | Proposed – Edge Federation Discovery API |
+| **Intent 22** | Cross-Operator Application Placement | Deploy app instances across federated networks. | Future CAMARA/GSMA initiative |
+| **Intent 23** | Consent and Policy Management | Manage end-user consent during discovery/exposure. | Privacy & Consent WG |
+| **Intent 24** | Service Quality Enforcement | Apply QoS constraints dynamically per application. | Future – Edge QoS Policy API |
+| **Intent 25** | Edge Resource Reservation / Pre-Booking | Reserve compute/storage/network capacity pre-deployment. | Proposed – Edge Reservation API |
+
+---
+
+
+## 5. Harmonised EdgeCloud Lifecycle Flow
+
+```mermaid
+flowchart LR
+ A[Intent 1: Discover Edge Zones] --> B[Intent 3: Retrieve Zone Info]
+ B --> C[Intent 5: Register Application]
+ C --> D[Intent 7: Instantiate Application]
+ D --> E[Intent 9: Register Application Endpoints]
+ E --> F[Intent 11: Discover Optimal Endpoints]
+ F --> G[Intent 13: Apply Traffic Influence - optional]
+ G --> H[Intent 18: Terminate Application]
+```
+```mermaid
+sequenceDiagram
+ participant AP as Application Provider
+ participant OP as Operator Platform
+ participant EIP as Edge Infrastructure Provider
+ participant UE as User Equipment
+ participant AF as Application Function
+
+ Note over AP,OP: Phase 1 - Discovery
+ AP->>OP: POST /discover-optimal-edge-zones
+ OP-->>AP: EdgeCloudZone list ordered by proximity
+
+ Note over AP,OP: Phase 2 - Provisioning & Deployment
+ AP->>OP: POST /applications (Onboard Application)
+ OP-->>AP: Returns appId
+ AP->>OP: POST /applications/{appId}/instances
+ OP->>EIP: Instantiate app in target Edge Zone
+ EIP-->>OP: Instance ready
+ OP-->>AP: appInstanceId + status "RUNNING"
+
+ Note over AP,OP: Phase 3 - Endpoint Management
+ AP->>OP: POST /register (Application Endpoint)
+ OP-->>AP: endpointId confirmation
+
+ Note over UE,OP: Phase 4 - Runtime & Discovery
+ UE->>OP: POST /retrieve-optimal-app-endpoints {appId, device}
+ OP-->>UE: Returns optimal endpoint (EdgeCloudZoneId, endpointURL)
+
+ Note over AF,OP: Phase 5 - Network Optimisation
+ AF->>OP: POST /traffic-influence (toward EAS)
+ OP-->>AF: Returns routing configuration ID
+ UE->>EIP: Connect to optimal EAS endpoint
+```
+# CAMARA EdgeCloud Harmonisation Analysis
+
+## 7. Harmonisation Analysis
+
+### 7.1 API Relationship Summary
+
+- **Simple Edge Discovery**: Provides baseline nearest-zone discovery using network proximity.
+- **Optimal Edge Discovery**: Extends discovery with richer metadata (zone characteristics, latency, region).
+- **Edge Application Management**: Enables deployment and lifecycle control of applications in these zones.
+- **Application Endpoint Registration**: Establishes registry of deployed endpoints.
+- **Application Endpoint Discovery**: Allows clients or servers to dynamically retrieve optimal endpoints.
+- **Traffic Influence**: Complements discovery and lifecycle by providing routing enforcement at the network level.
+
+### 7.2 Common Design Principles
+
+- **Entity Alignment**: Shared objects (e.g., `edgeCloudZoneId`, `appId`, `endpointId`) across all APIs.
+- **Security Consistency**: All APIs assume OAuth2-based access with clear roles.
+- **Consent Integration**: Optional per API (explicit in Discovery and Endpoint APIs).
+- **Operator Neutrality**: APIs work across multiple operators via federated exposure models.
+
+**Conclusion**: CAMARA EdgeCloud APIs collectively address all intents from earlier MEC proposals, forming a continuous lifecycle from discovery → provisioning → runtime → termination.
+
+## 8. Harmonised Data Model Overview
+
+| Entity | Description | Referenced In |
+|--------|-------------|---------------|
+| `edgeCloudZoneId` | Identifier of Edge Cloud Zone | Discovery, Lifecycle, Endpoint APIs |
+| `appId` | Unique application identifier | Lifecycle, Endpoint Discovery |
+| `appInstanceId` | Deployed instance ID | Lifecycle API |
+| `endpointId` | Registered endpoint for a deployed instance | Endpoint Registration & Discovery |
+| `deviceId` | Device identifier or token | Discovery and Endpoint Discovery APIs |
+| `trafficInfluenceId` | Identifier for a network routing session | Traffic Influence API |
+
+## 9. Inter-API Dependencies
+
+| API | Depends On | Dependency Description |
+|-----|------------|------------------------|
+| Simple Edge Discovery | None | Can be used standalone for planning |
+| Optimal Edge Discovery | None | Can be used standalone for planning |
+| Edge Application Management | Optimal Edge Discovery | Uses discovered zones for deployment decisions |
+| Application Endpoint Registration | Edge Cloud Lifecycle Management | Registers endpoints of instantiated applications |
+| Application Endpoint Discovery | Endpoint Registration | Discovers registered endpoints |
+| Traffic Influence | Endpoint Discovery | Optimises routing to discovered endpoints |
+
+**Harmonised APIs together enable a complete closed loop**:
+Discovery → Deployment → Registration → Discovery (endpoint) → Influence → Termination.
+
+## 10. Open Harmonisation Topics
+
+| Area | Description | Next Step |
+|------|-------------|-----------|
+| Unified Discovery Schema | Align Simple and Optimal Edge Discovery response objects | Define a shared `EdgeCloudZoneInfo` schema |
+| Cross-API Security Scopes | Establish unified OAuth2 roles and scopes | Coordinate with Commonalities WG |
+| Consent Management | Define consistent consent-handling process across Discovery and Endpoint APIs | Align with Privacy & Consent WG |
+| Federated Operations | Support discovery and lifecycle across multi-operator environments | Introduce Edge Federation API concept |
+| Traffic Policy Automation | Enable dynamic network steering based on real-time metrics | Collaborate with Network API group |
+
+## 11. References
+
+- **CAMARA – Simple Edge Discovery API**: [User Story](https://github.com/camaraproject/SimpleEdgeDiscovery/blob/main/documentation/API_documentation/SimpleEdgeDiscovery_User_Story.md)
+- **CAMARA – Optimal Edge Discovery API**: [User Story](https://github.com/camaraproject/OptimalEdgeDiscovery/blob/main/documentation/API_documentation/optimal-edge-discovery-User-Story.md)
+- **CAMARA – Edge Application Management**: [User Story](https://github.com/camaraproject/EdgeCloud/blob/main/documentation/SupportingDocuments/API_Documentation/User%20Stories/Edge.Cloud.Lifecycle.Management.User.Story.md)
+- **CAMARA – Application Endpoint Registration API**: [User Story](https://github.com/camaraproject/ApplicationEndpointRegistration/blob/main/documentation/API_documentation/application-endpoint-registration-User-Story.md)
+- **CAMARA – Application Endpoint Discovery API**: [User Story](https://github.com/camaraproject/ApplicationEndpointDiscovery/blob/main/documentation/SupportingDocuments/API_Documentation/User%20Stories/Application%20Endpoint%20Discovery%20User%20Story.md)
+- **CAMARA – Traffic Influence API**: [User Story](https://github.com/camaraproject/TrafficInfluence/blob/main/documentation/API_documentation/traffic-influence-user-story-use-case-1.md)
+- **GSMA – Open Gateway & CAMARA Harmonisation Framework**: [Reference](https://www.hcltech.com/sites/default/files/documents/resources/whitepaper/files/2024/09/16/gsma-open-gateway.pdf?utm_source=chatgpt.com)
+
+
+
diff --git a/marked/EdgeCloud/documentation/SupportingDocuments/README/raw.md b/marked/EdgeCloud/documentation/SupportingDocuments/README/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..37aa0ff405bf918d942905c10a0f435fd46c8ffd
--- /dev/null
+++ b/marked/EdgeCloud/documentation/SupportingDocuments/README/raw.md
@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.
diff --git a/marked/EnergyFootprintNotification/README/raw.md b/marked/EnergyFootprintNotification/README/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..0e263dab5efe77ccc89d08f2a31c389f30911864
--- /dev/null
+++ b/marked/EnergyFootprintNotification/README/raw.md
@@ -0,0 +1,53 @@
+
+
API Provider: role of EFN API provider
• Operator Platform ([EdgeCloud/documentation/SupportingDocuments/Edge terminology/edge_terminology.md at main · camaraproject/EdgeCloud](https://github.com/camaraproject/EdgeCloud/blob/main/documentation/SupportingDocuments/Edge%20terminology/edge_terminology.md)): role of Service host
• End User: both Teclo Operator's subscribers and Service Provider customer, role of Service consumer
• Scope: Computing Services (OGW Taxonomy)| M |
+|NF Requirements|NA| O |
+|Pre-conditions|• The Service Provider onboarded applications on the Operator Platform
• The Service Provider requested the deployment of some instances of those applications
• The Service Provider identifies the Services as collection of application instances
• The Service provided by those instances is up and running.
• The End Users are consuming the Service| M |
+|Begins when|The API Consumer invokes the EFN API to get the Energy consumption of the Service, composed by a set of application instances, in a specific time period.| M |
+|Step 2|The API Provider returns the overall Energy consumption of the Service in that specific time period.| M|
+|Step 4|The API Consumer invokes the EFN API to get the Carbon footprint of the Service, composed by a set of application instances, in a specific time period.| M |
+|Step 5|The API Provider returns the Carbon footprint of the Service in that specific time period.| M|
+|Post-conditions|The Service Provider is aware of the Energy consumption and of the Carbon footprint of the Service in the selected time periods| M |
diff --git a/marked/EnergyFootprintNotification/documentation/API_documentation/README/raw.md b/marked/EnergyFootprintNotification/documentation/API_documentation/README/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..37aa0ff405bf918d942905c10a0f435fd46c8ffd
--- /dev/null
+++ b/marked/EnergyFootprintNotification/documentation/API_documentation/README/raw.md
@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.
diff --git a/marked/EnergyFootprintNotification/documentation/API_documentation/energy-footprint-API-Readiness-Checklist/raw.md b/marked/EnergyFootprintNotification/documentation/API_documentation/energy-footprint-API-Readiness-Checklist/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..814f209ddfc96a434632744bdb766bdeae7aed87
--- /dev/null
+++ b/marked/EnergyFootprintNotification/documentation/API_documentation/energy-footprint-API-Readiness-Checklist/raw.md
@@ -0,0 +1,28 @@
+
+
+# API Readiness Checklist
+
+Checklist for API energy-footprint-notification 0.1.0 in r1.3
+
+
+
+| Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----|
+| 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/energy_footprint_notification.yaml) |
+| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3) |
+| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3) |
+| 4 | API versioning convention applied | M | M | M | M | Y | 0.1.0 |
+| 5 | API documentation | M | M | M | M | Y | inline in YAML |
+| 6 | User stories | O | O | O | M | Y | [link](/documentation/API_documentation/EFN_UserStory_UseCase_1.md) |
+| 7 | Basic API test cases & documentation | O | M | M | M | Y | [Test-EC](/code/Test_definitions/energy-footprint-notification-calculateEnergyConsumption.feature), [Test-CF](/code/Test_definitions/energy-footprint-notification-calculateCarbonFootprint.feature) |
+| 8 | Enhanced API test cases & documentation | O | O | O | M | N | |
+| 9 | Test result statement | O | O | O | M | N | |
+| 10 | API release numbering convention applied | M | M | M | M | Y | r1.3 |
+| 11 | Change log updated | M | M | M | M | Y | |
+| 12 | Previous public-release was certified | O | O | O | M | N | |
+| 13 | API description (for marketing) | O | O | M | M | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/81101707/EnergyFootprintNotification+API+description) |
+
+
+
+
+
diff --git a/marked/EnergyFootprintNotification/documentation/SupportingDocuments/README/raw.md b/marked/EnergyFootprintNotification/documentation/SupportingDocuments/README/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..37aa0ff405bf918d942905c10a0f435fd46c8ffd
--- /dev/null
+++ b/marked/EnergyFootprintNotification/documentation/SupportingDocuments/README/raw.md
@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.
diff --git a/marked/HighThroughputElasticNetworks/README/raw.md b/marked/HighThroughputElasticNetworks/README/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..b1ca34275458294f54ddd15f3b1f3b57e5834e1f
--- /dev/null
+++ b/marked/HighThroughputElasticNetworks/README/raw.md
@@ -0,0 +1,39 @@
+
+
This API is designed for large enterprises requiring efficient network bandwidth management. It dynamically adjusts and optimizes bandwidth utilization to handle high-volume data transmission scenarios such as video conferences, large file transfers, and cloud resource access. By leveraging advanced technologies, it ensures seamless and efficient data flow across different time periods. This API is ideal for organizations that need robust solutions to manage substantial data transfers, ensuring high performance and reliability in demanding network environments.
This API is suitable for customers in industries with massive data transfer requirements, such as Cross-cloud backup, model training at intelligent compute centers, video editing, and scientific computing. For example, the Five-hundred-meter Aperture Spherical radio Telescope (FAST), located in GuiZhou province of China, could generate more than 10 PB of observational data per year. By calling this API, users can dynamically adjust bandwidth and elastically orchestrate network resources according to their specific requirements for bandwidth, latency, and file size. This capability facilitates the efficient and expedient transmission of large observational datasets within short timeframes. In subsequent applications of the API, developers can set multiple groups of input parameters as standard configuration files, enabling quick selection and application.
Input:
1. Bandwidth Requirement: Time-segmented bandwidth requirements (can include multiple time points)
2. Bandwidth Requirement Type: Upload bandwidth, download bandwidth, two-way bandwidth Service
3. Latency Requirement: Latency guarantee requirement range
4. File Requirements: Size of files to be transmitted
5. Guarantee Requirements: Bandwidth guarantee and load sharing requirements
Output:
1. Success or failure
2. Estimation of transmission rate by time segment
3. Estimated transmission duration,
4. Statistical conclusions after successful transmission1. Estimation of transmission rate by time segment
5. (optional) any conditions required for the operator to meet the request (e.g. a particular entry point to the network must be used).
+* Describe, develop, document, and test the APIs
+* Started: November 2024
+
+
+
+
+## Release Information
+
+The repository has no (pre)releases yet, work in progress is within the main branch.
+
+
+## Contributing
+* Meetings are held virtually
+ * Schedule: !! tbd
+ * [Registration / Join](https://wiki.camaraproject.org/x/TQAG) !! Update this link with your meeting registration/join link
+ * Minutes: Access [meeting minutes] !! update this link to your wiki page using the "Share" link
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project 
+
public | stable
public | Status | Comments |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----|
+| 1 | API definition | M | M | M | M | Y | [home-devices-qod.yaml](/code/API_definitions/home-devices-qod.yaml) |
+| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | |
+| 3 | Guidelines from ICM applied | O | M | M | M | Y | |
+| 4 | API versioning convention applied | M | M | M | M | Y | |
+| 5 | API documentation | M | M | M | M | Y | Embedded in [API definition](/code/API_definitions/home-devices-qod.yaml) |
+| 6 | User stories | O | O | O | M | Y | [home-devices-qod-User-Stories.md](/documentation/API_documentation/home-devices-qod-User-Stories.md) |
+| 7 | Basic API test cases & documentation | O | M | M | M | Y | [home-devices-qod.feature](/code/Test_definitions/home-devices-qod.feature) |
+| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [home-devices-qod.feature](/code/Test_definitions/home-devices-qod.feature) |
+| 9 | Test result statement | O | O | O | M | N | |
+| 10 | API release numbering convention applied | M | M | M | M | Y | |
+| 11 | Change log updated | M | M | M | M | Y | [CHANGELOG.md](/CHANGELOG.md) |
+| 12 | Previous public release was certified | O | O | O | M | | |
+| 13 | API description (for marketing) | O | O | M | M | | [wiki link](https://lf-camaraproject.atlassian.net/wiki/xxx) |
+
+To fill the checklist:
+- in the line above the table, replace the api-name, api-version and the rx.y by their actual values for the current API version and release.
+- in the Status column, put "Y" (yes) if the release asset is available or fulfilled in the current release, a "N" (no) or a "tbd". Example use of "tbd" is in case an alpha or release-candidate API version does not yet provide all mandatory assets for the release.
+- in the Comments column, provide the link to the asset once available, and any other relevant comments.
+
+Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.
+
+The documentation for the content of the checklist is here: [API Readiness Checklist](https://wiki.camaraproject.org/x/HQBFAQ)
diff --git a/marked/HomeDevicesQoD/documentation/API_documentation/home-devices-qod-User-Stories/raw.md b/marked/HomeDevicesQoD/documentation/API_documentation/home-devices-qod-User-Stories/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..85f3cd88b13f601ebcde68c6499278008297f060
--- /dev/null
+++ b/marked/HomeDevicesQoD/documentation/API_documentation/home-devices-qod-User-Stories/raw.md
@@ -0,0 +1,11 @@
+**User Story: Configure traffic profile (DSCP)**
+
+
+| **Item** | **Details** |
+| ---- | ------- |
+| ***Summary*** | As an application developer belonging to an enterprise, I want to request (using my application server/backend service) specific QoS behaviours (service classes) to be configured at my end-user's home WiFi access point to ensure the required quality of experience I need for my service/app. |
+| ***Roles, Actors and Scope*** | **Roles:** Customer:User
**Actors:** Application service providers, hyperscalers, application developers.
**Scope:** Configure QoS behaviours to ensure needed quality of experience for a given device within a residential LAN. The expected behaviour is that the target device is the same device where the app is running. |
+| ***Pre-conditions*** |The preconditions are listed below:
|
+| ***Activities/Steps*** | **Starts when:** The server/backend service calls the API specifying the service class required and the target device.
**Ends when:** The requested QoS behaviour (service class) has been configured and the server/backend has being informed about it.
|
+| ***Post-conditions*** | Service class is applied and customer (application developer) app/service continues.
Note that default QoS behaviour could be restored on back-end side at a given frequency (e.g. daily) or on demand by customer doing another call to the API.|
+| ***Exceptions*** | Several exceptions might occur during the Home Devices QoD API operations
|
diff --git a/marked/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2022-11-17/raw.md b/marked/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2022-11-17/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..3b18aa44c5d2a7ac2bc28325a395725b019581b1
--- /dev/null
+++ b/marked/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2022-11-17/raw.md
@@ -0,0 +1,41 @@
+# Camara Home Devices QoD meeting
+
+*17/11/2022*
+
+## Attendees
+
+* Jesús Peña (Telefonica)
+* Josue Igual (Telefonica)
+* Eber Augusto (Telefonica)
+* Mona Mokhber (Telefonica)
+* Anne Matthieu (Orange)
+* Flury Thibaud (Orange)
+* Robert Ludovic (Orange)
+
+Home Devices QoD minutes: [https://github.com/camaraproject/HomeDevicesQoD/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/HomeDevicesQoD/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Kick-off follow-up meetings
+* Recap & Recent Updates
+* Housekeeping
+* Update on issues
+* AOB
+
+## Discussion
+
+| Agenda Item | Description |
+| ----------- | ------------|
+| **Kick-off** | |
+| | Telefonica provides a general view of the API value proposition and a general review of the API YAML definition already uploaded to the github repository. Waiting feedback from partners |
+| **Recap & Recent Updates** | |
+| |
|
+| **Housekeeping** | |
+| | Mailinglist: Please subscribe if not yet done to the mailinglist of the subproject here: [https://lists.camaraproject.org/g/sp-hdp](https://lists.camaraproject.org/g/sp-hdp)
The list will be used for invitations and discussions between members of the sub project. The address is: sp-hdp@lists.camaraproject.org |
+| **Open Issues** | |
+| | [#2](https://github.com/camaraproject/HomeDevicesQoD/issues/2) Pending API update related to CAMARA commonalities issue [#101](https://github.com/camaraproject/WorkingGroups/issues/101). API design would include an anonymised ID is it is eventually agreed on the corresponding CAMARA Commonalities track. |
+| | [#3](https://github.com/camaraproject/HomeDevicesQoD/issues/3) Maintainers. Is anyone interested in joining the maintainers group? In case you are, please comment on this issue.
+Issues: [https://github.com/camaraproject/HomeDevicesQoD/issues](https://github.com/camaraproject/HomeDevicesQoD/issues)
+Pull Requests: [https://github.com/camaraproject/HomeDevicesQoD/pulls](https://github.com/camaraproject/HomeDevicesQoD/pulls)
+
+## Discussion Items
+
+| Agenda Item | Description |
+| ----------- | ------------|
+| **Recap/Updates** | |
+| |
|
+| **New Issues** | |
+| | N/A |
+| **AOB** | |
+| |
The list will be used for invitations and discussions between members of the sub project. The address is: sp-hdp@lists.camaraproject.org |
+| **Open Issues** | |
+| | [#2](https://github.com/camaraproject/HomeDevicesQoD/issues/2) Pending API update related to CAMARA commonalities issue [#101](https://github.com/camaraproject/WorkingGroups/issues/101). API design would include an anonymised ID is it is eventually agreed on the corresponding CAMARA Commonalities track. |
+| | [#3](https://github.com/camaraproject/HomeDevicesQoD/issues/3) Maintainers. Is anyone interested in joining the maintainers group? In case you are, please comment on this issue.
+Issues: [https://github.com/camaraproject/HomeDevicesQoD/issues](https://github.com/camaraproject/HomeDevicesQoD/issues)
+Pull Requests: [https://github.com/camaraproject/HomeDevicesQoD/pulls](https://github.com/camaraproject/HomeDevicesQoD/pulls)
+
+## Discussion Items
+
+| Agenda Item | Description |
+| ----------- | ------------|
+| **Recap/Updates** | |
+| |
|
+| **AOB** | |
+| |
The list will be used for invitations and discussions between members of the sub project. The address is: sp-hdp@lists.camaraproject.org |
+| **Open Issues** | |
+| | [#2](https://github.com/camaraproject/HomeDevicesQoD/issues/2) Pending API update related to CAMARA commonalities issue [#101](https://github.com/camaraproject/WorkingGroups/issues/101). API design would include an anonymised ID is it is eventually agreed on the corresponding CAMARA Commonalities track. |
+| | [#3](https://github.com/camaraproject/HomeDevicesQoD/issues/3) Maintainers. Is anyone interested in joining the maintainers group? In case you are, please comment on this issue.
Comments received from Orange (Robert Ludovic) already answered in the PR itself. It has been agreed to include [some additional clarifications](https://github.com/camaraproject/HomeDevicesQoD/pull/10#issuecomment-1333796244) in the user story doc before merge it. |
+| **AOB** | |
+| | Next Home Devices QoD community call on Dic 15th, UTC 16:00, CET 17:00 (Dic 8th is bank holiday in Spain) |
+
+## Next Steps
+
+* TEF to update PR [#10](https://github.com/camaraproject/HomeDevicesQoD/pull/10) with agreed changes.
diff --git a/marked/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2023-01-12/raw.md b/marked/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2023-01-12/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..ffcb7d1d346a2048e85c12249703d104595f5bd7
--- /dev/null
+++ b/marked/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2023-01-12/raw.md
@@ -0,0 +1,56 @@
+# Camara Home Devices QoD meeting
+
+## Meeting Information
+
+> Meeting Date: 12/01/2023
+
+### Attendees
+
+* Jesús Peña (Telefonica)
+* Emilio Abraham Garrido García (Telefonica)
+* Eber Marins (Telefonica)
+* Christian Duran Gonzalez (Telefonica)
+* Robert Ludovic (Orange)
+* Rafal Artych (DT)
+
+### Agenda
+
+* Recap & Recent Updates
+* Update on issues
+* AOB
+
+Home Devices QoD minutes link:
+[https://github.com/camaraproject/HomeDevicesQoD/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/HomeDevicesQoD/tree/main/documentation/MeetingMinutes)
+
+## Discussion Items
+
+- Repo: [https://github.com/camaraproject/HomeDevicesQoD](https://github.com/camaraproject/HomeDevicesQoD)
+- Issues: [https://github.com/camaraproject/HomeDevicesQoD/issues](https://github.com/camaraproject/HomeDevicesQoD/issues)
+- Pull Requests: [https://github.com/camaraproject/HomeDevicesQoD/pulls](https://github.com/camaraproject/HomeDevicesQoD/pulls)
+
+
+| Agenda Item | Description |
+| ----------- | ------------|
+| **Recap/Updates** | |
+| |
API design would include an anonymised ID is it is eventually agreed on the corresponding CAMARA Commonalities track. |
+| | [#3](https://github.com/camaraproject/HomeDevicesQoD/issues/3) Maintainers.
To be CLOSED as soon DT contact/s are 100% confirmed.
|
+| | [#8](https://github.com/camaraproject/HomeDevicesQoD/issues/8) ~~Aligment with API Design Guidelines Commonality.~~
CLOSED. Addressed in PR [#13](https://github.com/camaraproject/HomeDevicesQoD/pull/13) already MERGED (which replaced PR [#7](https://github.com/camaraproject/HomeDevicesQoD/pull/7)).
|
+| | [#9](https://github.com/camaraproject/HomeDevicesQoD/issues/9) ~~Upload first version of user stories doc in API documentation~~
CLOSED. Addressed in PR [#10](https://github.com/camaraproject/HomeDevicesQoD/pull/10) already MERGED. |
+| **New Issues** | |
+| | [#16](https://github.com/camaraproject/HomeDevicesQoD/issues/16) ~~Upload first version of API documentation~~
CLOSED. Addressed in PR [#15](https://github.com/camaraproject/HomeDevicesQoD/pull/15) already MERGED. |
+| **AOB** | |
+| |
+
+> Mailinglist:
Please subscribe if not yet done to the mailing list of the subproject here: [https://lists.camaraproject.org/g/sp-hdp](https://lists.camaraproject.org/g/sp-hdp)
The list will be used for invitations and discussions between members of the sub project. The address is: sp-hdp@lists.camaraproject.org
\ No newline at end of file
diff --git a/marked/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2023-01-19/raw.md b/marked/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2023-01-19/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..1a81cda48c66502dbd639c41f70a905ad9a90c96
--- /dev/null
+++ b/marked/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2023-01-19/raw.md
@@ -0,0 +1,52 @@
+# Camara Home Devices QoD meeting
+
+## Meeting Information
+
+> Meeting Date: 19/01/2023
+
+### Attendees
+
+* Jesús Peña (Telefonica)
+* Emilio Abraham Garrido García (Telefonica)
+* Eber Marins (Telefonica)
+* Christian Duran Gonzalez (Telefonica)
+* Rafal Artych (DT)
+
+### Agenda
+
+* Recap & Recent Updates
+* Update on issues
+* AOB
+
+Home Devices QoD minutes link:
+[https://github.com/camaraproject/HomeDevicesQoD/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/HomeDevicesQoD/tree/main/documentation/MeetingMinutes)
+
+## Discussion Items
+
+- Repo: [https://github.com/camaraproject/HomeDevicesQoD](https://github.com/camaraproject/HomeDevicesQoD)
+- Issues: [https://github.com/camaraproject/HomeDevicesQoD/issues](https://github.com/camaraproject/HomeDevicesQoD/issues)
+- Pull Requests: [https://github.com/camaraproject/HomeDevicesQoD/pulls](https://github.com/camaraproject/HomeDevicesQoD/pulls)
+
+
+| Agenda Item | Description |
+| ----------- | ------------|
+| **Recap/Updates** | |
+| |
CLOSED. The corresponding CAMARA Commonalities track has been closed with some agreements but not a unique traversal solution. Each API we work on will need to consider additional requirements (if any) to decide which identifiers makes the most sense. So far, in case of Home Devices QoD current definition, it's assumed user authentication (3-legged token). And the user and home network information are deducted from the information included in the access token. There is no user identifier filed included in the API request body. |
+| | [#3](https://github.com/camaraproject/HomeDevicesQoD/issues/3) Maintainers.
To be CLOSED as soon DT contact/s are 100% confirmed.
Working with Noel Wirzius to get technical contact/s from DT and to get them involved in github project and API design. He was expected to provide information during this days. Still no confirmation received from him. So far Rafal Artych (representing DT) is joining weekly calls. He has confirmed that he is speaking with Noel already and next week they hope to be able to confirm who the contact person/s will be. |
+| **New Issues** | |
+| | [#18](https://github.com/camaraproject/HomeDevicesQoD/issues/18) Update API documentation according to v0.2.0 API version
Being addressed in PR [#19](https://github.com/camaraproject/HomeDevicesQoD/pull/19). Updates included so far corresponds to:
|
+| | [#20](https://github.com/camaraproject/HomeDevicesQoD/issues/20) Update commonalities glossary with HomeDevicesQoD-subproject relevant terms
It is related to Commonalities issue [#120](https://github.com/camaraproject/WorkingGroups/pull/120).
+
+> Mailinglist:
Please subscribe if not yet done to the mailing list of the subproject here: [https://lists.camaraproject.org/g/sp-hdp](https://lists.camaraproject.org/g/sp-hdp)
The list will be used for invitations and discussions between members of the sub project. The address is: sp-hdp@lists.camaraproject.org
\ No newline at end of file
diff --git a/marked/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2023-02-02/raw.md b/marked/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2023-02-02/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..f694a41e561d543286220037246b4b4dd83dcdfb
--- /dev/null
+++ b/marked/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2023-02-02/raw.md
@@ -0,0 +1,51 @@
+# Camara Home Devices QoD meeting
+
+## Meeting Information
+
+> Meeting Date: 02/02/2023
+
+### Attendees
+
+* Jesús Peña (Telefonica)
+* Emilio Abraham Garrido García (Telefonica)
+* Rafal Artych (DT)
+* "Mike" - Mihai Lazar (DELL)
+* Vaishali Gupta (DELL)
+
+### Agenda
+
+* Recap & Recent Updates
+* Update on issues
+* AOB
+
+Home Devices QoD minutes link:
+[https://github.com/camaraproject/HomeDevicesQoD/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/HomeDevicesQoD/tree/main/documentation/MeetingMinutes)
+
+## Discussion Items
+
+- Repo: [https://github.com/camaraproject/HomeDevicesQoD](https://github.com/camaraproject/HomeDevicesQoD)
+- Issues: [https://github.com/camaraproject/HomeDevicesQoD/issues](https://github.com/camaraproject/HomeDevicesQoD/issues)
+- Pull Requests: [https://github.com/camaraproject/HomeDevicesQoD/pulls](https://github.com/camaraproject/HomeDevicesQoD/pulls)
+
+
+| Agenda Item | Description |
+| ----------- | ------------|
+| **Recap/Updates** | |
+| |
To be CLOSED as soon DT contact/s are 100% confirmed.
Rafal can't confirm when the DT contact person(s) will be defined. He suggests to bring it up in the next SteerCo (next week). For the moment he will join the calls and keep the lights on. |
+| | [#18](https://github.com/camaraproject/HomeDevicesQoD/issues/18) Update API documentation according to v0.2.0 API version
Being addressed in PR [#19](https://github.com/camaraproject/HomeDevicesQoD/pull/19). Updates included so far corresponds to:
No further changes included last two weeks. |
+| | [#20](https://github.com/camaraproject/HomeDevicesQoD/issues/20) Update commonalities glossary with HomeDevicesQoD-subproject relevant terms
It is related to Commonalities issue [#120](https://github.com/camaraproject/WorkingGroups/pull/120).
No updates on this one. Still not clear how it is going to be handled in CAMARA Commonalities.(*)_To be confirmed depending on the call frequency re-evaluation_
|
+
+
+## Next Steps
+
+* Get the feedback DT may have about uses cases and API design.
(*)_It will most likely have to wait until DT technical contact(s) are confirmed._
+
+
+
+> Mailinglist:
Please subscribe if not yet done to the mailing list of the subproject here: [https://lists.camaraproject.org/g/sp-hdp](https://lists.camaraproject.org/g/sp-hdp)
The list will be used for invitations and discussions between members of the sub project. The address is: sp-hdp@lists.camaraproject.org
\ No newline at end of file
diff --git a/marked/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2023-02-15/raw.md b/marked/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2023-02-15/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..7616b6546e3fb87e56341cea4c8dfc6967816452
--- /dev/null
+++ b/marked/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2023-02-15/raw.md
@@ -0,0 +1,53 @@
+# Camara Home Devices QoD meeting
+
+## Meeting Information
+
+> Meeting Date: 15/02/2023
+
+### Attendees
+
+* Jesús Peña (Telefonica)
+* Emilio Abraham Garrido García (Telefonica)
+* Eber Marins (Telefonica)
+* Christian Duran Gonzalez (Telefonica)
+* Rafal Artych (DT)
+* "Mike" - Mihai Lazar (DELL)
+
+### Agenda
+
+* Recap & Recent Updates
+* Update on issues
+* AOB
+
+Home Devices QoD minutes link:
+[https://github.com/camaraproject/HomeDevicesQoD/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/HomeDevicesQoD/tree/main/documentation/MeetingMinutes)
+
+## Discussion Items
+
+- Repo: [https://github.com/camaraproject/HomeDevicesQoD](https://github.com/camaraproject/HomeDevicesQoD)
+- Issues: [https://github.com/camaraproject/HomeDevicesQoD/issues](https://github.com/camaraproject/HomeDevicesQoD/issues)
+- Pull Requests: [https://github.com/camaraproject/HomeDevicesQoD/pulls](https://github.com/camaraproject/HomeDevicesQoD/pulls)
+
+
+| Agenda Item | Description |
+| ----------- | ------------|
+| **Recap/Updates** | |
+| |
To be CLOSED as soon DT contact/s are 100% confirmed.
Rafal has no news in the matter of DT's technical contacts. No news is expected until after the Mobile World Congress. |
+| | [#18](https://github.com/camaraproject/HomeDevicesQoD/issues/18) Update API documentation according to v0.2.0 API version
Being addressed in PR [#19](https://github.com/camaraproject/HomeDevicesQoD/pull/19). Updates included so far corresponds to:
No further changes included in last two weeks. |
+| | [#20](https://github.com/camaraproject/HomeDevicesQoD/issues/20) Update commonalities glossary with HomeDevicesQoD-subproject relevant terms
It is related to Commonalities issue [#120](https://github.com/camaraproject/WorkingGroups/pull/120).
No updates on this one. Still not clear how it is going to be handled in CAMARA Commonalities.
+
+
+
+
+
+
+
+
+# InHomeDeviceManagement
+
+Sandbox API Repository to describe, develop, document, and test the InHomeDeviceManagement Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/AQCxGw)
+
+## Scope
+
+* Service API(s) “InHomeDeviceManagement” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * §Short API scope description§ !! Add here a scope description according to the API proposal
+* Describe, develop, document, and test the API(s)
+* Started: January 2026
+
+
+
+
+
+## Release Information
+
+The repository has no (pre)releases yet, work in progress is within the main branch.
+
+
+
+## Contributing
+
+* Meetings are held virtually
+
+ * Schedule: !! tbd
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meetings/telcoapi) !! Update this link with your meeting registration/join link and delete the task
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/EACpGw)
+ * Subscribe / Unsubscribe to the mailing list 
+
+
+
+
+
+
+
+
+# IoTDeviceManagement
+
+Sandbox API Repository to describe, develop, document, and test the IoT Device Management Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/boCeBQ)
+
+## Scope
+
+* Service API(s) “IoTDeviceManagement” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * manage communication functions, like activation and deactivation of voice, SMS, data services, and specific APNs, ensuring precise traffic control to prevent overload.
+ * manage device subscription state, perform operations such as adding, activating, suspending, restoring, deactivating, and deleting IoT cards.
+ * support real-time monitoring, provide visibility into the status of IoT cards, enabling continuous supervision and efficient control of service usage and status.
+* Describe, develop, document, and test the API(s)
+* Started: March 2025
+
+
+
+
+
+## Release Information
+
+The repository has no (pre)releases yet, work in progress is within the main branch.
+
+
+## Contributing
+
+* Meetings are held virtually
+ * Schedule: bi-weekly, Tuesday, 13:00 UTC
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/99489769217?password=b970b062-a3ef-4a58-95ed-2b15610d84fb)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/p4CgBQ)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list 
+
+
+
+
+
+
+
+
+# IoTNetworkOptimization
+
+Sandbox API Repository to describe, develop, document, and test the IoTNetworkOptimization Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/AYCzBw)
+* [Provider Implementation](https://github.com/camaraproject/IoTNetworkOptimization_PI)
+
+## Scope
+
+* Service API(s) “IoTNetworkOptimization” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * activate network features for that specific fleet of IoT devices, e.g., energy saving features.
+* Describe, develop, document, and test the API(s)
+* Started: April 2025
+
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> This repository has only pre-release versions available yet. Pre-releases are for testing and may change before public release.
+
+* **PREVIEW**: The latest pre-release is [r1.1](https://github.com/camaraproject/IoTNetworkOptimization/releases/tag/r1.1) (alpha), with the following API versions:
+ * **iot-network-optimization v0.1.0-alpha.1**
+ [[YAML]](https://github.com/camaraproject/IoTNetworkOptimization/blob/r1.1/code/API_definitions/iot-network-optimization.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/IoTNetworkOptimization/r1.1/code/API_definitions/iot-network-optimization.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/IoTNetworkOptimization/r1.1/code/API_definitions/iot-network-optimization.yaml)
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/IoTNetworkOptimization/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings are held virtually
+
+ * Schedule: bi-weekly, Wednesday 10:00 AM - 11:00 AM UTC (12:00 PM -13:00 PM CEST): [wiki Calandar](https://zoom-lfx.platform.linuxfoundation.org/meetings/telcoapi?view=week)
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meetings/telcoapi) !! Update this link with your meeting registration/join link and delete the task
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/T4CzBw)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list 
+
+
+
+
+
+
+
+
+# IoTSIMFraudPrevention
+
+Sandbox API Repository to describe, develop, document, and test the IoT SIM Fraud Prevention Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/xwKaBQ)
+
+## Scope
+
+* Service API(s) “IoTSIMFraudPrevention” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * manage device-card binding, includes bindng/unbinding imei to the card, when the imei is not match with the bind information, operator will block the network, when the imei is match, resume the network..
+ * manage device-area binding, includes binding/unbinding area to the card, when the area is not match with the bind information, operator will block the network, when the area is match, resume the network.
+ * query risk control information related to IoT SIM cards, includes machine-card binding and region restriction.
+* Describe, develop, document, and test the API(s)
+* Started: March 2025
+
+
+
+
+## Release Information
+
+The repository has no (pre)releases yet, work in progress is within the main branch.
+
+
+## Contributing
+* Meetings are held virtually
+ * Schedule: Every 2 weeks on Wednesdays at 9:00 UTC (start from April 30th, 2025)
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/92159554978?password=c5c63329-3b55-4fe0-94d9-9091c51f2ef9)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/GwCfBQ)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list 
+
+
+
+
+
+
+
+
+# KnowYourCustomer
+
+Incubating API Repository to evolve and maintain the definitions and documentation of KnowYourCustomer Service API(s) within the Sub Project [Know Your Customer](https://lf-camaraproject.atlassian.net/wiki/x/I4DGB)
+
+* API wiki page: [Know Your Customer](https://lf-camaraproject.atlassian.net/wiki/x/BjPe)
+
+
+> [!WARNING]
+> After the CAMARA Spring25 meta release this repository has been separated into 3 individual repositories:
+> - [KnowYourCustomerMatch](https://github.com/camaraproject/KnowYourCustomerMatch)
+> - [KnowYourCustomerFill-in](https://github.com/camaraproject/KnowYourCustomerFill-in)
+> - [KnowYourCustomerAgeVerification](https://github.com/camaraproject/KnowYourCustomerAgeVerification)
+>
+> This repository should be only used for maintenance of previous releases. For contributions to the API development please use exclusively the new repositories. Thanks!
+
+
+## Scope
+
+* Service APIs for “KnowYourCustomer” (see APIBacklog.md)
+* The APIs provide the API consumer with the ability to:
+ * compare the information it (Service Provider, SP) has for a particular user with that on file (and verified) by the user's Operator in their own KYC records, in order for the SP to confirm the accuracy of the information and provide a specific service to the user. (KYC Match)
+ * request and receive the information for a particular user, which on file (and verified) by the user's Operator in their own KYC records, in order for the SP to confirm the accuracy of the information and provide a specific service to the user. (KYC Fill-in)
+ * check if the user of the line is older than a provided age, in order to provide API customer's age-restricted services, access to its age-restricted website etc. (KYC Age Verification)
+* Describe, develop, document and test the APIs (with 1-2 Telcos)
+* Started: September 2023
+* Incubating stage since: February 2025
+
+## Release Information
+
+* Note: Please be aware that the project will have updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. For best results, use the latest available release
+
+* `NEW`:**The latest public release of CAMARA Know Your Customer is [r2.2](https://github.com/camaraproject/KnowYourCustomer/tree/r2.2)**. The Release Tag is [r2.2](https://github.com/camaraproject/KnowYourCustomer/releases/tag/r2.2).
+ - Contains the following API definitions **with inline documentation**:
+ - kyc-match: [YAML spec file](https://github.com/camaraproject/KnowYourCustomer/blob/r2.2/code/API_definitions/kyc-match.yaml) | [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r2.2/code/API_definitions/kyc-match.yaml&nocors) | [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r2.2/code/API_definitions/kyc-match.yaml&nocors)
+ - kyc-fill-in: [YAML spec file](https://github.com/camaraproject/KnowYourCustomer/blob/r2.2/code/API_definitions/kyc-fill-in.yaml) | [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r2.2/code/API_definitions/kyc-fill-in.yaml&nocors) | [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r2.2/code/API_definitions/kyc-fill-in.yaml&nocors)
+ - kyc-age-verification: [YAML spec file](https://github.com/camaraproject/KnowYourCustomer/blob/r2.2/code/API_definitions/kyc-age-verification.yaml) | [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r2.2/code/API_definitions/kyc-age-verification.yaml&nocors) | [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r2.2/code/API_definitions/kyc-age-verification.yaml&nocors)
+
+## Contributing
+
+* Meetings are held virtually
+ * Schedule: Bi-weekly, Tuesday, 09:00 CEST (07:00 UTC) (till October 27th 2024)
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/96235150735?password=7e3fea67-a76e-4941-8a70-392cf5545917)
+ * Access [Meeting Minutes](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14551060/KnowYourCustomer+Meeting+Minutes)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project https://lists.camaraproject.org/g/sp-kyc
+ * A message to the community of this Sub Project can be sent using 
+
+ Note:
+
+ * Before calling this API, 3rd parties / enterprise customers who want to use this API should make contract with API provider/ Operator for use of this API. As that will depend on each API provider / MNO's business processes as well as GSMA Open Gateway standard process, it is out of scope of this API definition.
+
+ * When calling this API, at the beginning, there should be required processes for Authentication / Authorisation / End User Consent capturing. As those processes are to be defined as CAMARA commonality standards, they are out of scope of this API definition, however, use of the OpenID Connect (OIDC) is stated as security scheme. **As an important note**, capturing end user consent is necessary, because this API provides end user information (PII).
+
+ * The above mentioned AuthN/AuthZ/End User consent capturing processes can give the API provider/ MNO the 3rd party identity (with the Access Token) and the end user identity (with the ID Token), so the API provider/ MNO can identify the 3rd party / enterprise customer and the end user. Then, it is up to API provider/ MNO to decide which information the 3rd party will receive by calling the API, and also the API provider / MNO is responsible for security and privacy issues.
+
+ * For example, below is a potential operation:
+ * when making contract with API provider/ MNO, a 3rd party / enterprise customer receives its 3rd party identity and also decide which information (attributes) it will receive for its API call
+ * then, API provider / MNO will provide information (attributes) which the 3rd party / enterprise customer is allowed to receive by the contract.
+
+ ### Special Scopes
+
+ This API uses the following special scope kyc-fill-in:set-all which means that the API provider returns an API response as if all these scopes were specified in the scope value in the request:
+ `kyc-fill-in:phoneNumber kyc-fill-in:idDocument kyc-fill-in:name kyc-fill-in:givenName kyc-fill-in:familyName kyc-fill-in:nameKanaHankaku kyc-fill-in:nameKanaZenkaku kyc-fill-in:middleNames kyc-fill-in:familyNameAtBirth kyc-fill-in:address kyc-fill-in:streetName kyc-fill-in:streetNumber kyc-fill-in:postalCode kyc-fill-in:region kyc-fill-in:locality kyc-fill-in:country kyc-fill-in:houseNumberExtension kyc-fill-in:birthdate kyc-fill-in:email kyc-fill-in:gender`
+
+ ## Resources and Operations overview
+
+ The API provides the following endpoint:
+
+ * An endpoint to request information related to an end user against the account data bound to their phone number.
+
+ ## Authorization and authentication
+
+ The "Camara Security and Interoperability Profile" provides details of how an API consumer requests an access token. Please refer to Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the profile.
+
+ The specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst also being subject to the prevailing legal framework dictated by local legislation.
+
+ In cases where personal data is processed by the API and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design.
+
+
+ # Identifying the phone number from the access token
+
+ This API requires the API consumer to identify a phone number as the subject of the API as follows:
+ - When the API is invoked using a two-legged access token, the subject will be identified from the optional `phoneNumber` field, which therefore MUST be provided.
+
+ - When a three-legged access token is used however, this optional identifier MUST NOT be provided, as the subject will be uniquely identified from the access token.
+
+ This approach simplifies API usage for API consumers using a three-legged access token to invoke the API by relying on the information that is associated with the access token and was identified during the authentication process.
+
+ ## Error handling:
+ - If the subject cannot be identified from the access token and the optional `phoneNumber` field is not included in the request, then the server will return an error with the `422 MISSING_IDENTIFIER` error code.
+
+ - If the subject can be identified from the access token and the optional `phoneNumber` field is also included in the request, then the server will return an error with the `422 UNNECESSARY_IDENTIFIER` error code. This will be the case even if the same phone number is identified by these two methods, as the server is unable to make this comparison.
+
+ license:
+ name: Apache 2.0
+ url: https://www.apache.org/licenses/LICENSE-2.0.html
+
+ version: 0.3.0
+ x-camara-commonalities: 0.5
+
+
+servers:
+ - url: '{apiRoot}/kyc-fill-in/v0.3'
+
+ variables:
+ apiRoot:
+ default: http://localhost:9091
+ description: API root, defined by the service provider, e.g. `api.example.com` or `api.example.com/somepath`
+
+tags:
+ - name: Fill-in
+ description: Operations to provide information related to a customer identity stored the account data bound to the customer's phone number.
+
+paths:
+ /fill-in:
+ post:
+ tags:
+ - Fill-in
+ summary: Providing information related to a customer identity stored the account data bound to the customer's phone number.
+
+ operationId: KYC_Fill-in
+
+ security:
+ - openId:
+ - kyc-fill-in:set-all
+ - openId:
+ - kyc-fill-in:phoneNumber
+ - openId:
+ - kyc-fill-in:idDocument
+ - openId:
+ - kyc-fill-in:name
+ - openId:
+ - kyc-fill-in:givenName
+ - openId:
+ - kyc-fill-in:familyName
+ - openId:
+ - kyc-fill-in:nameKanaHankaku
+ - openId:
+ - kyc-fill-in:nameKanaZenkaku
+ - openId:
+ - kyc-fill-in:middleNames
+ - openId:
+ - kyc-fill-in:familyNameAtBirth
+ - openId:
+ - kyc-fill-in:address
+ - openId:
+ - kyc-fill-in:streetName
+ - openId:
+ - kyc-fill-in:streetNumber
+ - openId:
+ - kyc-fill-in:postalCode
+ - openId:
+ - kyc-fill-in:region
+ - openId:
+ - kyc-fill-in:locality
+ - openId:
+ - kyc-fill-in:country
+ - openId:
+ - kyc-fill-in:houseNumberExtension
+ - openId:
+ - kyc-fill-in:birthdate
+ - openId:
+ - kyc-fill-in:email
+ - openId:
+ - kyc-fill-in:gender
+
+ parameters:
+ - $ref: '#/components/parameters/x-correlator'
+
+ requestBody:
+ content:
+ application/json:
+
+ schema:
+ $ref: '#/components/schemas/KYC_FillinRequest'
+ examples:
+ KYC_FillInBodyExample:
+ value:
+ { "phoneNumber": "+34629255833" }
+
+ responses:
+ '200':
+ description: OK
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/KYC_FillinResponse'
+ examples:
+ KYC_Fillin200Example:
+ value:
+ phoneNumber: '+34629255833'
+ idDocument: 66666666q
+ name: Federica Sanchez Arjona
+ givenName: Federica
+ familyName: Sanchez Arjona
+ nameKanaHankaku: federica
+ nameKanaZenkaku: Ｆｅｄｅｒｉｃａ
+ middleNames: Sanchez
+ familyNameAtBirth: YYYY
+ address: Tokyo-to Chiyoda-ku Iidabashi 3-10-10
+ streetName: Nicolas Salmeron
+ streetNumber: 4
+ postalCode: 1028460
+ region: Tokyo
+ locality: ZZZZ
+ country: JP
+ houseNumberExtension: 36
+ birthdate: '1978-08-22'
+ email: abc@example.com
+ gender: male
+
+ "400":
+ $ref: '#/components/responses/Generic400'
+ "401":
+ $ref: '#/components/responses/Generic401'
+ "403":
+ $ref: '#/components/responses/Generic403'
+ "404":
+ $ref: '#/components/responses/Generic404'
+ "422":
+ $ref: '#/components/responses/Generic422'
+
+components:
+ securitySchemes:
+ openId:
+ type: openIdConnect
+ openIdConnectUrl: https://example.com/.well-known/openid-configuration
+
+ headers:
+ X-Correlator:
+ description: Correlation id for the different services
+ required: false
+ schema:
+ type: string
+ pattern: ^[a-zA-Z0-9-]{1,55}$
+ example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
+
+ parameters:
+ x-correlator:
+ name: x-correlator
+ in: header
+ description: Correlation id for the different services
+ schema:
+ type: string
+ pattern: ^[a-zA-Z0-9-]{1,55}$
+ example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
+
+ schemas:
+ KYC_FillinRequest:
+ type: object
+ properties:
+ phoneNumber:
+ type: string
+ description: 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, prefixed with '+'.
+ pattern: '^\+[1-9][0-9]{4,14}$'
+ example: "+123456789"
+
+ KYC_FillinResponse:
+ type: object
+ properties:
+
+ phoneNumber:
+ type: string
+ description: 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, prefixed with '+'.
+ pattern: '^\+[1-9][0-9]{4,14}$'
+ example: "+123456789"
+
+ idDocument:
+ type: string
+ description: Id number associated to the id_document of the customer stored on the Operator's system.
+
+ name:
+ type: string
+ description: Complete name of the customer stored on the Operator's system. It is usually composed of first/given name and last/family/sur- name in a country. Depending on the country, the order of first/give name and last/family/sur- name varies, and middle name could be included. It can use givenName, middleNames, familyName and/or familyNameAtBirth. For example, in ESP, name+familyName; in NLD, it can be name+middleNames+familyName or name+middleNames+familyNameAtBirth, etc.
+
+ givenName:
+ type: string
+ description: First/given name or compound first/given name of the customer on the Operator's system.
+
+ familyName:
+ type: string
+ description: Last name, family name, or surname of the customer stored on the Operator's system.
+
+ nameKanaHankaku:
+ type: string
+ description: Complete name of the customer in Hankaku-Kana format (reading of name) for Japan, stored on the Operator's system.
+
+ nameKanaZenkaku:
+ type: string
+ description: Complete name of the customer in Zenkaku-Kana format (reading of name) for Japan, stored on the Operator's system.
+
+ middleNames:
+ type: string
+ description: Middle name/s of the customer stored on the Operator's system.
+
+ familyNameAtBirth:
+ type: string
+ description: Last/family/sur- name at birth of the customer stored on the Operator's system.
+
+ address:
+ type: string
+ description: Complete address of the customer stored on the Operator's system. For some countries, it is built following the usual concatenation of parameters in a country, but for other countries, this is not the case. For some countries, it can use streetName, streetNumber and/or houseNumberExtension. For example, in ESP, streetName+streetNumber; in NLD, it can be streetName+streetNumber or streetName+streetNumber+houseNumberExtension.
+
+ streetName:
+ type: string
+ description: Name of the street of the customer's address on the Operator's system. It should not include the type of the street.
+
+ streetNumber:
+ type: string
+ description: The street number of the customer's address on the Operator's system. Number identifying a specific property on the 'streetName'.
+
+ postalCode:
+ type: string
+ description: The postal code or Zip code of the customer's address, stored on the Operator's system.
+
+ region:
+ type: string
+ description: Region/prefecture of the customer's address, stored on the Operator's system.
+
+ locality:
+ type: string
+ description: Locality of the customer's address, stored on the Operator's system.
+
+ country:
+ type: string
+ description: Country of the customer's address stored on the Operator's system. Format ISO 3166-1 alpha-2.
+
+ houseNumberExtension:
+ type: string
+ description: House number extension of the customer stored on the Operator's system. Specific identifier of the house needed depending on the property type. For example, number of apartment in an apartment building.
+
+ birthdate:
+ type: string
+ format: date
+ description: Birthdate of the customer, in ISO 8601 calendar date format (YYYY-MM-DD), stored on the Operator's system.
+
+ email:
+ type: string
+ format: email
+ description: Email address of the customer in the RFC specified format (local-part@domain), stored on the Operator's system.
+
+ gender:
+ type: string
+ description: Gender of the customer stored on the Operator's system (male/female/other).
+ enum:
+ - MALE
+ - FEMALE
+ - OTHER
+
+ ErrorInfo:
+ type: object
+ required:
+ - status
+ - code
+ - message
+ properties:
+ status:
+ type: integer
+ description: HTTP response status code
+ code:
+ type: string
+ description: Code given to this error
+ message:
+ type: string
+ description: Detailed error description
+
+ responses:
+ Generic400:
+ description: Bad Request
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 400
+ code:
+ enum:
+ - INVALID_ARGUMENT
+ examples:
+ GENERIC_400_INVALID_ARGUMENT:
+ description: Invalid Argument. Generic Syntax Exception
+ value:
+ status: 400
+ code: INVALID_ARGUMENT
+ message: Client specified an invalid argument, request body or query param.
+
+ Generic401:
+ description: Unauthorized
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 401
+ code:
+ enum:
+ - UNAUTHENTICATED
+ - AUTHENTICATION_REQUIRED
+ examples:
+ GENERIC_401_UNAUTHENTICATED:
+ description: Request cannot be authenticated
+ value:
+ status: 401
+ code: UNAUTHENTICATED
+ message: Request not authenticated due to missing, invalid, or expired credentials.
+ GENERIC_401_AUTHENTICATION_REQUIRED:
+ description: New authentication is needed, authentication is no longer valid
+ value:
+ status: 401
+ code: AUTHENTICATION_REQUIRED
+ message: New authentication is required.
+
+ Generic403:
+ description: Forbidden
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 403
+ code:
+ enum:
+ - PERMISSION_DENIED
+
+ examples:
+ GENERIC_403_PERMISSION_DENIED:
+ description: Permission denied. OAuth2 token access does not have the required scope or when the user fails operational security
+ value:
+ status: 403
+ code: PERMISSION_DENIED
+ message: Client does not have sufficient permissions to perform this action.
+
+ Generic404:
+ description: Not found
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 404
+ code:
+ enum:
+ - IDENTIFIER_NOT_FOUND
+ examples:
+ GENERIC_404_IDENTIFIER_NOT_FOUND:
+ description: The phone number is not associated with a CSP customer account
+ value:
+ status: 404
+ code: IDENTIFIER_NOT_FOUND
+ message: The phone number provided is not associated with a customer account
+
+ Generic422:
+ description: Unprocessable Content
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 422
+ code:
+ enum:
+ - SERVICE_NOT_APPLICABLE
+ - MISSING_IDENTIFIER
+ - UNNECESSARY_IDENTIFIER
+ examples:
+ GENERIC_422_SERVICE_NOT_APPLICABLE:
+ description: Service is not applicable for the provided phone number
+ value:
+ status: 422
+ code: SERVICE_NOT_APPLICABLE
+ message: The service is not applicable for the provided phone number
+ GENERIC_422_MISSING_IDENTIFIER:
+ description: No phone number has been provided either explicitly or associated with the access token
+ value:
+ status: 422
+ code: MISSING_IDENTIFIER
+ message: No phone number has been provided
+ GENERIC_422_UNNECESSARY_IDENTIFIER:
+ description: An explicit phone number has been provided when one is already associated with the access token
+ value:
+ status: 422
+ code: UNNECESSARY_IDENTIFIER
+ message: An explicit phone number has been provided when one is already associated with the access token
+```
diff --git a/marked/KnowYourCustomer/code/API_definitions/kyc-match/raw.md b/marked/KnowYourCustomer/code/API_definitions/kyc-match/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..116e943733a9bd6b1711dc84ef9d6f2dc0c64c20
--- /dev/null
+++ b/marked/KnowYourCustomer/code/API_definitions/kyc-match/raw.md
@@ -0,0 +1,646 @@
+# kyc-match
+
+```yaml
+openapi: 3.0.3
+info:
+ title: Know Your Customer Match
+
+ description: |
+
+ This API provides the customer with the ability to compare the information it (Service Provider, SP) has for a particular mobile phone user with that on file (and verified) by the mobile phone user's Operator in their own KYC records, in order for the SP to confirm the accuracy of the information and provide a specific service to the mobile phone user.
+
+ ## Relevant Definitions and concepts
+
+ * **KYC**: stands for Know Your Customer and it is the process of a business verifying the identity of their clients and assessing their suitability, along with the potential risks of illegal intentions towards the business relationship.
+
+ * **Match Score**: a numerical value that quantifies the similarity between two pieces of text based on the words they contain. This score is often used in various applications like text comparison, plagiarism detection, information retrieval, and natural language processing. The score typically reflects how well the words in one text match the words in another text. In the context of this API, this score will be used to determine how much does the input information looks like the information stored in the Operator's system. Unless otherwise captured in the implementation notes which Operators may publish, score will use the Jaro-Winkler distance algorithm for all countries. This parameter, as optional, will be returned depending on the capability of the Operator to calculate the scoring value. This means that not all Operators will implement this functionality or won't have the requested parameter available. It can happen that an Operator implements the score functionality but, for whatever reason, is not able to calculate it based on the client's input or the related stored information. For these cases, the score property related won't be returned in the response.
+ The range of score values is between "0" and "100", where higher scores indicate a higher similarity between the two compared parameters.
+
+ ## API Functionality
+
+ This API allows API clients to verify the matching of a number of attributes related to a customer identity against the account data bound to their phone number. The API is intended to be used in the following scenarios, for example:
+
+ * To verify the user personal data during the digital registration of an account to a 3rd party service.
+
+ * To prevent fraud, wrong or imprecise information, and/or facilitate the onboarding of a mobile phone user to a 3rd party service.
+
+ The API supports a multi-level hierarchy of property validation. In addition to the initial verification of the `phoneNumber`, an additional `idDocument` validation may occur based on different Operator requirements. This means that, in those cases, if the value of `idDocument` is not provided or it does not match the one bound to the specific phone number in the Operator systems, the operation will return an error.
+
+ The following figure is the generic high-level flows of this API.
+
+ 
+
+ Note:
+
+ * Before calling this API, 3rd parties / enterprise customers who want to use this API should make contact with API provider/ MNO for use of this API. As that will depend on each API provider / MNO's business process as well as GSMA Open Gateway standard process, it is out of scope of this API definition.
+
+ * When calling this API, at the beginning, there should be required processes for Authentication / Authorisation / End User Consent capturing. As those processes are defined as CAMARA commonality standards, they are out of scope of this API definition, however, use of the OpenID Connect (OIDC) is stated as security scheme.
+
+ ## Resources and Operations overview
+
+ The API provides the following endpoint:
+
+ * An endpoint to verify the matching of a number of attributes related to a mobile phone user identity against the account data bound to their phone number.
+
+ # Identifying the phoneNumber from the access token
+
+ This API requires the API consumer to identify a phoneNumber as the subject of the API as follows:
+ - When the API is invoked using a two-legged access token, the subject will be identified from the optional phoneNumber field, which therefore MUST be provided.
+ - When a three-legged access token is used, the subject will be uniquely identified from the access token. So, the optional phoneNumber is not used for identifying the subject, but, if it is provided in the API request body, it needs to match with the one associated with the access token.
+
+ ## Error handling:
+
+ - If the subject cannot be identified from the access token and the optional phoneNumber field is not included in the request, then the server will return an error with the `422 MISSING_IDENTIFIER` error code. This is an error typically, but not uniquely, returned in 2-legged scenarios when the access token doesn't identify a single subscription.
+ - If there is a mismatch between the provided phone number in the request body and the phone number associated with the access token, the server will return an error with the `403 INVALID_TOKEN_CONTEXT` error code.
+
+ # Authorization and authentication
+
+ The "Camara Security and Interoperability Profile" provides details of how an API consumer requests an access token. Please refer to Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the profile.
+
+ The specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst also being subject to the prevailing legal framework dictated by local legislation.
+
+ In cases where personal data is processed by the API and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design.
+
+
+ license:
+ name: Apache 2.0
+ url: https://www.apache.org/licenses/LICENSE-2.0.html
+ version: 0.3.0
+
+ x-camara-commonalities: 0.5
+
+servers:
+ - url: '{apiRoot}/kyc-match/v0.3'
+ variables:
+ apiRoot:
+ default: http://localhost:9091
+ description: API root, defined by the service provider, e.g. `api.example.com` or `api.example.com/somepath`
+
+tags:
+ - name: Match
+ description: Operations to match a customer identity against the account data bound to their phone number.
+
+paths:
+ /match:
+ post:
+ tags:
+ - Match
+ summary: Matching a customer identity by checking a set of attributes related against the account data bound to their phone number.
+ description: |-
+ Verify matching of a number of attributes related to a customer identity against the verified data bound to their phone number in the Operator systems. Regardless of whether the `phoneNumber` is explicitly stated in the request body, at least one of the other fields must be provided, otherwise a `HTTP 400 - KNOW_YOUR_CUSTOMER.INVALID_PARAM_COMBINATION` error will be returned.
+
+ In order to proceed with the match check, some Operators may have the requirement to perform an additional level of validation based on the `idDocument` property. This means that, in those cases, the `idDocument` is required and the provided value needs to match the one stored in the Operator system associated with the indicated `phoneNumber`. This validation will be done before proceeding with the match check of the rest of the properties. The following two rules apply only in the cases where the Operator have the requirement to validate the `idDocument`:
+ - If no `idDocument` is provided, then a `HTTP 403 - KNOW_YOUR_CUSTOMER.ID_DOCUMENT_REQUIRED` error will be returned.
+ - If the provided `idDocument` does not match the one stored in the Operator systems, then a `HTTP 403 - KNOW_YOUR_CUSTOMER.ID_DOCUMENT_MISMATCH` error will be returned.
+
+ The API will return the result of the matching process for each requested attribute. This means that the response will **only** contain the attributes for which validation has been requested. Possible values are:
+ - **true**: the attribute provided matches with the one in the Operator systems.
+ - **false**: the attribute provided does not match with the one in the Operator systems.
+ - **not_available**: the attribute is not available to validate.
+ operationId: KYC_Match
+
+ security:
+ - openId:
+ - kyc-match:match
+
+
+ parameters:
+ - $ref: '#/components/parameters/x-correlator'
+
+ requestBody:
+ required: true
+ content:
+ application/json:
+
+ schema:
+ $ref: '#/components/schemas/KYC_MatchRequestBody'
+ examples:
+ Two-Legged and Three-leg Access Token Example:
+ value:
+ phoneNumber: '+34629255833'
+ idDocument: 66666666q
+ name: Federica Sanchez Arjona
+ givenName: Federica
+ familyName: Sanchez Arjona
+ nameKanaHankaku: federica
+ nameKanaZenkaku: Ｆｅｄｅｒｉｃａ
+ middleNames: Sanchez
+ familyNameAtBirth: YYYY
+ address: Tokyo-to Chiyoda-ku Iidabashi 3-10-10
+ streetName: Nicolas Salmeron
+ streetNumber: '4'
+ postalCode: '1028460'
+ region: Tokyo
+ locality: ZZZZ
+ country: JP
+ houseNumberExtension: VVVV
+ birthdate: '1978-08-22'
+ email: abc@example.com
+ gender: OTHER
+ Three-Legged Without Phone Number Example:
+ value:
+ idDocument: 66666666q
+ name: Federica Sanchez Arjona
+ givenName: Federica
+ familyName: Sanchez Arjona
+ nameKanaHankaku: federica
+ nameKanaZenkaku: Ｆｅｄｅｒｉｃａ
+ middleNames: Sanchez
+ familyNameAtBirth: YYYY
+ address: Tokyo-to Chiyoda-ku Iidabashi 3-10-10
+ streetName: Nicolas Salmeron
+ streetNumber: '4'
+ postalCode: '1028460'
+ region: Tokyo
+ locality: ZZZZ
+ country: JP
+ houseNumberExtension: VVVV
+ birthdate: '1978-08-22'
+ email: abc@example.com
+ gender: OTHER
+
+ responses:
+ '200':
+ description: OK
+ headers:
+ x-correlator:
+ $ref: '#/components/headers/x-correlator'
+
+ content:
+ application/json:
+
+ schema:
+ $ref: '#/components/schemas/KYC_MatchResponse'
+ examples:
+ KYC_Match200Example:
+ value:
+ idDocumentMatch: 'true'
+ nameMatch: 'true'
+ givenNameMatch: 'not_available'
+ familyNameMatch: 'not_available'
+ nameKanaHankakuMatch: 'true'
+ nameKanaZenkakuMatch: 'false'
+ middleNamesMatch: 'true'
+ familyNameAtBirthMatch: 'false'
+ familyNameAtBirthMatchScore: 90
+ addressMatch: 'true'
+ streetNameMatch: 'true'
+ streetNumberMatch: 'true'
+ postalCodeMatch: 'true'
+ regionMatch: 'true'
+ localityMatch: 'not_available'
+ countryMatch: 'true'
+ houseNumberExtensionMatch: 'not_available'
+ birthdateMatch: 'false'
+ emailMatch: 'false'
+ emailMatchScore: 87
+ genderMatch: 'false'
+
+ '400':
+ $ref: '#/components/responses/Generic400'
+
+ '401':
+ $ref: '#/components/responses/Generic401'
+
+ '403':
+ $ref: '#/components/responses/Generic403'
+
+ '404':
+ $ref: '#/components/responses/Generic404'
+
+ '422':
+ $ref: '#/components/responses/Generic422'
+
+components:
+ securitySchemes:
+ openId:
+ type: openIdConnect
+ openIdConnectUrl: https://example.com/.well-known/openid-configuration
+
+
+ headers:
+ x-correlator:
+ description: Correlation id for the different services
+ schema:
+ type: string
+ pattern: ^[a-zA-Z0-9-]{0,55}$
+
+ parameters:
+ x-correlator:
+ name: x-correlator
+ in: header
+ description: Correlation id for the different services
+ schema:
+ type: string
+ pattern: ^[a-zA-Z0-9-]{0,55}$
+ example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
+
+ schemas:
+ KYC_MatchRequestBody:
+ type: object
+ description: Payload to validate the customer data.
+
+ properties:
+ phoneNumber:
+ type: string
+ description: 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, prefixed with '+'.
+ pattern: '^\+[1-9][0-9]{4,14}$'
+ example: "+123456789"
+
+ idDocument:
+ type: string
+ description: Id number associated to the official identity document in the country. It may contain alphanumeric characters.
+
+ name:
+ type: string
+ description: Complete name of the customer, usually composed of first/given name and last/family/sur- name in a country. Depending on the country, the order of first/give name and last/family/sur- name varies, and middle name could be included. It can use givenName, middleNames, familyName and/or familyNameAtBirth. For example, in ESP, name+familyName; in NLD, it can be name+middleNames+familyName or name+middleNames+familyNameAtBirth, etc.
+
+ givenName:
+ type: string
+ description: First/given name or compound first/given name of the customer.
+
+ familyName:
+ type: string
+ description: Last name, family name, or surname of the customer.
+
+ nameKanaHankaku:
+ type: string
+ description: Complete name of the customer in Hankaku-Kana format (reading of name) for Japan.
+
+ nameKanaZenkaku:
+ type: string
+ description: Complete name of the customer in Zenkaku-Kana format (reading of name) for Japan.
+
+ middleNames:
+ type: string
+ description: Middle name/s of the customer.
+
+ familyNameAtBirth:
+ type: string
+ description: Last/family/sur- name at birth of the customer.
+
+ address:
+ type: string
+ description: Complete address of the customer. For some countries, it is built following the usual concatenation of parameters in a country, but for other countries, this is not the case. For some countries, it can use streetName, streetNumber and/or houseNumberExtension. For example, in ESP, streetName+streetNumber; in NLD, it can be streetName+streetNumber or streetName+streetNumber+houseNumberExtension.
+
+ streetName:
+ type: string
+ description: Name of the street of the customer's address. It should not include the type of the street.
+
+ streetNumber:
+ type: string
+ description: The street number of the customer's address. Number identifying a specific property on the 'streetName'.
+
+ postalCode:
+ type: string
+ description: Zip code or postal code
+
+ region:
+ type: string
+ description: Region/prefecture of the customer's address
+
+ locality:
+ type: string
+ description: Locality of the customer's address
+
+ country:
+ type: string
+ description: Country of the customer's address. Format ISO 3166-1 alpha-2
+
+ houseNumberExtension:
+ type: string
+ description: Specific identifier of the house needed depending on the property type. For example, number of apartment in an apartment building.
+
+ birthdate:
+ type: string
+ format: date
+ description: The birthdate of the customer, in RFC 3339 / ISO 8601 calendar date format (YYYY-MM-DD).
+
+ email:
+ type: string
+ format: email
+ description: Email address of the customer in the RFC specified format (local-part@domain).
+
+ gender:
+ type: string
+ description: Gender of the customer (Male/Female/Other).
+ enum:
+ - MALE
+ - FEMALE
+ - OTHER
+
+ MatchResult:
+ type: string
+ enum:
+ - 'true'
+ - 'false'
+ - 'not_available'
+
+ MatchScoreResult:
+ type: integer
+ description: Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator's system. This property shall only be returned when the value of the corresponding match field is `false`.
+ minimum: 0
+ maximum: 100
+
+ KYC_MatchResponse:
+ type: object
+ properties:
+ idDocumentMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether Id number associated to the ID document of the customer matches with the one on the Operator's system.
+ nameMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the complete name of the customer matches with the one on the Operator's system.
+ nameMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ givenNameMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether First name/given name of the customer matches with the one on the Operator's system.
+ givenNameMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ familyNameMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether last name/ family name/ surname of the customer matches with the one on the Operator's system.
+ familyNameMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ nameKanaHankakuMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether complete name of the customer in Hankaku-Kana format (reading of name) for Japan matches with the one on the Operator's system.
+ nameKanaHankakuMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ nameKanaZenkakuMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether complete name of the customer in Zenkaku-Kana format (reading of name) for Japan matches with the one on the Operator's system.
+ nameKanaZenkakuMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ middleNamesMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the middle names of the customer matches with the one on the Operator's system.
+ middleNamesMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ familyNameAtBirthMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the Family Name At Birth of the customer matches with the one on the Operator's system.
+ familyNameAtBirthMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ addressMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether complete address of the customer matches with the one on the Operator's system.
+ addressMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ streetNameMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the street name of the customer matches with the one on the Operator's system.
+ streetNameMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ streetNumberMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the street number of the customer matches with the one on the Operator's system.
+ streetNumberMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ postalCodeMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the postal code / zip code of the customer matches with the one on the Operator's system.
+ regionMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the region of the customer's address matches with the one on the Operator's system.
+ regionMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ localityMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the locality of the customer's address matches with the one on the Operator's system.
+ localityMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ countryMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the country of the customer's address matches with the one on the Operator's system.
+ houseNumberExtensionMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the house number extension of the customer's address with the one on the Operator's system.
+ birthdateMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the birthdate of the customer matches with the one on the Operator's system.
+ emailMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the email address of the customer matches with the one on the Operator's system.
+ emailMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ genderMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the gender of the customer matches with the one on the Operator's system.
+
+ ErrorInfo:
+ type: object
+ required:
+ - status
+ - code
+ - message
+ properties:
+ status:
+ type: integer
+ description: HTTP response status code
+ code:
+ type: string
+ description: Code given to this error
+ message:
+ type: string
+ description: Detailed error description
+
+ responses:
+ Generic400:
+ description: Bad Request
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 400
+ code:
+ enum:
+ - INVALID_ARGUMENT
+ - KNOW_YOUR_CUSTOMER.INVALID_PARAM_COMBINATION
+ examples:
+ GENERIC_400_INVALID_ARGUMENT:
+ description: Invalid Argument. Generic Syntax Exception
+ value:
+ status: 400
+ code: INVALID_ARGUMENT
+ message: Client specified an invalid argument, request body or query param.
+ KNOW_YOUR_CUSTOMER.INVALID_PARAM_COMBINATION:
+ description: Indicated param combination is invalid
+ value:
+ status: 400
+ code: KNOW_YOUR_CUSTOMER.INVALID_PARAM_COMBINATION
+ message: Indicated parameter combination is invalid
+
+ Generic401:
+ description: Unauthorized
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 401
+ code:
+ enum:
+ - UNAUTHENTICATED
+ - AUTHENTICATION_REQUIRED
+ examples:
+ GENERIC_401_UNAUTHENTICATED:
+ description: Request cannot be authenticated
+ value:
+ status: 401
+ code: UNAUTHENTICATED
+ message: Request not authenticated due to missing, invalid, or expired credentials.
+ GENERIC_401_AUTHENTICATION_REQUIRED:
+ description: New authentication is needed, authentication is no longer valid
+ value:
+ status: 401
+ code: AUTHENTICATION_REQUIRED
+ message: New authentication is required.
+
+ Generic403:
+ description: Forbidden
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 403
+ code:
+ enum:
+ - PERMISSION_DENIED
+ - INVALID_TOKEN_CONTEXT
+ - KNOW_YOUR_CUSTOMER.ID_DOCUMENT_REQUIRED
+ - KNOW_YOUR_CUSTOMER.ID_DOCUMENT_MISMATCH
+ examples:
+ GENERIC_403_PERMISSION_DENIED:
+ description: Permission denied. OAuth2 token access does not have the required scope or when the user fails operational security
+ value:
+ status: 403
+ code: PERMISSION_DENIED
+ message: Client does not have sufficient permissions to perform this action.
+ GENERIC_403_INVALID_TOKEN_CONTEXT:
+ description: Reflect some inconsistency between information in some field of the API and the related OAuth2 Token
+ value:
+ status: 403
+ code: INVALID_TOKEN_CONTEXT
+ message: "phoneNumber is not consistent with access token."
+ KNOW_YOUR_CUSTOMER.ID_DOCUMENT_REQUIRED:
+ description: The idDocument is required by the implementation
+ value:
+ status: 403
+ code: KNOW_YOUR_CUSTOMER.ID_DOCUMENT_REQUIRED
+ message: The idDocument is required to perform the properties validation
+ KNOW_YOUR_CUSTOMER.ID_DOCUMENT_MISMATCH:
+ description: idDocument mismatch
+ value:
+ status: 403
+ code: KNOW_YOUR_CUSTOMER.ID_DOCUMENT_MISMATCH
+ message: The idDocument needs to match the one associated with the provided phoneNumber
+
+ Generic404:
+ description: Not found
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 404
+ code:
+ enum:
+ - NOT_FOUND
+ - IDENTIFIER_NOT_FOUND
+ examples:
+ GENERIC_404_NOT_FOUND:
+ description: Resource is not found
+ value:
+ status: 404
+ code: NOT_FOUND
+ GENERIC_404_IDENTIFIER_NOT_FOUND:
+ description: The phone number is not associated with a CSP customer account
+ value:
+ status: 404
+ code: IDENTIFIER_NOT_FOUND
+ message: The phone number provided is not associated with a customer account
+
+ Generic422:
+ description: Unprocessable Content
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 422
+ code:
+ enum:
+ - SERVICE_NOT_APPLICABLE
+ - MISSING_IDENTIFIER
+ examples:
+ GENERIC_422_SERVICE_NOT_APPLICABLE:
+ description: Service is not applicable for the provided phone number
+ value:
+ status: 422
+ code: SERVICE_NOT_APPLICABLE
+ message: The service is not applicable for the provided phone number
+ GENERIC_422_MISSING_IDENTIFIER:
+ description: No phone number has been provided either explicitly or associated with the access token
+ value:
+ status: 422
+ code: MISSING_IDENTIFIER
+ message: No phone number has been provided
+```
diff --git a/marked/KnowYourCustomer/documentation/API_documentation/KYC-Fill-in/raw.md b/marked/KnowYourCustomer/documentation/API_documentation/KYC-Fill-in/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..57b06aef04ea15329d39ec08c28a94325c03a451
--- /dev/null
+++ b/marked/KnowYourCustomer/documentation/API_documentation/KYC-Fill-in/raw.md
@@ -0,0 +1,40 @@
+# CAMARA KnowYourCustomer KYC Fill-in API
+
+(NOTE: This API description is supposed to be incorporated into the YAML definition file in the future releases.)
+
+This API provides the customer with the ability request and receive the information for a particular user, which on file (and verified) by the user's Operator in their own KYC records, in order for the SP to confirm the accuracy of the information and provide a specific service to the user.
+
+## Relevant Definitions and concepts
+
+* **KYC**: stands for Know Your Customer and it is the process of a business verifying the identity of their clients and assessing their suitability, along with the potential risks of illegal intentions towards the business relationship.
+
+## API Functionality
+
+This API allows API clients to request for API provider / MNO to provide information related to a mobile phone user, derived from the account data bound to their phone number. The API is intended to be used in the following scenario, for example:
+
+* To fill-in the user personal data during the digital registration of an account to a 3rd party service.
+
+The following figure is the generic high-level flows of this API.
+
+
+
+
+
+
+
+
+
+
+# KnowYourCustomerAgeVerification
+
+Sandbox API Repository to describe, develop, document, and test the KnowYourCustomerAgeVerification Service API(s) within the Sub Project [Know Your Customer](https://lf-camaraproject.atlassian.net/wiki/x/I4DGB).
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/mYAzC)
+
+## Scope
+
+* Service API(s) “KnowYourCustomerAgeVerification” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * check if the user of the line is older than a provided age, in order to provide API customer's age-restricted services, access to its age-restricted website etc..
+* Describe, develop, document, and test the API(s)
+* Started: September 2023 (within [KnowYourCustomer](https://github.com/camaraproject/KnowYourCustomer))
+* Incubating stage since: February 2025
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r1.3](https://github.com/camaraproject/KnowYourCustomerAgeVerification/releases/tag/r1.3) (Fall25), with the following API versions:
+ * **kyc-age-verification v0.2.1**
+ [[YAML]](https://github.com/camaraproject/KnowYourCustomerAgeVerification/blob/r1.3/code/API_definitions/kyc-age-verification.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomerAgeVerification/r1.3/code/API_definitions/kyc-age-verification.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomerAgeVerification/r1.3/code/API_definitions/kyc-age-verification.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/KnowYourCustomerAgeVerification/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/KnowYourCustomerAgeVerification/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/KnowYourCustomerAgeVerification/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+* **Releases of the CAMARA KYC Age Verification API until Spring25 are available in [KnowYourCustomer](https://github.com/camaraproject/KnowYourCustomer).**
+
+## Contributing
+
+* Meetings are held virtually
+
+ * Schedule: bi-weekly, Tuesday, 08:00 UTC (09:00 CET, 10:00 CEST). For date/time of the next meeting, see previous meeting minutes.
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/96235150735?password=7e3fea67-a76e-4941-8a70-392cf5545917)
+ * Access [Meeting Minutes](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14551060/KnowYourCustomer+Meeting+Minutes)
+
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list 
+
+
+
+
+
+
+
+
+# KnowYourCustomerFill-in
+
+Incubating API Repository to evolve and maintain the definitions and documentation of KnowYourCustomerFill-in Service API(s) within the Sub Project [Know Your Customer](https://lf-camaraproject.atlassian.net/wiki/x/I4DGB)
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/AYAzC)
+
+## Scope
+
+* Service API(s) “KnowYourCustomerFill-in” (see APIBacklog.md)
+* The API provides the API consumer with the ability to:
+ * request and receive the information for a particular end user, which is on file (and verified) by the end user's Operator in their own KYC records, in order for the service provider (API consumer) to confirm the accuracy of the information and provide a specific service to the end user.
+* Describe, develop, document, and test the API(s)
+* Started: September 2023 (within [KnowYourCustomer](https://github.com/camaraproject/KnowYourCustomer))
+* Incubating stage since: February 2025
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r1.3](https://github.com/camaraproject/KnowYourCustomerFill-in/releases/tag/r1.3) (Fall25), with the following API versions:
+ * **kyc-fill-in v0.4.1**
+ [[YAML]](https://github.com/camaraproject/KnowYourCustomerFill-in/blob/r1.3/code/API_definitions/kyc-fill-in.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomerFill-in/r1.3/code/API_definitions/kyc-fill-in.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomerFill-in/r1.3/code/API_definitions/kyc-fill-in.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/KnowYourCustomerFill-in/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/KnowYourCustomerFill-in/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/KnowYourCustomerFill-in/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+* Note: **Releases of the KnowYourCustomerFill-in API until Spring25 are available in [KnowYourCustomer](https://github.com/camaraproject/KnowYourCustomer).**
+
+## Contributing
+
+* Meetings are held virtually
+
+ * Schedule: bi-weekly, Tuesday, 08:00 UTC (09:00 CET, 10:00 CEST). For date/time of the next meeting, see previous meeting minutes.
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/96235150735?password=7e3fea67-a76e-4941-8a70-392cf5545917)
+ * Access [Meeting Minutes](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14551060/KnowYourCustomer+Meeting+Minutes)
+
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list 
+
+ Note:
+
+ * Before calling this API, 3rd parties / enterprise customers who want to use this API should make contract with API provider/ Operator for use of this API. As that will depend on each API provider / MNO's business processes as well as GSMA Open Gateway standard process, it is out of scope of this API definition.
+
+ * When calling this API, at the beginning, there should be required processes for Authentication / Authorisation / End User Consent capturing. As those processes are to be defined as CAMARA commonality standards, they are out of scope of this API definition, however, use of the OpenID Connect (OIDC) is stated as security scheme. **As an important note**, capturing end user consent is necessary, because this API provides end user information (PII).
+
+ * The above mentioned AuthN/AuthZ/End User consent capturing processes can give the API provider/ MNO the 3rd party identity (with the Access Token) and the end user identity (with the ID Token), so the API provider/ MNO can identify the 3rd party / enterprise customer and the end user. Then, it is up to API provider/ MNO to decide which information the 3rd party will receive by calling the API, and also the API provider / MNO is responsible for security and privacy issues.
+
+ * For example, below is a potential operation:
+ * when making contract with API provider/ MNO, a 3rd party / enterprise customer receives its 3rd party identity and also decide which information (attributes) it will receive for its API call
+ * then, API provider / MNO will provide information (attributes) which the 3rd party / enterprise customer is allowed to receive by the contract.
+
+ ### Special Scopes
+
+ This API uses the following special scope `kyc-fill-in:set-all` which means that the API provider returns an API response as if all these scopes were specified in the scope value in the request:
+
+ `kyc-fill-in:phoneNumber kyc-fill-in:idDocument kyc-fill-in:idDocumentType kyc-fill-in:idDocumentExpiryDate kyc-fill-in:name kyc-fill-in:givenName kyc-fill-in:familyName kyc-fill-in:nameKanaHankaku kyc-fill-in:nameKanaZenkaku kyc-fill-in:middleNames kyc-fill-in:familyNameAtBirth kyc-fill-in:address kyc-fill-in:streetName kyc-fill-in:streetNumber kyc-fill-in:postalCode kyc-fill-in:region kyc-fill-in:locality kyc-fill-in:country kyc-fill-in:houseNumberExtension kyc-fill-in:birthdate kyc-fill-in:email kyc-fill-in:gender kyc-fill-in:cityOfBirth kyc-fill-in:countryOfBirth kyc-fill-in:nationality`
+
+ ## Resources and Operations overview
+
+ The API provides the following endpoint:
+
+ * An endpoint to request information related to an end user against the account data bound to their phone number.
+
+ ## Authorization and authentication
+
+ The "Camara Security and Interoperability Profile" provides details of how an API consumer requests an access token. Please refer to Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the profile.
+
+ The specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst also being subject to the prevailing legal framework dictated by local legislation.
+
+ In cases where personal data is processed by the API and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design.
+
+
+ # Identifying the phone number from the access token
+
+ This API requires the API consumer to identify a phone number as the subject of the API as follows:
+ - When the API is invoked using a two-legged access token, the subject will be identified from the optional `phoneNumber` field, which therefore MUST be provided.
+
+ - When a three-legged access token is used however, this optional identifier MUST NOT be provided, as the subject will be uniquely identified from the access token.
+
+ This approach simplifies API usage for API consumers using a three-legged access token to invoke the API by relying on the information that is associated with the access token and was identified during the authentication process.
+
+ ## Error handling:
+ - If the subject cannot be identified from the access token and the optional `phoneNumber` field is not included in the request, then the server will return an error with the `422 MISSING_IDENTIFIER` error code.
+
+ - If the subject can be identified from the access token and the optional `phoneNumber` field is also included in the request, then the server will return an error with the `422 UNNECESSARY_IDENTIFIER` error code. This will be the case even if the same phone number is identified by these two methods, as the server is unable to make this comparison.
+
+ ### Additional CAMARA error responses
+ The list of error codes in this API specification is not exhaustive. Therefore the API specification may not document some non-mandatory error statuses as indicated in `CAMARA API Design Guide`.
+
+ Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version.
+
+ As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API.
+
+ license:
+ name: Apache 2.0
+ url: https://www.apache.org/licenses/LICENSE-2.0.html
+
+ version: wip
+ x-camara-commonalities: 0.6
+
+externalDocs:
+ description: Product documentation at CAMARA.
+ url: https://github.com/camaraproject/KnowYourCustomerFill-in
+
+servers:
+ - url: '{apiRoot}/kyc-fill-in/vwip'
+
+ variables:
+ apiRoot:
+ default: http://localhost:9091
+ description: API root, defined by the service provider, e.g. `api.example.com` or `api.example.com/somepath`
+
+tags:
+ - name: Fill-in
+ description: Operations to provide information related to a customer identity stored the account data bound to the customer's phone number.
+
+paths:
+ /fill-in:
+ post:
+ tags:
+ - Fill-in
+ summary: Providing information related to a customer identity stored the account data bound to the customer's phone number.
+
+ operationId: KYC_Fill-in
+
+ security:
+ - openId:
+ - kyc-fill-in:set-all
+ - openId:
+ - kyc-fill-in:phoneNumber
+ - openId:
+ - kyc-fill-in:idDocument
+ - openId:
+ - kyc-fill-in:idDocumentType
+ - openId:
+ - kyc-fill-in:idDocumentExpiryDate
+ - openId:
+ - kyc-fill-in:name
+ - openId:
+ - kyc-fill-in:givenName
+ - openId:
+ - kyc-fill-in:familyName
+ - openId:
+ - kyc-fill-in:nameKanaHankaku
+ - openId:
+ - kyc-fill-in:nameKanaZenkaku
+ - openId:
+ - kyc-fill-in:middleNames
+ - openId:
+ - kyc-fill-in:familyNameAtBirth
+ - openId:
+ - kyc-fill-in:address
+ - openId:
+ - kyc-fill-in:streetName
+ - openId:
+ - kyc-fill-in:streetNumber
+ - openId:
+ - kyc-fill-in:postalCode
+ - openId:
+ - kyc-fill-in:region
+ - openId:
+ - kyc-fill-in:locality
+ - openId:
+ - kyc-fill-in:country
+ - openId:
+ - kyc-fill-in:houseNumberExtension
+ - openId:
+ - kyc-fill-in:birthdate
+ - openId:
+ - kyc-fill-in:email
+ - openId:
+ - kyc-fill-in:gender
+ - openId:
+ - kyc-fill-in:cityOfBirth
+ - openId:
+ - kyc-fill-in:countryOfBirth
+ - openId:
+ - kyc-fill-in:nationality
+
+ parameters:
+ - $ref: '#/components/parameters/x-correlator'
+
+ requestBody:
+ required: true
+ content:
+ application/json:
+
+ schema:
+ $ref: '#/components/schemas/KYC_FillinRequest'
+ examples:
+ KYC_FillInBodyExample:
+ value:
+ {"phoneNumber": "+34629255833"}
+
+ responses:
+ '200':
+ description: OK
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/KYC_FillinResponse'
+ examples:
+ KYC_Fillin200Example:
+ value:
+ phoneNumber: '+34629255833'
+ idDocument: 66666666q
+ idDocumentType: passport
+ idDocumentExpiryDate: '2027-07-12'
+ name: Federica Sanchez Arjona
+ givenName: Federica
+ familyName: Sanchez Arjona
+ nameKanaHankaku: federica
+ nameKanaZenkaku: Ｆｅｄｅｒｉｃａ
+ middleNames: Sanchez
+ familyNameAtBirth: YYYY
+ address: Tokyo-to Chiyoda-ku Iidabashi 3-10-10
+ streetName: Nicolas Salmeron
+ streetNumber: '4'
+ postalCode: '1028460'
+ region: Tokyo
+ locality: ZZZZ
+ country: JP
+ houseNumberExtension: '36'
+ birthdate: '1978-08-22'
+ email: abc@example.com
+ gender: MALE
+ cityOfBirth: Madrid
+ countryOfBirth: ES
+ nationality: ES
+
+ "400":
+ $ref: '#/components/responses/Generic400'
+ "401":
+ $ref: '#/components/responses/Generic401'
+ "403":
+ $ref: '#/components/responses/Generic403'
+ "404":
+ $ref: '#/components/responses/Generic404'
+ "422":
+ $ref: '#/components/responses/Generic422'
+
+components:
+ securitySchemes:
+ openId:
+ type: openIdConnect
+ openIdConnectUrl: https://example.com/.well-known/openid-configuration
+
+ headers:
+ X-Correlator:
+ description: Correlation id for the different services
+ required: false
+ schema:
+ $ref: "#/components/schemas/XCorrelator"
+
+ parameters:
+ x-correlator:
+ name: x-correlator
+ in: header
+ description: Correlation id for the different services
+ schema:
+ $ref: "#/components/schemas/XCorrelator"
+
+ schemas:
+ KYC_FillinRequest:
+ type: object
+ properties:
+ phoneNumber:
+ type: string
+ description: 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, prefixed with '+'.
+ pattern: '^\+[1-9][0-9]{4,14}$'
+ example: "+123456789"
+
+ KYC_FillinResponse:
+ type: object
+ properties:
+
+ phoneNumber:
+ type: string
+ description: 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, prefixed with '+'.
+ pattern: '^\+[1-9][0-9]{4,14}$'
+ example: "+123456789"
+
+ idDocument:
+ type: string
+ description: Id number associated to the id_document of the customer stored on the Operator's system.
+
+ idDocumentType:
+ type: string
+ enum: [passport, national_id_card, residence_permit, diplomatic_id, driver_licence, social_security_id, other]
+ description: Type of the official identity document provided.
+
+ idDocumentExpiryDate:
+ type: string
+ format: date
+ description: Expiration date of the identity document (ISO 8601).
+
+ name:
+ type: string
+ description: Complete name of the customer stored on the Operator's system. It is usually composed of first/given name and last/family/sur- name in a country. Depending on the country, the order of first/give name and last/family/sur- name varies, and middle name could be included. It can use givenName, middleNames, familyName and/or familyNameAtBirth. For example, in ESP, name+familyName; in NLD, it can be name+middleNames+familyName or name+middleNames+familyNameAtBirth, etc.
+
+ givenName:
+ type: string
+ description: First/given name or compound first/given name of the customer on the Operator's system.
+
+ familyName:
+ type: string
+ description: Last name, family name, or surname of the customer stored on the Operator's system.
+
+ nameKanaHankaku:
+ type: string
+ description: Complete name of the customer in Hankaku-Kana format (reading of name) for Japan, stored on the Operator's system.
+
+ nameKanaZenkaku:
+ type: string
+ description: Complete name of the customer in Zenkaku-Kana format (reading of name) for Japan, stored on the Operator's system.
+
+ middleNames:
+ type: string
+ description: Middle name/s of the customer stored on the Operator's system.
+
+ familyNameAtBirth:
+ type: string
+ description: Last/family/sur- name at birth of the customer stored on the Operator's system.
+
+ address:
+ type: string
+ description: Complete address of the customer stored on the Operator's system. For some countries, it is built following the usual concatenation of parameters in a country, but for other countries, this is not the case. For some countries, it can use streetName, streetNumber and/or houseNumberExtension. For example, in ESP, streetName+streetNumber; in NLD, it can be streetName+streetNumber or streetName+streetNumber+houseNumberExtension.
+
+ streetName:
+ type: string
+ description: Name of the street of the customer's address on the Operator's system. It should not include the type of the street.
+
+ streetNumber:
+ type: string
+ description: The street number of the customer's address on the Operator's system. Number identifying a specific property on the 'streetName'.
+
+ postalCode:
+ type: string
+ description: The postal code or Zip code of the customer's address, stored on the Operator's system.
+
+ region:
+ type: string
+ description: Region/prefecture of the customer's address, stored on the Operator's system.
+
+ locality:
+ type: string
+ description: Locality of the customer's address, stored on the Operator's system.
+
+ country:
+ type: string
+ description: Country of the customer's address stored on the Operator's system. Format ISO 3166-1 alpha-2.
+
+ houseNumberExtension:
+ type: string
+ description: House number extension of the customer stored on the Operator's system. Specific identifier of the house needed depending on the property type. For example, number of apartment in an apartment building.
+
+ birthdate:
+ type: string
+ format: date
+ description: Birthdate of the customer, in ISO 8601 calendar date format (YYYY-MM-DD), stored on the Operator's system.
+
+ email:
+ type: string
+ format: email
+ description: Email address of the customer in the RFC specified format (local-part@domain), stored on the Operator's system.
+
+ gender:
+ type: string
+ description: Gender of the customer stored on the Operator's system (Male/Female/Other).
+ enum:
+ - MALE
+ - FEMALE
+ - OTHER
+
+ cityOfBirth:
+ type: string
+ description: City where the customer was born.
+
+ countryOfBirth:
+ type: string
+ description: Country where the customer was born. Format ISO 3166-1 alpha-2.
+
+ nationality:
+ type: string
+ description: ISO 3166-1 alpha-2 code of the customer’s nationality. In the case a customer has more than one nationality, it is supposed to be the nationality related to the ID document provided in the match request.
+
+ ErrorInfo:
+ type: object
+ required:
+ - status
+ - code
+ - message
+ properties:
+ status:
+ type: integer
+ description: HTTP response status code
+ code:
+ type: string
+ description: A human-readable code to describe the error
+ message:
+ type: string
+ description: A human-readable description of what the event represents
+
+ XCorrelator:
+ type: string
+ pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
+ example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
+
+ responses:
+ Generic400:
+ description: Bad Request
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 400
+ code:
+ enum:
+ - INVALID_ARGUMENT
+ examples:
+ GENERIC_400_INVALID_ARGUMENT:
+ description: Invalid Argument. Generic Syntax Exception
+ value:
+ status: 400
+ code: INVALID_ARGUMENT
+ message: Client specified an invalid argument, request body or query param.
+
+ Generic401:
+ description: Unauthorized
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 401
+ code:
+ enum:
+ - UNAUTHENTICATED
+ examples:
+ GENERIC_401_UNAUTHENTICATED:
+ description: Request cannot be authenticated and a new authentication is required
+ value:
+ status: 401
+ code: UNAUTHENTICATED
+ message: Request not authenticated due to missing, invalid, or expired credentials. A new authentication is required.
+
+ Generic403:
+ description: Forbidden
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 403
+ code:
+ enum:
+ - PERMISSION_DENIED
+
+ examples:
+ GENERIC_403_PERMISSION_DENIED:
+ description: Permission denied. OAuth2 token access does not have the required scope or when the user fails operational security
+ value:
+ status: 403
+ code: PERMISSION_DENIED
+ message: Client does not have sufficient permissions to perform this action.
+
+ Generic404:
+ description: Not found
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 404
+ code:
+ enum:
+ - IDENTIFIER_NOT_FOUND
+ examples:
+ GENERIC_404_IDENTIFIER_NOT_FOUND:
+ description: The phone number is not associated with a CSP customer account
+ value:
+ status: 404
+ code: IDENTIFIER_NOT_FOUND
+ message: The phone number provided is not associated with a customer account
+
+ Generic422:
+ description: Unprocessable Content
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 422
+ code:
+ enum:
+ - SERVICE_NOT_APPLICABLE
+ - MISSING_IDENTIFIER
+ - UNNECESSARY_IDENTIFIER
+ examples:
+ GENERIC_422_SERVICE_NOT_APPLICABLE:
+ description: Service is not applicable for the provided phone number
+ value:
+ status: 422
+ code: SERVICE_NOT_APPLICABLE
+ message: The service is not applicable for the provided phone number
+ GENERIC_422_MISSING_IDENTIFIER:
+ description: No phone number has been provided either explicitly or associated with the access token
+ value:
+ status: 422
+ code: MISSING_IDENTIFIER
+ message: No phone number has been provided
+ GENERIC_422_UNNECESSARY_IDENTIFIER:
+ description: An explicit phone number has been provided when one is already associated with the access token
+ value:
+ status: 422
+ code: UNNECESSARY_IDENTIFIER
+ message: An explicit phone number has been provided when one is already associated with the access token
+```
diff --git a/marked/KnowYourCustomerFill-in/documentation/API_documentation/KnowYourCustomer_User_Story/raw.md b/marked/KnowYourCustomerFill-in/documentation/API_documentation/KnowYourCustomer_User_Story/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..f837f2947c4437abaf6904c2a3a23ffc0a966ef5
--- /dev/null
+++ b/marked/KnowYourCustomerFill-in/documentation/API_documentation/KnowYourCustomer_User_Story/raw.md
@@ -0,0 +1,27 @@
+**User Story: KYC Match - verify customer information**
+
+
+
+
+
+
+
+
+
+# KnowYourCustomerMatch
+
+Incubating API Repository to evolve and maintain the definitions and documentation of KnowYourCustomerMatch Service API(s) within the Sub Project [Know Your Customer](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/80117795/Know+Your+Customer)
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/EQAzC)
+
+## Scope
+
+* Service API(s) “KnowYourCustomerMatch” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * compare the information that the Service Provider (SP) has for a particular user with that on file (and verified) by the user's Operator in their own KYC records, in order for the SP to confirm the accuracy of the information and provide a specific service to the user.
+* Describe, develop, document, and test the API(s)
+* Started: September 2023 (within [KnowYourCustomer](https://github.com/camaraproject/KnowYourCustomer))
+* Incubating stage since: February 2025
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r1.2](https://github.com/camaraproject/KnowYourCustomerMatch/releases/tag/r1.2) (Fall25), with the following API versions:
+ * **kyc-match v0.4.0**
+ [[YAML]](https://github.com/camaraproject/KnowYourCustomerMatch/blob/r1.2/code/API_definitions/kyc-match.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomerMatch/r1.2/code/API_definitions/kyc-match.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomerMatch/r1.2/code/API_definitions/kyc-match.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/KnowYourCustomerMatch/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/KnowYourCustomerMatch/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/KnowYourCustomerMatch/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+* Note: **Releases of the KnowYourCustomerMatch API until Spring25 are available in [KnowYourCustomer](https://github.com/camaraproject/KnowYourCustomer).**
+
+## Contributing
+
+* Meetings are held virtually
+
+ * Schedule: bi-weekly, Tuesday, 08:00 UTC (09:00 CET, 10:00 CEST). For date/time of the next meeting, see previous meeting minutes.
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/96235150735?password=7e3fea67-a76e-4941-8a70-392cf5545917)
+ * Access [Meeting Minutes](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14551060/KnowYourCustomer+Meeting+Minutes)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list 
+
+ Note:
+
+ * Before calling this API, 3rd parties / enterprise customers who want to use this API should make contact with API provider/ MNO for use of this API. As that will depend on each API provider / MNO's business process as well as GSMA Open Gateway standard process, it is out of scope of this API definition.
+
+ * When calling this API, at the beginning, there should be required processes for Authentication / Authorisation / End User Consent capturing. As those processes are defined as CAMARA commonality standards, they are out of scope of this API definition, however, use of the OpenID Connect (OIDC) is stated as security scheme.
+
+ ## Resources and Operations overview
+
+ The API provides the following endpoint:
+
+ * An endpoint to verify the matching of a number of attributes related to a mobile phone user identity against the account data bound to their phone number.
+
+ # Identifying the phoneNumber from the access token
+
+ This API requires the API consumer to identify a phoneNumber as the subject of the API as follows:
+ - When the API is invoked using a two-legged access token, the subject will be identified from the optional phoneNumber field, which therefore MUST be provided.
+ - When a three-legged access token is used, the subject will be uniquely identified from the access token. So, the optional phoneNumber is not used for identifying the subject, but, if it is provided in the API request body, it needs to match with the one associated with the access token.
+
+ ## Error handling:
+
+ - If the subject cannot be identified from the access token and the optional phoneNumber field is not included in the request, then the server will return an error with the `422 MISSING_IDENTIFIER` error code. This is an error typically, but not uniquely, returned in 2-legged scenarios when the access token doesn't identify a single subscription.
+ - If there is a mismatch between the provided phone number in the request body and the phone number associated with the access token, the server will return an error with the `403 INVALID_TOKEN_CONTEXT` error code.
+
+ ### Additional CAMARA error responses
+ The list of error codes in this API specification is not exhaustive. Therefore the API specification may not document some non-mandatory error statuses as indicated in `CAMARA API Design Guide`.
+ Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version.
+ As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API.
+
+ # Authorization and authentication
+
+ The "Camara Security and Interoperability Profile" provides details of how an API consumer requests an access token. Please refer to Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the profile.
+
+ The specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst also being subject to the prevailing legal framework dictated by local legislation.
+
+ In cases where personal data is processed by the API and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design.
+
+ version: wip
+ x-camara-commonalities: 0.6
+
+ license:
+ name: Apache 2.0
+ url: https://www.apache.org/licenses/LICENSE-2.0.html
+
+externalDocs:
+ description: Product documentation at CAMARA
+ url: https://github.com/camaraproject/KnowYourCustomerMatch
+
+servers:
+ - url: '{apiRoot}/kyc-match/v0.4'
+ variables:
+ apiRoot:
+ default: http://localhost:9091
+ description: API root, defined by the service provider, e.g. `api.example.com` or `api.example.com/somepath`
+
+tags:
+ - name: Match
+ description: Operations to match a customer identity against the account data bound to their phone number.
+
+paths:
+ /match:
+ post:
+ tags:
+ - Match
+ summary: Matching a customer identity by checking a set of attributes related against the account data bound to their phone number.
+ description: |-
+ Verify matching of a number of attributes related to a customer identity against the verified data bound to their phone number in the Operator systems. Regardless of whether the `phoneNumber` is explicitly stated in the request body, at least one of the other fields must be provided, otherwise a `HTTP 400 - KNOW_YOUR_CUSTOMER.INVALID_PARAM_COMBINATION` error will be returned.
+
+ The API will return the result of the matching process for each requested attribute. This means that the response will **only** contain the attributes for which validation has been requested. Possible values are:
+ - **true**: the attribute provided matches with the one in the Operator systems, which is equal to a `match_score` of 100.
+ - **false**: the attribute provided does not match with the one in the Operator systems.
+ - **not_available**: the attribute is not available to validate.
+ operationId: KYC_Match
+
+ security:
+ - openId:
+ - kyc-match:match
+
+
+ parameters:
+ - $ref: '#/components/parameters/x-correlator'
+
+ requestBody:
+ required: true
+ content:
+ application/json:
+
+ schema:
+ $ref: '#/components/schemas/KYC_MatchRequestBody'
+ examples:
+ Two-Legged and Three-leg Access Token Example:
+ value:
+ phoneNumber: '+34629255833'
+ idDocument: 66666666q
+ idDocumentType: passport
+ idDocumentExpiryDate: '2027-07-12'
+ name: Federica Sanchez Arjona
+ givenName: Federica
+ familyName: Sanchez Arjona
+ nameKanaHankaku: federica
+ nameKanaZenkaku: Ｆｅｄｅｒｉｃａ
+ middleNames: Sanchez
+ familyNameAtBirth: YYYY
+ address: Tokyo-to Chiyoda-ku Iidabashi 3-10-10
+ streetName: Nicolas Salmeron
+ streetNumber: '4'
+ postalCode: '1028460'
+ region: Tokyo
+ locality: ZZZZ
+ country: JP
+ houseNumberExtension: VVVV
+ birthdate: '1978-08-22'
+ email: abc@example.com
+ gender: OTHER
+ cityOfBirth: Madrid
+ countryOfBirth: ES
+ nationality: ES
+ Three-Legged Without Phone Number Example:
+ value:
+ idDocument: 66666666q
+ idDocumentType: passport
+ idDocumentExpiryDate: '2027-07-12'
+ name: Federica Sanchez Arjona
+ givenName: Federica
+ familyName: Sanchez Arjona
+ nameKanaHankaku: federica
+ nameKanaZenkaku: Ｆｅｄｅｒｉｃａ
+ middleNames: Sanchez
+ familyNameAtBirth: YYYY
+ address: Tokyo-to Chiyoda-ku Iidabashi 3-10-10
+ streetName: Nicolas Salmeron
+ streetNumber: '4'
+ postalCode: '1028460'
+ region: Tokyo
+ locality: ZZZZ
+ country: JP
+ houseNumberExtension: VVVV
+ birthdate: '1978-08-22'
+ email: abc@example.com
+ gender: OTHER
+ cityOfBirth: Madrid
+ countryOfBirth: ES
+ nationality: ES
+
+ responses:
+ '200':
+ description: OK
+ headers:
+ x-correlator:
+ $ref: '#/components/headers/x-correlator'
+
+ content:
+ application/json:
+
+ schema:
+ $ref: '#/components/schemas/KYC_MatchResponse'
+ examples:
+ KYC_Match200Example:
+ value:
+ idDocumentMatch: 'true'
+ idDocumentTypeMatch: 'true'
+ idDocumentExpiryDateMatch: 'true'
+ nameMatch: 'true'
+ givenNameMatch: 'not_available'
+ familyNameMatch: 'not_available'
+ nameKanaHankakuMatch: 'true'
+ nameKanaZenkakuMatch: 'false'
+ middleNamesMatch: 'true'
+ familyNameAtBirthMatch: 'false'
+ familyNameAtBirthMatchScore: 90
+ addressMatch: 'true'
+ streetNameMatch: 'true'
+ streetNumberMatch: 'true'
+ postalCodeMatch: 'true'
+ regionMatch: 'true'
+ localityMatch: 'not_available'
+ countryMatch: 'true'
+ houseNumberExtensionMatch: 'not_available'
+ birthdateMatch: 'false'
+ emailMatch: 'false'
+ emailMatchScore: 87
+ genderMatch: 'false'
+ cityOfBirthMatch: 'false'
+ cityOfBirthMatchScore: 86
+ countryOfBirthMatch: 'true'
+ nationalityMatch: 'true'
+
+ '400':
+ $ref: '#/components/responses/Generic400'
+
+ '401':
+ $ref: '#/components/responses/Generic401'
+
+ '403':
+ $ref: '#/components/responses/Generic403'
+
+ '404':
+ $ref: '#/components/responses/Generic404'
+
+ '422':
+ $ref: '#/components/responses/Generic422'
+
+components:
+ securitySchemes:
+ openId:
+ type: openIdConnect
+ openIdConnectUrl: https://example.com/.well-known/openid-configuration
+
+
+ headers:
+ x-correlator:
+ description: Correlation id for the different services
+ required: false
+ schema:
+ $ref: "#/components/schemas/XCorrelator"
+
+ parameters:
+ x-correlator:
+ name: x-correlator
+ in: header
+ description: Correlation id for the different services
+ required: false
+ schema:
+ $ref: "#/components/schemas/XCorrelator"
+
+ schemas:
+
+ XCorrelator:
+ type: string
+ pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
+ example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
+
+ KYC_MatchRequestBody:
+ type: object
+ description: Payload to validate the customer data.
+
+ properties:
+ phoneNumber:
+ type: string
+ description: 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, prefixed with '+'.
+ pattern: '^\+[1-9][0-9]{4,14}$'
+ example: "+123456789"
+
+ idDocument:
+ type: string
+ description: Id number associated to the official identity document in the country. It may contain alphanumeric characters.
+
+ idDocumentType:
+ type: string
+ enum: [passport, national_id_card, residence_permit, diplomatic_id, driver_licence, social_security_id, other]
+ description: Type of the official identity document provided.
+
+ idDocumentExpiryDate:
+ type: string
+ format: date
+ description: Expiration date of the identity document (ISO 8601).
+
+ name:
+ type: string
+ description: Complete name of the customer, usually composed of first/given name and last/family/sur- name in a country. Depending on the country, the order of first/give name and last/family/sur- name varies, and middle name could be included. It can use givenName, middleNames, familyName and/or familyNameAtBirth. For example, in ESP, name+familyName; in NLD, it can be name+middleNames+familyName or name+middleNames+familyNameAtBirth, etc.
+
+ givenName:
+ type: string
+ description: First/given name or compound first/given name of the customer.
+
+ familyName:
+ type: string
+ description: Last name, family name, or surname of the customer.
+
+ nameKanaHankaku:
+ type: string
+ description: Complete name of the customer in Hankaku-Kana format (reading of name) for Japan.
+
+ nameKanaZenkaku:
+ type: string
+ description: Complete name of the customer in Zenkaku-Kana format (reading of name) for Japan.
+
+ middleNames:
+ type: string
+ description: Middle name/s of the customer.
+
+ familyNameAtBirth:
+ type: string
+ description: Last/family/sur- name at birth of the customer.
+
+ address:
+ type: string
+ description: Complete address of the customer. For some countries, it is built following the usual concatenation of parameters in a country, but for other countries, this is not the case. For some countries, it can use streetName, streetNumber and/or houseNumberExtension. For example, in ESP, streetName+streetNumber; in NLD, it can be streetName+streetNumber or streetName+streetNumber+houseNumberExtension.
+
+ streetName:
+ type: string
+ description: Name of the street of the customer's address. It should not include the type of the street.
+
+ streetNumber:
+ type: string
+ description: The street number of the customer's address. Number identifying a specific property on the 'streetName'.
+
+ postalCode:
+ type: string
+ description: Zip code or postal code
+
+ region:
+ type: string
+ description: Region/prefecture of the customer's address
+
+ locality:
+ type: string
+ description: Locality of the customer's address
+
+ country:
+ type: string
+ description: Country of the customer's address. Format ISO 3166-1 alpha-2
+
+ houseNumberExtension:
+ type: string
+ description: Specific identifier of the house needed depending on the property type. For example, number of apartment in an apartment building.
+
+ birthdate:
+ type: string
+ format: date
+ description: The birthdate of the customer, in RFC 3339 / ISO 8601 calendar date format (YYYY-MM-DD).
+
+ email:
+ type: string
+ format: email
+ description: Email address of the customer in the RFC specified format (local-part@domain).
+
+ gender:
+ type: string
+ description: Gender of the customer (Male/Female/Other).
+ enum:
+ - MALE
+ - FEMALE
+ - OTHER
+
+ cityOfBirth:
+ type: string
+ description: City where the customer was born.
+
+ countryOfBirth:
+ type: string
+ description: Country where the customer was born. Format ISO 3166-1 alpha-2.
+
+ nationality:
+ type: string
+ description: ISO 3166-1 alpha-2 code of the customer’s nationality. In the case a customer has more than one nationality, it is supposed to be the nationality related to the ID document provided in the match request.
+ MatchResult:
+ type: string
+ description: |
+ true - the attribute provided matches with the one in the Operator systems, which is equal to a `match_score` of 100.
+ false - the attribute provided does not match with the one in the Operator systems.
+ not_available - the attribute is not available to validate.
+ enum:
+ - 'true'
+ - 'false'
+ - 'not_available'
+
+ MatchScoreResult:
+ type: integer
+ description: |
+ Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator's system.
+ This property shall only be returned when the value of the corresponding match field is `false`.
+ A perfect match with a score of 100 is indicated by `match` being 'true' and no `matchScore` is returned in this case.
+ minimum: 0
+ maximum: 99
+
+ KYC_MatchResponse:
+ type: object
+ properties:
+ idDocumentMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether Id number associated to the ID document of the customer matches with the one on the Operator's system.
+ idDocumentTypeMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether document type associated to the ID document of the customer matches with the one on the Operator's system.
+ idDocumentExpiryDateMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether document expiration date associated to the ID document of the customer matches with the one on the Operator's system.
+ nameMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the complete name of the customer matches with the one on the Operator's system.
+ nameMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ givenNameMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether First name/given name of the customer matches with the one on the Operator's system.
+ givenNameMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ familyNameMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether last name/ family name/ surname of the customer matches with the one on the Operator's system.
+ familyNameMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ nameKanaHankakuMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether complete name of the customer in Hankaku-Kana format (reading of name) for Japan matches with the one on the Operator's system.
+ nameKanaHankakuMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ nameKanaZenkakuMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether complete name of the customer in Zenkaku-Kana format (reading of name) for Japan matches with the one on the Operator's system.
+ nameKanaZenkakuMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ middleNamesMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the middle names of the customer matches with the one on the Operator's system.
+ middleNamesMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ familyNameAtBirthMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the Family Name At Birth of the customer matches with the one on the Operator's system.
+ familyNameAtBirthMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ addressMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether complete address of the customer matches with the one on the Operator's system.
+ addressMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ streetNameMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the street name of the customer matches with the one on the Operator's system.
+ streetNameMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ streetNumberMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the street number of the customer matches with the one on the Operator's system.
+ streetNumberMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ postalCodeMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the postal code / zip code of the customer matches with the one on the Operator's system.
+ regionMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the region of the customer's address matches with the one on the Operator's system.
+ regionMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ localityMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the locality of the customer's address matches with the one on the Operator's system.
+ localityMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ countryMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the country of the customer's address matches with the one on the Operator's system.
+ houseNumberExtensionMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the house number extension of the customer's address with the one on the Operator's system.
+ birthdateMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the birthdate of the customer matches with the one on the Operator's system.
+ emailMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the email address of the customer matches with the one on the Operator's system.
+ emailMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ genderMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the gender of the customer matches with the one on the Operator's system.
+ cityOfBirthMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the city at birth of the customer matches with the one on the Operator's system
+ cityOfBirthMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ countryOfBirthMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the country at birth of the customer matches with the one on the Operator's system
+ nationalityMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the nationality of the customer matches with the one on the Operator's system
+
+ ErrorInfo:
+ type: object
+ required:
+ - status
+ - code
+ - message
+ properties:
+ message:
+ type: string
+ description: A human-readable description of what the event represents
+ status:
+ type: integer
+ description: HTTP response status code
+ code:
+ type: string
+ description: A human-readable code to describe the error
+
+ responses:
+ Generic400:
+ description: Bad Request
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 400
+ code:
+ enum:
+ - INVALID_ARGUMENT
+ - KNOW_YOUR_CUSTOMER.INVALID_PARAM_COMBINATION
+ examples:
+ GENERIC_400_INVALID_ARGUMENT:
+ description: Invalid Argument. Generic Syntax Exception
+ value:
+ status: 400
+ code: INVALID_ARGUMENT
+ message: Client specified an invalid argument, request body or query param.
+ KNOW_YOUR_CUSTOMER.INVALID_PARAM_COMBINATION:
+ description: Indicated param combination is invalid
+ value:
+ status: 400
+ code: KNOW_YOUR_CUSTOMER.INVALID_PARAM_COMBINATION
+ message: Indicated parameter combination is invalid
+
+ Generic401:
+ description: Unauthorized
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 401
+ code:
+ enum:
+ - UNAUTHENTICATED
+
+ examples:
+ GENERIC_401_UNAUTHENTICATED:
+ description: Request cannot be authenticated and a new authentication is required
+ value:
+ status: 401
+ code: UNAUTHENTICATED
+ message: Request not authenticated due to missing, invalid, or expired credentials. A new authentication is required.
+
+ Generic403:
+ description: Forbidden
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 403
+ code:
+ enum:
+ - PERMISSION_DENIED
+ - INVALID_TOKEN_CONTEXT
+ examples:
+ GENERIC_403_PERMISSION_DENIED:
+ description: Permission denied. OAuth2 token access does not have the required scope or when the user fails operational security
+ value:
+ status: 403
+ code: PERMISSION_DENIED
+ message: Client does not have sufficient permissions to perform this action.
+ GENERIC_403_INVALID_TOKEN_CONTEXT:
+ description: Reflect some inconsistency between information in some field of the API and the related OAuth2 Token
+ value:
+ status: 403
+ code: INVALID_TOKEN_CONTEXT
+ message: "phoneNumber is not consistent with access token."
+
+ Generic404:
+ description: Not found
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 404
+ code:
+ enum:
+ - NOT_FOUND
+ - IDENTIFIER_NOT_FOUND
+ examples:
+ GENERIC_404_NOT_FOUND:
+ description: Resource is not found
+ value:
+ status: 404
+ code: NOT_FOUND
+ message: The specified resource is not found.
+ GENERIC_404_IDENTIFIER_NOT_FOUND:
+ description: The phone number is not associated with a CSP customer account
+ value:
+ status: 404
+ code: IDENTIFIER_NOT_FOUND
+ message: The phone number provided is not associated with a customer account
+
+ Generic422:
+ description: Unprocessable Content
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 422
+ code:
+ enum:
+ - SERVICE_NOT_APPLICABLE
+ - MISSING_IDENTIFIER
+ examples:
+ GENERIC_422_SERVICE_NOT_APPLICABLE:
+ description: Service is not applicable for the provided phone number
+ value:
+ status: 422
+ code: SERVICE_NOT_APPLICABLE
+ message: The service is not applicable for the provided phone number
+ GENERIC_422_MISSING_IDENTIFIER:
+ description: No phone number has been provided either explicitly or associated with the access token
+ value:
+ status: 422
+ code: MISSING_IDENTIFIER
+ message: No phone number has been provided
+```
diff --git a/marked/KnowYourCustomerMatch/documentation/API_documentation/KnowYourCustomer_User_Story/raw.md b/marked/KnowYourCustomerMatch/documentation/API_documentation/KnowYourCustomer_User_Story/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..f837f2947c4437abaf6904c2a3a23ffc0a966ef5
--- /dev/null
+++ b/marked/KnowYourCustomerMatch/documentation/API_documentation/KnowYourCustomer_User_Story/raw.md
@@ -0,0 +1,27 @@
+**User Story: KYC Match - verify customer information**
+
+
+
+
+
+
+
+
+
+# ModelAsAService
+
+Sandbox API Repository to describe, develop, document, and test the ModelAsAService Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/_4AjAw)
+
+## Scope
+
+* Service APIs “ModelAsAService” (see APIBacklog.md)
+* MaaS (Model as a Services) refers to the packaging of AI models and their associated capabilities into reusable services, enabling users to quickly and efficiently build, deploy, monitor, and invoke models without the need to develop and maintain underlying foundational capabilities.
+* The API provides the API consumer with the ability to:
+ * build and manage personalized Knowledge Bases (knowledge-base)
+ * quickly construct unique Q&A Assistant applications (qa-assistant-manage)
+ * provide Q&A services to the users of the application (qa-assistant-service)
+ * NOTE: more model services to be added.
+* Describe, develop, document, and test the APIs
+* Started: November 2024
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r1.2](https://github.com/camaraproject/ModelAsAService/releases/tag/r1.2) (Fall25), with the following API versions:
+ * **knowledge-base v0.1.0**
+ [[YAML]](https://github.com/camaraproject/ModelAsAService/blob/r1.2/code/API_definitions/knowledge-base.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ModelAsAService/r1.2/code/API_definitions/knowledge-base.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ModelAsAService/r1.2/code/API_definitions/knowledge-base.yaml)
+ * **qa-assistant-manage v0.1.0**
+ [[YAML]](https://github.com/camaraproject/ModelAsAService/blob/r1.2/code/API_definitions/qa-assistant-manage.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ModelAsAService/r1.2/code/API_definitions/qa-assistant-manage.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ModelAsAService/r1.2/code/API_definitions/qa-assistant-manage.yaml)
+ * **qa-assistant-service v0.1.0**
+ [[YAML]](https://github.com/camaraproject/ModelAsAService/blob/r1.2/code/API_definitions/qa-assistant-service.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ModelAsAService/r1.2/code/API_definitions/qa-assistant-service.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ModelAsAService/r1.2/code/API_definitions/qa-assistant-service.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/ModelAsAService/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/ModelAsAService/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/ModelAsAService/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings are held virtually
+ * Schedule: Bi-weekly (odd weeks), Tuesday, 09:00 UTC (11:00 UTC+2, 17:00 UTC+8)
+ * [Join](https://teams.live.com/meet/9374614741908?p=QFhUf7b0SHZRdXSfA6)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/l/cp/GpKaVSqC)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project 
+
+
+
+
+
+
+
+
+# MostFrequentLocation
+
+Sandbox API Repository to describe, develop, document, and test the MostFrequentLocation Service API(s). The repository does not yet belong to a CAMARA Sub Project, but works together with DeviceVisitLocation as Location Insights.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/XjPe)
+
+## Scope
+
+* Service APIs for “MostFrequentLocation” (see APIBacklog.md)
+* It provides the API Consumer with the ability to:
+ * "MostFrequentLocation": validate, in terms of scoring, of the user's expected home area
+ * NOTE: The scope of these APIs should be limited (at least at the first stage) to 4G and 5G.
+* Describe, develop, document and test the APIs (with 1-2 Telcos)
+* Started: May 2024
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r2.2](https://github.com/camaraproject/MostFrequentLocation/releases/tag/r2.2) (Fall25), with the following API versions:
+ * **most-frequent-location v0.2.0**
+ [[YAML]](https://github.com/camaraproject/MostFrequentLocation/blob/r2.2/code/API_definitions/most-frequent-location.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/MostFrequentLocation/r2.2/code/API_definitions/most-frequent-location.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/MostFrequentLocation/r2.2/code/API_definitions/most-frequent-location.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/MostFrequentLocation/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/MostFrequentLocation/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/MostFrequentLocation/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings are held virtually
+ * Schedule: On-demand
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/99479758031?password=c705dd6f-a1c5-44e4-af97-331a18395fb8)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14564467/MostFrequentLocation+2024+Minutes)
+ * Slack channel: [camara-project.slack.com](https://camara-project.slack.com/archives/C07BHCZ3XUY) #sp-location-insights
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project 
+
+
+
+
+
+
+
+
+# MultiPointVPN
+
+Sandbox API Repository to describe, develop, document, and test the MultiPointVPN Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/AYD7Bw)
+
+## Scope
+
+* Service API(s) “MultiPointVPN” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * The MultiPoint VPN API transforms the process of ordering private or customized network services across multiple touchpoints. It enables users to create and configure on-demand edge connectivity services with guaranteed SLA and bandwidth with just one click, eliminating the need for manual orders through phone calls or customer managers. When the API is called with specific network SLA requirements, telecom operators can create non-public cloud leased network services by orchestrating IP VPN connections across various networks, including data centers, private clouds, operator networks, and satellite links
+* Describe, develop, document, and test the API(s)
+* Started: June 2025
+
+
+
+
+
+## Release Information
+
+The repository has no (pre)releases yet, work in progress is within the main branch.
+
+
+## Contributing
+
+* Meetings are held virtually
+ * Schedule: Bi-weekly meeting on Wednesday every 2 week(s), at 12:30 UTC
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meetings/telcoapi)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/AYD7Bw)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list 
+
+
+
+
+
+
+
+
+# NetworkAccessManagement
+
+Sandbox API Repository to describe, develop, document, and test the NetworkAccessManagement Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/5wCzHQ)
+
+## Scope
+* Service APIs for “Network Access Management” of Home Devices (see APIBacklog.md)
+* It provides the customer with the ability to:
+ * manage fixed devices provided by network operators that reside at customer premises.
+* Describe, develop, document, and test the APIs (with 1-2 Telcos)
+* Started: May 2024
+
+
+
+
+## Release Information
+
+The repository has no (pre)releases yet, work in progress is within the main branch.
+
+
+## Contributing
+* Meetings
+ * [Registration/Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/96846363178?password=9ebebe6c-c59c-42be-a709-7d5fd42fb626)
+ * Schedule: Bi-weekly on Fridays at 8AM MDT / 4PM CEST
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/ez3e).
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project 
+
+
+
+
+
+
+
+
+# NetworkInsights
+
+Sandbox API Repository to describe, develop, document, and test the NetworkInsights Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/fQCoBg)
+
+## Scope
+
+* Service API(s) “NetworkInsights” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * Network Insight offers a unified analytical platform for specific networks, such as private networks and slices, focusing exclusively on aggregated network-level data rather than individual device information. It empowers users to both evaluate the overall network health through a comprehensive, component-based scoring system and to analyze service traffic patterns with customizable granularity. By providing a holistic view — from infrastructure health to user traffic trends — this API suite delivers the critical, real-time data needed for comprehensive network monitoring, strategic performance optimization, and effective early warning systems.
+* Describe, develop, document, and test the API(s)
+* Started: May 2025
+
+
+
+
+
+## Release Information
+
+The repository has no (pre)releases yet, work in progress is within the main branch.
+
+
+## Contributing
+
+* Meetings are held virtually
+
+ * Schedule: !! tbd
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meetings/telcoapi) !! Update this link with your meeting registration/join link and delete the task
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/fQCoBg) !! update this link to your minutes archive page using the "Share" link and delete the task
+
+* Mailing List
+
+ * Subscribe / Unsubscribe to the mailing list 
+
+
+
+
+
+
+
+
+# NetworkSliceBooking
+
+Sandbox API Repository to describe, develop, document, and test the NetworkSliceBooking Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/rDPe)
+
+## Scope
+* Service APIs for “Network Slice Booking” (see APIBacklog.md)
+* It provides the API consumer with the ability to:
+ * reserve, dynamically provisioning, query, dynamically delete a slice with customized SLA assurance capabilities, customized service duration, expected slice covered locations.
+ * manage user subscription to the network slices.
+* Describe, develop, document and test the APIs (with 1-2 Telcos)
+* Started: January 2024
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest pre-release is [r2.1](https://github.com/camaraproject/NetworkSliceBooking/releases/tag/r2.1), with the following API versions:
+ * **network-slice-booking v0.2.0-rc.1**
+ [[YAML]](https://github.com/camaraproject/NetworkSliceBooking/blob/r2.1/code/API_definitions/network-slice-booking.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r2.1/code/API_definitions/network-slice-booking.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r2.1/code/API_definitions/network-slice-booking.yaml)
+ * **network-slice-assignment v0.1.0-rc.1**
+ [[YAML]](https://github.com/camaraproject/NetworkSliceBooking/blob/r2.1/code/API_definitions/network-slice-assignment.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r2.1/code/API_definitions/network-slice-assignment.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r2.1/code/API_definitions/network-slice-assignment.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/NetworkSliceBooking/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/NetworkSliceBooking/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/NetworkSliceBooking/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings are held virtually
+ * Schedule: Bi-weekly on Fridays 16:00 CST / 10:00 CEST
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/92204181217?password=7ef83098-28d4-417c-95bc-3f0ab7904c8f)
+ * Minutes: Access [Meeting minutes](https://wiki.camaraproject.org/display/CAM/NetworkSliceBooking)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project 
+
+
+
+
+
+
+
+
+# NumberRecycling
+
+Sandbox API Repository to describe, develop, document, and test the NumberRecycling API within the [Know Your Customer (KYC)](https://lf-camaraproject.atlassian.net/wiki/x/I4DGB) Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/ggCaBQ)
+
+## Scope
+
+* Service API “NumberRecycling” (see [APIBacklog.md](https://github.com/camaraproject/APIBacklog/blob/main/documentation/APIbacklog.md))
+* The API provides the API consumer with the ability to:
+ * Check whether the subscriber of the phone number has changed. A common scenario is when Application service provider (ASP) wants to check whether there has been a change in the user associated with the phone number after the specified date. This allows the ASP to ensure that a phone number is correctly linked to an user and prevent the mis-delivery of SMS messages.
+* Describe, develop, document, and test the API
+* Started: August 2024
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r2.2](https://github.com/camaraproject/NumberRecycling/releases/tag/r2.2) (Fall25), with the following API versions:
+ * **number-recycling v0.2.0**
+ [[YAML]](https://github.com/camaraproject/NumberRecycling/blob/r2.2/code/API_definitions/number-recycling.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberRecycling/r2.2/code/API_definitions/number-recycling.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NumberRecycling/r2.2/code/API_definitions/number-recycling.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/NumberRecycling/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/NumberRecycling/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/NumberRecycling/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings of KnowYourCustomer Sub Project are held virtually
+ * Schedule: Bi-weekly, Tuesday, 08:00 UTC (09:00 CET, 10:00 CEST)
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/96235150735?password=7e3fea67-a76e-4941-8a70-392cf5545917)
+ * Minutes: Access [meeting minutes](https://github.com/camaraproject/KnowYourCustomer/tree/main/documentation/MeetingMinutes)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project 
+
+ Note:
+ * When API receives a request with specified date on which a user signed a contract with MNO, the API respond sets to 'false'(e.g., 2023-10-09 in the Scenario 1 of the figure above).
+
+ * Scenario 2
+ * Pre-conditions
+ * User A signed a contract with MNO A for the phone number '+123456789' on October 9, 2023, and canceled it on February 25, 2024. Subsequently, User B signed a contract with MNO A for the same phone number on September 21, 2024, and is still using it.
+ * User A also signed contracts with ASP A on December 22, 2023 for its services.
+ * ASP A holds the contract date (2023-12-22) and the phone number (+123456789) for User A.
+ * Currently, on November 2, 2024, ASP A wishes to send a SMS message to User A.
+ * Potential operations
+ * ASP A sends a request with specified date (2023-12-22) and phone number (+123456789) to the Number Recycling API.
+ * The API response sets to 'true', indicating that there has been a change in the user associated with the phone number.
+ * Post-conditions
+ * ASP A decides to stop sending the SMS message to User A and contacts User A by mail.
+ * By following these steps, ASP A ensures that a phone number is not linked to User A and prevents the mis-delivery of the SMS message.
+
+ 
+
+ Note:
+ * When the API receives a request with specified date during which there is no contract with MNO for the phone number, the API respond sets to 'true'(e.g., the period between 2024-02-25 and 2024-09-20 in the Scenario 2 of the figure above).
+
+ # Authorization and authentication
+
+ The "Camara Security and Interoperability Profile" provides details of how an API consumer requests an access token. Please refer to Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the profile.
+
+ The specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst also being subject to the prevailing legal framework dictated by local legislation.
+
+ In cases where personal data is processed by the API and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design.
+
+ # Identifying the phone number from the access token
+
+ This API requires the API consumer to identify a phone number as the subject of the API as follows:
+ - When the API is invoked using a two-legged access token, the subject will be identified from the optional `phoneNumber` field, which therefore MUST be provided.
+ - When a three-legged access token is used however, this optional identifier MUST NOT be provided, as the subject will be uniquely identified from the access token.
+
+ This approach simplifies API usage for API consumers using a three-legged access token to invoke the API by relying on the information that is associated with the access token and was identified during the authentication process.
+
+ ## Error handling:
+
+ - If the subject cannot be identified from the access token and the optional `phoneNumber` field is not included in the request, then the server will return an error with the `422 MISSING_IDENTIFIER` error code.
+ - If the subject can be identified from the access token and the optional `phoneNumber` field is also included in the request, then the server will return an error with the `422 UNNECESSARY_IDENTIFIER` error code. This will be the case even if the same phone number is identified by these two methods, as the server is unable to make this comparison.
+
+ ### Additional CAMARA error responses
+ The list of error codes in this API specification is not exhaustive. Therefore the API specification may not document some non-mandatory error statuses as indicated in `CAMARA API Design Guide`.
+ Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version.
+ As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API.
+
+ version: wip
+ x-camara-commonalities: tbd
+
+ license:
+ name: Apache 2.0
+ url: https://www.apache.org/licenses/LICENSE-2.0.html
+externalDocs:
+ description: Product documentation at CAMARA
+ url: https://github.com/camaraproject/NumberRecycling
+servers:
+ - url: '{apiRoot}/number-recycling/vwip'
+ variables:
+ apiRoot:
+ default: http://localhost:9091
+ description: API root, defined by the service provider, e.g. `api.example.com` or `api.example.com/somepath`
+paths:
+ /check:
+ post:
+ security:
+ - openId:
+ - number-recycling:check
+ tags:
+ - Check Number Recycling
+ summary: Check whether the subscriber of the phone number has changed.
+ description: Check whether the subscriber of the phone number has changed.
+ operationId: checkNumberRecycling
+ parameters:
+ - $ref: '#/components/parameters/x-correlator'
+ requestBody:
+ description: |
+ Check whether the subscriber of the phone number has changed.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CreateCheckNumRecycling'
+ required: true
+ responses:
+ '200':
+ description: OK
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/CheckNumRecyclingInfo"
+ '400':
+ $ref: '#/components/responses/Generic400'
+ '401':
+ $ref: '#/components/responses/Generic401'
+ '403':
+ $ref: '#/components/responses/Generic403'
+ '404':
+ $ref: '#/components/responses/Generic404'
+ '422':
+ $ref: '#/components/responses/Generic422'
+components:
+ securitySchemes:
+ openId:
+ type: openIdConnect
+ openIdConnectUrl: https://example.com/.well-known/openid-configuration
+ parameters:
+ x-correlator:
+ name: x-correlator
+ in: header
+ description: Correlation id for the different services
+ schema:
+ $ref: "#/components/schemas/XCorrelator"
+ headers:
+ x-correlator:
+ description: Correlation id for the different services
+ schema:
+ $ref: "#/components/schemas/XCorrelator"
+ schemas:
+ CreateCheckNumRecycling:
+ type: object
+ required:
+ - specifiedDate
+ properties:
+ phoneNumber:
+ $ref: '#/components/schemas/PhoneNumber'
+ specifiedDate:
+ type: string
+ format: date
+ description: Specified date to check whether there has been a change in the subscriber associated with the specific phone number, in RFC 3339 calendar date format (YYYY-MM-DD).
+ example: "2024-10-31"
+ PhoneNumber:
+ description: 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, prefixed with '+'.
+ type: string
+ pattern: '^\+[1-9][0-9]{4,14}$'
+ example: "+123456789"
+ CheckNumRecyclingInfo:
+ type: object
+ required:
+ - phoneNumberRecycled
+ properties:
+ phoneNumberRecycled:
+ type: boolean
+ description: |
+ Set to true (Boolean, not string) when there has been a change in the subscriber associated with the specific phone number after “specifiedDate”.
+ ErrorInfo:
+ type: object
+ required:
+ - status
+ - code
+ - message
+ properties:
+ status:
+ type: integer
+ description: HTTP response status code
+ code:
+ type: string
+ description: A human-readable code to describe the error
+ message:
+ type: string
+ description: A human-readable description of what the event represents
+ XCorrelator:
+ type: string
+ pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
+ example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
+ responses:
+ Generic200:
+ description: OK
+ headers:
+ x-correlator:
+ $ref: '#/components/headers/x-correlator'
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CheckNumRecyclingInfo'
+
+ Generic400:
+ description: Problem with the client request
+ headers:
+ x-correlator:
+ $ref: '#/components/headers/x-correlator'
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 400
+ code:
+ enum:
+ - INVALID_ARGUMENT
+ - OUT_OF_RANGE
+ examples:
+ InvalidArgument:
+ description: Invalid Argument. Generic Syntax Exception
+ value:
+ status: 400
+ code: INVALID_ARGUMENT
+ message: Client specified an invalid argument, request body or query param.
+ OutOfRange:
+ description: Out of Range. Specific Syntax Exception used when a given field has a pre-defined range or a invalid filter criteria combination is requested
+ value:
+ status: 400
+ code: OUT_OF_RANGE
+ message: Client specified an invalid range.
+
+ Generic401:
+ description: Authentication problem with the client request
+ headers:
+ x-correlator:
+ $ref: '#/components/headers/x-correlator'
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 401
+ code:
+ enum:
+ - UNAUTHENTICATED
+ examples:
+ Unauthenticated:
+ description: Request cannot be authenticated and a new authentication is required
+ value:
+ status: 401
+ code: UNAUTHENTICATED
+ message: Request not authenticated due to missing, invalid, or expired credentials. A new authentication is required.
+
+ Generic403:
+ description: Client does not have sufficient permission
+ headers:
+ x-correlator:
+ $ref: '#/components/headers/x-correlator'
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 403
+ code:
+ enum:
+ - PERMISSION_DENIED
+ examples:
+ Permission Denied:
+ description: Permission denied. OAuth2 token access not have the required scope or when the user fails operational security
+ value:
+ status: 403
+ code: PERMISSION_DENIED
+ message: Client does not have sufficient permissions to perform this action
+
+ Generic404:
+ description: Resource Not Found
+ headers:
+ x-correlator:
+ $ref: '#/components/headers/x-correlator'
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 404
+ code:
+ enum:
+ - IDENTIFIER_NOT_FOUND
+ examples:
+ Phone Number Used By Different Network Operator:
+ description: Provided phone number is used by a different network operator
+ value:
+ status: 404
+ code: IDENTIFIER_NOT_FOUND
+ message: Phone number not found.
+
+ Generic422:
+ description: Unprocessable Content
+ headers:
+ x-correlator:
+ $ref: '#/components/headers/x-correlator'
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 422
+ code:
+ enum:
+ - SERVICE_NOT_APPLICABLE
+ - MISSING_IDENTIFIER
+ - UNNECESSARY_IDENTIFIER
+ examples:
+ Device Not Applicable:
+ description: Service not applicable for the provided phone number
+ value:
+ status: 422
+ code: SERVICE_NOT_APPLICABLE
+ message: The service is not available for the provided phone number
+ Unnecessary Identifier:
+ description: An explicit identifier is provided when a phone number has already been identified from the access token
+ value:
+ status: 422
+ code: UNNECESSARY_IDENTIFIER
+ message: The phone number is already identified by the access token
+ Missing Identifier:
+ description: An identifier is not included in the request and the phone number identification cannot be derived from the 3-legged access token
+ value:
+ status: 422
+ code: MISSING_IDENTIFIER
+ message: The phone number cannot be identified
+```
diff --git a/marked/NumberRecycling/documentation/API_documentation/Number_Recycling_User_Story/raw.md b/marked/NumberRecycling/documentation/API_documentation/Number_Recycling_User_Story/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..7d1a252830864b728c0aae885ba755060cec74e7
--- /dev/null
+++ b/marked/NumberRecycling/documentation/API_documentation/Number_Recycling_User_Story/raw.md
@@ -0,0 +1,11 @@
+# Number Recycling API User Story
+
+
+| **Item** | **Details** |
+| ---- | ------- |
+| ***Summary*** | As an enterprise application developer, I want to check whether there has been a change in the user associated with the phone number after the specified date so that I can ensure that a phone number is correctly linked to an user and prevent mis-delivery before sending SMS messages to an user. |
+| ***Roles, Actors and Scope*** | **Actors:** Application service providers (ASP), ASP:User, ASP: BusinessManager, ASP:Administrator, Communication service Provider (CSP), Channel Partner. 
+
+
+
+
+
+
+
+
+# NumberVerification
+
+Incubating API Repository to evolve and maintain the definitions and documentation of the NumberVerification Service API within the Sub Project [Number Insights](https://lf-camaraproject.atlassian.net/wiki/x/BYEpBQ).
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/XzTe)
+
+## Scope
+
+* Service API for “NumberVerification” (see APIBacklog.md)
+* It provides the API consumer with the ability to:
+ * verify the phone number associated with the SIM used in the device connected to the mobile data network.
+* Describe, develop, document and test the APIs (with 1-2 Telcos)
+* Started: October 2022
+* Incubating stage since: February 2025
+
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r3.2](https://github.com/camaraproject/NumberVerification/releases/tag/r3.2) (Fall25), with the following API versions:
+ * **number-verification v2.1.0**
+ [[YAML]](https://github.com/camaraproject/NumberVerification/blob/r3.2/code/API_definitions/number-verification.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r3.2/code/API_definitions/number-verification.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r3.2/code/API_definitions/number-verification.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/NumberVerification/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/NumberVerification/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/NumberVerification/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings are held virtually
+ * Schedule: Every 4 weeks, Thursday, 7:30 AM UTC (8:30 CET/9:30 CEST)
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/94893248838?password=05b2197d-309e-41ef-aadf-639f71ef7f38)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14564484/Minutes+-+Number+Insights)
+* Mailing list:
+ * To subscribe / unsubscribe to the mailing list of this Sub Project and thus be / resign as Contributor please visit 
+
+
+
+
+
+
+
+
+# OTPValidation
+
+Incubating API Repository to evolve and maintain the definitions and documentation of OTPValidation Service API within the Sub Project [Number Insights](https://lf-camaraproject.atlassian.net/wiki/x/BYEpBQ)
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/yDXe)
+
+## Scope
+
+* Service APIs for “OTPValidation” (see APIBacklog.md)
+ * The OTP SMS API facilitates real-time verification of a user's device by sending a unique code via SMS to the specified mobile phone number. The process involves three key steps:
+1. **Code Generation and Delivery:**
+ The send-code operation is used by the API consumer (e.g., an application) to request a one-time code to be sent by SMS to the application user's mobile phone along with an message to the user's mobile device.
+2. **User Input:**
+ The user receives the SMS and enters the received code into the application.
+3. **Verification:**
+ The application submits the entered code using the validate-code operation, which then verifies its accuracy and responds with a confirmation indicating whether the code is valid.
+
+This process ensures secure, real-time validation of user possession of the specified device, enhancing authentication security.
+ * by delivering a one-time password (OTP) to it through SMS and validating the received code with the user's operator after the code is entered as requested.
+ * Started: October 2022
+ * Incubating stage since: February 2025
+
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r3.2](https://github.com/camaraproject/OTPValidation/releases/tag/r3.2) (Fall25), with the following API versions:
+ * **one-time-password-sms v1.1.1**
+ [[YAML]](https://github.com/camaraproject/OTPValidation/blob/r3.2/code/API_definitions/one-time-password-sms.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/OTPValidation/r3.2/code/API_definitions/one-time-password-sms.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/OTPValidation/r3.2/code/API_definitions/one-time-password-sms.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/OTPValidation/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/OTPValidation/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/OTPValidation/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings are held virtually
+ * Schedule: Every 4 weeks, Thursday, 7:30 AM UTC (8:30 CET/9:30 CEST)
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/94893248838?password=05b2197d-309e-41ef-aadf-639f71ef7f38)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14564484/Minutes+-+Number+Insights)
+* Mailing list
+ * Subscribe / Unsubscribe to the mailing list 
+
+
+
+
+
+
+
+
+# OptimalEdgeDiscovery
+
+Sandbox API Repository to describe, develop, document, and test the OptimalEdgeDiscovery Service API(s) within the Sub Project [Edge Cloud](https://lf-camaraproject.atlassian.net/wiki/x/IwEpBQ).
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/AYAtC)
+
+## Scope
+
+* Service API(s) “OptimalEdgeDiscovery” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * Discover the optimal regions and zones for their edge cloud application
+* Describe, develop, document, and test the API(s)
+* Started: July 2022 (in [EdgeCloud](https://github.com/camaraproject/EdgeCloud) repository)
+
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r1.2](https://github.com/camaraproject/OptimalEdgeDiscovery/releases/tag/r1.2) (Fall25), with the following API versions:
+ * **optimal-edge-discovery v0.1.0**
+ [[YAML]](https://github.com/camaraproject/OptimalEdgeDiscovery/blob/r1.2/code/API_definitions/optimal-edge-discovery.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/OptimalEdgeDiscovery/r1.2/code/API_definitions/optimal-edge-discovery.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/OptimalEdgeDiscovery/r1.2/code/API_definitions/optimal-edge-discovery.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/OptimalEdgeDiscovery/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/OptimalEdgeDiscovery/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/OptimalEdgeDiscovery/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings are held virtually
+ * Schedule: Bi-weekly on Tuesdays 14:00 - 15:00 UTC
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/91868502920?password=a9ec9dff-ea92-4216-b0a1-ce152f49170f)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/8Tve)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list 
+
+
+
+
+
+
+
+
+# PopulationDensityData
+
+Incubating API Repository to evolve and maintain the definitions and documentation of PopulationDensityData Service API(s) within the Sub Project [Population Density Data](https://lf-camaraproject.atlassian.net/wiki/x/LwAwC)
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/3DXe)
+
+## Scope
+* Service APIs for “Population Density Data” (see APIBacklog.md)
+* It provides the API consumer with the ability to:
+ * The service enables developers with the capability to get dynamic population density data in a specific area for a specified date&time, considering anonymized information of the network connected devices in the requested area at the flight time.
+ * Use Case (1): Providing BVLOS flight the data to meet SORA 2.5 requirements in terms of intrinsic Ground Risk Class (iGRC).
+ * Use Case (2): Providing data to identify if the ground risk class for a given drone flight is acceptable for the time of the flight, or an alternative time should be considered to lower the risk.
+ * Service Inputs: Area of the interest. Date & time range.
+ * Service Outputs: maximum, average and minimum population density value for the given area, and interval corresponding to the valid range of that value. (space and time maps).
+ * NOTE: The scope of these APIs should be limited (at least at a first stage) to 4G and 5G.
+* Describe, develop, document and test the APIs (with 1-2 Telcos)
+* Started: December 2023
+* Incubating stage since: June 2025
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r3.2](https://github.com/camaraproject/PopulationDensityData/releases/tag/r3.2) (Fall25), with the following API versions:
+ * **population-density-data v0.3.0**
+ [[YAML]](https://github.com/camaraproject/PopulationDensityData/blob/r3.2/code/API_definitions/population-density-data.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/PopulationDensityData/r3.2/code/API_definitions/population-density-data.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/PopulationDensityData/r3.2/code/API_definitions/population-density-data.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/PopulationDensityData/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/PopulationDensityData/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/PopulationDensityData/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings are held virtually
+ * Schedule: bi-weekly, Wednesday, 14:00 Europe/Amsterdam (CET) (13:00 UTC, 12:00 UTC during European DST).
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/95956472717?password=e4e7e889-ffb8-4fac-9e9d-d9adcaf2e711)
+ * For date/time of next meeting see previous [ meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/HwPe)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list \ No newline at end of file diff --git a/marked/PopulationDensityData/documentation/MeetingMinutes/PopulationDensityDataAPI-KOmeeting_2024-01-24/raw.md b/marked/PopulationDensityData/documentation/MeetingMinutes/PopulationDensityDataAPI-KOmeeting_2024-01-24/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..6f13d1e1a2ca410dc9eaa235bdefca6415cf6dfb --- /dev/null +++ b/marked/PopulationDensityData/documentation/MeetingMinutes/PopulationDensityDataAPI-KOmeeting_2024-01-24/raw.md @@ -0,0 +1,65 @@ +# CAMARA Population Density Data API - KO meeting - 2024-01-24 + +*January 24th, 2024* + +## Attendees + +|| +| --- | +|Sachin Kumar (Vodafone)| +|Thomas Wana (Dimetor)| +|Thomas Neubauer (Dimetor)| +|Violeta Gonzalez Fernandez (Telefonica)| +|Jorge Garcia Hospital (Telefonica)| + + + +Population Density Data API minutes: [https://github.com/camaraproject/PopulationDensityData/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/PopulationDensityData/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Presentation of the working group + * Density Population Data reference use cases +* Schedule and bi-weekly planification +* Timeline and next steps +* AoB + + +## Open Issues & PRs + + +Item | Who | Description +---- | ---- | ---- +N/A | N/A | N/A + +## Introduction to the working group + +Supporting material: [KO supporting material](https://github.com/camaraproject/PopulationDensityData/tree/main/documentation/SupportingDocuments/KO%20-%20Population%20Density%20Data%20Proposal%20for%20Camara%20Standarizationv3.pptx) + +### Scope + +**API definition:** The Population Density Data API enables developers with the capability to get population density estimations for a specific area at a future date and time, considering historical anonymized information of the network connected devices in the requested area. + +**API inputs (TBC):** Geographical area (2D map) and time range (future) + +**API outputs (TBC):** Max, min and average estimated statistics of population density for the required map, divided in uniform cells depending on the accuracy of the data. In a time series, to include information for the complete requested time range + + +### Density Population Data reference use cases + +For the reference use case, the API fills the need of assessing the ground risk to allow safe drone flights by providing estimations of the number of people under a drone flight path. This assessment will be needed every time a drone flight in the specific category need to conduct an operation and will help the operator to identify operational limitations, to develop the appropriate operational procedures and to identify mitigations and safety objectives. More information in [KO supporting material](https://github.com/camaraproject/PopulationDensityData/tree/main/documentation/SupportingDocuments/KO%20-%20Population%20Density%20Data%20Proposal%20for%20Camara%20Standarizationv3.pptx) + +## Discussion + +Item | Discussion +---- | ---- +Group Scope | Telefonica shares the proposal to include not only the specification of the API but also the agreement on the required algorithms of prediction and interpolation that are required in the API to provide a homogeneous response among operators. Aggrement reached. +Meeting Schedule | It's agreed to keep KO time schedule to be replicated in the following repetitions of the subgroup meetings. Be-weekly meeting on Wednesday, 14:00 Europe/Amsterdam (CET) (13:00 UTC, 12:00 UTC during European DST), starting February, 7th. +Timeline and next steps | Schedule to close scope, prepare innitial yaml proposal and close RC version is proposed. +AoB | N/A + + + +- Next call will be **February 7th, 2024** + +
diff --git a/marked/PopulationDensityData/documentation/MeetingMinutes/README/raw.md b/marked/PopulationDensityData/documentation/MeetingMinutes/README/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..37aa0ff405bf918d942905c10a0f435fd46c8ffd --- /dev/null +++ b/marked/PopulationDensityData/documentation/MeetingMinutes/README/raw.md @@ -0,0 +1 @@ +This README.MD can be deleted when the first file is added to this directory. diff --git a/marked/PopulationDensityData/documentation/SupportingDocuments/Population_Density_API_-_Algorithm_Initial_Proposal/raw.md b/marked/PopulationDensityData/documentation/SupportingDocuments/Population_Density_API_-_Algorithm_Initial_Proposal/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..4602e628731485ff1df4299b08a0ba1e83ee42d6 --- /dev/null +++ b/marked/PopulationDensityData/documentation/SupportingDocuments/Population_Density_API_-_Algorithm_Initial_Proposal/raw.md @@ -0,0 +1,30 @@ +# Population Density Data API +## Algorithm initial proposal + +This document serves as a reference model for the population density calculation algorithm. It provides an illustrative high-level overview of the steps proposed to determine population density. Designed for developers, this guide is created to enhance understanding and implementation of the algorithm. While it aims to enhance understanding and implementation, it is the responsibility of the developer to create their own algorithm to calculate population density. + +### Inputs for the algorithm: +* Devices connection records data is received pseudonymized or hashed. +* Requested Space is received in the API customers’ request. +### Process is as follows: +
+
+
+
+
+
+
+
+
+# PredictiveConnectivityData
+
+Sandbox API Repository to describe, develop, document, and test the PredictiveConnectivityData Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/AQAnBw)
+
+## Scope
+
+* Service API(s) “PredictiveConnectivityData” (see APIBacklog.md)
+* The API provides the capability to get the estimation of connectivity delivered by 4G/5G networks along a volume/area for a future date, time, and height.
+* Use Cases:
+ * Network Airspace Connectivity Information for Flight Planning: Provides mobile network coverage forecasts in specific geographic areas to help identify “black volumes” and mitigate the risk of losing drone control due to poor connectivity.
+ * Autonomous Car Routing: Delivers mobile network coverage forecasts along the planned route of an autonomous car to support decision-making in path planning and connectivity-dependent operations.
+* Describe, develop, document and test the APIs (with 1-2 Telcos)
+* Started: April 2025
+
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r1.2](https://github.com/camaraproject/PredictiveConnectivityData/releases/tag/r1.2) (Fall25), with the following API versions:
+ * **predictive-connectivity-data v0.1.0**
+ [[YAML]](https://github.com/camaraproject/PredictiveConnectivityData/blob/r1.2/code/API_definitions/predictive-connectivity-data.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/PredictiveConnectivityData/r1.2/code/API_definitions/predictive-connectivity-data.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/PredictiveConnectivityData/r1.2/code/API_definitions/predictive-connectivity-data.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/PredictiveConnectivityData/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/PredictiveConnectivityData/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/PredictiveConnectivityData/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings are held virtually
+
+* Schedule: Monthly on Tuesdays, 10:00–11:00 UTC
+ (corresponds to 12:00–13:00 CEST, 06:00–07:00 EDT during Daylight Saving Time)
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/95479380109?password=0386fbda-1fb5-4e1a-8687-7b81fe8cacfa&invite=true)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/PAAnBw)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list 
+
+
+
+
+
+
+
+
+# QoSBooking
+
+Sandbox API Repository to describe, develop, document, and test the QoSBooking Service API(s) within the Sub Project [Connectivity Quality Management](https://lf-camaraproject.atlassian.net/wiki/x/XCPe)
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/SADHB)
+
+## Scope
+
+* Service API(s) “QoSBooking” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * book an assignment of a certain QoS Profile to a certain device with some conditions such as start time, duration and location in advance.
+ * update the booking, remove it, and get the information of it.
+* Describe, develop, document, and test the API(s)
+* Started: January 2025
+
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r1.2](https://github.com/camaraproject/QoSBooking/releases/tag/r1.2) (Fall25), with the following API versions:
+ * **qos-booking-and-assignment v0.1.0**
+ [[YAML]](https://github.com/camaraproject/QoSBooking/blob/r1.2/code/API_definitions/qos-booking-and-assignment.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/QoSBooking/r1.2/code/API_definitions/qos-booking-and-assignment.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/QoSBooking/r1.2/code/API_definitions/qos-booking-and-assignment.yaml)
+ * **qos-booking v0.1.0**
+ [[YAML]](https://github.com/camaraproject/QoSBooking/blob/r1.2/code/API_definitions/qos-booking.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/QoSBooking/r1.2/code/API_definitions/qos-booking.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/QoSBooking/r1.2/code/API_definitions/qos-booking.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/QoSBooking/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/QoSBooking/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/QoSBooking/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings are held virtually
+ * Schedule: Bi-weekly on Friday at 13:00 UTC
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/94112812156?password=f238d6af-c959-48d7-a862-abdb3c648e40)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/ABje)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list 
+
+
+
+
+
+
+
+
+# QualityOnDemand
+
+Incubating API Repository to evolve and maintain the definitions and documentation of QualityOnDemand Service API(s) within the Sub Project [Connectivity Quality Management](https://lf-camaraproject.atlassian.net/wiki/x/hAClB)
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/XCPe)
+
+## Scope
+
+* Service APIs for “Quality on Demand” (see APIBacklog.md)
+* The Service APIs provide the API consumer with the ability to:
+ * retrieve the possible quality options (profiles) from the network (qos-profiles)
+ * set the quality for a connection of a mobile device or a home device within the access network
+ * dynamically, for a selected session of a specific duration (quality-on-demand)
+ * provisioned, applying the same quality each time the device connects to the network (qod-provisioning)
+ * get a notification if the network cannot fulfill the requested quality profile (quality-on-demand, qod-provisioning)
+* Describe, develop, document and test the APIs (with 1–2 Service Providers)
+* Started: October 2021
+* Incubating stage since: February 2025
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r3.2](https://github.com/camaraproject/QualityOnDemand/releases/tag/r3.2) (Fall25), with the following API versions:
+ * **qos-profiles v1.1.0**
+ [[YAML]](https://github.com/camaraproject/QualityOnDemand/blob/r3.2/code/API_definitions/qos-profiles.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r3.2/code/API_definitions/qos-profiles.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r3.2/code/API_definitions/qos-profiles.yaml)
+ * **qos-provisioning v0.3.0**
+ [[YAML]](https://github.com/camaraproject/QualityOnDemand/blob/r3.2/code/API_definitions/qos-provisioning.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r3.2/code/API_definitions/qos-provisioning.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r3.2/code/API_definitions/qos-provisioning.yaml)
+ * **quality-on-demand v1.1.0**
+ [[YAML]](https://github.com/camaraproject/QualityOnDemand/blob/r3.2/code/API_definitions/quality-on-demand.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r3.2/code/API_definitions/quality-on-demand.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r3.2/code/API_definitions/quality-on-demand.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/QualityOnDemand/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/QualityOnDemand/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/QualityOnDemand/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings are held virtually
+ * Schedule: bi-weekly, Friday, 13:00 UTC (14:00 CET, 15:00 CEST). For date/time of the next meeting, see previous meeting minutes
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/94112812156?password=f238d6af-c959-48d7-a862-abdb3c648e40)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/XCPe)
+* Mailing List
+ * Subscribe / unsubscribe to the mailing list of this Sub Project 
+
+
+
+
+
+
+
+
+# RainfallIntensity
+
+Sandbox API Repository to describe, develop, document, and test the RainfallIntensity Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/DYDEH)
+
+## Scope
+
+* Service API(s) “RainfallIntensity” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * Obtain the power measurements for the communication links inside a geographical area for a specific time period. The data includes the time of measurement, the transmit and received power, and the link ID (which identifies each link uniquely).
+ * Obtain the metadata of the communication links within a geographical area. The metadata includes the link ID, time of update, signal frequecny, signal polarization (horizontal or vertical), and location (latetude and longitude) of the transmitter and the receiver.
+ * Obtain the rainfall data associated with communciation links inside a geographical are for a specific time. The rainfall data include the estimation of rainfall, time stamp, and link ID.
+* Describe, develop, document, and test the API(s)
+* Started: January 2026
+
+
+
+
+
+## Release Information
+
+The repository has no (pre)releases yet, work in progress is within the main branch.
+
+
+
+## Contributing
+
+* Meetings are held virtually
+
+ * Schedule: !! tbd
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meetings/telcoapi) !! Update this link with your meeting registration/join link and delete the task
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/AgDHH)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list 
+
+
+
+
+
+
+
+
+# RegionDeviceCount
+
+Sandbox API Repository to describe, develop, document, and test the RegionDeviceCount Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/JSTe)
+
+## Scope
+* Service APIs for “RegionDeviceCount” (see APIBacklog.md)
+* It provides the API consumer with the ability to:
+ * query device count in the specified area during a certain time interval.The query area can be a circle or a polygon composed of longitude and latitude points.In addition, this API also provides a filtering function. Customers can filter devices by passing in different constraints. Currently, it supports two filtering conditions: roaming status and device type, and it is designed to be extended in the future
+ * NOTE: The scope of this API should be limited (at least at a first stage) to 4G and 5G.
+* Describe, develop, document and test the APIs (with 1-2 Telcos)
+* Started: December 2023
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r2.2](https://github.com/camaraproject/RegionDeviceCount/releases/tag/r2.2) (Fall25), with the following API versions:
+ * **region-device-count v0.2.0**
+ [[YAML]](https://github.com/camaraproject/RegionDeviceCount/blob/r2.2/code/API_definitions/region-device-count.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/RegionDeviceCount/r2.2/code/API_definitions/region-device-count.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/RegionDeviceCount/r2.2/code/API_definitions/region-device-count.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/RegionDeviceCount/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/RegionDeviceCount/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/RegionDeviceCount/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings are held virtually
+ * Schedule: Bi-Weekly on Fridays 11:00 CET/CEST / 09:00 UTC
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/91734372257?password=28df8c0a-941a-4f41-adc2-fd5de2791a96)
+ * Minutes: Access [Meeting minutes](https://wiki.camaraproject.org/display/CAM/RegionDeviceCount)
+* Mailing List
+
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project 
+
+
+
+
+
+
+
+
+# SessionInsights
+
+Sandbox API Repository to describe, develop, document, and test the SessionInsights Service API(s) in group with [Connectivity Insights](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/93946006/Connectivity+Insights)
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/44CaBQ)
+
+## Scope
+
+* Concept and Service APIs for “SessionInsights” (see APIBacklog.md)
+* The API provides an API Consumer with the ability to:
+ - report application KPIs to network operator
+ - receive score from network operator
+ - receive root cause analysis and recommended corrective actions
+ - request service improvements
+* Note: in first steps the concept will be described with user stories. The relation to existing APIs (e.g. application-profiles, connectivity-insights, quality-on-demand) will be describe to identify if any and which new API(s) are needed
+* Describe the concept, develop, document, and test the APIs
+* Started: September 2024
+* Originally proposed as Quality by Design (QbD) - has been renamed to SessionInsights to better reflect the scope of the API
+
+
+
+
+## Release Information
+
+The repository has no (pre)releases yet, work in progress is within the main branch.
+
+
+## Contributing
+* Meetings are held virtually
+ * Schedule: Bi-weekly on Wednesday at 8AM PST (see https://wiki.camaraproject.org/display/CAM/ConnectivityInsights)
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/92345695827?password=35dff2b2-058d-44de-bd7e-67d08c9e9f9d)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/vzve)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project https://lists.camaraproject.org/g/sp-coi.
+ * A message to the community of this Sub Project can be sent using sp-coi@lists.camaraproject.org.
diff --git a/marked/SessionInsights/code/API_definitions/README/raw.md b/marked/SessionInsights/code/API_definitions/README/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..04313f153aeff65f43b757c99d7f1296cfbf3183
--- /dev/null
+++ b/marked/SessionInsights/code/API_definitions/README/raw.md
@@ -0,0 +1 @@
+Here you can add your definitions and delete this README.MD file
diff --git a/marked/SessionInsights/code/API_definitions/session-insights/raw.md b/marked/SessionInsights/code/API_definitions/session-insights/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..82e2656dc4a1861797b9143c2b0757410ca11061
--- /dev/null
+++ b/marked/SessionInsights/code/API_definitions/session-insights/raw.md
@@ -0,0 +1,1063 @@
+# session-insights
+
+```yaml
+openapi: 3.0.3
+info:
+ title: Session Insights
+ version: wip
+ x-camara-commonalities: 0.6
+ license:
+ name: Apache 2.0
+ url: https://www.apache.org/licenses/LICENSE-2.0.html
+ description: |
+ The Session Insights API is part of the CAMARA Connectivity Insights API group. It extends the capabilities of the Connectivity Insights API by enabling applications to continuously monitor and evaluate their real-time session quality, based on observed KPIs and network operator feedback.
+
+ While the Connectivity Insights API allows applications to query whether a network can meet predefined performance thresholds (e.g., jitter, packet loss, bitrate), the Session Insights API supports the lifecycle of an ongoing session. It allows applications to stream KPI metrics to the network operator, receive dynamic scoring on current session performance, and engage in adaptive optimization strategies.
+
+ # Key Features
+
+ - Create a monitoring session using an existing Application Profile.
+ - Send application-level KPIs (e.g., latency, jitter, throughput, loss) to the network operator.
+ - Receive a Session Insights Score reflecting network-evaluated session quality.
+ - Respond to events and adjust application configuration.
+ - Receive notifications and root cause analysis (RCA) when session quality degrades.
+ - Request network service improvements using complementary CAMARA APIs (e.g., QualityOnDemand, NetworkAccessManagement).
+ - Gracefully terminate the session when monitoring is no longer needed.
+
+ # Use of Application Profiles API
+
+ This API leverages CAMARA’s [Application Profiles](https://github.com/camaraproject/ApplicationProfiles) to define threshold criteria for session quality. The Application Profile specifies the application's expected network performance requirements and is referenced when creating a session.
+
+ # Example Use Cases
+
+ ## Wi-Fi Congestion Mitigation
+ - Application sets thresholds for latency and packet loss.
+ - Session score drops due to congestion, triggering an RCA event.
+ - RCA identifies local Wi-Fi congestion; application adjusts QoS policies (e.g., enables WMM) to prioritize traffic.
+
+ ## Access Network Impairment
+ - Degraded score attributed to poor signal or congestion in the access network.
+ - Application requests service enhancement through APIs like QualityOnDemand or NetworkAccessManagement.
+
+ # Authorization and Authentication
+
+ ## Identifying the [ device | phone number ](*) from the access token
+
+ This API requires the API consumer to identify a device as the subject of the API as follows:
+ - When the API is invoked using a two-legged access token, the subject will be identified from the optional `device` object, which therefore MUST be provided.
+ - When a three-legged access token is used however, this optional identifier MUST NOT be provided, as the subject will be uniquely identified from the access token.
+
+ This approach simplifies API usage for API consumers using a three-legged access token to invoke the API by relying on the information that is associated with the access token and was identified during the authentication process.
+
+ ## Error handling:
+
+ - If the subject cannot be identified from the access token and the optional `device` object is not included in the request, then the server will return an error with the `422 MISSING_IDENTIFIER` error code.
+
+ - If the subject can be identified from the access token and the optional `device` is also included in the request, then the server will return an error with the `422 UNNECESSARY_IDENTIFIER` error code. This will be the case even if the same [ device | phone number ](*) is identified by these two methods, as the server is unable to make this comparison.
+
+ # Additional CAMARA error responses
+
+ The list of error codes in this API specification is not exhaustive. Therefore the API specification may not document some non-mandatory error statuses as indicated in `CAMARA API Design Guide`.
+
+ Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version.
+
+ As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API.
+
+externalDocs:
+ description: Project documentation at CAMARA
+ url: https://github.com/camaraproject/SessionInsights
+
+servers:
+ - url: "{apiRoot}/session-insights/vwip"
+ variables:
+ apiRoot:
+ default: http://localhost:9091
+ description: |
+ API root, defined by service provider, e.g.
+ `api.example.com` or `api.example.com/somepath`
+
+tags:
+ - name: Session Insights
+ description: |
+ Manage the lifecycle of real-time monitoring sessions between an application and the network.
+ Applications can stream KPIs, receive session scores and event notifications, and take actions
+ based on current session quality and network conditions.
+
+
+paths:
+ /sessions:
+ post:
+ tags:
+ - Session Insights
+ summary: Create a Session Insights session
+ description: |
+ Create a new session for monitoring application performance and network
+ quality. The session can be used to stream KPIs, receive session
+ scores, and handle RCA events.
+
+ The session is created under an existing Application Profile, which
+ defines the expected performance thresholds and other parameters.
+
+ The operator allocates a sink (HTTP webhook or MQTT topic) for the
+ application to send metrics and receive notifications.
+ operationId: createSession
+ parameters:
+ - $ref: "#/components/parameters/x-correlator"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ oneOf:
+ - $ref: "#/components/schemas/HTTPSessionRequest"
+ - $ref: "#/components/schemas/MQTTSessionRequest"
+ discriminator:
+ propertyName: protocol
+ responses:
+ "201":
+ description: Session created
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/CreateSessionResponse"
+ "400":
+ $ref: "#/components/responses/BadRequest400"
+ "401":
+ $ref: "#/components/responses/Generic401"
+ "403":
+ $ref: "#/components/responses/Forbidden403"
+ "409":
+ $ref: "#/components/responses/Conflict409"
+ "422":
+ $ref: "#/components/responses/Generic422"
+
+ /sessions/{sessionId}:
+ get:
+ tags:
+ - Session Insights
+ summary: "Get session by sessionId"
+ description: |
+ Retrieve the details of a specific session by its operator-assigned
+ session ID.
+ operationId: getSession
+ parameters:
+ - name: sessionId
+ in: path
+ description: Operator-assigned session ID
+ required: true
+ schema:
+ $ref: "#/components/schemas/SessionId"
+ - $ref: "#/components/parameters/x-correlator"
+ responses:
+ "200":
+ description: Session detail
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Session"
+ "401":
+ $ref: "#/components/responses/Generic401"
+ "403":
+ $ref: "#/components/responses/Forbidden403"
+ "404":
+ $ref: "#/components/responses/NotFound404"
+ "410":
+ $ref: "#/components/responses/Generic410"
+
+ delete:
+ tags:
+ - Session Insights
+ summary: Delete session
+ description: |
+ Delete a session by its operator-assigned session ID. This will stop
+ all notifications and metrics streaming for the session.
+ operationId: deleteSession
+ parameters:
+ - name: sessionId
+ in: path
+ description: Operator-assigned session ID
+ required: true
+ schema:
+ $ref: "#/components/schemas/SessionId"
+ - $ref: "#/components/parameters/x-correlator"
+ responses:
+ "204":
+ description: Deleted
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ "401":
+ $ref: "#/components/responses/Generic401"
+ "403":
+ $ref: "#/components/responses/Forbidden403"
+ "404":
+ $ref: "#/components/responses/NotFound404"
+ "410":
+ $ref: "#/components/responses/Generic410"
+
+ /retrieve-sessions:
+ post:
+ tags:
+ - Session Insights
+ summary: Retrieve Session Insights sessions by device
+ description: |
+ Retrieve all Session Insights sessions for a given device.
+
+ **Notes:**
+ - This operation allows retrieving all active or historical sessions associated with a device.
+ - It uses POST instead of GET to allow passing sensitive device identifiers in the body, per CAMARA guidelines.
+ - The request must include a `device` object if using a two-legged token. If using a three-legged token, do not provide a `device` as the device is derived from the token.
+
+ operationId: retrieveSessionsByDevice
+ parameters:
+ - $ref: "#/components/parameters/x-correlator"
+ requestBody:
+ description: Parameters to get Session Insights session information by device
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/RetrieveSessionsInput"
+ required: true
+ responses:
+ "200":
+ description: An array of sessions matching the specified device. Empty array if none found.
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/RetrieveSessionsOutput"
+ "400":
+ $ref: "#/components/responses/BadRequest400"
+ "401":
+ $ref: "#/components/responses/Generic401"
+ "403":
+ $ref: "#/components/responses/Forbidden403"
+ "404":
+ $ref: "#/components/responses/NotFound404"
+ "422":
+ $ref: "#/components/responses/Generic422"
+ "429":
+ $ref: "#/components/responses/Generic429"
+
+ /sessions/{sessionId}/metrics:
+ post:
+ tags:
+ - Session Insights
+ summary: Send session metrics
+ description: |
+ Stream application-level KPIs (e.g., latency, jitter, throughput, loss)
+ to the network operator for the specified session. This is used to
+ evaluate session quality and trigger notifications if thresholds are
+ breached.
+ operationId: sendSessionMetrics
+ parameters:
+ - name: sessionId
+ in: path
+ description: Operator-assigned session ID
+ required: true
+ schema:
+ $ref: "#/components/schemas/SessionId"
+ - $ref: "#/components/parameters/x-correlator"
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/MetricsPayload"
+ responses:
+ "204":
+ description: Metrics accepted
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ "400":
+ $ref: "#/components/responses/BadRequest400"
+ "401":
+ $ref: "#/components/responses/Generic401"
+ "403":
+ $ref: "#/components/responses/Forbidden403"
+ "404":
+ $ref: "#/components/responses/NotFound404"
+ "410":
+ $ref: "#/components/responses/Generic410"
+ "422":
+ $ref: "#/components/responses/Generic422"
+
+components:
+ parameters:
+ x-correlator:
+ name: x-correlator
+ in: header
+ description: Correlation id for the different services
+ schema:
+ $ref: "#/components/schemas/XCorrelator"
+
+ headers:
+ x-correlator:
+ description: Correlation id for the different services
+ schema:
+ $ref: "#/components/schemas/XCorrelator"
+
+ schemas:
+ XCorrelator:
+ type: string
+ pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
+ example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
+
+ SessionId:
+ description: Session ID in UUID format
+ type: string
+ format: uuid
+
+ SessionRequest:
+ description: |
+ Request body for creating a new session. The session is created under
+ an existing Application Profile, which defines the expected
+ performance thresholds and other parameters.
+
+ The operator allocates a sink (HTTP webhook or MQTT topic) for the
+ application to send metrics and receive notifications.
+ type: object
+ properties:
+ applicationProfileId:
+ $ref: "#/components/schemas/ApplicationProfileId"
+ device:
+ $ref: "#/components/schemas/Device"
+ applicationServer:
+ $ref: "#/components/schemas/ApplicationServer"
+ applicationSessionId:
+ type: string
+ description: |
+ Optional app-level meeting / match / stream ID used for correlation.
+ example: "meet-12345"
+ protocol:
+ $ref: "#/components/schemas/Protocol"
+ types:
+ type: array
+ items:
+ $ref: "#/components/schemas/EventType"
+ required:
+ - applicationProfileId
+ - device
+ - applicationServer
+ - protocol
+ - subscribedEventTypes
+
+ SessionBase:
+ type: object
+ properties:
+ id:
+ type: string
+ description: Operator-assigned session ID
+ example: "op-sess-abc123"
+ applicationSessionId:
+ type: string
+ description: Application-provided session reference
+ example: "meet-12345"
+ device:
+ $ref: "#/components/schemas/DeviceResponse"
+ applicationServer:
+ $ref: "#/components/schemas/ApplicationServer"
+ protocol:
+ $ref: "#/components/schemas/Protocol"
+ sink:
+ type: string
+ description: |
+ • HTTP → webhook URL (from request)
+ • MQTT → quality topic (allocated by operator)
+ subscribedEventTypes:
+ type: array
+ items:
+ $ref: "#/components/schemas/EventType"
+ startTime:
+ type: string
+ format: date-time
+ expiresAt:
+ type: string
+ format: date-time
+ required:
+ - id
+ - device
+ - applicationServer
+ - protocol
+ - sink
+ - subscribedEventTypes
+ - startTime
+
+ HTTPSettings:
+ type: object
+ description: No additional settings
+
+ MQTTSettings:
+ type: object
+ required: [brokerUri, metricsTopic, qualityTopic, qos]
+ properties:
+ brokerUri:
+ type: string
+ format: uri
+ metricsTopic:
+ type: string
+ description: Topic the **application PUBLISHES** KPI messages to
+ example: session/op-sess-abc123/appSession/meet-12345/metrics
+ qualityTopic:
+ type: string
+ description: Topic the **application SUBSCRIBES** to for CloudEvents
+ example: session/op-sess-abc123/appSession/meet-12345/quality
+ qos:
+ type: integer
+ enum:
+ - 0
+ - 1
+ retain:
+ type: boolean
+ default: false
+ messageExpiryInterval:
+ type: integer
+
+ HTTPSessionRequest:
+ allOf:
+ - $ref: "#/components/schemas/SessionRequest"
+ - type: object
+ properties:
+ sink:
+ type: string
+ description: Webhook URL for event delivery
+ sinkCredential:
+ type: string
+ description: Optional credential for HTTP callbacks
+ required:
+ - sink
+
+ MQTTSessionRequest:
+ allOf:
+ - $ref: "#/components/schemas/SessionRequest"
+ - type: object
+ properties:
+ sinkCredential:
+ type: string
+ description: Credential for MQTT broker access
+
+ HTTPSession:
+ allOf:
+ - $ref: "#/components/schemas/SessionBase"
+ - type: object
+ properties:
+ protocol:
+ type: string
+ enum:
+ - "HTTP"
+ protocolSettings:
+ $ref: "#/components/schemas/HTTPSettings"
+
+ MQTTSession:
+ allOf:
+ - $ref: "#/components/schemas/SessionBase"
+ - type: object
+ properties:
+ protocol:
+ type: string
+ enum:
+ - "MQTT3"
+ - "MQTT5"
+ protocolSettings:
+ $ref: "#/components/schemas/MQTTSettings"
+
+ Session:
+ oneOf:
+ - $ref: "#/components/schemas/HTTPSession"
+ - $ref: "#/components/schemas/MQTTSession"
+ discriminator:
+ propertyName: protocol
+
+ CreateHTTPSession:
+ allOf:
+ - $ref: "#/components/schemas/HTTPSession"
+ - type: object
+ properties:
+ sinkCredential:
+ type: string
+ description: Returned only on creation (HTTP)
+
+ CreateMQTTSession:
+ allOf:
+ - $ref: "#/components/schemas/MQTTSession"
+ - type: object
+ properties:
+ sinkCredential:
+ type: string
+ description: Broker credential (creation only)
+
+ CreateSessionResponse:
+ oneOf:
+ - $ref: "#/components/schemas/CreateHTTPSession"
+ - $ref: "#/components/schemas/CreateMQTTSession"
+ discriminator:
+ propertyName: protocol
+
+ Device:
+ description: |
+ End-user equipment able to connect to a network. Examples of
+ devices include smartphones or IoT sensors/actuators.
+
+ The developer can choose to provide the below specified device
+ identifiers:
+
+ * `ipv4Address`
+ * `ipv6Address`
+ * `phoneNumber`
+ * `networkAccessIdentifier`
+
+ type: object
+ properties:
+ phoneNumber:
+ $ref: "#/components/schemas/PhoneNumber"
+ networkAccessIdentifier:
+ $ref: "#/components/schemas/NetworkAccessIdentifier"
+ ipv4Address:
+ $ref: "#/components/schemas/DeviceIpv4Addr"
+ ipv6Address:
+ $ref: "#/components/schemas/DeviceIpv6Address"
+ minProperties: 1
+
+ DeviceResponse:
+ description: |
+ An identifier for the end-user equipment able to connect to the network
+ that the response refers to. This parameter is only returned when the
+ API consumer includes the `device` parameter in their request (i.e.
+ they are using a two-legged access token), and is relevant when more
+ than one device identifier is specified, as only one of those device
+ identifiers is allowed in the response.
+
+ If the API consumer provides more than one device identifier in their
+ request, the API provider must return a single identifier which is the
+ one they are using to fulfil the request, even if the identifiers do
+ not match the same device. API provider does not perform any logic to
+ validate/correlate that the indicated device identifiers match the same
+ device. No error should be returned if the identifiers are otherwise
+ valid to prevent API consumers correlating different identifiers with a
+ given end user.
+ allOf:
+ - $ref: "#/components/schemas/Device"
+ - maxProperties: 1
+
+ NetworkAccessIdentifier:
+ description: |
+ 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.
+ type: string
+ example: "123456789@domain.com"
+
+ PhoneNumber:
+ description: |
+ 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,
+ optionally prefixed with '+'.
+ type: string
+ pattern: '^\+?[0-9]{5,15}$'
+ example: "123456789"
+
+ DeviceIpv4Addr:
+ type: object
+ description: |
+ The device should be identified by either the public (observed) IP
+ address and port as seen by the application server, or the private
+ (local) and any public (observed) IP addresses in use by the device
+ (this information can be obtained by various means, for example from
+ some DNS servers).
+
+ If the allocated and observed IP addresses are the same (i.e. NAT is
+ not in use) then the same address should be specified for both
+ publicAddress and privateAddress.
+
+ If NAT64 is in use, the device should be identified by its
+ publicAddress and publicPort, or separately by its allocated IPv6
+ address (field ipv6Address of the Device object)
+
+ In all cases, publicAddress must be specified, along with at least one
+ of either privateAddress or publicPort, dependent upon which is known.
+ In general, mobile devices cannot be identified by their public IPv4
+ address alone.
+ properties:
+ publicAddress:
+ $ref: "#/components/schemas/SingleIpv4Addr"
+ privateAddress:
+ $ref: "#/components/schemas/SingleIpv4Addr"
+ publicPort:
+ $ref: "#/components/schemas/Port"
+ anyOf:
+ - required: [publicAddress, privateAddress]
+ - required: [publicAddress, publicPort]
+ example: {"publicAddress": "84.125.93.10", "publicPort": 59765}
+
+ DeviceIpv6Address:
+ description: |
+ The device should be identified by the observed IPv6 address, or by any
+ single IPv6 address from within the subnet allocated to the device
+ (e.g. adding ::0 to the /64 prefix).
+
+ The session shall apply to all IP flows between the device subnet and
+ the specified application server, unless further restricted by the
+ optional parameters devicePorts or applicationServerPorts.
+ type: string
+ format: ipv6
+ example: 2001:db8:85a3:8d3:1319:8a2e:370:7344
+ SingleIpv4Addr:
+ description: A single IPv4 address with no subnet mask
+ type: string
+ format: ipv4
+ example: "84.125.93.10"
+
+ Port:
+ description: TCP or UDP port number
+ type: integer
+ minimum: 0
+ maximum: 65535
+
+ ApplicationProfileId:
+ description: Identifier for the Application Profile
+ type: string
+ format: uuid
+
+ ApplicationServer:
+ type: object
+ minProperties: 1
+ properties:
+ domainName:
+ type: string
+ ipv4Address:
+ type: string
+ format: ipv4
+ ipv6Address:
+ type: string
+ format: ipv6
+ port:
+ type: integer
+
+ Protocol:
+ type: string
+ enum:
+ - HTTP
+ - MQTT3
+ - MQTT5
+
+ EventType:
+ type: string
+ enum:
+ - org.camaraproject.session-insights.v0.quality-score
+ - org.camaraproject.session-insights.v0.network-event
+ - org.camaraproject.session-insights.v0.proposed-resolution
+ - org.camaraproject.session-insights.v0.subscription-ends
+
+ # ---------- CloudEvents & data payloads ----------
+ CloudEvent:
+ type: object
+ properties:
+ specversion:
+ type: string
+ enum:
+ - "1.0"
+ id:
+ type: string
+ source:
+ type: string
+ type:
+ $ref: "#/components/schemas/EventType"
+ time:
+ type: string
+ format: date-time
+ datacontenttype:
+ type: string
+ default: application/json
+ data:
+ type: object
+ required:
+ - specversion
+ - id
+ - source
+ - type
+ - time
+ - data
+
+ SessionQualityData:
+ type: object
+ properties:
+ upstreamRate:
+ description: |
+ The upstream bitrate
+ allOf:
+ - $ref: "#/components/schemas/Rate"
+ downstreamRate:
+ description: |
+ The downstream bitrate
+ allOf:
+ - $ref: "#/components/schemas/Rate"
+ packetDelay:
+ description: |
+ The packet delay one-way latency between the customer's device
+ and the gateway from the operator's network to other networks. By limiting the delay, the network
+ can provide an acceptable level of performance for various services, such as voice calls,
+ video streaming, and data.
+ The end-to-end or round trip latency will be about two times this value plus the latency not controlled
+ by the operator
+ allOf:
+ - $ref: "#/components/schemas/Duration"
+ jitter:
+ description: |
+ The variation in round-trip
+ packet delay for the 99th percentile of traffic, following ITU Y.1540
+ standards. It considers only acknowledged packets in a session, which are
+ packets that receive a confirmation of receipt from the recipient (e.g.,
+ using TCP). This requirement helps maintain consistent latency, essential
+ for real-time applications such as VoIP, video calls, and gaming.
+ allOf:
+ - $ref: "#/components/schemas/Duration"
+ packetErrorLossRate:
+ type: integer
+ description: |
+ This field specifies the measured level of data loss during transmission.
+ The value is an exponent of 10, so a value of 3 means that up to 10⁻³, or 0.1%, of the
+ data packets may be lost. This setting is part of a broader system that categorizes
+ different types of network traffic (like phone calls, video streams, or data transfers)
+ to ensure they perform reliably on the network.
+ format: int32
+ minimum: 1
+ maximum: 10
+ example: 3
+ resolution:
+ type: string
+ score:
+ type: integer
+ required:
+ - packetDelay
+ - jitter
+ - packetErrorLossRate
+ - downstreamRate
+ - upstreamRate
+ - resolution
+ - score
+
+ ScoreAlertData:
+ type: object
+ properties:
+ score:
+ type: integer
+ threshold:
+ type: integer
+ severity:
+ type: string
+ enum:
+ - warning
+ - critical
+ required:
+ - score
+
+ ResolutionProposedData:
+ type: object
+ properties:
+ resolutionType:
+ type: string
+ enum:
+ - NETWORK_QOS
+ - APPLICATION_CONFIG
+ - OTHER
+ description:
+ type: string
+ required:
+ - resolutionType
+ - description
+
+ SubscriptionEndsData:
+ type: object
+ properties:
+ reason:
+ type: string
+
+ SessionQualityNotification:
+ allOf:
+ - $ref: "#/components/schemas/CloudEvent"
+ - type: object
+ properties:
+ type:
+ enum:
+ - org.camaraproject.session-insights.v0.quality-score
+ data:
+ $ref: "#/components/schemas/SessionQualityData"
+
+ ScoreAlertNotification:
+ allOf:
+ - $ref: "#/components/schemas/CloudEvent"
+ - type: object
+ properties:
+ type:
+ enum:
+ - org.camaraproject.session-insights.v0.network-event
+ data:
+ $ref: "#/components/schemas/ScoreAlertData"
+
+ ResolutionProposedNotification:
+ allOf:
+ - $ref: "#/components/schemas/CloudEvent"
+ - type: object
+ properties:
+ type:
+ enum:
+ - org.camaraproject.session-insights.v0.proposed-resolution
+ data:
+ $ref: "#/components/schemas/ResolutionProposedData"
+
+ SubscriptionEndsNotification:
+ allOf:
+ - $ref: "#/components/schemas/CloudEvent"
+ - type: object
+ properties:
+ type:
+ enum:
+ - org.camaraproject.session-insights.v0.subscription-ends
+ data:
+ $ref: "#/components/schemas/SubscriptionEndsData"
+
+ NotificationEvent:
+ oneOf:
+ - $ref: "#/components/schemas/SessionQualityNotification"
+ - $ref: "#/components/schemas/ScoreAlertNotification"
+ - $ref: "#/components/schemas/ResolutionProposedNotification"
+ - $ref: "#/components/schemas/SubscriptionEndsNotification"
+ discriminator:
+ propertyName: type
+
+ MetricsPayload:
+ type: object
+ description: KPI message published to `metricsTopic`
+ properties:
+ latency:
+ type: number
+ format: float
+ jitter:
+ type: number
+ format: float
+ packetLoss:
+ type: number
+ bitrate:
+ type: number
+ resolution:
+ type: string
+ required:
+ - latency
+ - jitter
+ - packetLoss
+ - bitrate
+ - resolution
+
+ Rate:
+ description: Specification of rate
+ type: object
+ properties:
+ value:
+ description: Quantity of rate
+ type: integer
+ example: 10
+ format: int32
+ minimum: 0
+ maximum: 1024
+ unit:
+ $ref: "#/components/schemas/RateUnitEnum"
+
+ Duration:
+ description: Specification of duration
+ type: object
+ properties:
+ value:
+ description: Quantity of duration
+ type: integer
+ example: 12
+ format: int32
+ minimum: 1
+ unit:
+ $ref: "#/components/schemas/TimeUnitEnum"
+
+ TimeUnitEnum:
+ description: Units of time
+ type: string
+ enum:
+ - Days
+ - Hours
+ - Minutes
+ - Seconds
+ - Milliseconds
+ - Microseconds
+ - Nanoseconds
+
+ RateUnitEnum:
+ description: Units of rate
+ type: string
+ enum:
+ - bps
+ - kbps
+ - Mbps
+ - Gbps
+ - Tbps
+
+ ErrorInfo:
+ type: object
+ properties:
+ status:
+ type: integer
+ code:
+ type: string
+ message:
+ type: string
+ required:
+ - status
+ - code
+ - message
+
+ RetrieveSessionsInput:
+ description: Parameters to get QoS session information by device
+ type: object
+ properties:
+ device:
+ $ref: "#/components/schemas/Device"
+
+ RetrieveSessionsOutput:
+ description: QoS session information for a given device
+ type: array
+ items:
+ $ref: "#/components/schemas/Session"
+ minItems: 0
+
+
+ responses:
+ BadRequest400:
+ description: Bad request
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorInfo"
+
+ Generic401:
+ description: Unauthorized
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 401
+ code:
+ enum:
+ - UNAUTHENTICATED
+
+ Forbidden403:
+ description: Forbidden
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorInfo"
+
+ NotFound404:
+ description: Not found
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorInfo"
+
+ Conflict409:
+ description: Conflict
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ErrorInfo"
+
+ Generic410:
+ description: Gone
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 410
+ code:
+ enum:
+ - GONE
+
+ Generic422:
+ description: Unprocessable Content
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 422
+ code:
+ enum:
+ - SERVICE_NOT_APPLICABLE
+ - MISSING_IDENTIFIER
+ - UNSUPPORTED_IDENTIFIER
+ - UNNECESSARY_IDENTIFIER
+
+ Generic429:
+ description: Too Many Requests
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 429
+ code:
+ enum:
+ - QUOTA_EXCEEDED
+ - TOO_MANY_REQUESTS
+```
diff --git a/marked/SessionInsights/documentation/API_documentation/SessionInsights_User_Story/raw.md b/marked/SessionInsights/documentation/API_documentation/SessionInsights_User_Story/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..83c024671f55e31e4755e08467cfd09c12d4a1bb
--- /dev/null
+++ b/marked/SessionInsights/documentation/API_documentation/SessionInsights_User_Story/raw.md
@@ -0,0 +1,15 @@
+# Session Insights (SI) User Story
+
+| **Item** | **Description** |
+| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **_Summary_** | As an application developer, I want to be able to stream my application's network KPIs to the network operator. This allows the network operator to monitor in real-time whether it is meeting these dynamic requirements, and if not, proactively suggest or implement corrective measures to maintain optimal performance. |
+| **_Roles, Actor(s) and scope_** | **Roles:** API Consumer:Developer
+
+
+
+
+
+
+
+
+# ShortMessageService
+
+Sandbox API Repository to describe, develop, document, and test the ShortMessageService Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/wSne)
+
+## Scope
+* Service APIs for “Short Message Service” (see APIBacklog.md)
+* It provides the customer with the ability to:
+ * to send SMS to the destination address(es). There are 3 different categories of SMS i.e. Service, Promotional & Transactional. This API is used to send all categories of messages. Pre-requisite for using this API is that SMS Sender application / enterprise (or customer) needs to onboard itself with the access provider before using this API. This API has only single operation i.e. Send SMS - Provides the capability to deliver SMS to the recepient. In order to the receive delivery receipt separate API to be defined which is to be implemented by the API consumer for sending back the delivery receipt to the 'Send SMS' API consumer in a standardized callback API.
+ * NOTE: The scope of these APIs should be limited (at least at a first stage) to 4G and 5G.
+* Describe, develop, document and test the APIs (with 1-2 Telcos)
+* Started: December 2023
+* Location: virtually
+
+## Meetings
+* Meetings are held virtually
+* Schedule: tbd
+* Meeting link: tbd
+
+## Contributorship and mailing list
+* To subscribe / unsubscribe to the mailing list of this Sub Project and thus be / resign as Contributor please visit 
+
+
+
+
+
+
+
+
+# SimSwap
+
+Incubating API Repository to evolve and maintain the definitions and documentation of SimSwap Service APIs within the Sub Project [Number Insights](https://lf-camaraproject.atlassian.net/wiki/x/BYEpBQ)
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/0jXe)
+
+## Scope
+
+* Service APIs for “SimSwap” (see APIBacklog.md)
+* The APIs provide the API consumer with the ability to:
+ * obtain information on any recent SIM pairing change related to the User’s mobile account.
+* Describe, develop, document and test the APIs (with 1-2 Telcos)
+* Started: October 2022
+* Incubating stage since: February 2025
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r3.3](https://github.com/camaraproject/SimSwap/releases/tag/r3.3) (Fall25), with the following API versions:
+ * **sim-swap-subscriptions v0.3.0**
+ [[YAML]](https://github.com/camaraproject/SimSwap/blob/r3.3/code/API_definitions/sim-swap-subscriptions.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r3.3/code/API_definitions/sim-swap-subscriptions.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r3.3/code/API_definitions/sim-swap-subscriptions.yaml)
+ * **sim-swap v2.1.0**
+ [[YAML]](https://github.com/camaraproject/SimSwap/blob/r3.3/code/API_definitions/sim-swap.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r3.3/code/API_definitions/sim-swap.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/SimSwap/r3.3/code/API_definitions/sim-swap.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/SimSwap/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/SimSwap/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/SimSwap/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings are held virtually
+ * Schedule: Every 4 weeks, Thursday, 7:30 AM UTC (8:30 CET/9:30 CEST)
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/94893248838?password=05b2197d-309e-41ef-aadf-639f71ef7f38)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/hDze)
+* Mailing List:
+ * Subscribe / Unsubscribe to the mailing list 
+
+
+
+
+
+
+
+
+# SimpleEdgeDiscovery
+
+Incubating API Repository to evolve and maintain the definitions and documentation of SimpleEdgeDiscovery Service API(s) within the Sub Project [Edge Cloud](https://lf-camaraproject.atlassian.net/wiki/x/IwEpBQ)
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/QwCbBQ)
+
+## Scope
+* Service APIs for “SimpleEdgeDiscovery” (see APIBacklog.md)
+* It provides the API Consumer with the ability to:
+ * Discover the closest edge cloud zone to a given device.
+ * NOTE: The scope of this API should be limited (at least at the first stage) to 4G and 5G.
+* Describe, develop, document, and test the APIs
+* Started: June 2022 (as part of [EdgeCloud](https://github.com/camaraproject/EdgeCloud/))
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r2.2](https://github.com/camaraproject/SimpleEdgeDiscovery/releases/tag/r2.2) (Fall25), with the following API versions:
+ * **simple-edge-discovery v2.0.0**
+ [[YAML]](https://github.com/camaraproject/SimpleEdgeDiscovery/blob/r2.2/code/API_definitions/simple-edge-discovery.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SimpleEdgeDiscovery/r2.2/code/API_definitions/simple-edge-discovery.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/SimpleEdgeDiscovery/r2.2/code/API_definitions/simple-edge-discovery.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/SimpleEdgeDiscovery/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/SimpleEdgeDiscovery/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/SimpleEdgeDiscovery/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings (as part of Edge Cloud Sub Project)
+ * [Registration/Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/94237809115?password=05fb6d8a-a913-47d8-b003-db75ecdaa5d9)
+ * Schedule: Tuesdays 16h-17 CET, every two weeks.
+ * Minutes: Access [meeting minutes](https://wiki.camaraproject.org/display/CAM/EdgeCloud+Meeting+Minutes).
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project [https://lists.camaraproject.org/g/sp-edc](https://lists.camaraproject.org/g/sp-edc).
+ * A message to the community of this Sub Project can be sent using [sp-edc@lists.camaraproject.org](sp-edc@lists.camaraproject.org).
diff --git a/marked/SimpleEdgeDiscovery/code/API_definitions/simple-edge-discovery/raw.md b/marked/SimpleEdgeDiscovery/code/API_definitions/simple-edge-discovery/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..c6ea305942a95de1ac2ffb65daae243afec9d18c
--- /dev/null
+++ b/marked/SimpleEdgeDiscovery/code/API_definitions/simple-edge-discovery/raw.md
@@ -0,0 +1,712 @@
+# simple-edge-discovery
+
+```yaml
+---
+openapi: 3.0.3
+info:
+ title: Simple Edge Discovery
+ version: wip
+ x-camara-commonalities: 0.6
+ description: |
+ # Find the closest Edge Cloud Zone
+ ---
+ # Summary
+
+ The Simple Edge Discovery API returns the name of the closest operator Edge
+ Cloud Zone to a particular user device.
+
+ # Purpose
+ Network operators may host multiple Edge Cloud Zones in a
+ given territory. Connecting your application to a server on the closest
+ Edge Cloud Zone means packets travel the shortest distance between
+ endpoints, typically resulting in the lowest round-trip latency. Note, the
+ physical (GPS) location of a user device is not a reliable way to determine
+ the closest Edge Cloud Zone, due to the way operator networks are routed -
+ so the operator will calculate the Edge Cloud Zone with the
+ _shortest network path_ to the network-attached device identified in the API
+ request.
+
+ Once you have the name of the closest Edge Cloud Zone to the user device,
+ you may:
+
+ * connect the application client on the user device to your application
+ server instance on that Edge Cloud Zone. Note: the IP address of that
+ application server instance is not part of the API response, so you will need
+ to map the edge cloud zone name to the server endpoint IP address you received
+ when you deployed the server via the cloud provider's API.
+ * or, if you have no instance on that Edge Cloud Zone, you may wish to
+ deploy one there using the cloud provider's APIs.
+
+ Note: the provider of the Edge Cloud Zone may be an operator, or a cloud
+ provider working in partnership with the operator.
+
+ # Usage
+
+ The API may be called either by an application client hosted on a device
+ attached to the operator network (i.e. phone, tablet), or by a server.
+
+ There is a single API endpoint: `/retrieve-closest-edge-cloud-zone`.
+
+ To call this endpoint, the API consumer must first obtain a valid OAuth2 token
+ from the token endpoint, and pass it as an `Authorization` header in the API
+ request.
+
+ # Identifying the device
+
+ The API returns the closest Edge Cloud Zone to a given device, so that
+ device needs to be identifiable by the network. This can be achieved either
+ by passing one or more device identifiers in the request, or, from the
+ three-legged access token where implemented by the operator.
+
+ ## Passing device identifier(s) in the request
+ At least one of the following device identifiers must be provided, unless
+ using a 3-legged access token (see next section):
+ - Phone number (i.e. MSISDN)
+ - Network Access Identifier assigned by the mobile network operator for the device
+ - IPv6 address
+ - IPv4 address
+
+
+ NOTE1: the network operator might support only a subset of these options.
+ The API invoker can provide multiple identifiers to be compatible across
+ different network operators. In this case the identifiers MUST belong to the
+ same device.
+
+ NOTE2: for this Commonalities release, we are enforcing that the
+ `networkAccessIdentifier` is only part of the schema for future-proofing, and
+ CAMARA does not currently allow its use. After the CAMARA meta-release work
+ is concluded and the relevant issues are resolved, its use will need to be
+ explicitly documented in the guidelines.
+
+
+ ## Identifying the device from the access token
+
+ This API requires the API consumer to identify a device as the subject of
+ the API as follows:
+
+ - When the API is invoked using a two-legged access token, the subject will be
+ identified from the optional `device` object, which therefore MUST be provided.
+ - When a three-legged access token is used however, this optional identifier
+ MUST NOT be provided, as the subject will be uniquely identified from the access
+ token.
+
+ This approach simplifies API usage for API consumers using a three-legged access
+ token to invoke the API by relying on the information that is associated with the
+ access token and was identified during the authentication process.
+
+ ## Error handling:
+
+ - If the subject cannot be identified from the access token and the optional `device`
+ object is not included in the request, then the server will return an error with the
+ `422 MISSING_IDENTIFIER` error code.
+
+ - If the subject can be identified from the access token and the optional `device`
+ object is also included in the request, then the server will return an error with the
+ `422 UNNECESSARY_IDENTIFIER` error code. This will be the case even if the same device
+ is identified by these two methods, as the server is unable to make this comparison.
+
+ # Responses
+
+ ## Success
+
+ A JSON object is returned containing an array with a single member object.
+ This contains identifiers for the closest Edge Cloud Zone. The HTTP status
+ code will be`200 OK`. An example response:
+
+ ```
+ [
+ {
+ "edgeCloudZoneId": "4gt555-6457-7890-d4he-1dc79f44gb66",
+ "edgeCloudZoneName": "example zone name",
+ "edgeCloudProvider": "example zone provider"
+ }
+ ]
+ ```
+ * `edgeCloudZoneId` is a UUID for the Edge Cloud Zone.
+ * `edgeCloudZoneName` is the common name of the closest Edge Cloud Zone to
+ the user device.
+ * `edgeCloudProvider` is the name of the operator or cloud provider of
+ the Edge Cloud Zone.
+
+ ## Errors
+
+ If the authentication token is not valid, a `401 UNAUTHENTICATED` error is
+ returned.
+
+ If the mobile subscription parameters contain a formatting error, a `400
+ INVALID_ARGUMENT` error is returned.
+
+ If the mobile subscription cannot be identified from the provided
+ parameters, a `404 NOT_FOUND` error is returned.
+
+ Any more general service failures will result in an error in the `5xx`range
+ with an explanation.
+
+ ### Additional CAMARA error responses
+ The list of error codes in this API specification is not exhaustive. Therefore
+ the API specification may not document some non-mandatory error statuses as
+ indicated in `CAMARA API Design Guide`.
+
+ Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated
+ to this API version for a complete list of error responses. The applicable
+ Commonalities Release can be identified in the `API Readiness Checklist` document
+ associated to this API version.
+
+ As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error
+ response if it is explicitly documented in the API.
+
+ # Notes for Simple Edge Discovery API publishers
+
+ Should your implementation require the `Port` value to be passed in addition
+ to the `IP-Address`, please make that explicit in the documentation, and
+ utilise the `GENERIC_400_MISSING_PORT` error if the `Port` header is omitted.
+
+ # Authorization and authentication
+
+ The "Camara Security and Interoperability Profile" provides details of how
+ an API consumer requests an access token. Please refer to Identity and Consent
+ Management (https://github.com/camaraproject/IdentityAndConsentManagement/)
+ for the released version of the profile.
+
+ The specific authorization flows to be used will be agreed upon during the
+ onboarding process, happening between the provider of the application consuming
+ the API and the operator's API exposure platform, taking into account the
+ declared purpose for accessing the API, whilst also being subject to the
+ prevailing legal framework dictated by local legislation.
+
+ In cases where personal data is processed by the API and users can exercise
+ their rights through mechanisms such as opt-in and/or opt-out, the use of
+ three-legged access tokens is mandatory. This ensures that the API remains
+ in compliance with privacy regulations, upholding the principles of
+ transparency and user-centric privacy-by-design.
+
+ # Further info and support
+ ---
+
+ license:
+ name: Apache 2.0
+ url: https://www.apache.org/licenses/LICENSE-2.0.html
+
+externalDocs:
+ description: Product documentation at CAMARA.
+ url: https://github.com/camaraproject/EdgeCloud
+
+servers:
+ - url: "{apiRoot}/simple-edge-discovery/vwip"
+ variables:
+ apiRoot:
+ default: https://localhost:9091
+ description: |
+ API root, defined by the service provider, e.g.
+ `api.example.com` or `api.example.com/somepath`
+
+tags:
+ - name: Discovery
+ description: |
+ Find the closest Edge Cloud Zone to the user device.
+
+paths:
+ /retrieve-closest-edge-cloud-zone:
+ post:
+ security:
+ - openId:
+ - simple-edge-discovery:read
+ operationId: readClosestEdgeCloudZone
+ parameters:
+ - in: header
+ name: x-correlator
+ description: Correlation id for the different services
+ required: false
+ schema:
+ $ref: "#/components/schemas/XCorrelator"
+ requestBody:
+ description: Parameters to create a new session
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/RequestBody"
+ examples:
+ Identify Device By 3-Legged Access Token:
+ $ref: '#/components/examples/IdentifyDeviceBy3LeggedToken'
+ Identify Device By Phone Number:
+ $ref: '#/components/examples/IdentifyDeviceByPhoneNumber'
+ Identify Device By IP Address:
+ $ref: '#/components/examples/IdentifyDeviceByIPAddress'
+ Identify Device By Multiple Identifiers:
+ $ref: '#/components/examples/IdentifyDeviceByMultipleIdentifiers'
+
+ responses:
+ "200":
+ $ref: "#/components/responses/200Success"
+ "400":
+ $ref: "#/components/responses/Generic401"
+ "401":
+ $ref: "#/components/responses/Generic401"
+ "403":
+ $ref: "#/components/responses/Generic403"
+ "404":
+ $ref: "#/components/responses/Generic404"
+ "422":
+ $ref: "#/components/responses/Generic422"
+ "429":
+ $ref: "#/components/responses/Generic429"
+
+ tags:
+ - Discovery
+ summary: |
+ Returns the name of the Edge Cloud Zone closest to user device
+ identified in the request.
+ description: |
+ On receiving this request, the network will return the name
+ of the Edge Cloud Zone with the shortest network path to the end user
+ device identified in the request.
+
+components:
+ securitySchemes:
+ openId:
+ description: Common security scheme for all CAMARA APIs
+ type: openIdConnect
+ openIdConnectUrl: https://example.com/.well-known/openid-configuration
+
+ headers:
+ x-correlator:
+ description: Correlation id for the different services
+ required: false
+ schema:
+ $ref: "#/components/schemas/XCorrelator"
+ schemas:
+ EdgeCloudZone:
+ type: object
+ description: |
+ An Edge Cloud Zone, uniquely identified by a combination
+ of the value of the Edge Resource Name object and the value of the
+ Provider object (the name of the cloud provider or operator hosting that
+ edge cloud zone).
+ properties:
+ edgeCloudZoneId:
+ $ref: "#/components/schemas/EdgeCloudZoneId"
+ edgeCloudZoneName:
+ $ref: "#/components/schemas/EdgeCloudZoneName"
+ edgeCloudProvider:
+ $ref: "#/components/schemas/EdgeCloudProvider"
+ required:
+ - edgeCloudZoneId
+ - edgeCloudZoneName
+ - edgeCloudProvider
+
+
+ EdgeCloudZoneId:
+ description: |
+ Operator-issued UUID for the Edge Cloud Zone.
+ type: string
+ format: uuid
+ additionalProperties: false
+
+ EdgeCloudZoneName:
+ description: |
+ Edge Cloud Zone Name - the common name for the Edge Cloud Zone.
+ type: string
+ additionalProperties: false
+
+ EdgeCloudProvider:
+ description: |
+ The company name of the Edge Cloud Zone provider.
+ type: string
+
+ ErrorInfo:
+ type: object
+ description: Error information
+ required:
+ - status
+ - code
+ - message
+ properties:
+ status:
+ type: integer
+ description: HTTP response status code
+ code:
+ type: string
+ description: Friendly Code to describe the error
+ message:
+ type: string
+ description: A human readable description of what the event represents
+
+ RequestBody:
+ description: Common request body to allow optional Device object to be passed
+ type: object
+ properties:
+ device:
+ $ref: "#/components/schemas/Device"
+
+ DeviceResponse:
+ description: |
+ An identifier for the end-user equipment able to connect to the network that the response refers to. This parameter is only returned when the API consumer includes the `device` parameter in their request (i.e. they are using a two-legged access token), and is relevant when more than one device identifier is specified, as only one of those device identifiers is allowed in the response.
+
+ If the API consumer provides more than one device identifier in their request, the API provider must return a single identifier which is the one they are using to fulfil the request, even if the identifiers do not match the same device. API provider does not perform any logic to validate/correlate that the indicated device identifiers match the same device. No error should be returned if the identifiers are otherwise valid to prevent API consumers correlating different identifiers with a given end user.
+
+ allOf:
+ - $ref: "#/components/schemas/Device"
+ - maxProperties: 1
+
+ Device:
+ description: |
+ End-user equipment able to connect to a mobile network. Examples of devices include smartphones or IoT sensors/actuators.
+ The developer can choose to provide the below specified device identifiers:
+ * `ipv4Address`
+ * `ipv6Address`
+ * `phoneNumber`
+ * `networkAccessIdentifier`
+ NOTE 1: the MNO might support only a subset of these options. The API invoker can provide multiple identifiers to be compatible across different MNOs. In this case the identifiers MUST belong to the same device.
+ NOTE 2: as for this Commonalities release, we are enforcing that the networkAccessIdentifier is only part of the schema for future-proofing, and CAMARA does not currently allow its use. After the CAMARA meta-release work is concluded and the relevant issues are resolved, its use will need to be explicitly documented in the guidelines.
+ type: object
+ properties:
+ phoneNumber:
+ $ref: "#/components/schemas/PhoneNumber"
+ networkAccessIdentifier:
+ $ref: "#/components/schemas/NetworkAccessIdentifier"
+ ipv4Address:
+ $ref: "#/components/schemas/DeviceIpv4Addr"
+ ipv6Address:
+ $ref: "#/components/schemas/DeviceIpv6Address"
+ minProperties: 1
+
+ PhoneNumber:
+ description: |
+ 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, prefixed with '+'.
+ type: string
+ pattern: '^\+[1-9][0-9]{4,14}$'
+ example: "+123456789"
+
+ NetworkAccessIdentifier:
+ description: |
+ 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.
+ type: string
+ example: "123456789@domain.com"
+
+ DeviceIpv4Addr:
+ type: object
+ description: |
+ The device should be identified by either the public (observed) IP address and port as seen by the application server, or the private (local) and any public (observed) IP addresses in use by the device (this information can be obtained by various means, for example from some DNS servers).
+
+ If the allocated and observed IP addresses are the same (i.e. NAT is not in use) then the same address should be specified for both publicAddress and privateAddress.
+
+ If NAT64 is in use, the device should be identified by its publicAddress and publicPort, or separately by its allocated IPv6 address (field ipv6Address of the Device object)
+
+ In all cases, publicAddress must be specified, along with at least one of either privateAddress or publicPort, dependent upon which is known. In general, mobile devices cannot be identified by their public IPv4 address alone.
+ properties:
+ publicAddress:
+ $ref: "#/components/schemas/SingleIpv4Addr"
+ privateAddress:
+ $ref: "#/components/schemas/SingleIpv4Addr"
+ publicPort:
+ $ref: "#/components/schemas/Port"
+ anyOf:
+ - required: [publicAddress, privateAddress]
+ - required: [publicAddress, publicPort]
+ example:
+ {
+ "publicAddress": "84.125.93.10",
+ "publicPort": 59765
+ }
+
+ DeviceIpv6Address:
+ description: |
+ The device should be identified by the observed IPv6 address, or by any single IPv6 address from within the subnet allocated to the device (e.g. adding ::0 to the /64 prefix).
+ type: string
+ format: ipv6
+ example: 2001:db8:85a3:8d3:1319:8a2e:370:7344
+
+ SingleIpv4Addr:
+ description: A single IPv4 address with no subnet mask
+ type: string
+ format: ipv4
+ example: "84.125.93.10"
+
+ Port:
+ description: TCP or UDP port number
+ type: integer
+ minimum: 1024
+ maximum: 65535
+
+ XCorrelator:
+ type: string
+ pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
+ example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
+
+ DeviceResponseBody:
+ description: |
+ The optional device identifier to include in the response
+ properties:
+ device:
+ description: |
+ The device identifier that was used to fulfil the request.
+ If this property is not present then the device
+ identifier sent in the request was used.
+ allOf:
+ - $ref: "#/components/schemas/DeviceResponse"
+ - example: {"phoneNumber": "+123456789"}
+
+ responses:
+ 200Success:
+ description: 200 OK
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ required:
+ - edgeCloudZoneId
+ - edgeCloudZoneName
+ - edgeCloudProvider
+ allOf:
+ - $ref: "#/components/schemas/EdgeCloudZone"
+ - $ref: "#/components/schemas/DeviceResponseBody"
+ examples:
+ Closest Edge Cloud details:
+ description: The details of the closest Edge Cloud Zone
+ value:
+ edgeCloudZoneId: "f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
+ edgeCloudZoneName: "UK-SOUTH"
+ edgeCloudProvider: "Example Provider"
+ Closest Edge Cloud plus device identifier:
+ description: The details of the closest Edge Cloud Zone
+ and the device identifier used to fulfill the request
+ value:
+ edgeCloudZoneId: "f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
+ edgeCloudZoneName: "UK-SOUTH"
+ edgeCloudProvider: "Example Provider"
+ device:
+ phoneNumber: "+123456789"
+
+ Generic400:
+ description: Bad Request
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 400
+ code:
+ enum:
+ - INVALID_ARGUMENT
+ - OUT_OF_RANGE
+ examples:
+ GENERIC_400_INVALID_ARGUMENT:
+ description: Invalid Argument. Generic Syntax Exception
+ value:
+ status: 400
+ code: INVALID_ARGUMENT
+ message: Client specified an invalid argument, request body or query param.
+ GENERIC_400_OUT_OF_RANGE:
+ description: Out of Range. Specific Syntax Exception used when a given field has a pre-defined range or a invalid filter criteria combination is requested
+ value:
+ status: 400
+ code: OUT_OF_RANGE
+ message: Client specified an invalid range.
+ Generic401:
+ description: Unauthorized
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 401
+ code:
+ enum:
+ - UNAUTHENTICATED
+ - AUTHENTICATION_REQUIRED
+ examples:
+ GENERIC_401_UNAUTHENTICATED:
+ description: Request cannot be authenticated
+ value:
+ status: 401
+ code: UNAUTHENTICATED
+ message: Request not authenticated due to missing, invalid, or expired credentials.
+ Generic403:
+ description: Forbidden
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 403
+ code:
+ enum:
+ - PERMISSION_DENIED
+ - INVALID_TOKEN_CONTEXT
+ examples:
+ GENERIC_403_PERMISSION_DENIED:
+ description: Permission denied. OAuth2 token access does not have the required scope or when the user fails operational security
+ value:
+ status: 403
+ code: PERMISSION_DENIED
+ message: Client does not have sufficient permissions to perform this action.
+ GENERIC_403_INVALID_TOKEN_CONTEXT:
+ description: Reflect some inconsistency between information in some field of the API and the related OAuth2 Token
+ value:
+ status: 403
+ code: INVALID_TOKEN_CONTEXT
+ message: "{{field}} is not consistent with access token."
+ Generic404:
+ description: Not found
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 404
+ code:
+ enum:
+ - NOT_FOUND
+ - IDENTIFIER_NOT_FOUND
+ examples:
+ GENERIC_404_NOT_FOUND:
+ description: Resource is not found
+ value:
+ status: 404
+ code: NOT_FOUND
+ message: The specified resource is not found.
+ GENERIC_404_IDENTIFIER_NOT_FOUND:
+ description: Some identifier cannot be matched to a device
+ value:
+ status: 404
+ code: IDENTIFIER_NOT_FOUND
+ message: Device identifier not found.
+ Generic422:
+ description: Unprocessable Content
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 422
+ code:
+ enum:
+ - SERVICE_NOT_APPLICABLE
+ - MISSING_IDENTIFIER
+ - UNSUPPORTED_IDENTIFIER
+ - UNNECESSARY_IDENTIFIER
+ examples:
+ GENERIC_422_SERVICE_NOT_APPLICABLE:
+ description: Service not applicable for the provided identifier
+ value:
+ status: 422
+ code: SERVICE_NOT_APPLICABLE
+ message: The service is not available for the provided identifier.
+ GENERIC_422_MISSING_IDENTIFIER:
+ description: An identifier is not included in the request and the device or phone number identification cannot be derived from the 3-legged access token
+ value:
+ status: 422
+ code: MISSING_IDENTIFIER
+ message: The device cannot be identified.
+ GENERIC_422_UNSUPPORTED_IDENTIFIER:
+ description: None of the provided identifiers is supported by the implementation
+ value:
+ status: 422
+ code: UNSUPPORTED_IDENTIFIER
+ message: The identifier provided is not supported.
+ GENERIC_422_UNNECESSARY_IDENTIFIER:
+ description: An explicit identifier is provided when a device or phone number has already been identified from the access token
+ value:
+ status: 422
+ code: UNNECESSARY_IDENTIFIER
+ message: The device is already identified by the access token.
+ Generic429:
+ description: Too Many Requests
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 429
+ code:
+ enum:
+ - QUOTA_EXCEEDED
+ - TOO_MANY_REQUESTS
+ examples:
+ GENERIC_429_QUOTA_EXCEEDED:
+ description: Request is rejected due to exceeding a business quota limit
+ value:
+ status: 429
+ code: QUOTA_EXCEEDED
+ message: Out of resource quota.
+ GENERIC_429_TOO_MANY_REQUESTS:
+ description: Access to the API has been temporarily blocked due to rate or spike arrest limits being reached.
+ value:
+ status: 429
+ code: TOO_MANY_REQUESTS
+ message: Rate limit reached.
+ examples:
+ IdentifyDeviceBy3LeggedToken:
+ description: Empty JSON when device is identified by access token
+ value:
+ {}
+
+ IdentifyDeviceByPhoneNumber:
+ description: Identifying device by phone number
+ value:
+ device:
+ phoneNumber: "+123456789"
+
+ IdentifyDeviceByIPAddress:
+ description: Identifying device by IP address
+ value:
+ device:
+ ipv4Address:
+ publicAddress: "84.125.93.10"
+ publicPort: 59765
+
+ IdentifyDeviceByMultipleIdentifiers:
+ description: Identifying device by multiple device identifiers
+ value:
+ device:
+ phoneNumber: "+123456789"
+ ipv4Address:
+ publicAddress: "84.125.93.10"
+ publicPort: 59765
+ networkAccessIdentifier: "123456789@domain.com"
+```
diff --git a/marked/SimpleEdgeDiscovery/documentation/API_documentation/README/raw.md b/marked/SimpleEdgeDiscovery/documentation/API_documentation/README/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..37aa0ff405bf918d942905c10a0f435fd46c8ffd
--- /dev/null
+++ b/marked/SimpleEdgeDiscovery/documentation/API_documentation/README/raw.md
@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.
diff --git a/marked/SimpleEdgeDiscovery/documentation/API_documentation/SimpleEdgeDiscovery_User_Story/raw.md b/marked/SimpleEdgeDiscovery/documentation/API_documentation/SimpleEdgeDiscovery_User_Story/raw.md
new file mode 100644
index 0000000000000000000000000000000000000000..edddaad50dad1e3ed4ebb089ad2e16f5023319e8
--- /dev/null
+++ b/marked/SimpleEdgeDiscovery/documentation/API_documentation/SimpleEdgeDiscovery_User_Story/raw.md
@@ -0,0 +1,48 @@
+# Simple Edge Discovery API User Story
+
+| **Item** | **Details** |
+| ---- | ------- |
+| ***Summary*** | As an application developer belonging to an enterprise, I want to discover (using either my application server/backend service, or an HTTPS application client on the end-user device) the closest Edge Cloud Zone to a given end-user's device. |
+| ***Roles, Actors and Scope*** | **Roles:** Customer:User
+
+
+
+
+
+
+
+
+# SiteToCloudVPN
+
+Sandbox API Repository to describe, develop, document, and test the SiteToCloudVPN Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/KC3e)
+
+## Scope
+* Service APIs for “Site To Cloud VPN” (see APIBacklog.md)
+* It provides the customer with the ability to:
+ * Instead of ordering a private or customized network service by phone call, or through customer manager manually, this API allows users to create and configure site to cloud network service according to the user request by one click. With the proposed API, when someone calls the API service with network SLA requirements, telecom operators can create non-public cloud leased network service by orchestrating the IP VPN connections of metropolitan network and/or backbone network.
+ * S2C VPN API aims to provide multi-site, multi-cloud network connection for customers, and provide virtual private network services. Currently most of the use cases are in the field of industries, finance, education, medical, Internet of things, cloud desktop, cloud conference, cloud recording and etc.
+* Describe, develop, document and test the APIs (with 1-2 Telcos)
+* Started: December 2023
+* Location: virtually
+
+## Meetings
+* Meetings are held virtually
+* Schedule: Schedule: Biweekly on Friday, 17:50-18:30(GMT+08:00) CST / 11:50-12:30 CET
+* Meeting link: https://teams.live.com/meet/9559310154416?p=X9GldgzTnpV6NUdx / Meeting ID: 955 931 015 441 6 & PWD:V2RXNd
+
+## Contributorship and mailing list
+* To subscribe / unsubscribe to the mailing list of this Sub Project and thus be / resign as Contributor please visit 
+
+
+
+
+
+
+
+
+# SponsoredData
+
+Sandbox API Repository to describe, develop, document, and test the **Sponsored Data Service API(s)**. This repository currently belongs to the *Sandbox* stage and is under active development within the CAMARA framework.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/f4CVDg)
+
+## Scope
+
+The **Sponsored Data** API enables a sponsoring company to cover the data usage of end users for a defined period and/or data volume, thereby strengthening its brand presence and enhancing the user experience.
+
+The API is organized into three hierarchical levels:
+
+- **Sponsor:** The company that finances the sponsored data usage.
+- **Campaigns:** Sets of sponsorship actions contracted by sponsors for various commercial or marketing purposes.
+- **Sponsored Subscribers:** Individual users participating in a campaign, who opt in to receive sponsored data for a defined volume and duration. The sponsorship is always activated upon the user’s explicit choice or consent.
+
+Campaigns can follow one of two commercial models:
+
+Campaigns can be organized under different commercial models, depending on the sponsorship agreement between the Sponsor and the Operator:
+
+- **Prepaid** — The Sponsor pre-purchases a total data volume, from which units are deducted as sponsored sessions are started and consumed.
+- **Postpaid** — The Sponsor is billed at the end of the campaign cycle based on the actual sponsored data consumption.
+
+The API supports the following operations:
+
+- `/start-sponsorship`
+- `/session-status`
+- `/revoke-sponsorship`
+- `/campaign-status`
+- `/active-sponsorships`
+- `/configure-alerts`
+- `/campaign-management`
+
+Identifiers such as **Sponsor_Id**, **Campaign_ID** and **Session_ID** are generated and managed by the Operator Platform (MNO).
+
+
+
+
+## Release Information
+
+The repository has no (pre)releases yet, work in progress is within the main branch.
+
+
+## Contributing
+
+* Meetings are held virtually
+
+ * Schedule: Bi-Weekly on Fridays at 14:00 UTC
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meetings/telcoapi) !! Update this link with your meeting registration/join link and delete the task
+ * Minutes: Access [meeting minutes](https://github.com/camaraproject/SponsoredData/tree/main/documentation/MeetingMinutes)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list 
+
+
+
+
+
+
+
+
+# SubscriptionStatus
+
+Sandbox API Repository to describe, develop, document, and test the SubscriptionStatus Service API within the Sub Project [Know Your Customer](https://lf-camaraproject.atlassian.net/wiki/x/I4DGB) of CAMARA
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/hACbBQ)
+
+## Scope
+
+* Service API “SubscriptionStatus” (see [APIBacklog.md](https://github.com/camaraproject/APIBacklog/blob/main/documentation/APIbacklog.md))
+* The API provides the customer with the ability to:
+ * obtain the current subscription status of a certain phone number, including the subscription of Voice/SMS Inbound, Voice/SMS Outbound, and Data Service Status
+* Describe, develop, document, and test the APIs
+* Started: August 2024
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r1.2](https://github.com/camaraproject/SubscriptionStatus/releases/tag/r1.2) (Fall25), with the following API versions:
+ * **subscription-status v0.1.0**
+ [[YAML]](https://github.com/camaraproject/SubscriptionStatus/blob/r1.2/code/API_definitions/subscription-status.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SubscriptionStatus/r1.2/code/API_definitions/subscription-status.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/SubscriptionStatus/r1.2/code/API_definitions/subscription-status.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/SubscriptionStatus/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/SubscriptionStatus/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/SubscriptionStatus/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings of Sub Project KnowYourCustomer are held virtually
+ * Schedule: Bi-weekly, Tuesday, 09:00 CEST (07:00 UTC)
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/96235150735?password=7e3fea67-a76e-4941-8a70-392cf5545917)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/FAje)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project 
+
+
+
+
+
+
+
+
+# Tenure
+
+Sandbox API Repository to describe, develop, document, and test the Tenure Service API(s) within the Sub Project [Know Your Customer (KYC)](https://lf-camaraproject.atlassian.net/wiki/x/I4DGB).
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/ZIDGB)
+
+## Scope
+* Service API(s) for “Tenure” (see [APIBacklog.md](https://github.com/camaraproject/APIBacklog/blob/main/documentation/APIbacklog.md))
+* It provides the API consumer with the ability to:
+ * Establish a level of trust for a given network subscription identifier (e.g. phone number) by verifying the period of time (i.e. "tenure") for which the end user currently allocated that identifier has been associated with it by their current network operator.
+* Describe, develop, document, and test the APIs
+* Started: May 2024
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r2.2](https://github.com/camaraproject/Tenure/releases/tag/r2.2) (Fall25), with the following API versions:
+ * **kyc-tenure v0.2.0**
+ [[YAML]](https://github.com/camaraproject/Tenure/blob/r2.2/code/API_definitions/kyc-tenure.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/Tenure/r2.2/code/API_definitions/kyc-tenure.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/Tenure/r2.2/code/API_definitions/kyc-tenure.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/Tenure/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/Tenure/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/Tenure/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings and minutes see [KnowYourCustomer Meetings](https://lf-camaraproject.atlassian.net/wiki/x/I4DGB)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project https://lists.camaraproject.org/g/sp-kyc
+ * A message to the community of this Sub Project can be sent using 
+
+
+
+
+
+
+
+
+# TrafficInfluence
+
+Sandbox API Repository to describe, develop, document, and test the TrafficInfluence Service API(s) within the Sub Project [EdgeCloud](https://lf-camaraproject.atlassian.net/wiki/x/ujLe)
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/XQCbBQ)
+
+## Scope
+
+* Service API(s) “TrafficInfluence” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * Influence the traffic flow from the user device toward the Edge instance of the Application providing the optimal routing.
+ * The traffic can be influencend even when the user device moves to a different geographical location to always get the optimal routing toward the nearer instance of an Application.
+* Describe, develop, document, and test the API(s)
+* Started: February 2025 (with previous work in EdgeCloud repository)
+
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r1.3](https://github.com/camaraproject/TrafficInfluence/releases/tag/r1.3) (Fall25), with the following API versions:
+ * **traffic-influence v0.10.0**
+ [[YAML]](https://github.com/camaraproject/TrafficInfluence/blob/r1.3/code/API_definitions/traffic-influence.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/TrafficInfluence/r1.3/code/API_definitions/traffic-influence.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/TrafficInfluence/r1.3/code/API_definitions/traffic-influence.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/TrafficInfluence/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/TrafficInfluence/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/TrafficInfluence/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings of the EdgeCloud Sub Project are held virtually
+ * Schedule: Tuesdays 1400-1500 UTC, every two weeks (see [CAMARA Community Calendar](https://zoom-lfx.platform.linuxfoundation.org/meetings/telcoapi) for concrete dates)
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/94237809115?password=05fb6d8a-a913-47d8-b003-db75ecdaa5d9)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/8Tve)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list 
+
+
+
+
+
+
+
+
+# VerifiedCaller
+
+Sandbox API Repository to describe, develop, document, and test the VerifiedCaller Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/Pive)
+
+## Scope
+
+* Service APIs to deliver secure and branded calls (see “VerifiedCaller” within [APIBacklog.md](https://github.com/camaraproject/APIBacklog/blob/main/documentation/APIbacklog.md))
+* It provides the API consumer with the ability to:
+ * Announce a branded call via the Verified Caller API
+ * Register the content via Service Registration
+ * NOTE: The scope of these APIs should be limited (at least at the first stage) to calls made over 4G or 5G.
+* Describe, develop, document, and test the APIs
+* Started: May 2024
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r1.3](https://github.com/camaraproject/VerifiedCaller/releases/tag/r1.3) (Fall25), with the following API versions:
+ * **brand-registration v0.1.0**
+ [[YAML]](https://github.com/camaraproject/VerifiedCaller/blob/r1.3/code/API_definitions/brand-registration.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/VerifiedCaller/r1.3/code/API_definitions/brand-registration.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/VerifiedCaller/r1.3/code/API_definitions/brand-registration.yaml)
+ * **verified-caller v0.1.0**
+ [[YAML]](https://github.com/camaraproject/VerifiedCaller/blob/r1.3/code/API_definitions/verified-caller.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/VerifiedCaller/r1.3/code/API_definitions/verified-caller.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/VerifiedCaller/r1.3/code/API_definitions/verified-caller.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/VerifiedCaller/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/VerifiedCaller/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/VerifiedCaller/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/95553339882?password=c2022918-91d5-4d3d-9c4f-14b759b16e69)
+ * Schedule: bi-weekly (odd weeks), Thursday, 10:00 AM UTC (11:00 AM CET)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/l/cp/1k9fcyv1)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project 
+
+
+
+
+
+
+
+
+# VoiceNotification
+
+Sandbox API Repository to describe, develop, document, and test the VoiceNotification Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/owAbBw)
+
+## Scope
+
+* Service API(s) “VoiceNotification” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * §Short API scope description§ !! Add here a scope description according to the API proposal
+* Describe, develop, document, and test the API(s)
+* Started: May 2025
+
+
+
+
+
+## Release Information
+
+The repository has no (pre)releases yet, work in progress is within the main branch.
+
+
+## Contributing
+
+* Meetings are held virtually
+
+ * Schedule: !! tbd
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meetings/telcoapi) !! Update this link with your meeting registration/join link and delete the task
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/owAbBw) !! update this link to your minutes archive page using the "Share" link and delete the task
+* Mailing List
+
+ * Subscribe / Unsubscribe to the mailing list 
+
+
+
+
+
+
+
+
+# VoiceVerificationCode
+
+Sandbox API Repository to describe, develop, document, and test the VoiceVerificationCode Service API(s) within the Sub Project [Number Insights](https://lf-camaraproject.atlassian.net/wiki/x/BYEpBQ).
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/nID7Bw)
+
+## Scope
+
+* Service API(s) “VoiceVerificationCode” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * §Short API scope description§ !! ⚠️ Add here a scope description according to the API proposal
+* Describe, develop, document, and test the API(s)
+* Started: June 2025
+
+
+
+
+
+## Release Information
+
+The repository has no (pre)releases yet, work in progress is within the main branch.
+
+
+## Contributing
+
+* Meetings are held virtually
+
+ * Schedule: !! tbd
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meetings/telcoapi) !! Update this link with your meeting registration/join link and delete the task
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/nID7Bw) !! update this link to your minutes archive page using the "Share" link and delete the task
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list 
+
+
+
+
+
+
+
+
+# WebRTC
+
+Sandbox API Repository to describe, develop, document, and test the WebRTC Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/MS7e)
+
+## Scope
+* Service APIs for “WebRTC” (see APIBacklog.md)
+* It provides the API consumer with the ability to:
+ * Add real-time communication capabilities to their applications like video, voice, and generic data.
+ * Enable an API consumer to register for communication services through a network using Oauth 2.0 and OIDC.
+ * Create subscriptions to receive call notifications using CloudEvents: Ability to follow the call establishment process and to receive new incoming calls.
+ * Make and receive calls from the API consumer (client) side establishing a realiable media session to securely exchange media.
+* Describe, develop, document and test the APIs (with 1-2 Telcos)
+* Started: September 2023
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r2.2](https://github.com/camaraproject/WebRTC/releases/tag/r2.2) (Fall25), with the following API versions:
+ * **webrtc-call-handling v0.3.0**
+ [[YAML]](https://github.com/camaraproject/WebRTC/blob/r2.2/code/API_definitions/webrtc-call-handling.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-call-handling.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-call-handling.yaml)
+ * **webrtc-events v0.2.0**
+ [[YAML]](https://github.com/camaraproject/WebRTC/blob/r2.2/code/API_definitions/webrtc-events.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-events.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-events.yaml)
+ * **webrtc-registration v0.3.0**
+ [[YAML]](https://github.com/camaraproject/WebRTC/blob/r2.2/code/API_definitions/webrtc-registration.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-registration.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/r2.2/code/API_definitions/webrtc-registration.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/WebRTC/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/WebRTC/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/WebRTC/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## API Extra documentation
+
+* Find API reference documentation at folder: [code/API_definitions](code/API_definitions/)
+* Find API testing documentation at folder: [code/Test_definitions](code/Test_definitions/)
+* Find release status documentation at folder: [documentation/API_documentation](documentation/API_documentation)
+* Find UML and complementary documentation at folder: [documentation/SupportingDocuments](documentation/SupportingDocuments)
+* For other information refer to [Confluence CAMARA project wiki](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14560817/WebRTC)
+
+## Meetings
+* Meetings are held virtually
+ * Find meeting notes at https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14564608/Minutes+-+WebRTC
+* Schedule:
+ * Tuesdays 4pm CEST (Madrid, Paris, Berlin, Rome), each 15 days
+
+## Contributorship and mailing list
+
+* To subscribe / unsubscribe to the mailing list of this Sub Project and thus be / resign as Contributor please visit 
+
+
+
+
+
+
+
+
+# eSimRemoteManagement
+
+Sandbox API Repository to describe, develop, document, and test the eSimRemoteManagement Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/K4CbFg)
+
+## Scope
+
+* Service API(s) “eSimRemoteManagement” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * Provide eSIM-based remote management capability, allowing users to remotely manage the status of profiles on the device's eUICC and complete remote operations such as downloading, activating, de-activating or deleting.
+* Describe, develop, document, and test the API(s)
+* Started: December 2025
+
+
+
+
+
+## Release Information
+
+The repository has no (pre)releases yet, work in progress is within the main branch.
+
+
+
+## Contributing
+
+* Meetings are held virtually
+ * Schedule: Weekly on Thursday 16:00 CST / 10:00 CEST
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/96461951353?password=150ba7bb-550f-40f6-b8b2-82e67d36ac4e)
+ * Minutes: Access [Meeting minutes](https://wiki.camaraproject.org/display/CAM/eSIMRemoteManagement)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project
+
+
+
+
+
+
+
+
+# ApplicationEndpointDiscovery
+
+Sandbox API Repository to describe, develop, document, and test the ApplicationEndpointDiscovery Service API(s) within the Sub Project [Edge Cloud](https://lf-camaraproject.atlassian.net/wiki/x/IwEpBQ).
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/AQAtC)
+
+## Scope
+
+* Service API(s) “ApplicationEndpointDiscovery” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * Discover the optimal application endpoint(s) that a given end-user's device can connect to.
+* Describe, develop, document, and test the API(s)
+* Started: July 2022 (in [EdgeCloud](https://github.com/camaraproject/EdgeCloud) repository)
+
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r1.2](https://github.com/camaraproject/ApplicationEndpointDiscovery/releases/tag/r1.2) (Fall25), with the following API versions:
+ * **application-endpoint-discovery v0.1.0**
+ [[YAML]](https://github.com/camaraproject/ApplicationEndpointDiscovery/blob/r1.2/code/API_definitions/application-endpoint-discovery.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ApplicationEndpointDiscovery/r1.2/code/API_definitions/application-endpoint-discovery.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ApplicationEndpointDiscovery/r1.2/code/API_definitions/application-endpoint-discovery.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/ApplicationEndpointDiscovery/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/ApplicationEndpointDiscovery/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/ApplicationEndpointDiscovery/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings are held virtually
+ * Schedule: Bi-weekly on Tuesdays 14:00 - 15:00 UTC
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/91868502920?password=a9ec9dff-ea92-4216-b0a1-ce152f49170f)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/8Tve)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list
+
+
+
+
+
+
+
+
+# ApplicationEndpointRegistration
+
+Sandbox API Repository to describe, develop, document, and test the ApplicationEndpointRegistration Service API(s) within the Sub Project [Edge Cloud](https://lf-camaraproject.atlassian.net/wiki/x/IwEpBQ).
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/AQAsC)
+
+## Scope
+
+* Service API(s) “ApplicationEndpointRegistration” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * register the endpoints of an application which is deployed across various Edge Cloud Zones
+* Describe, develop, document, and test the API(s)
+* Started: July 2022 (in [EdgeCloud](https://github.com/camaraproject/EdgeCloud) repository)
+
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r1.2](https://github.com/camaraproject/ApplicationEndpointRegistration/releases/tag/r1.2) (Fall25), with the following API versions:
+ * **application-endpoint-registration v0.1.0**
+ [[YAML]](https://github.com/camaraproject/ApplicationEndpointRegistration/blob/r1.2/code/API_definitions/application-endpoint-registration.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ApplicationEndpointRegistration/r1.2/code/API_definitions/application-endpoint-registration.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ApplicationEndpointRegistration/r1.2/code/API_definitions/application-endpoint-registration.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/ApplicationEndpointRegistration/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/ApplicationEndpointRegistration/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/ApplicationEndpointRegistration/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings are held virtually
+ * Schedule: Bi-weekly on Tuesdays 14:00 - 15:00 UTC
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/91868502920?password=a9ec9dff-ea92-4216-b0a1-ce152f49170f)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/8Tve)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list
+
+
+
+
+
+
+
+
+# ApplicationProfiles
+
+Sandbox API Repository to describe, develop, document, and test the ApplicationProfiles Service API(s) within the context of [ConnectivityInsights](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14561833/ConnectivityInsights)
+
+* API Repository [Wiki page](https://lf-camaraproject.atlassian.net/wiki/x/mgGaBQ)
+
+## Scope
+
+* Service API(s) “ApplicationProfiles” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * Application profiles allows application developers to share all the information about their application which would be relevant for network CAMARA APIs related decision making.
+* Describe, develop, document, and test the API(s)
+* Started: October 2024 (within ConnectivityInsights, own repository since March 2025)
+
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r1.2](https://github.com/camaraproject/ApplicationProfiles/releases/tag/r1.2) (Fall25), with the following API versions:
+ * **application-profiles v0.5.0**
+ [[YAML]](https://github.com/camaraproject/ApplicationProfiles/blob/r1.2/code/API_definitions/application-profiles.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ApplicationProfiles/r1.2/code/API_definitions/application-profiles.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ApplicationProfiles/r1.2/code/API_definitions/application-profiles.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/ApplicationProfiles/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/ApplicationProfiles/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/ApplicationProfiles/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings are held virtually together with ConnectivityInsights
+ * Schedule: Bi-weekly on Wednesday at 15:00 UTC
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/92345695827?password=35dff2b2-058d-44de-bd7e-67d08c9e9f9d)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/vzve)
+* Mailing List
+
+ * Subscribe / Unsubscribe to the mailing list
+
+
+
+
+
+
+
+
+# BlockchainPublicAddress
+
+Sandbox API Repository to describe, develop, document, and test the BlockchainPublicAddress Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/KDHe)
+
+## Scope
+* Service APIs for “Blockchain Public Address” (see APIBacklog.md)
+* It provides the API consumer with the ability to:
+ * Blockchain Public Address API:
+ * Manage a Blockchain Public Address associated to a phone number, i.e. to retrieve the blockchain public address(es) and to bind/unbind a Blockchain Public Address. The Blockchain Public Address is utilized as Decentralized Identifier (DID). With the proposed API, API providers offer API consumers the following capability: pairing phone number with Blockchain Public Address whenever this 3rd party wants to offer its customers a way to make transactions more easily based on the phone number instead of the Blockchain Public Address.
+ * Optional binding enforcement procedure, ensuring both `phoneNumber` and `blockchainPublicAddress` belongs to the same owner (i.e. person), within binding process by means of the checking of provided `nonce` and `signature` fields. To generate `nonce` below mentioned Blockchain Public Address Validation API has been designed, and `signature` generation is an off-chain process.
+ * Blockchain Public Address Validation API:
+ * Manage generation of a nonce (one-time challenge) to be used in binding enforcemnet procedure.
+* Describe, develop, document and test the APIs (with 1-2 Telcos)
+* Started: June 2023
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r2.2](https://github.com/camaraproject/BlockchainPublicAddress/releases/tag/r2.2) (Fall25), with the following API versions:
+ * **blockchain-public-address-validation v0.1.0**
+ [[YAML]](https://github.com/camaraproject/BlockchainPublicAddress/blob/r2.2/code/API_definitions/blockchain-public-address-validation.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/BlockchainPublicAddress/r2.2/code/API_definitions/blockchain-public-address-validation.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/BlockchainPublicAddress/r2.2/code/API_definitions/blockchain-public-address-validation.yaml)
+ * **blockchain-public-address v0.3.0**
+ [[YAML]](https://github.com/camaraproject/BlockchainPublicAddress/blob/r2.2/code/API_definitions/blockchain-public-address.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/BlockchainPublicAddress/r2.2/code/API_definitions/blockchain-public-address.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/BlockchainPublicAddress/r2.2/code/API_definitions/blockchain-public-address.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/BlockchainPublicAddress/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/BlockchainPublicAddress/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/BlockchainPublicAddress/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings
+ * [Registration/Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/99023344259?password=cb995600-56ee-48a2-ade1-607bb10487df)
+ * Schedule: Bi-weekly on Thursdays, 13:00-14:00 CET/CEST (12:00 UTC, 11:00 UTC during European DST)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/thDe).
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project
+
+
+
+
+
+
+
+
+# CallForwardingSignal
+
+Incubating API Repository to evolve and maintain the definitions and documentation of CallForwardingSignal Service API within the Sub Project [Call Forwarding Signal](https://lf-camaraproject.atlassian.net/wiki/x/IIAfBQ).
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/HADe)
+
+## Scope
+* Service APIs for “CallForwardingSignal” (see APIBacklog.md)
+* It provides the API consumer with the ability to:
+ * retrieve information about the status of the Call Forwarding Service on a specific phone number.
+ * avoid fraud leveraging the Call Forwarding Service.
+ * The main scope of the Call Forwarding Signal API is anti fraud to avoid fraudsters to use the Call Forwarding Service to carry on a scam. Other use cases are anyway supported by the Call Forwarding Signal API that also provides additional endpoints to detect the general Call Forwarding Service settings.
+* Describe, develop, document and test the API
+* Started: February 2024
+* Incubating stage since: February 2025
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r3.3](https://github.com/camaraproject/CallForwardingSignal/releases/tag/r3.3) (Fall25), with the following API versions:
+ * **call-forwarding-signal v0.4.0**
+ [[YAML]](https://github.com/camaraproject/CallForwardingSignal/blob/r3.3/code/API_definitions/call-forwarding-signal.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/r3.3/code/API_definitions/call-forwarding-signal.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/r3.3/code/API_definitions/call-forwarding-signal.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/CallForwardingSignal/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/CallForwardingSignal/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/CallForwardingSignal/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings are held virtually
+ * Schedule: Monday 15h-16 CET, usually every two weeks. For the next meetings information, have a look on the [API Wiki Page](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14549020/CallForwardingSignal).
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/96706226837?password=2d113354-bf97-4441-8d6d-9fd0ae69f2d1)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14574452/CallForwardingSignal+Minutes?atlOrigin=eyJpIjoiNjc1Mzc3ZWIwNGI4NGRhMmE2YjBkMGFjNmFjMTNiZDUiLCJwIjoiYyJ9)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list
+
+
+
+
+
+
+
+
+# CapabilitiesAndRuntimeRestrictions
+
+Sandbox API Repository to describe, develop, document, and test the CapabilitiesAndRuntimeRestrictions Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/6YAjAw)
+
+## Scope
+
+* Service APIs for “CapabilitiesAndRuntimeRestrictions” (see APIBacklog.md)
+* The CAMARA Runtime Restrictions API allows API consumers to understand and adapt to environment-specific differences in how CAMARA APIs are implemented. It provides details on what is supported, what is temporarily unavailable, and any other limitations that might affect how you call and consume those APIs. This API provides that information about other CAMARA APIs.
+* The API provides the API consumer with the ability to:
+ * Discover Capabilities and Constraints
+ * Stay updated on changes
+ * Adapt your requests Automatically
+* Describe, develop, document, and test the APIs
+* Started: November 2024
+
+
+
+
+## Release Information
+
+The repository has no (pre)releases yet, work in progress is within the main branch.
+
+
+## Contributing
+* Meetings are held virtually
+ * Schedule: Tuesdays 1400-1500 UTC, every two weeks.
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/96678356438?password=706020d3-07bc-4d90-a0d5-1d6b94452a53)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/6YAjAw)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project
+
+
+
+
+
+
+
+
+# CarrierBillingCheckOut
+
+Sandbox API Repository to describe, develop, document, and test the CarrierBillingCheckOut Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/CDDe)
+
+## Scope
+* Service APIs for “CarrierBillingCheckOut” (see APIBacklog.md)
+* It provides the API consumer with the ability to:
+ * Trigger carrier billing payment request (in one or two steps), which is a process that allows API consumers to make purchases by charging payments against Telco Operator Billing Systems.
+ * Follow up of payment, by means of query endpoints to get information about a list of payments or a specific payment.
+ * Trigger carrier billing refund request, which is a process that allows API consumers to ask for a `total` or `partial` return of the amount associated to a previous performed payment.
+ * Follow up of refund, by means of query endpoints to get information about a list of refunds or a specific refund.
+ * NOTE: The scope of these APIs should be limited (at least at a first stage) to 4G and 5G.
+* Describe, develop, document and test the APIs (with 1-2 Telcos)
+* Started: October 2022
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r3.2](https://github.com/camaraproject/CarrierBillingCheckOut/releases/tag/r3.2) (Fall25), with the following API versions:
+ * **carrier-billing-refund v0.3.0**
+ [[YAML]](https://github.com/camaraproject/CarrierBillingCheckOut/blob/r3.2/code/API_definitions/carrier-billing-refund.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r3.2/code/API_definitions/carrier-billing-refund.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r3.2/code/API_definitions/carrier-billing-refund.yaml)
+ * **carrier-billing v0.5.0**
+ [[YAML]](https://github.com/camaraproject/CarrierBillingCheckOut/blob/r3.2/code/API_definitions/carrier-billing.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r3.2/code/API_definitions/carrier-billing.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/CarrierBillingCheckOut/r3.2/code/API_definitions/carrier-billing.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/CarrierBillingCheckOut/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/CarrierBillingCheckOut/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/CarrierBillingCheckOut/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings are held virtually
+ * Schedule: Bi-Weekly, Wednesdays 13:00 - 14:00 UTC
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/96513497117?password=ac26d34b-87d2-4d78-aa47-4de1ca14c882)
+ * Minutes: Access [Meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/CDDe)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project
+
+#### 4.2.1 API attributes
+
+
+Attribute definition
+
+**Payment Class description:**
+
+ **Name** | **Description** | **Comment** |
+| -------- | --------- | ----------- |
+| endUserId | Identify the mobile account to be charged - in general mobile number is provided | Mandatory attribute in POST request |
+| clientCorrelator | Provided by the requester - Uniquely identifies this create charge request | Optionally valued by requester |
+| paymentAmount | See PaymentAmount class table description| Mandatory attribute in POST request |
+| referenceCode | Merchant generated payment reference to uniquely identify the request, for example the purchase or order identifier | Mandatory attribute in POST request |
+| transactionOperationStatus | Specifies the payment status (example: Processing, Denied, Reserved, Succeeded, Cancelled) | Must be valued by server side (not in POST request) |
+| resourceURL | URI of the created resource (same as in the Location header) | Only valued (optionally) by server side (not in POST request) |
+| serverReferenceCode | Reference to the charge or refund, provided by the server, and meaningful to the server’s backend system for the purpose of reconciliation | Only valued (optionally) by server side (not in POST request) |
+| paymentCreationDate | Date when the payment is created in server data base. This is a technically information | Only valued (optionally) by server side (not in POST request) |
+| paymentDate | Date when the payment is effectively performed. This is a business information. | Only valued (optionally) by server side (not in POST request) |
+| notificationUrl | Allows asynchronous delivery of purchase related events | Optionally valued by requester - if used, customer needs to have a notification endpoint |
+| notificationAuthToken | Authentification token for callback API (if provided) | Optionally valued by requester |
+
+**PaymentAccount class description:**
+
+2 classes are defined:
+
+ChargingInformation:
+
+ **Name** | **Description** | **Comment** |
+| -------- | --------- | ----------- |
+| amount | Amount to be charged or reserved (number) | Mandatory attribute in POST request |
+| currency | Currency identifier as defined in [ISO4217] | Mandatory attribute in POST request |
+| description | Description text to be used for information and billing text | Mandatory attribute in POST request|
+
+
+ChargingMetaData
+
+ **Name** | **Description** | **Comment** |
+| -------- | --------- | ----------- |
+| onBehalfOf | Allows aggregators/partners to specify the actual payee | Optionally valued by requester |
+| purchaseCategoryCode | Allows aggregators/partners to specify the actual payee | Optionally valued by requester |
+| channel | Channel where the order occurred | Optionally valued by requester |
+| isTaxIncluded | if true, the amount is tax included, if false the amount is provided without tax. In both case, taxAmount could be valued to provide tax amount.| Optionally valued by requester |
+| taxAmount | The tax amount charged by the merchant if the charge has tax already included (number). This also provides an indicator to the downstream billing system | Optionally valued by requester |
+| serviceId | Identifier of service related to the payment | Optionally valued by requester |
+| productId | Identifier of product related to the payment | Optionally valued by requester |
+
+**Payment State engine**
+
+Follow schema provides information about the payment state engine (state description & transition)
+
+
+
+
+### 4.3 Endpoint Definitions
+
+Following table defines API endpoints of exposed REST based for Carrier Billing Payment API management operations.
+
+| **Endpoint** | **Operation** | **Description** |
+| -------- | --------- | ----------- |
+| POST
+
+
+
+
+
+
+
+
+# ClickToDial
+
+Sandbox API Repository to describe, develop, document, and test the ClickToDial Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [Click To Dial](https://lf-camaraproject.atlassian.net/wiki/x/3DHe)
+
+## Scope
+* Service APIs for “Click-To-Dial”
+* It provides the API consumer with the ability to:
+ * establish a voice call between a caller and callee
+ * terminate an active call
+ * retrieve the recording of a call (if available)
+* Describe, develop, document and test the APIs
+* Started: September 2023
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> This repository has only pre-release versions available yet. Pre-releases are for testing and may change before public release.
+
+* The latest pre-release is [r1.2](https://github.com/camaraproject/ClickToDial/releases/tag/r1.2) (release candidate), with the following API versions:
+ * **click-to-dial 0.1.0-rc.1**
+ [[YAML]](https://github.com/camaraproject/ClickToDial/blob/r1.2/code/API_definitions/click-to-dial.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ClickToDial/r1.2/code/API_definitions/click-to-dial.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ClickToDial/r1.2/code/API_definitions/click-to-dial.yaml)
+
+* For changes see [CHANGELOG](https://github.com/camaraproject/ClickToDial/tree/main/CHANGELOG)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings are held virtually
+ * Schedule: Bi-weekly (odd weeks), Wednesday, 3 PM CET/CEST (13:00 UTC,21:00 Beijing)
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/96843390032?password=1153dd0f-f8c8-4d3b-9962-d9685444d145)
+ * Minutes: Access [Meeting minutes](https://wiki.camaraproject.org/display/CAM/ClickToDial)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project
+
+
+
+
+
+
+
+
+# ConnectedNetworkType
+
+Sandbox API Repository to describe, develop, document, and test the ConnectedNetworkType Service API(s) within the Sub Project [Device Status](https://lf-camaraproject.atlassian.net/wiki/x/6wApBQ).
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/AQD1Bg)
+
+## Scope
+
+* Service API(s) “ConnectedNetworkType” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * query the the mobile technology of the network that the device is connected to
+ * receive notifications when the connected network type has changed
+* Describe, develop, document, and test the API(s)
+* Started: June 2024 (within [DeviceStatus](https://github.com/camaraproject/DeviceStatus) repository)
+
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r1.2](https://github.com/camaraproject/ConnectedNetworkType/releases/tag/r1.2) (Fall25), with the following API versions:
+ * **connected-network-type-subscriptions v0.2.0**
+ [[YAML]](https://github.com/camaraproject/ConnectedNetworkType/blob/r1.2/code/API_definitions/connected-network-type-subscriptions.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectedNetworkType/r1.2/code/API_definitions/connected-network-type-subscriptions.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ConnectedNetworkType/r1.2/code/API_definitions/connected-network-type-subscriptions.yaml)
+ * **connected-network-type v0.2.0**
+ [[YAML]](https://github.com/camaraproject/ConnectedNetworkType/blob/r1.2/code/API_definitions/connected-network-type.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectedNetworkType/r1.2/code/API_definitions/connected-network-type.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ConnectedNetworkType/r1.2/code/API_definitions/connected-network-type.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/ConnectedNetworkType/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/ConnectedNetworkType/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/ConnectedNetworkType/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings are held virtually
+
+ * Schedule: Bi-weekly on Wednesday, 09:00 UTC
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/93413850406?password=3aeb0f1b-d9f9-42c5-91d8-3d2b20421ef1)
+ * Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/fzLe)
+
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list
+
+
+
+
+
+
+
+
+# ConnectivityInsights
+
+Sandbox API Repository to describe, develop, document, and test the ConnectivityInsights Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/KTLe)
+
+## Scope
+* Service APIs for “Connectivity Insights” (see APIBacklog.md)
+* It provides the API consumer with the ability to:
+ * share key details about their applications that are relevant for network-related decisions across various CAMARA APIs.
+ * gain visibility into network quality, allowing them to
+check if their application's network requirements can be met for a given user session. Based on the API’s response, developers can make informed decisions - like requesting a network boost through CAMARA Quality on Demand API or adjusting application settings (e.g. adjust video resolution) to ensure the best possible user experience.
+ * enables application developers to receive continuous updates
+about network quality through event notifications.
+ * NOTE: The scope of these APIs should be limited (at least at a first stage) to 4G and 5G.
+* Describe, develop, document and test the APIs (with 1-2 Telcos)
+* Started: November 2023
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r3.2](https://github.com/camaraproject/ConnectivityInsights/releases/tag/r3.2) (Fall25), with the following API versions:
+ * **connectivity-insights-subscriptions v0.6.0**
+ [[YAML]](https://github.com/camaraproject/ConnectivityInsights/blob/r3.2/code/API_definitions/connectivity-insights-subscriptions.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r3.2/code/API_definitions/connectivity-insights-subscriptions.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r3.2/code/API_definitions/connectivity-insights-subscriptions.yaml)
+ * **connectivity-insights v0.6.0**
+ [[YAML]](https://github.com/camaraproject/ConnectivityInsights/blob/r3.2/code/API_definitions/connectivity-insights.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r3.2/code/API_definitions/connectivity-insights.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r3.2/code/API_definitions/connectivity-insights.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/ConnectivityInsights/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/ConnectivityInsights/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/ConnectivityInsights/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/92345695827?password=35dff2b2-058d-44de-bd7e-67d08c9e9f9d)
+ * Schedule: Bi-weekly on Wednesday at 1500UTC
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/vTve)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project
+
+
+
+
+
+
+
+
+# ConsentInfo
+
+Sandbox API Repository to describe, develop, document, and test the ConsentInfo API(s) within the Working Group [IdentityAndConsentManagement](https://lf-camaraproject.atlassian.net/wiki/x/ZzDe)
+
+* API Repository [Wiki page](https://lf-camaraproject.atlassian.net/wiki/x/NICeBQ)
+
+
+## Scope
+
+* Service APIs for “ConsentInfo" (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * **Check the validity of data processing**: The API returns `statusValidForProcessing`, a boolean flag that indicates whether the requested data processing is currently permitted (`true`) or not (`false`).
+ * **Understand why processing is not allowed**: If data processing is not permitted, the response includes a `statusReason` field to explain why.
+ * **Retrieve a Capture URL (if requested)**: If the status is not valid because user action is required, and the API Consumer sets `requestCaptureUrl` to `true`, the API will return a `captureUrl` field that can be presented to the User. This URL directs them to the API Provider's secure Consent capture channel, where they can provide or renew their Consent.
+
+ Importantly, this API does NOT delegate Consent capture to the API Consumer but rather empowers the API Consumer to present the API Provider's Consent capture URL at the most opportune time and place. The actual Consent capture occurs within the API Provider's secure environment, ensuring the User's authentication with the API Provider.
+* Describe, develop, document, and test the API(s)
+* Started: March 2025
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* The latest public release is [r2.3](https://github.com/camaraproject/ConsentInfo/releases/tag/r2.3), with the following API versions:
+ * **consent-info 0.2.0**
+ [[YAML]](https://github.com/camaraproject/ConsentInfo/blob/r2.3/code/API_definitions/consent-info.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConsentInfo/r2.3/code/API_definitions/consent-info.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ConsentInfo/r2.3/code/API_definitions/consent-info.yaml)
+
+* The latest public release is always available here: https://github.com/camaraproject/ConsentInfo/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/ConsentInfo/releases
+* For changes see [CHANGELOG](https://github.com/camaraproject/ConsentInfo/tree/main/CHANGELOG)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings of the working group are held virtually
+ * Schedule: Every 2 weeks on Wednesdays at 14:00 UTC (IdentityAndConsentManagement Working Group meeting)
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/94629188836?password=278b4c8a-f370-43bf-bac1-b30a39f169f3)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/lE7e)
+
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list
+
+
+
+
+
+
+
+
+# ConsentManagement
+
+Sandbox API Repository to describe, develop, document, and test the ConsentManagement Service API(s) within the Working Group [Identity And Consent Management](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14561383/Identity+Consent+Management).
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/WgDDH)
+
+## Scope
+
+* Service API(s) “ConsentManagement” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * **Create Consent**: Allows API Consumers to create a new Consent for a User, specifying the requested scope(s) and Purpose. The API Consumer must provide the necessary information to capture the User's Consent.
+ * **Update Consent**: Enables API Consumers to update an existing Consent and change its status.
+ * **Retrieve Consent Information**: Allows API Consumers to retrieve information about existing Consents for a User based on specified scope(s) and Purpose. This operation can also return the Consent texts presented to the User during the Consent Capture process if requested.
+
+ It is important to note that the API Provider remains fully responsible for Consent storage, auditing and transparency. Access to this functionality is restricted to trusted API Consumers in accordance with the API Provider's policy. This API only applies to scenarios involving the legal basis of Consent. Scenarios involving a different legal basis for data processing are excluded and would be handled by the API Provider through non-delegated mechanisms.
+* Describe, develop, document, and test the API(s)
+* Started: December 2025
+
+
+
+
+
+## Release Information
+
+The repository has no (pre)releases yet, work in progress is within the main branch.
+
+
+
+## Contributing
+
+* Meetings are held virtually
+
+ * Schedule: Every 2 weeks on Wednesdays at 14:00 UTC (IdentityAndConsentManagement Working Group meeting)
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/94629188836?password=278b4c8a-f370-43bf-bac1-b30a39f169f3)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/lE7e)
+ * Subscribe / Unsubscribe to the mailing list
+
+
+
+
+
+
+
+
+# CustomerInsights
+
+Sandbox API Repository to describe, develop, document, and test the CustomerInsights Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/owBuAQ)
+
+## Scope
+
+* Service APIs for “CustomerInsights”
+* The API provides the customer with the ability to:
+ * Provides a risk index (a.k.a. Scoring) based on the individual's profile owned by a Telco Operator.
+ * So far two scoring scales are defined within the current proposal (GaugeMetric, VeritasIndex).
+* Describe, develop, document, and test the APIs
+* Started: October 2024
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r2.2](https://github.com/camaraproject/CustomerInsights/releases/tag/r2.2) (Fall25), with the following API versions:
+ * **customer-insights v0.2.0**
+ [[YAML]](https://github.com/camaraproject/CustomerInsights/blob/r2.2/code/API_definitions/customer-insights.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CustomerInsights/r2.2/code/API_definitions/customer-insights.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/CustomerInsights/r2.2/code/API_definitions/customer-insights.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/CustomerInsights/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/CustomerInsights/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/CustomerInsights/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings are held virtually
+ * Schedule: Bi-Weekly on Thursdays at 14:00 UTC
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/95737002367?password=034d9b74-a944-4def-ae30-0f93802430a5)
+ * Minutes: Access [[meeting minutes]](https://lf-camaraproject.atlassian.net/wiki/x/XIBuAQ)
+* Mailing List
+
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project
+
+
+
+
+
+
+
+
+# DedicatedNetworks
+
+Sandbox API Repository to describe, develop, document, and test the DedicatedNetworks Service API(s) within the Sub Project [Connectivity Quality Management](https://lf-camaraproject.atlassian.net/wiki/x/hAClB).
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/XIArAQ)
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/OICGAQ)
+
+For background on Dedicated Networks concepts and workflows, see the [General Description](documentation/API_documentation/DedicatedNetworks_GeneralDescription.md).
+
+## Scope
+
+* Service APIs for DedicatedNetworks (see [APIBacklog.md](https://github.com/camaraproject/APIBacklog/blob/main/documentation/APIbacklog.md))
+* The API provides the API Consumer with the ability to:
+ * request/modify/delete a (logical) Dedicated Network for API consumers.
+ * A Dedicated Network offers
+ * specific connectivity performance (e.g. speed/ latency)
+ * during a specific time duration (e.g. one hour) and
+ * at specific locations (e.g. the area of a festival)
+ * A Dedicated Network may be ensured by an SLA.
+ * API consumers are able to manage access to this dedicated network for specific devices.
+* Describe, develop, document, and test the APIs
+* Started: October 2024
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r1.2](https://github.com/camaraproject/DedicatedNetworks/releases/tag/r1.2) (Fall25), with the following API versions:
+ * **dedicated-network-accesses v0.1.0**
+ [[YAML]](https://github.com/camaraproject/DedicatedNetworks/blob/r1.2/code/API_definitions/dedicated-network-accesses.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network-accesses.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network-accesses.yaml)
+ * **dedicated-network-profiles v0.1.0**
+ [[YAML]](https://github.com/camaraproject/DedicatedNetworks/blob/r1.2/code/API_definitions/dedicated-network-profiles.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network-profiles.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network-profiles.yaml)
+ * **dedicated-network v0.1.0**
+ [[YAML]](https://github.com/camaraproject/DedicatedNetworks/blob/r1.2/code/API_definitions/dedicated-network.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r1.2/code/API_definitions/dedicated-network.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/DedicatedNetworks/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/DedicatedNetworks/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/DedicatedNetworks/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings are held virtually
+ * Schedule: bi-weekly, Mondays, 10 AM CET (09:00 UTC). For date/time of the next meeting, see previous meeting minutes
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/94505909302?password=67b9a175-154f-4fe1-986d-0b825227a95b)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/l/cp/S3hQ1AFG)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project
+
+
+
+
+
+
+
+
+# DeviceAuthenticity
+
+Sandbox API Repository to describe, develop, document, and test the DeviceAuthenticity Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/czLe)
+
+## Scope
+
+* Service API(s) “DeviceAuthenticity” (see APIBacklog.md)
+* The API provides the API consumer with the ability to:
+ * Determine whether a given device associated with the provided device identifier is subject to any restrictions or risk flags.
+ * Provide a clear overall status describing the device’s condition.
+* Describe, develop, document, and test the API(s)
+* Started: **December 2025**
+
+
+
+
+
+## Release Information
+
+The repository has no (pre)releases yet, work in progress is within the main branch.
+
+
+## Contributing
+
+* Meetings are held virtually together with the DeviceIdentifier API team
+
+ * Schedule: First Friday of each month at 09:00 UTC
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/96981252767?password=fc957607-cc06-450f-b80a-229bb6a88c39)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/yjve)
+* Mailing List (of DeviceIdentifier)
+ * Subscribe / Unsubscribe to the mailing list
+
+
+
+
+
+
+
+
+# DeviceDataVolume
+
+Sandbox API Repository to describe, develop, document, and test the DeviceDataVolume APIs within the Sub Project [DeviceStatus](https://lf-camaraproject.atlassian.net/wiki/x/6wApBQ) of CAMARA
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/PoCaBQ)
+
+## Scope
+
+* Service APIs “Device Data Volume” and "Device Data Volume Subscriptions" (see [APIBacklog.md](https://github.com/camaraproject/APIBacklog/blob/main/documentation/APIbacklog.md))
+* The service APIs provide the customer with the ability to:
+ * get detailed insights into the customer's data usage status
+ * get alerts when the customer's data usage status changes
+* Describe, develop, document, and test the service APIs
+* Started: August 2024
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r1.3](https://github.com/camaraproject/DeviceDataVolume/releases/tag/r1.3) (Fall25), with the following API versions:
+ * **device-data-volume-subscriptions v0.1.0**
+ [[YAML]](https://github.com/camaraproject/DeviceDataVolume/blob/r1.3/code/API_definitions/device-data-volume-subscriptions.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.3/code/API_definitions/device-data-volume-subscriptions.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.3/code/API_definitions/device-data-volume-subscriptions.yaml)
+ * **device-data-volume v0.1.0**
+ [[YAML]](https://github.com/camaraproject/DeviceDataVolume/blob/r1.3/code/API_definitions/device-data-volume.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.3/code/API_definitions/device-data-volume.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.3/code/API_definitions/device-data-volume.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/DeviceDataVolume/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/DeviceDataVolume/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/DeviceDataVolume/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings for the DeviceStatus Sub Project are held virtually
+ * Bi-weekly on Wednesday, 09:00 UTC
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/93413850406?password=3aeb0f1b-d9f9-42c5-91d8-3d2b20421ef1)
+ * Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/fzLe)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project
+
+
+
+
+
+
+
+
+# DeviceIdentifier
+
+Sandbox API Repository to describe, develop, document, and test the DeviceIdentifier Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/czLe)
+
+## Scope
+
+* Service API “DeviceIdentifier” (see [APIBacklog](https://github.com/camaraproject/APIBacklog/blob/main/documentation/APIbacklog.md))
+* The API provides the API consumer with the ability to:
+ * Retrieve the current identity (IMEI) of the mobile device being used by a given mobile subscriber
+ * Retrieve the type (manufacturer and model) of the mobile device being used by a given mobile subscriber
+* Describe, develop, document, and test the API
+* Started: October 2022
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r2.2](https://github.com/camaraproject/DeviceIdentifier/releases/tag/r2.2) (Fall25), with the following API versions:
+ * **device-identifier v0.3.0**
+ [[YAML]](https://github.com/camaraproject/DeviceIdentifier/blob/r2.2/code/API_definitions/device-identifier.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceIdentifier/r2.2/code/API_definitions/device-identifier.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceIdentifier/r2.2/code/API_definitions/device-identifier.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/DeviceIdentifier/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/DeviceIdentifier/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/DeviceIdentifier/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings are held virtually
+ * Schedule: First Friday of each month at 15:00 UTC via Linux Foundation Zoom service
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/96981252767?password=fc957607-cc06-450f-b80a-229bb6a88c39)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14564298/DeviceIdentifier+Meeting+Minutes)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list [https://lists.camaraproject.org/g/sp-dvi](https://lists.camaraproject.org/g/sp-dvi) .
+ * A message to the community of this Sub Project can be sent using [sp-dvi@lists.camaraproject.org](mailto:sp-dvi@lists.camaraproject.org).
diff --git a/original/DeviceIdentifier/code/API_definitions/device-identifier.yaml b/original/DeviceIdentifier/code/API_definitions/device-identifier.yaml
new file mode 100644
index 0000000000000000000000000000000000000000..e1500227c918f641ada93ae9f08309de9bf4a906
--- /dev/null
+++ b/original/DeviceIdentifier/code/API_definitions/device-identifier.yaml
@@ -0,0 +1,865 @@
+openapi: 3.0.3
+info:
+ title: Device Identifier
+ version: wip
+ description: |
+ # Summary
+
+ The Mobile Device Identifier API returns details of the physical mobile device currently being used by a specified mobile subscriber. The following information can be returned:
+ - A unique network identifier for the specific device itself (IMEI SV and IMEI)
+ - A pseudonymised network identifier for the specific device itself (Pairwise Pseudonymous Identifier)
+ - A network identifier for the device make and model (IMEI Type Allocation Code)
+ - Device manufacturer name and model
+
+ This information can be useful in a number of scenarios, such as the following:
+ - For insurance purposes, to automatically identify a device that a customer wishes to insure
+ - For security / fraud reasons, to establish that a customer is not using a device they claim to have broken or lost
+ - For service delivery reasons, to optimise content for a particular device or OS type
+
+ # Introduction
+
+ Mobile devices are allocated a unique identifier by the manufacturer, known as the International Mobile Equipment Identity, or IMEI. The current software version (SV) of the device can be appended to this, in which case the identifier is known as the IMEI SV. This identifier is signalled to the mobile network when the device connects, both to confirm that the device is not blocked, and also allow device dependent network configurations to be implemented.
+
+ The IMEI is a 15 digit integer, and the IMEI SV is a 16 digit integer:
+ - The first 8 digits are known as the Type Allocation Code (TAC), and identify the manufacturer and model of the device
+ - The following 6 digits are the serial number of the device for that TAC
+ - For IMEI, the remaining digit is a check digit
+ - For IMEI SV, the remaining two digits are the software version
+
+ TACs are issued and managed by the GSMA, and can be queried using the [GSMA IMEI database](https://www.gsma.com/aboutus/workinggroups/terminal-steering-group/imei-database).
+
+ The mobile network associates this device identifier with the mobile subscription currently using the device. The mobile subscription is defined by the Subscriber Identity Module (SIM) currently active in the mobile device. This may be a removable SIM or an eSIM. In either case, it is possible for the association between the device identifier and subscription to change - for example, when a physical SIM is transferred to another mobile device.
+
+ 
+
+ The Device Identifier API allows the API consumer to obtain the IMEI and associated parameters for a specified mobile subscription identifier or equivalent. The mobile subscription can be identified using one or more of the following subscription identifiers:
+ - the subscription phone number (also known as MSISDN)
+ - the subscription network access identifier, which is a domain specific identifier typically allocated to devices that do not require voice / SMS connectivity
+ - the current IP address and port alloacted to the device, which must be an IPv6 or public IPv4 address
+
+ The API can be called by an API consumer to establish an identifier for the physical device currently being used by the mobile subscription. The information returned will depend upon the consent that the end user (i.e. mobile subscription owner) has given for that information to be provided to the API consumer. For example, if the end user has not consented to any information about their device being given, then the API consumer will receive an error in response to their request. Otherwise, the information that the end user has consented to being given will be returned.
+
+ # Relevant terms and definitions
+
+ ### Device Identifier API service endpoint
+ The URL pointing to the RESTful resource of the Device Identifier API.
+
+ ### Identifier for the mobile subscription
+ At least one identifier for the mobile subscription from the following four options:
+ - Phone number (i.e. MSISDN)
+ - Network Access Identifier assigned by the mobile network operator for the device
+ - IPv6 address
+ - IPv4 address
+
+ ### Identifier for the physical mobile device
+ The IMEI or IMEISV of the physical mobile device
+
+ ### Pairwise Pseudonymous Identifier
+ An identifier that has been pseudonymised such that the resulting pseudonymous identifier is unique to but persistent for a given API consumer
+
+ # API functionality
+
+ The API defines three service endpoints:
+
+ - `POST /retrieve-identifier` to get details about the specific device being used by a given mobile subscriber, including IMEI / IMEISV and the type of device
+ - `POST /retrieve-type` to get details only about the type (i.e. manufacturer and model) of device being used by a given mobile subscriber
+ - `POST /retrieve-ppid` to get a pseudonymised identifier for the specific device being used by a given mobile subscriber
+
+ To call any of these endpoints, the API consumer must first obtain a valid access token from the token endpoint, which is then passed as an Authorization header. When a 2-legged access token is used, the API consumer must also pass at least one of the available mobile subscription identifiers in the body of the request.
+
+ If the request is valid, the API response is a JSON object containing the data that the end user has consented to sharing with the API consumer.
+ - When calling endpoint `retrieve-identifier`, the response will always contain `imei`
+ - When calling endpoint `retrieve-type`, the response will always contain `tac`
+ - When calling endpoint `retrieve-ppid`, the response will always contain `ppid`
+ - Responses will also always contain a `lastChecked` field, indicating when the information provided was last confirmed to be correct
+ - Other response parameters are implementation dependent, and thus optional
+
+ An example of a JSON response object is as follows:
+ ```
+ {
+ "lastChecked": "2024-02-20T10:41:38.657Z",
+ "imeisv": "49015420323751800",
+ "imei": "4901542032375181",
+ "tac": "49015420",
+ "model": "3110",
+ "manufacturer": "Nokia"
+ }
+ ```
+
+ ## Error handling
+
+ Errors may be returned for the following reasons. Note that this list is not exhaustive.
+
+ `401 UNAUTHENTICATED`:
+ - The access token is not a valid access token for the API provider
+ - The access token was valid but has now expired
+
+ `400 INVALID_ARGUMENT`:
+ - The API request is not compliant with this OAS definition
+
+ `400 OUT_OF_RANGE`:
+ - A parameter value in the API request is outwith the range documented in this OAS definition for that parameter
+
+ `404 IDENTIFIER_NOT_FOUND`:
+ - The device identified by the `device` object in the request is not managed by the API provider
+
+ `403 PERMISSION_DENIED`:
+ - The access token does not have the required scope for the endpoint being called
+ - The end user has not consented to the API consumer getting access to the device identifier information (2-legged access token only)
+
+ `422 SERVICE_NOT_APPLICABLE`:
+ - A device identifier cannot be provided for the identified device. For example, the phone number might identify a landline.
+
+ `422 UNSUPPORTED_IDENTIFIER`:
+ - A parameter provided in the `device` object is not supported by this implementation (e.g. `networkAccessIdentifier`)
+
+ `422 MISSING_IDENTIFIER`:
+ `422 UNNECESSARY_IDENTIFIER`:
+ - See the section "Identifying the device from the access token" below
+
+ `429 QUOTA_EXCEEDED`:
+ - The API consumer has used up the quota of API requests that they were allocated for this API
+
+ `429 TOO_MANY_REQUESTS`:
+ - The rate at which the API consumer is sending requests has exceeded that allowed by the API provider. Try again later.
+
+ ### Additional CAMARA error responses
+
+ The list of error codes in this API specification is not exhaustive. Therefore the API specification may not document some non-mandatory error statuses as indicated in `CAMARA API Design Guide`.
+
+ Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version.
+
+ As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API.
+
+ # Further info and support
+
+ ## Authorization and authentication
+
+ The "Camara Security and Interoperability Profile" provides details of how an API consumer requests an access token. Please refer to Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the profile.
+
+ The specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst also being subject to the prevailing legal framework dictated by local legislation.
+
+ In cases where personal data is processed by the API and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design.
+
+ ## Identifying the device from the access token
+
+ This API requires the API consumer to identify a device as the subject of the API as follows:
+ - When the API is invoked using a two-legged access token, the subject will be identified from the optional `device` object, which therefore MUST be provided.
+
+ - When a three-legged access token is used however, this optional identifier MUST NOT be provided, as the subject will be uniquely identified from the access token.
+
+ This approach simplifies API usage for API consumers using a three-legged access token to invoke the API by relying on the information that is associated with the access token and was identified during the authentication process.
+
+ ### Error handling:
+ - If the subject cannot be identified from the access token and the optional `device` object is not included in the request, then the server will return an error with the `422 MISSING_IDENTIFIER` error code.
+
+ - If the subject can be identified from the access token and the optional `device` object is also included in the request, then the server will return an error with the `422 UNNECESSARY_IDENTIFIER` error code. This will be the case even if the same device is identified by these two methods, as the server is unable to make this comparison.
+
+ ## Multi-SIM scenario handling
+
+ In scenarios where a main phone number is shared between multiple devices, each of which has its own individual "secondary" phone number (e.g. connectivity plans that let you share your airtime and data allowances with a smartwatch or eSIM-enabled tablet), the phone number passed by the API consumer will be treated as the secondary phone number, and hence the identifier returned will be that of the single device associated with that phone number (e.g. smartphone, smartwatch, or eSIM-enabled tablet).
+
+ In such scenarios, the "primary" device is usually allocated the same main and secondary phone numbers, and hence providing the main phone number to the API will return the identity of the primary device (usually the smartphone) and not any associated devices.
+
+ (FAQs will be added in a later version of the documentation)
+
+ license:
+ name: Apache 2.0
+ url: https://www.apache.org/licenses/LICENSE-2.0.html
+ x-camara-commonalities: 0.6
+
+externalDocs:
+ description: Product documentation at CAMARA
+ url: https://github.com/camaraproject/DeviceIdentifier
+
+servers:
+ - url: "{apiRoot}/device-identifier/vwip"
+ variables:
+ apiRoot:
+ default: http://localhost:9091
+ description: API root, defined by the service provider, e.g. `api.example.com` or `api.example.com/somepath`
+
+tags:
+ - name: Get Device Identifiers
+ description: Retrieve details about the device being used by a mobile subscriber
+
+paths:
+ "/retrieve-identifier":
+ post:
+ summary: Get details about the specific device being used by a given mobile subscriber
+ description: Get details about the specific device being used by a given mobile subscriber
+ operationId: retrieveIdentifier
+ tags:
+ - Get Device Identifiers
+ security:
+ - openId:
+ - device-identifier:retrieve-identifier
+ parameters:
+ - $ref: "#/components/parameters/x-correlator"
+
+ requestBody:
+ description: Parameters to create a new session
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/RequestBody"
+ examples:
+ Identify Device By 3-Legged Access Token:
+ $ref: '#/components/examples/IdentifyDeviceBy3LeggedToken'
+ Identify Device By Phone Number:
+ $ref: '#/components/examples/IdentifyDeviceByPhoneNumber'
+ Identify Device By IP Address:
+ $ref: '#/components/examples/IdentifyDeviceByIPAddress'
+ Identify Device By Multiple Identifiers:
+ $ref: '#/components/examples/IdentifyDeviceByMultipleIdentifiers'
+
+ responses:
+ "200":
+ $ref: '#/components/responses/200RetrieveIdentifier'
+ "400":
+ $ref: '#/components/responses/400BadRequest'
+ "401":
+ $ref: '#/components/responses/401Unauthorized'
+ "403":
+ $ref: '#/components/responses/403Forbidden'
+ "404":
+ $ref: '#/components/responses/404NotFound'
+ "422":
+ $ref: '#/components/responses/422UnprocessableContent'
+ "429":
+ $ref: '#/components/responses/429TooManyRequests'
+
+ "/retrieve-type":
+ post:
+ summary: Get details about the type of device being used by a given mobile subscriber
+ description: Get details about the type of device being used by a given mobile subscriber
+ operationId: retrieveType
+ tags:
+ - Get Device Identifiers
+ security:
+ - openId:
+ - device-identifier:retrieve-type
+ parameters:
+ - $ref: "#/components/parameters/x-correlator"
+
+ requestBody:
+ description: Parameters to create a new session
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/RequestBody"
+ examples:
+ Identify Device By 3-Legged Access Token:
+ $ref: '#/components/examples/IdentifyDeviceBy3LeggedToken'
+ Identify Device By Phone Number:
+ $ref: '#/components/examples/IdentifyDeviceByPhoneNumber'
+ Identify Device By IP Address:
+ $ref: '#/components/examples/IdentifyDeviceByIPAddress'
+ Identify Device By Multiple Identifiers:
+ $ref: '#/components/examples/IdentifyDeviceByMultipleIdentifiers'
+
+ responses:
+ "200":
+ $ref: '#/components/responses/200RetrieveType'
+ "400":
+ $ref: '#/components/responses/400BadRequest'
+ "401":
+ $ref: '#/components/responses/401Unauthorized'
+ "403":
+ $ref: '#/components/responses/403Forbidden'
+ "404":
+ $ref: '#/components/responses/404NotFound'
+ "422":
+ $ref: '#/components/responses/422UnprocessableContent'
+ "429":
+ $ref: '#/components/responses/429TooManyRequests'
+
+ "/retrieve-ppid":
+ post:
+ summary: Get a pseudonymous identifier for device being used by a given mobile subscriber
+ description: Get a pseudonymous identifier for device being used by a given mobile subscriber
+ operationId: retrievePPID
+ tags:
+ - Get Device Identifiers
+ security:
+ - openId:
+ - device-identifier:retrieve-ppid
+ parameters:
+ - $ref: "#/components/parameters/x-correlator"
+
+ requestBody:
+ description: Parameters to identify the mobile subscription when a 2-legged access token is being used
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/RequestBody"
+ examples:
+ Identify Device By 3-Legged Access Token:
+ $ref: '#/components/examples/IdentifyDeviceBy3LeggedToken'
+ Identify Device By Phone Number:
+ $ref: '#/components/examples/IdentifyDeviceByPhoneNumber'
+ Identify Device By IP Address:
+ $ref: '#/components/examples/IdentifyDeviceByIPAddress'
+ Identify Device By Multiple Identifiers:
+ $ref: '#/components/examples/IdentifyDeviceByMultipleIdentifiers'
+
+ responses:
+ "200":
+ $ref: '#/components/responses/200RetrievePPID'
+ "400":
+ $ref: '#/components/responses/400BadRequest'
+ "401":
+ $ref: '#/components/responses/401Unauthorized'
+ "403":
+ $ref: '#/components/responses/403Forbidden'
+ "404":
+ $ref: '#/components/responses/404NotFound'
+ "422":
+ $ref: '#/components/responses/422UnprocessableContent'
+ "429":
+ $ref: '#/components/responses/429TooManyRequests'
+
+components:
+ securitySchemes:
+ openId:
+ description: Common security scheme for all CAMARA APIs
+ type: openIdConnect
+ openIdConnectUrl: https://example.com/.well-known/openid-configuration
+
+ parameters:
+ x-correlator:
+ name: x-correlator
+ in: header
+ description: Correlation id for the different services
+ schema:
+ $ref: "#/components/schemas/XCorrelator"
+
+ headers:
+ X-Correlator:
+ description: Correlation id for the different services
+ required: false
+ schema:
+ $ref: "#/components/schemas/XCorrelator"
+
+ responses:
+ 200RetrieveIdentifier:
+ description: An device identifier has been found for the specified subscriber
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ required:
+ - lastChecked
+ - imei
+ allOf:
+ - $ref: "#/components/schemas/CommonResponseBody"
+ - $ref: "#/components/schemas/DeviceIdentifier"
+ - $ref: "#/components/schemas/DeviceType"
+ examples:
+ Successful Identifier Retrieval:
+ description: Device identifier has been successfully retrieved when the device subscription was identified by a 3-legged access token or single device subscription identifier
+ value:
+ lastChecked: "2024-02-20T10:41:38.657Z"
+ imeisv: "49015420323751800"
+ imei: "4901542032375181"
+ tac: "49015420"
+ model: "3110"
+ manufacturer: "Nokia"
+ Successful Identifier Retrieval With Device Disambiguation:
+ description: Device identifier has been successfully retrieved when a 2-legged access token and multiple device subscription identifiers were provided
+ value:
+ device:
+ phoneNumber: "+123456789"
+ lastChecked: "2024-02-20T10:41:38.657Z"
+ imeisv: "49015420323751800"
+ imei: "4901542032375181"
+ tac: "49015420"
+ model: "3110"
+ manufacturer: "Nokia"
+
+ 200RetrieveType:
+ description: A device identifier has been found for the specified subscriber
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ required:
+ - lastChecked
+ - tac
+ allOf:
+ - $ref: "#/components/schemas/CommonResponseBody"
+ - $ref: "#/components/schemas/DeviceType"
+ examples:
+ Successful Type Retrieval:
+ description: Device type has been successfully retrieved when the device subcsription was identified by a 3-legged access token or single device subscription identifier
+ value:
+ lastChecked: "2024-02-20T10:41:38.657Z"
+ tac: "49015420"
+ model: "3110"
+ manufacturer: "Nokia"
+ Successful Type Retrieval With Device Disambiguation:
+ description: Device type has been successfully retrieved when a 2-legged access token and multiple device subscription identifiers were provided
+ value:
+ device:
+ phoneNumber: "+123456789"
+ lastChecked: "2024-02-20T10:41:38.657Z"
+ tac: "49015420"
+ model: "3110"
+ manufacturer: "Nokia"
+
+ 200RetrievePPID:
+ description: A pseudonymous device identifier has been found for the specified mobile subscriber
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ required:
+ - lastChecked
+ - ppid
+ allOf:
+ - $ref: "#/components/schemas/CommonResponseBody"
+ - $ref: "#/components/schemas/DevicePPID"
+ examples:
+ Successful PPID Retrieval:
+ description: Device PPID has been successfully retrieved when the device subcsription was identified by a 3-legged access token or single device subscription identifier
+ value:
+ lastChecked: "2024-02-20T10:41:38.657Z"
+ ppid: "b083f65ccdad365d7489fff24b6d5074b30c12b6d81db3404d25964ffd908813"
+ Successful PPID Retrieval With Device Disambiguation:
+ description: Device PPID has been successfully retrieved when a 2-legged access token and multiple device subscription identifiers were provided
+ value:
+ device:
+ phoneNumber: "+123456789"
+ lastChecked: "2024-02-20T10:41:38.657Z"
+ ppid: "b083f65ccdad365d7489fff24b6d5074b30c12b6d81db3404d25964ffd908813"
+
+ 400BadRequest:
+ description: Bad Request
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 400
+ code:
+ enum:
+ - INVALID_ARGUMENT
+ - OUT_OF_RANGE
+ examples:
+ Insufficient Parameters:
+ description: Sufficient parameters must be provided to allow the target UE to be identified
+ value:
+ status: 400
+ code: INVALID_ARGUMENT
+ message: "At least one of phoneNumber, networkAccessIdentifier, ipv4Address and ipv6Address must be specified"
+ Inconsistent Device Properties:
+ description: Device parameters provided identify different devices
+ value:
+ status: 400
+ code: INVALID_ARGUMENT
+ message: "Multiple inconsistent device parameters specified"
+ Invalid Network Access Identifier:
+ value:
+ status: 400
+ code: INVALID_ARGUMENT
+ message: "Invalid format: networkAccessIdentifier"
+ Invalid Phone Number:
+ value:
+ status: 400
+ code: INVALID_ARGUMENT
+ message: "Invalid format: phoneNumber"
+ Invalid IPv4 Address:
+ value:
+ status: 400
+ code: INVALID_ARGUMENT
+ message: "Invalid format: ipv4Address"
+ Invalid IPv6 Address:
+ value:
+ status: 400
+ code: INVALID_ARGUMENT
+ message: "Invalid format: ipv6Address"
+ Invalid Port Value:
+ value:
+ status: 400
+ code: OUT_OF_RANGE
+ message: "Invalid value: ipv4Address.publicPort"
+
+ 401Unauthorized:
+ description: Unauthorized
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 401
+ code:
+ enum:
+ - UNAUTHENTICATED
+ examples:
+ Unauthenticated Request:
+ description: Request cannot be authenticated and a new authentication is required
+ value:
+ status: 401
+ code: UNAUTHENTICATED
+ message: Request not authenticated due to missing, invalid, or expired credentials. A new authentication is required.
+
+ 403Forbidden:
+ description: Forbidden
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 403
+ code:
+ enum:
+ - PERMISSION_DENIED
+ examples:
+ Permision Denied:
+ description: Permission denied. OAuth2 token access does not have the required scope or when the user fails operational security
+ value:
+ status: 403
+ code: PERMISSION_DENIED
+ message: Client does not have sufficient permissions to perform this action.
+
+ 404NotFound:
+ description: Not found
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 404
+ code:
+ enum:
+ - IDENTIFIER_NOT_FOUND
+ examples:
+ Device Cannot Be Found:
+ description: The provided identifier cannot be matched to a device known to the API provider
+ value:
+ status: 404
+ code: IDENTIFIER_NOT_FOUND
+ message: The provided identifier cannot be matched to a device.
+
+ 422UnprocessableContent:
+ description: Unprocessable Content
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 422
+ code:
+ enum:
+ - SERVICE_NOT_APPLICABLE
+ - MISSING_IDENTIFIER
+ - UNSUPPORTED_IDENTIFIER
+ - UNNECESSARY_IDENTIFIER
+ examples:
+ Service Not Applicable For Device:
+ description: The service is not applicable for the identified device
+ value:
+ status: 422
+ code: SERVICE_NOT_APPLICABLE
+ message: The service is not applicable for the identified device.
+ Unsupported Identifier:
+ description: None of the provided identifiers is supported by the implementation
+ value:
+ status: 422
+ code: UNSUPPORTED_IDENTIFIER
+ message: None of the provided identifiers is supported by the implementation.
+ Unnecessary Identifier:
+ description: An explicit identifier has been provided for the device when this is already identified by the access token
+ value:
+ status: 422
+ code: UNNECESSARY_IDENTIFIER
+ message: An explicit identifier has been provided for the device when this is already identified by the access token
+ Missing Identifier:
+ description: An identifier is not included in the request and the device cannot be identified from the 2-legged access token
+ value:
+ status: 422
+ code: MISSING_IDENTIFIER
+ message: An identifier is not included in the request and the device cannot be identified from the 2-legged access token
+
+ 429TooManyRequests:
+ description: Too Many Requests
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 429
+ code:
+ enum:
+ - QUOTA_EXCEEDED
+ - TOO_MANY_REQUESTS
+ examples:
+ Too Many Requests:
+ description: Access to the API has been temporarily blocked due to quota or spike arrest limits being reached
+ value:
+ status: 429
+ code: TOO_MANY_REQUESTS
+ message: Rate limit reached
+ Quota Exceeded:
+ description: Request is rejected due to exceeding a business quota limit
+ value:
+ status: 429
+ code: QUOTA_EXCEEDED
+ message: Out of resource quota
+
+ schemas:
+ CommonResponseBody:
+ description: |
+ Common parameters to be included in all responses
+ properties:
+ device:
+ description: The device subscription identifier that was used to identify the device whose identifier is being returned. If this property is not present, then the device subscription identifier specified in the request was used.
+ allOf:
+ - $ref: "#/components/schemas/DeviceResponse"
+ - example: {"phoneNumber": "+123456789"}
+ lastChecked:
+ description: |
+ Date and time that the information was last confirmed by the mobile operator to be correct. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
+ type: string
+ format: date-time
+ example: "2024-02-20T10:41:38.657Z"
+
+ DeviceIdentifier:
+ description: |
+ The individual physical mobile device identifier, as expressed by the IMEI and IMEISV
+ type: object
+ properties:
+ imeisv:
+ type: string
+ description: IMEISV of the device
+ example: "49015420323751800"
+ imei:
+ type: string
+ description: IMEI of the device
+ example: "4901542032375181"
+
+ DeviceType:
+ description: |
+ The physical device type, as expressed by Type Approval Code, manufacturer name and model name
+ type: object
+ properties:
+ tac:
+ type: string
+ description: IMEI TAC of the device
+ example: "49015420"
+ model:
+ type: string
+ description: Model of the device
+ example: "3110"
+ manufacturer:
+ type: string
+ description: Manufacturer of the device
+ example: "Nokia"
+
+ DevicePPID:
+ description: |
+ The individual physical mobile device identifier, expressed as a PPID (Pairwise Pseudonymous Identifier)
+ type: object
+ properties:
+ ppid:
+ type: string
+ description: A PPID for the identified physical device
+ example: "b083f65ccdad365d7489fff24b6d5074b30c12b6d81db3404d25964ffd908813"
+
+ Device:
+ description: |
+ End-user equipment able to connect to a mobile network. Examples of devices include smartphones or IoT sensors/actuators.
+ The developer can choose to provide the below specified device identifiers:
+ * `ipv4Address`
+ * `ipv6Address`
+ * `phoneNumber`
+ * `networkAccessIdentifier`
+ NOTE 1: The MNO might support only a subset of these options. The API invoker can provide multiple identifiers to be compatible across different MNOs. In this case the identifiers MUST belong to the same device.
+ NOTE 2: For the current Commonalities release, we are enforcing that the networkAccessIdentifier is only part of the schema for future-proofing, and CAMARA does not currently allow its use. After the CAMARA meta-release work is concluded and the relevant issues are resolved, its use will need to be explicitly documented in the guidelines.
+ type: object
+ properties:
+ phoneNumber:
+ $ref: "#/components/schemas/PhoneNumber"
+ networkAccessIdentifier:
+ $ref: "#/components/schemas/NetworkAccessIdentifier"
+ ipv4Address:
+ $ref: "#/components/schemas/DeviceIpv4Addr"
+ ipv6Address:
+ $ref: "#/components/schemas/DeviceIpv6Address"
+ minProperties: 1
+
+ DeviceResponse:
+ description: |
+ An identifier for the end-user equipment able to connect to the network that the response refers to. This parameter is only returned when the API consumer includes the `device` parameter in their request (i.e. they are using a two-legged access token), and is relevant when more than one device identifier is specified, as only one of those device identifiers is allowed in the response.
+
+ If the API consumer provides more than one device identifier in their request, the API provider must return a single identifier which is the one they are using to fulfil the request, even if the identifiers do not match the same device. API provider does not perform any logic to validate/correlate that the indicated device identifiers match the same device. No error should be returned if the identifiers are otherwise valid to prevent API consumers correlating different identifiers with a given end user.
+
+ allOf:
+ - $ref: "#/components/schemas/Device"
+ - maxProperties: 1
+
+ DeviceIpv4Addr:
+ type: object
+ description: |
+ The device should be identified by either the public (observed) IP address and port as seen by the application server, or the private (local) and any public (observed) IP addresses in use by the device (this information can be obtained by various means, for example from some DNS servers).
+
+ If the allocated and observed IP addresses are the same (i.e. NAT is not in use) then the same address should be specified for both publicAddress and privateAddress.
+
+ If NAT64 is in use, the device should be identified by its publicAddress and publicPort, or separately by its allocated IPv6 address (field ipv6Address of the Device object)
+
+ In all cases, publicAddress must be specified, along with at least one of either privateAddress or publicPort, dependent upon which is known. In general, mobile devices cannot be identified by their public IPv4 address alone.
+ properties:
+ publicAddress:
+ $ref: "#/components/schemas/SingleIpv4Addr"
+ privateAddress:
+ $ref: "#/components/schemas/SingleIpv4Addr"
+ publicPort:
+ $ref: "#/components/schemas/Port"
+ anyOf:
+ - required: [publicAddress, privateAddress]
+ - required: [publicAddress, publicPort]
+ example:
+ {
+ "publicAddress": "84.125.93.10",
+ "publicPort": 59765
+ }
+
+ ErrorInfo:
+ type: object
+ required:
+ - status
+ - code
+ - message
+ properties:
+ status:
+ type: integer
+ description: HTTP response status code
+ code:
+ type: string
+ description: A human-readable code to describe the error
+ message:
+ type: string
+ description: A human-readable description of what the event represents
+
+ NetworkAccessIdentifier:
+ description: 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.
+ type: string
+ example: "123456789@example.com"
+
+ PhoneNumber:
+ description: 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, prefixed with '+'.
+ type: string
+ pattern: '^\+[1-9][0-9]{4,14}$'
+ example: "+123456789"
+
+ Port:
+ description: TCP or UDP port number
+ type: integer
+ minimum: 0
+ maximum: 65535
+
+ RequestBody:
+ description: Common request body to allow optional Device object to be passed
+ type: object
+ properties:
+ device:
+ $ref: "#/components/schemas/Device"
+
+ SingleIpv4Addr:
+ description: A single IPv4 address with no subnet mask
+ type: string
+ format: ipv4
+ example: "84.125.93.10"
+
+ DeviceIpv6Address:
+ description: |
+ The device should be identified by the observed IPv6 address, or by any single IPv6 address from within the subnet allocated to the device (e.g. adding ::0 to the /64 prefix).
+ type: string
+ format: ipv6
+ example: 2001:db8:85a3:8d3:1319:8a2e:370:7344
+
+ XCorrelator:
+ type: string
+ pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
+ example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
+
+ examples:
+ IdentifyDeviceBy3LeggedToken:
+ description: Empty JSON when device is identified by access token
+ value:
+ {}
+
+ IdentifyDeviceByPhoneNumber:
+ description: Identifying device by phone number
+ value:
+ device:
+ phoneNumber: "+123456789"
+
+ IdentifyDeviceByIPAddress:
+ description: Identifying device by IP address
+ value:
+ device:
+ ipv4Address:
+ publicAddress: "84.125.93.10"
+ publicPort: 59765
+
+ IdentifyDeviceByMultipleIdentifiers:
+ description: Identifying device by multiple device identifiers
+ value:
+ device:
+ phoneNumber: "+123456789"
+ ipv4Address:
+ publicAddress: "84.125.93.10"
+ publicPort: 59765
+ networkAccessIdentifier: "123456789@example.com"
diff --git a/original/DeviceIdentifier/documentation/API_documentation/Device_Identifier_User_Story.md b/original/DeviceIdentifier/documentation/API_documentation/Device_Identifier_User_Story.md
new file mode 100644
index 0000000000000000000000000000000000000000..6aa86f0d55984387d841af11d92d031b41ef028c
--- /dev/null
+++ b/original/DeviceIdentifier/documentation/API_documentation/Device_Identifier_User_Story.md
@@ -0,0 +1,44 @@
+# Device Identifier API User Story
+
+| **Item** | **Details** |
+| ---- | ------- |
+| ***Summary*** | As an application developer belonging to an enterprise, I want my application server to be able to request the identity of the mobile device (represented by the IMEI) currently being used by a given mobile network subscriber (identified by MSISDN, IP address or, when supported by network operators, a Network Access Identifier). Optionally, I'd like to know the make and model of that device. |
+| ***Roles, Actors and Scope*** | **Roles:** Customer:User
+
+
+
+
+
+
+
+
+# DeviceLocation
+
+Incubating API Repository to evolve and maintain the definitions and documentation of DeviceLocation Service API(s) within the Sub Project [Device Location](https://lf-camaraproject.atlassian.net/wiki/x/wgApBQ)
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/GDLe)
+
+## Scope
+* Service APIs for “Device Location” (see APIBacklog.md)
+* The APIs provide the API consumer with the ability to:
+ * verify the location of a device (location-verification).
+ * retrieve the location of a device (location-retrieval).
+ * subscribe and receive notifications about a device entering or leaving certain location (geofencing-subscriptions).
+ * NOTE: The scope of these APIs is limited (at least at a first stage) to 4G and 5G.
+* Describe, develop, document and test the APIs (with 1-2 Telcos)
+* Started: July 2022
+* Incubating stage since: February 2025
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r3.2](https://github.com/camaraproject/DeviceLocation/releases/tag/r3.2) (Fall25), with the following API versions:
+ * **geofencing-subscriptions v0.5.0**
+ [[YAML]](https://github.com/camaraproject/DeviceLocation/blob/r3.2/code/API_definitions/geofencing-subscriptions.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/code/API_definitions/geofencing-subscriptions.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/code/API_definitions/geofencing-subscriptions.yaml)
+ * **location-retrieval v0.5.0**
+ [[YAML]](https://github.com/camaraproject/DeviceLocation/blob/r3.2/code/API_definitions/location-retrieval.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/code/API_definitions/location-retrieval.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/code/API_definitions/location-retrieval.yaml)
+ * **location-verification v3.0.0**
+ [[YAML]](https://github.com/camaraproject/DeviceLocation/blob/r3.2/code/API_definitions/location-verification.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/code/API_definitions/location-verification.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/code/API_definitions/location-verification.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/DeviceLocation/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/DeviceLocation/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/DeviceLocation/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings are held virtually
+ - Schedule: bi-weekly (odd weeks), Tuesday, 8:00 AM UTC (9:00 CET/10:00 CEST)
+ - Meeting link: [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/91878854906?password=7e620a89-fcb5-4d2d-927a-17e3a0d1d28e)
+* Mailing list:
+ - To subscribe / unsubscribe to the mailing list of this Sub Project, please visit + +* [Issue #52](https://github.com/camaraproject/DeviceLocation/issues/52). Review doc/guidelines about units + - OK for doc enhancement + - Need to check if we are using meter or kilometer. **@Jose to open poll** +
+ +* Adopt [decision in Commonalities](https://github.com/camaraproject/WorkingGroups/issues/164) about keeping API documentation as part of the spec + - **@José will make it but after subscription is closed (and implemented)** +
+ +## Other questions during meeting + +* Question about checking CAMARA API compliance ? + - There is no formal certification process right now --> nobody will check the code + - CAMARA is about the interface not the code to provide it --> Implementation has to align on the swagger definition. + - Example of issue on compliance: how to have a common behavior for MatchRate compute - there will be interpretation by implementation. + - Good topic for discussion in Commonalities --> Need an issue. +
+ +* Comment about Partial answer + - Partial means the location match is no complete - but there will not additional response. This is not related to HTTP code 206. +
+ +* Discussion about event subscription + - Geofencing probably will be in Check Location + - But we can imagine other subscription to get directly location (every 30 minutes for example). In this case in will be the Get location API. Right now we do not have requested for this later. +
+ +* Question about authorization + - Several ways are defined but will be depending on local regulations + - Will be discussed case per case between consumer and provider + - This is beyond scope of this team +
+ +* **Next call is on May 23th.** diff --git a/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-05-23.md b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-05-23.md new file mode 100644 index 0000000000000000000000000000000000000000..d53d51d3dfda3a2a9a29b2ed822c2a10d793d28b --- /dev/null +++ b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-05-23.md @@ -0,0 +1,103 @@ +# CAMARA DeviceLocation meeting - 2023-05-23 + +*May 23rd, 2023* + +## Attendees + +* Akos Hunyadi (DT) +* Amit Ahuja (Etisalat) +* Hacene Sali (Etisalat) +* Joachim Dahlgren (Ericsson) +* José Luis Urien Pinedo (Telefónica) +* Mohammad Sahid Khan () +* Rafal Artych (DT) +* Ravi Shekhar (ravishek) +* Syed Iqbal Hussain +* Tuan Tran (Broadpeak) +* 若山 敏康 () + + +QoD minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + +### Alignment with guidelines + +* [Issue #15](https://github.com/camaraproject/DeviceLocation/issues/15), related to [Issue #12](https://github.com/camaraproject/DeviceLocation/issues/12) + +* New model for `ueId`/`device` defined in [QualityOnDemand](https://github.com/camaraproject/QualityOnDemand), including new model for IPv4Address. Already merged + +* **@jlurien will make a PR for this** Still pending + +### Subscription for Location Area + +* [Issue #18](https://github.com/camaraproject/DeviceLocation/issues/18), [PR #49](https://github.com/camaraproject/DeviceLocation/pull/49) + +* Discussed in [Commonalities](https://github.com/camaraproject/WorkingGroups/issues/156) + - Ludovic updated the guidelines accordingly. Now waiting for the merge in Commonalities, pending on discussion for Guidelines versioning. + +* **PR once agreed (Ludovic)** -> Pending, Ludovic updated by email that he's ok with versioning proposal. + +### New API to provide raw location + +* [Issue #40](https://github.com/camaraproject/DeviceLocation/issues/40), [PR #55](https://github.com/camaraproject/DeviceLocation/pull/55) + - Also [Issue #43](https://github.com/camaraproject/DeviceLocation/issues/43) may be related -> **@ukkaps to clarify** + +* Agreed to have a separate API from the current one + - Proposal to move current one to a new basePath, e.g. `device-location-verification`, and leave `device-location` to this new one + - **@jlurien to open issue to discuss new name** + +* Review PR by Ludovic + - Discussion about modelling endpoint as POST vs GET in [Commonalities Issue #212](https://github.com/camaraproject/WorkingGroups/issues/212) + - Seems there is consensus about using POST for use cases like this one + - Opinions, further comments on the PR? + - **@Ludovic Ludovic will modify the spec** | + +### Add new parameter `maxAge` + +* [Issue #34](https://github.com/camaraproject/DeviceLocation/issues/34), [PR #53](https://github.com/camaraproject/DeviceLocation/pull/53) + +* Some comments on the issue, no comments on PR + +* **@all, please provide comments to PR** + +### Consolidate documentation into spec + +* Adopt [decision in Commonalities](https://github.com/camaraproject/WorkingGroups/issues/164) about keeping API documentation as part of the spec + +* **@José will make it but after subscription is closed (and implemented)** -> Pending + +### Units for radius + +* [Issue #52](https://github.com/camaraproject/DeviceLocation/issues/52). Review doc/guidelines about units + - OK for doc enhancement + - Need to check if we are using meter or kilometer. + +* **@Jose to open new issue** + +### Postal Code Area + +* [Issue #39](https://github.com/camaraproject/DeviceLocation/issues/39), [PR #47](https://github.com/camaraproject/DeviceLocation/pull/47) + +* Proposal by TEF to add Postal Codes as new type of area, lack of support from other partners about the business case + +* TEF keeps the PR on hold + +## AOB + +* Some questions about general topics of CAMARA, not directly related to Device Location. Pointing to the right place to raise that questions. + +* DT ask for time planning for new Release. Agreed to open an issue with tentative scope and roadmap, as they did in QoD. **AP on @jlurien** + +* Joachim comments about what is expected behaviour when requested accuracy is more restrictive that the one that network is able to satisfy. + - Current proposal is not clear about that + - **Joachim to open issue** + +
+ +**Next call is on June 6th.** diff --git a/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-06-06.md b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-06-06.md new file mode 100644 index 0000000000000000000000000000000000000000..8eafc18fe029c3331a024c2b4c43477f2d1427d5 --- /dev/null +++ b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-06-06.md @@ -0,0 +1,135 @@ +# CAMARA DeviceLocation meeting - 2023-06-06 + +*June 6th, 2023* + +## Attendees + +* Akos Hunyadi (DT) +* Asad Imran Aslam +* Cetin Alpaycetin (Vodafone) +* Joachim Dahlgren (Ericsson) +* Jorge Garcia Hospital (TEF) +* José Luis Urien Pinedo (TEF) +* Ludovic Robert (Orange) +* Rafal Artych (DT) +* Ravi Shekar +* Sébastien Synold (Intersec) +* Shyamal Patabendige +* Toshi Wakayama (KDDI) +* Udaka Kappagoda (Axiata) + +QoD minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Introduction to new members: Sébastien & Cetin +* Open issues and PRs +* Any other business + +## Open issues and PRs + +### Alignment with guidelines + +* [Issue #15](https://github.com/camaraproject/DeviceLocation/issues/15), related to [Issue #12](https://github.com/camaraproject/DeviceLocation/issues/12) + +* New model for `ueId`/`device` defined in [QualityOnDemand](https://github.com/camaraproject/QualityOnDemand), including new model for IPv4Address. + +* New PR #61 [https://github.com/camaraproject/DeviceLocation/pull/61]. Reviewed by Orange +* **Merge planned June 7th EOB if no blocking comment** + +### Subscription for Location Area + +* [Issue #18](https://github.com/camaraproject/DeviceLocation/issues/18), [PR #49](https://github.com/camaraproject/DeviceLocation/pull/49) + +* Discussed in [Commonalities](https://github.com/camaraproject/WorkingGroups/issues/156) + - New model now consolidated in Guidelines. + - New [PR in QoD](https://github.com/camaraproject/QualityOnDemand/pull/155) with a similar alignment to guidelines. It could be taken as example. + +* [PR #49](https://github.com/camaraproject/DeviceLocation/pull/49) by @maxl2287 (DT) needs to be adapted. * **DT will continue the crafting work** + +* Need discussion if Geo fence should be separated from check location operation as distinct model/business case could be provided. + - **Ludovic will create an issue to capture team feedback.** + + +### New API to provide raw location + +* [Issue #40](https://github.com/camaraproject/DeviceLocation/issues/40), [PR #55](https://github.com/camaraproject/DeviceLocation/pull/55) + +* Agreed to have a separate API from the current one + - Proposal to move current one to a new basePath, e.g. `device-location-verification`, and leave `device-location` to this new one + - Issue [#59](https://github.com/camaraproject/DeviceLocation/issues/59). **To discuss during meeting** + +* Review PR by Ludovic + - Discussion about modelling endpoint as POST vs GET in [Commonalities Issue #212](https://github.com/camaraproject/WorkingGroups/issues/212) + - Seems there is consensus about using POST for use cases like this one + - Some comments and fixes in PR. + - Discussion in meeting about link with consent in particular when the location requested is for IoT - there is an Identity & Consent Management project where discussion occurs + +* **Merge planned June 7th EOB if no blocking comment.** + +### Add new parameter `maxAge` + +* [Issue #34](https://github.com/camaraproject/DeviceLocation/issues/34), [PR #53](https://github.com/camaraproject/DeviceLocation/pull/53) + +* Some comments on the issue, no comments on PR + +* **@all, please provide comments to PR** + - Need additional work to be completed as it is not 100% clear + +### Consolidate documentation into spec + +* Adopt [decision in Commonalities](https://github.com/camaraproject/WorkingGroups/issues/164) about keeping API documentation as part of the spec + +* **@José will make it but after subscription is closed (and implemented)** +* **@Ludovic will make for the 'raw' location API** + +### Units for radius + +* [Issue #52](https://github.com/camaraproject/DeviceLocation/issues/52). Review doc/guidelines about units + - OK for doc enhancement + - Need to check if we are using meter or kilometer. + +* [Issue #60](https://github.com/camaraproject/DeviceLocation/issues/60) + - Discuss during meeting: Depending on the back end - glmc (meter accuracy) or nef - the accuracy is very different + +* **Ask for team to provide comments in issue** + +### Behaviour when requesting too high precision + +* [Issue #58](https://github.com/camaraproject/DeviceLocation/issues/58) about what is expected behaviour when requested accuracy is more restrictive that the one that network is able to satisfy. + - No comments so far + - Discuss during meeting: We need to provide a hint that the precision request is (definitely) too fine for API provider + +* **Ask for team to provide comments in issue** + +### Roadmap for Release v0.2 + +* We have to decide in Commonalities how to communicate roadmap for multiple API project. +* Our roadmap could be: + - Release in June featuring + - For check location: + - Rename location to location-verification (issue 59) + - Align device model (PR 61) + - Add documentation in the OAS + - For raw location: + - Provide v0.1 + - With documentation integrated in the OAS + - Release in August + - Adding location subscription/notification for checking location + +### Postal Code Area + +* [Issue #39](https://github.com/camaraproject/DeviceLocation/issues/39), [PR #47](https://github.com/camaraproject/DeviceLocation/pull/47) + +* Proposal by TEF to add Postal Codes as new type of area, lack of support from other partners about the business case + +* TEF keeps the PR on hold. + +* **TEF will move discussion to business track in GSMA (@Jorge)** + +## AOB + + +
+ +**Next call is on June 20th.** diff --git a/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-06-20.md b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-06-20.md new file mode 100644 index 0000000000000000000000000000000000000000..61de824a0ec56e66d75ba473a55540f6ac721a19 --- /dev/null +++ b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-06-20.md @@ -0,0 +1,140 @@ +# CAMARA DeviceLocation meeting - 2023-06-20 + +*June 20th, 2023* + +## Attendees + +* Akos Hunyadi (DT) +* Cetin Alpaycetin (Vodafone) +* Fernando Prado Cabrillo (TEF) +* Joachim Dahlgren (Ericsson) +* Jorge Garcia Hospital (TEF) +* José Luis Urien Pinedo (TEF) +* Ludovic Robert (Orange) +* Rafal Artych (DT) +* Sébastien Synold (Intersec) +* Toshi Wakayama (KDDI) + +QoD minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + +### Alignment with guidelines + +* [Issue #15](https://github.com/camaraproject/DeviceLocation/issues/15) closed. +* [PR #61](https://github.com/camaraproject/DeviceLocation/pull/61) merged. + + +### Subscription for Location Area + +* [Issue #18](https://github.com/camaraproject/DeviceLocation/issues/18), [PR #49](https://github.com/camaraproject/DeviceLocation/pull/49) + - To be aligned with Commonalities + - **DT will continue the crafting work** + +* [Issue #64](https://github.com/camaraproject/DeviceLocation/issues/64): Discussion if Geo fence should be separated from check location operation as distinct model/business case could be provided. + - **Team Decision**: We will have 2 APIS - Ludovic will comment issue & close it. + - Current Device location verification will stay only with one operation + - PR #49 should be close + - Need a discussion about the name + + +### New API to provide raw location + +* [Issue #40](https://github.com/camaraproject/DeviceLocation/issues/40), [PR #55](https://github.com/camaraproject/DeviceLocation/pull/55) + +* Agreed to have a separate API from the current one + - [Issue #59](https://github.com/camaraproject/DeviceLocation/issues/59), [PR #66](https://github.com/camaraproject/DeviceLocation/pull/66) + - `device-location-verification` or `location-verification`: **Team Decision**: remove device prefix + +* Review PR by Ludovic + - **Team Decision**: need to switch to meter, related to [Issue #60](https://github.com/camaraproject/DeviceLocation/issues/60) + - Discussion on age of location: + - Depends on the UC. If we do not provide age of location we need to have a global rule about retrieval delay + +* **Team Decision**: Regarding the date related parameters + - `lastLocationTime` in the response mandatory + - `maxAge` will be optional in the request + +* Documentation will be handled in a second PR for raw location + +* Another API could be to have a history API but data are not obviously available from network. If needed, it is a separate use case. + + +### Add new parameter `maxAge` + +* [Issue #34](https://github.com/camaraproject/DeviceLocation/issues/34), [PR #53](https://github.com/camaraproject/DeviceLocation/pull/53) + +* Some comments on the issue, no comments on PR + +* **Team Decision** Regarding the date related parameters: + - `lastLocationTime` in the response mandatory + - `maxAge` will be optional in the request + - Add explicit information of maxAge about the fact that its concerns only the last location + - `maxAge` will be in second with a minimum of 60. + +* [PR #53](https://github.com/camaraproject/DeviceLocation/pull/53) will be aligned. @José will comment +* @Ludovic will align raw location API + + +### Consolidate documentation into spec + +* Adopt [decision in Commonalities](https://github.com/camaraproject/WorkingGroups/issues/164) about keeping API documentation as part of the spec + +* **@José will make it but after subscription is closed (and implemented)** -> Pending +* **@Ludovic will make for the 'raw' location API**, separate PR after [PR #55](https://github.com/camaraproject/DeviceLocation/pull/55) + +### Units for radius + +* [Issue #60](https://github.com/camaraproject/DeviceLocation/issues/60) + - Discuss during meeting: Depending on the back end - glmc (meter accuracy) or nef - the accuracy is very different + +* **Team decision**: Move to meters + +### Behaviour when requesting too high precision + +* [Issue #58](https://github.com/camaraproject/DeviceLocation/issues/58) about what is expected behaviour when requested accuracy is more restrictive that the one that network is able to satisfy. + - No comments so far + - Discuss during meeting: We need to provide a hint that the precision request is (definitely) too fine for API provider + +* **Ask for team to provide comments in issue** + - Need to check how current system manage when the accuracy is to small - always False? + - Need additional discussion + + +### Roadmap for Release v0.2 + +* We have to decide in Commonalities how to communicate roadmap for multiple API project. +* Our roadmap could be: + - Release in June featuring + - For check location: + - Rename location to location-verification (issue 59) -> PR + - ~~Align device model (PR 61)~~ + - Add documentation in the OAS -> Pending PR + - For raw location: + - Provide v0.1 + - With documentation integrated in the OAS + - Release in August + - Adding location subscription/notification for checking location + +* From roadmap perspective we are on track for API definition - for the documentation it could be probably delivered in July. + +### Postal Code Area + +* [Issue #39](https://github.com/camaraproject/DeviceLocation/issues/39), [PR #47](https://github.com/camaraproject/DeviceLocation/pull/47) + +* Proposal by TEF to add Postal Codes as new type of area, lack of support from other partners about the business case + +* TEF has moved discussion to business track in GSMA. Any update? + - Not yet, @Jorge provides update on business track. + +## AOB + + +
+ +**Next call is on July 4th.** diff --git a/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-07-04.md b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-07-04.md new file mode 100644 index 0000000000000000000000000000000000000000..ee528f666fae71282cf081eabe90667e4c9dac65 --- /dev/null +++ b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-07-04.md @@ -0,0 +1,145 @@ +# CAMARA DeviceLocation meeting - 2023-07-04 + +*July 4th, 2023* + +## Attendees + +* Akos Hunyadi (DT) +* Cetin Alpaycetin (Vodafone) +* Fernando Prado Cabrillo (TEF) +* Joachim Dahlgren (Ericsson) +* Jorge Garcia Hospital (TEF) +* José Luis Urien Pinedo (TEF) +* Ludovic Robert (Orange) +* Ravi Shekhar () +* Sébastien Synold (Intersec) +* Toshi Wakayama (KDDI) + +QoD minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + + +### Subscription for Location Area + +* [Issue #18](https://github.com/camaraproject/DeviceLocation/issues/18), [PR #49](https://github.com/camaraproject/DeviceLocation/pull/49) + - PR #49 should be close, new PR to be created + - **DT will open new PR soon** + +* [Issue #69](https://github.com/camaraproject/DeviceLocation/issues/69): Proposal for new name + - Orange preference for `location-verification-subscription` + - Keep open to get more opinions + + +### New API to provide raw location + +* [Issue #40](https://github.com/camaraproject/DeviceLocation/issues/40), [PR #55](https://github.com/camaraproject/DeviceLocation/pull/55) + +* Review PR by @Orange: + - Switched to meters + - Added `maxAge` (optional) to request + - Added `lastLocationTime` (required) to response + - Documentation will be handled in a second PR for raw location + +* Almost ready - Ludovic will integrate José requests this week +* Align Area model with Location verification with allOf + + +### Add new parameter `maxAge` + +* [Issue #34](https://github.com/camaraproject/DeviceLocation/issues/34), [PR #53](https://github.com/camaraproject/DeviceLocation/pull/53) + +* Agreed: + - `lastLocationTime` in the response mandatory + - `maxAge` will be optional in the request + - Add explicit information of maxAge about the fact that its concerns only the last location + - `maxAge` will be in second with a minimum of 60. + +* Comments in [PR #53](https://github.com/camaraproject/DeviceLocation/pull/53). It must be rebased, or close this and new PR + - ** @DT will discuss with the team how to process (rebase or new PR) ** +* Applied to [PR #55](https://github.com/camaraproject/DeviceLocation/pull/55) + + +### Consolidate documentation into spec + +* Adopt [decision in Commonalities](https://github.com/camaraproject/WorkingGroups/issues/164) about keeping API documentation as part of the spec + +* New [PR #71](https://github.com/camaraproject/DeviceLocation/pull/71), + - **ready to be merged** + + +### Units for radius + +* [Issue #60](https://github.com/camaraproject/DeviceLocation/issues/60) + - Decided to move to meters. + - Pending new PR -> @TEF will do it, just converting to meters + +* Decide on new limits. Now, they are 2km to 200 km + - Discussion to set minimum to 1 km + - Privacy needs to be considered if we are too precise. + - Probably better for now to keep 2 km. + - Question from Joachim Dahlgren about correlation between precision vs consent required + - Question from Cetin about the max - Do we really need to set to 200 km explicitly + - We can remove it probably? + - ** AP: Open an Issue to discuss this. ** + + +### Behaviour when requesting too high precision + +* [Issue #58](https://github.com/camaraproject/DeviceLocation/issues/58) about what is expected behaviour when requested accuracy is more restrictive that the one that network is able to satisfy. + - No new comments + - From previous meeting: We need to provide a hint that the precision request is (definitely) too fine for API provider, need to check how current system manage when the accuracy is to small - always False? + +* To be discussed during meeting. + - ** @TEF will provide examples about 'Partial' UC ** + - We need to align on the formula to calculate the 'matchRate' for PARTIAL answer + + +### Align Area to new model for inheritance vs polymorphism + +* [Issue #72](https://github.com/camaraproject/DeviceLocation/issues/72) + - ** @TEF will open new PR ** + + +### Roadmap for Release v0.2 + +* We have to decide in Commonalities how to communicate roadmap for multiple API project. +* Our roadmap could be: + - Release in July featuring + - For check location: + - ~~Rename location to location-verification (issue 59)~~ + - ~~Align device model (PR 61)~~ + - Add documentation in the OAS -> PR to be merged + - For raw location: + - Provide v0.1 -> PR to be merged + - With documentation integrated in the OAS -> Pending PR + - Release in August / September (depending on holidays): + - Adding location subscription/notification for checking location + +* From roadmap perspective we are on track for API definition - for the documentation it could be probably delivered in July. + + +### Postal Code Area + +* [Issue #39](https://github.com/camaraproject/DeviceLocation/issues/39), [PR #47](https://github.com/camaraproject/DeviceLocation/pull/47) + +* Proposal by TEF to add Postal Codes as new type of area, lack of support from other partners about the business case + +* New request from GSMA to add administrative code (like postal code) + - How we will manage case where implementation did not provide all location type?, Discovery?, Error? + +* **@TEF: add a new issue and close this one.** + + +## AOB + +* Add a file for summer presence (Ludovic will do) + +
+ +**Next call is on July 18th.** diff --git a/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-07-18.md b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-07-18.md new file mode 100644 index 0000000000000000000000000000000000000000..6e12f6f2c916150943033d8bea2e19fa07f2f5b1 --- /dev/null +++ b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-07-18.md @@ -0,0 +1,148 @@ +# CAMARA DeviceLocation meeting - 2023-07-18 + +*July 18th, 2023* + +## Attendees + +* Akos Hunyadi (DT) +* Cetin Alpaycetin (Vodafone) +* Fernando Prado Cabrillo (TEF) +* Joachim Dahlgren (Ericsson) +* José Luis Urien Pinedo (TEF) +* Ludovic Robert (Orange) +* Rafal Artych (DT) +* Sébastien Synold (Intersec) +* Toshi Wakayama (KDDI) + + +QoD minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + + +### Subscription for Location Area + +* [Issue #18](https://github.com/camaraproject/DeviceLocation/issues/18), [PR #74](https://github.com/camaraproject/DeviceLocation/pull/74) + - Old PR #49 was close, new PR created + - Many comments, most resolved. Ongoing discussions in Commonalities may affect this PR. + - Probably better to **stick to current design** and then adjust later. + - DT team keeps the design aligned with Device Status API. + - Ludovic Robert will make a review of his previous comments to close resolved one + + +* [Issue #69](https://github.com/camaraproject/DeviceLocation/issues/69): Proposal for new name + - Orange preference for `location-verification-subscription`, Ericsson preference for `geofencing` + - Joachim Dahlgren provided rational for geofencing instead of location-verification-subscription as we can have a second location subscription feature for geotracking. + - DT as owner of this API will consider this naming proposal and get back to the team (Akos Hunyadi) + - Looking for team feedback + + + +### New API to provide raw location + +* [Issue #40](https://github.com/camaraproject/DeviceLocation/issues/40), [PR #55](https://github.com/camaraproject/DeviceLocation/pull/55) + - Most comments resolved + - José Luis Urien Pinedo will make a final review + - Ludovic will work on the documentation only once PR#55 has been merged to avoid + + +### Add new parameter `maxAge` + +* [Issue #34](https://github.com/camaraproject/DeviceLocation/issues/34), [PR #53](https://github.com/camaraproject/DeviceLocation/pull/53) + +* Agreed: + - `lastLocationTime` in the response mandatory + - `maxAge` will be optional in the request + - Add explicit information of maxAge about the fact that its concerns only the last location + - `maxAge` will be in second with a minimum of 60. + +* Comments in [PR #53](https://github.com/camaraproject/DeviceLocation/pull/53). It must be rebased, or close this and new PR + - ** @DT will discuss with the team how to process (rebase or new PR) ** -> José will check but the rebase has probably been already done +* Applied to [PR #55](https://github.com/camaraproject/DeviceLocation/pull/55) + + +### Behaviour when requesting too high precision + +* [Issue #58](https://github.com/camaraproject/DeviceLocation/issues/58) about what is expected behaviour when requested accuracy is more restrictive that the one that network is able to satisfy. + - No new comments + - From previous meeting: We need to provide a hint that the precision request is (definitely) too fine for API provider, need to check how current system manage when the accuracy is to small - always False? + +* To be discussed during meeting. + - ** @TEF will provide examples about 'Partial' UC ** -> Some internal discussions, José will post some material to illustrate the problem; + - We need to align on the formula to calculate the 'matchRate' for PARTIAL answer + + +### Roadmap for Release v0.2 + +* We have to decide in Commonalities how to communicate roadmap for multiple API project. +* Our roadmap could be: + - Release in July featuring + - For check location: -> ready for 0.2 + - ~~Rename location to location-verification (issue 59)~~ + - ~~Align device model (PR 61)~~ + - ~~Add documentation in the OAS~~ + - For raw location: + - Provide v0.1 -> ready to be merged - documentation will be tackled in a separate PR + - With documentation integrated in the OAS -> Pending PR + - Release in August / September (depending on holidays): + - Adding location subscription/notification for checking location + +* From roadmap perspective we are on track for API definition - for the documentation it could be probably delivered in July. + + +### Postal Code Area + +* [Issue #39](https://github.com/camaraproject/DeviceLocation/issues/39), [PR #47](https://github.com/camaraproject/DeviceLocation/pull/47) + +* Proposal by TEF to add Postal Codes as new type of area, lack of support from other partners about the business case + +* New request from GSMA to add administrative code (like postal code) + - How we will manage case where implementation did not provide all location type?, Discovery?, Error? + +* **@TEF: add a new issue and close this one.** -> Pending + +* Discussion on how to handle the 'diversity' of the 'geo' code that we can have in a given country. + +* How a developer will know the 'type' of area managed by a telco + - José mentioned discussion about TMF Catalog API (as operate API) - As a discovery feature. + - An error scenario must be defined in CAMARA if the area type requested is not supported by the telco + + +## Test Cases + +* New [Issue #80](https://github.com/camaraproject/DeviceLocation/issues/80) + +* Wait for other working group & commonalities agreement alignment + +* Discussion about use of Gherkin + specific implementation + - Gherkin file should (must?) be provided + - Specific language implementation file could be provided but as part of implementation contribution + + +## Accuracy Levels for Device Location APIs + +* New [Issue #78](https://github.com/camaraproject/DeviceLocation/issues/78) + - Discuss if we need this functionality + +* José/Ludovic not sure about the relevance of the problem with current technology as we're not able to provide 'fine-grain' location. + +* Joachim raised that if we have this capabilities to provide coarse vs fine we'll have a consent issue that cannot be at 'global' api level but dependent on the accuracy + + +## Summer 2023 presence + +* New [PR #75](https://github.com/camaraproject/DeviceLocation/pull/75) + - Only Ludovic added this presence + +* Keep Aug 1st - José will host. +* Skip Aug 15th …. except of someone volunteer to host it + + +
+ +**Next call is on August 1st** diff --git a/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-08-01.md b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-08-01.md new file mode 100644 index 0000000000000000000000000000000000000000..05b05033af846547a0e9880c7fd9c3aaca1f710d --- /dev/null +++ b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-08-01.md @@ -0,0 +1,100 @@ +# CAMARA DeviceLocation meeting - 2023-08-01 + +*August 1st, 2023* + +## Attendees + +* Abhisek Das (Infosys) +* Akos Hunyadi (DT) +* Cetin Alpaycetin (Vodafone) +* Fernando Prado Cabrillo (TEF) +* Javier Carro (TEF) +* Jorge Garcia Hospital (TEF) +* José Luis Urien Pinedo (TEF) +* Rafal Artych (DT) +* Toshi Wakayama (KDDI) +* Tuan Tran (Broadpeak) + +QoD minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + + +### Geofencing v0.1-wip (Subscription for Location Area) + +* [Issue #18](https://github.com/camaraproject/DeviceLocation/issues/18), [PR #74](https://github.com/camaraproject/DeviceLocation/pull/74) + - Old PR #49 was close, new PR created + - Comments addressed, ready for final approval + +* [Issue #69](https://github.com/camaraproject/DeviceLocation/issues/69): Proposal for new name + - `geofencing` got consensus as name, PR updated, issue closed + + +### New API to provide raw location, v0.1-wip + +* [Issue #40](https://github.com/camaraproject/DeviceLocation/issues/40), [PR #55](https://github.com/camaraproject/DeviceLocation/pull/55) + - Reviewed, has 2 approvals. Ready to be merged + - Ludovic will work on the documentation only once PR#55 has been merged to avoid + + +### Behaviour when requesting too high precision + +* [Issue #58](https://github.com/camaraproject/DeviceLocation/issues/58) about what is expected behaviour when requested accuracy is more restrictive that the one that network is able to satisfy. + +* New [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85) + - TEF provided a doc with a proposal and use cases for the implementation of 'Partial' and matchRate + - Discussion during meeting. Issue to be updated: + - Akos commented that the ratio may not be enough and maybe we should add some text or rational. + - Cetin thinks that it makes sense to return a low percent since it is caused by a bad behaviour of the network. + - Telefónica agrees but raise the problem with Product team approach and how the quality of the product is perceived. + - We will see the possibility to split the partial values into different values as proposed by Jose and Akos. + +### Roadmap for Release v0.2 + +* New [Issue #84](https://github.com/camaraproject/DeviceLocation/issues/84) to unify naming for POST operations + - Current one: POST /verifications + POST /retrieve-location + - Decide on POST /verify-location + POST /retrieve-location, or simpler: POST /verify + POST /retrieve + - **Agreed to change paths to POST /verify + POST /retrieve** + +* We have to decide in Commonalities how to communicate roadmap for multiple API project. + +* Our roadmap could be: + - Release in August featuring + - For location-verification: -> ready for 0.2 + - For location: + - Provide v0.1 -> ready to be merged - documentation will be tackled in a separate PR + - For geofencing: + - Provide v0.1 -> ready to be merged - documentation will be tackled in a separate PR + - Release in late August / September (depending on holidays): + + +### Postal Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track, closing old [Issue #39](https://github.com/camaraproject/DeviceLocation/issues/39). [PR #47](https://github.com/camaraproject/DeviceLocation/pull/47) to be closed when new one is created. + +* Some initial comments, we can start discussion but this requirement will be in the scope of future releases. + - How to handle the 'diversity' of the 'geo' code that we can have in a given country. + - How to discover what is implemented by each provider. + - Error scenario must be defined in CAMARA if the area type requested is not supported by the telco + +* Requirement to be covered by future releases, we keep discussion open in issue. + + +## Summer 2023 presence + +* Decided to skip Aug 15th + + +## AOB + +* Akos raises the Commonalities Issue regarding CloudEvents and how it will affect the Geofencing API. + - From Telefónica, another colleague is working on the issue and will update Commonalities in the next days. + +
+ +**Next call is on August 29th** diff --git a/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-08-29.md b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-08-29.md new file mode 100644 index 0000000000000000000000000000000000000000..bfd1fbbf9a7f022cdbbfcdc041fa64c8fbe1acff --- /dev/null +++ b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-08-29.md @@ -0,0 +1,86 @@ +# CAMARA DeviceLocation meeting - 2023-08-29 + +*August 29th, 2023* + +## Attendees + +* Cetin Alpaycetin (Vodafone) +* Joachim Dahlgren (Ericsson) +* Jorge Garcia Hospital (TEF) +* José Luis Urien Pinedo (TEF) +* Ludovic Robert (Orange) +* Rafal Artych (DT) +* Vidhi Mehta (Comviva) + + +QoD minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + + +### Location Retrieval, v0.1-wip (Get raw location) + +* [Issue #40](https://github.com/camaraproject/DeviceLocation/issues/40), [PR #55](https://github.com/camaraproject/DeviceLocation/pull/55) + - Official name to be location-retrieval + - Reviewed, has 2 approvals. Decided to merge! + - Ludovic will work on the documentation only once PR#55 has been merged + + +### Geofencing v0.1-wip (Subscription for Location Area) + +* [Issue #18](https://github.com/camaraproject/DeviceLocation/issues/18), [PR #74](https://github.com/camaraproject/DeviceLocation/pull/74) + - Ludovic provided feedback on notification discussion in Commonalities, progress & plan: + - Have a specific swagger for generic notification + - Format for this dedicated notification swagger --> probably use Cloud Event structure + - Use of callbacks clause in the API swagger to describe API notification + - Issue API Design for "Resource-based subscription", [Commonalities Issue #44](https://github.com/camaraproject/Commonalities/issues/44) is the good place to follow progress + - Some comments still pending + - Probably for next meeting we can align Geofencing with commonalities + - Close to be merged as v0.1.0-wip, inline doc to be added later + + +### Roadmap to Release v0.2 + +* The proposed process for a version is to have a version x.y-wip then x.y-rc and then finally released as x.y. This pattern is used in QoD. +* Align the Device Location API with the security schema as described in Unify specification of `securitySchemes`, `security` and scopes, [Commonalities Issue #53](https://github.com/camaraproject/Commonalities/issues/53) +* Next steps: + - Create v0.2-rc for location-verification, updating Changelog and Release notes. + - Add location-retrieval v0.1.0-wip + - Add geofencing v0.1.0-wip, if aligned with Commonalities + - Give a couple of weeks for final testing and comments + - Approve a release after next meeting + + +### Behaviour when requesting too high precision + +* [Issue #58](https://github.com/camaraproject/DeviceLocation/issues/58) about what is expected behaviour when requested accuracy is more restrictive that the one that network is able to satisfy. +* New [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85) + - TEF provided a doc with a proposal and use cases for the implementation of 'Partial' and matchRate + - Further discussion needed. Orange team will make a review. + +### Administrative Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track + - Old [PR #47](https://github.com/camaraproject/DeviceLocation/pull/47) to be closed when new one is created. +* No new comments since last meeting, same questions/doubts: + - How to handle the 'diversity' of the 'geo' code that we can have in a given country. + - How to discover what is implemented by each provider. + - Error scenario must be defined in CAMARA if the area type requested is not supported by the telco. +* Discussion during the meeting: + - These questions could have a larger magnitude than this Device location API and should also infuse in Commonalities + - Adding Open Gateway product in the discussion could make sense as this OPGW could probably restrict a CAMARA API capability + - Discussion on the 'critical mass' to introduce API or API capability within one country. + + + +## AOB +N/A + +
+ +**Next call is on September 12th** diff --git a/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-09-12.md b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-09-12.md new file mode 100644 index 0000000000000000000000000000000000000000..43c1f7afd8f62e9a75d3e1c07aa6dc9111ce13f2 --- /dev/null +++ b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-09-12.md @@ -0,0 +1,93 @@ +# CAMARA DeviceLocation meeting - 2023-09-12 + +*September 12th, 2023* + +## Attendees + +* Akos Hunyadi (DT) +* Fernando Prado Cabrillo (TEF) +* Javier Carro (TEF) +* Joachim Dahlgren (Ericsson) +* José Luis Urien Pinedo (TEF) +* Ludovic Robert (Orange) +* Rafal Artych (DT) +* Toshi Wakayama (KDDI) + + +QoD minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + + +### Location Retrieval, v0.1-wip (Get raw location) + +* [Issue #40](https://github.com/camaraproject/DeviceLocation/issues/40), [PR #55](https://github.com/camaraproject/DeviceLocation/pull/55) + - Merged but any comment are welcome + - Joachim: Maybe we should consider to send back other area than circle. +This is only in the response -> **@Joachim will raise an issue** + +### Geofencing v0.1-wip (Subscription for Location Area) + +* [Issue #18](https://github.com/camaraproject/DeviceLocation/issues/18), [PR #74](https://github.com/camaraproject/DeviceLocation/pull/74) + - Notification pattern is still in progress in Commonalities to accommodate use of [CloudEvents](https://github.com/camaraproject/Commonalities/pull/56) -> Once the model close in Commonalities should be quick to craft the API. + + +### Roadmap to Release v0.2 + +* The proposed process for a version is to have a version x.y-wip then x.y-rc and then finally released as x.y. This pattern is used in QoD. + +* Align the Device Location API with the security schema as described in Unify specification of `securitySchemes`, `security` and scopes, [Commonalities Issue #53](https://github.com/camaraproject/Commonalities/issues/53), [PR #57](https://github.com/camaraproject/Commonalities/pull/57) + - PR still not merged, we should wait until Commonalities are approved. + +* Next steps: + - Then create v0.2-rc for location-verification, updating Changelog and Release notes. + - Add location-retrieval v0.1.0-wip + - Add geofencing v0.1.0-wip, after discussion in Commonalities is closed. + +* Joachim asked the question about consistence between the release name and the API name. + - Perhaps we can have a name for a family release + - Good topic to release in Commonalities -> **@Ludovic will raise an issue in Commonalities** + +### Behaviour when requesting too high precision + +* [Issue #58](https://github.com/camaraproject/DeviceLocation/issues/58) about what is expected behaviour when requested accuracy is more restrictive that the one that network is able to satisfy. + +* New [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85) + - TEF provided a doc with a proposal and use cases for the implementation of 'Partial' and matchRate + +* Discussion during meeting: + - Ludovic provided comment on José document + - The first point is to be aligned on the matchRate formulae. + - Both TEF & Orange feedbacks are that most of the result will be false or partial but very few chance to get True result. + - The problem is more significant if we allow 'small' scope (minimum radius) + - Good to keep in open + - **@Ludovic will fix the comment - should be matchRate no maxRate** + - Joachim: other alternative will be to answer the True/False but also the location + - This is not easy for Privacy issue + - We have the 'other' API to trigger this. + - Javier look on Ludovic proposal: could have worst result but in same time current approach did not cover all the case. + - After discussion seems that the team direction is to work on the PARTIAL answer and differentiate depending on the situation (see José document UC 3 & 4 for example). The PARTIAL answer could be completed with additional information + - **Think about improving PARTIAL information for next version** + +### Administrative Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track + - Old [PR #47](https://github.com/camaraproject/DeviceLocation/pull/47) closed. + +* No new comments since last meeting, **no update or discussion during meeting**. Previous questions/doubts: + - How to handle the 'diversity' of the 'geo' code that we can have in a given country. + - How to discover what is implemented by each provider. + - Error scenario must be defined in CAMARA if the area type requested is not supported by the telco. + + +## AOB +N/A + +
+ +**Next call is on September 26th** diff --git a/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-09-26.md b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-09-26.md new file mode 100644 index 0000000000000000000000000000000000000000..2425d766dca51b8af6e2078ea64a9feafc295ef3 --- /dev/null +++ b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-09-26.md @@ -0,0 +1,104 @@ +# CAMARA DeviceLocation meeting - 2023-09-26 + +*September 26th, 2023* + +## Attendees + +* José Luis Urien (TEF) +* Nicholas Venezia (centillion.ai) +* Cetin Alpaycetin (Vodafone) +* Joachim Dahlgren (Ericsson) +* Akos Hunyadi (DT) +* Ludovic Robert (Orange) +* Rafal Artych (DT) +* Jorge Garcia Hospital (TEF) +* Javier Carro Calador (TEF) + + +Device Location minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + + +### Geofencing v0.1-wip (Subscription for Location Area) + +* [Issue #18](https://github.com/camaraproject/DeviceLocation/issues/18), [PR #74](https://github.com/camaraproject/DeviceLocation/pull/74) + - Notification pattern is still in progress in Commonalities to accommodate use of [CloudEvents](https://github.com/camaraproject/Commonalities/pull/56) -> Once the model close in Commonalities should be quick to craft the API. + - Discuss progress in commonalities but close to be merged + - José is OK and wait Pedro return to validate + - Shilpa validated + - Objective is to have the API ready for review for next meeting. + + +### New: Location retrieval - Allow additional area types in the response + +* [Issue #94](https://github.com/camaraproject/DeviceLocation/issues/94) + - Other possible areas other than circle + - Discuss which ones make sense: Polygon, Ellipse/EllipsoidArc, Areas including altitude? + - Positive feedback from Telefonica in particular for polygon in a first step. Orange shares this feedback for Polygon. + - José raised the point about multi-polygon + - Joachin mentionned used of GMLC + - **[question]** Question on how getting the altitude. + - **[action]** Check how the network how the polygon is described (set of points) and then we can craft the P/R to improve the API with this new feature. + + +### Roadmap to Release v0.2 + +* The proposed process for a version is to have a version x.y-wip then x.y-rc and then finally released as x.y. This pattern is used in QoD. + +* Align the Device Location API with the security schema as described in Unify specification of `securitySchemes`, `security` and scopes, [Commonalities Issue #53](https://github.com/camaraproject/Commonalities/issues/53), [PR #57](https://github.com/camaraproject/Commonalities/pull/57) + - [Draft PR #95](https://github.com/camaraproject/DeviceLocation/pull/95) for location-verification, changing securitySchemes to openIdConnect. Waiting for resolution in Commonalities and Identity and Consent Management WGs. + +* Next steps: + - Then create v0.2-rc for location-verification, updating Changelog and Release notes. + - Add location-retrieval v0.1.0-wip + - Add geofencing v0.1.0-wip, after discussion in Commonalities is closed. + +* Naming of the Release + - Issue opened in [Commonalities Issue #60](https://github.com/camaraproject/Commonalities/issues/60) + - Proposal to use date format, such as Release 2023-09, but no agreement so far. + - **[action]** José will check how this release management for a family is done within Edge API + - **[decision]** Without formal decision we will use the date & lead the path + +### Behaviour when requesting too high precision + +* [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85), related to [Issue #58](https://github.com/camaraproject/DeviceLocation/issues/58) + - TEF provided a doc with a proposal and use cases for the implementation of 'Partial' and matchRate + +* Discussion during previous meeting: + - Need to align on the matchRate formulae. + - Problem with current proposal is that result will be false or partial but very few chance to get True result. The problem is more significant if we allow small areas as input. + - After discussion seems that the team direction is to work on the PARTIAL answer and differentiate depending on the situation (see José document UC 3 & 4 for example). The PARTIAL answer could be completed with additional information + - **Think about improving PARTIAL information for next version** + - Joachim had an internal review of the document - we have to write a document to explain how the matchRate is calculated. + - Discussion on the consent but probably not difference between retrieval & verification. + - The problem we have here for Location Verification will be also very significant for future geofencing API. + - Probably we need to have more maturity on this with some real implementation + - Nicholas Venezia provides feedback on how the Device location API is used within a podcast app to provide targeted ad. Nicholas demonstrated utilisation of location data. + +### Administrative Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track + - Old [PR #47](https://github.com/camaraproject/DeviceLocation/pull/47) closed. + - Javier shared a proposal on this topic. + - **[Question]** How to map postal code to geolocation/coordinate? + - depending on the country - could be provided by local regulations + - Javier will share the proposal in the GIT. + +* No new comments or progress since last meeting, **no update or discussion during meeting**. Previous questions/doubts: + - How to handle the 'diversity' of the 'geo' code that we can have in a given country. + - How to discover what is implemented by each provider. + - Error scenario must be defined in CAMARA if the area type requested is not supported by the telco. + + +## AOB +N/A + +
+ +**Next call is on October 10th** diff --git a/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-10-10.md b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-10-10.md new file mode 100644 index 0000000000000000000000000000000000000000..952acef1de32fffb2359036647ad843017bf7305 --- /dev/null +++ b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-10-10.md @@ -0,0 +1,114 @@ +# CAMARA DeviceLocation meeting - 2023-10-10 + +*October 10th, 2023* + +## Attendees + +* José Luis Urien (Telefonica) +* Foo Ming Hui (Singtel) +* Cetin Alpaycetin (Vodafone) +* Joachim Dahlgreen (Ericsson) +* Rafal Artych (DT) +* Akos Hunyadi (DT) +* Sébastien Synold (Intersec) +* Ludovic Robert (Orange) +* Fernando Prado Cabrillo (Telefonica) +* Jorge Garcia Hospital (Telefonica) +* Javier Carro Calador (Telefonica) + + +Device Location minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + + +### Geofencing v0.1-wip (Subscription for Location Area) + +* [Issue #18](https://github.com/camaraproject/DeviceLocation/issues/18), [PR #74](https://github.com/camaraproject/DeviceLocation/pull/74) + - New model based on CloudEvents are now approved + - PR proposed by DT https://github.com/camaraproject/DeviceLocation/pull/98 before the meeting. + - Ludovic raised the point about the event granularity - José shared the point and also expected 2 event types. + - Akos questionned if we need maxRate in this API. + - Cetin explained that in Vodafone implementation the cell id is used as an input. This will need API consumer to 'know' the cell which is a 'technical' information. + - [action] PR#74 could be close and point to PR#98 + + +### New: Location retrieval - Allow additional area types in the response + +* [Issue #94](https://github.com/camaraproject/DeviceLocation/issues/94) + - Other possible areas other than circle + - Discuss which ones make sense: Polygon, Ellipse/EllipsoidArc, Areas including altitude? + - Some comments on issue: + - OK to add polygon? + - Others? + + - José provided a feedback about TS29.572 review + - Limit to max 15 points could be challenged + - [action] Need PR for adding polygon as it is obvious. + - Need additional thinking for other area type + - Ludovic: What about adding the cell id ? + - José: It could be a way to discover the cell id but perhaps we could have a dedicated endpoint. + - [action] Worth to open an issue for this and think about it. + - Joachim : Need to verify if telco are willing to share this information. José: Perhaps using an alias could be an alternative. + - Discussion to be continued. + + +### Roadmap to Release v0.2 + +* The proposed process for a version is to have a version x.y-wip then x.y-rc and then finally released as x.y. This pattern is used in QoD. + +* Align the Device Location API with the security schema as described in Unify specification of `securitySchemes`, `security` and scopes, [Commonalities Issue #53](https://github.com/camaraproject/Commonalities/issues/53), [PR #57](https://github.com/camaraproject/Commonalities/pull/57) + - [PR #95](https://github.com/camaraproject/DeviceLocation/pull/95) for location-verification, changing securitySchemes to openIdConnect. Waiting for resolution in Commonalities and Identity and Consent Management WGs. + - Some approvals, can we merge? + - [Decision] Yes + - Joachim questionned about OIDC flows use-able. + - José/Ludovic answered that the proposal allow flexibilty by splitting the API yaml from the managed authorization for the API. This solution did not restriction authorization flow. In order to simplify adoption authorization flow must be constitent within one country + - [Action] : check for Device-location-retrieval and if not aligned to be tackled in next version. + +* Next steps: + - Then create v0.2-rc for location-verification, updating Changelog and Release notes. + - Add location-retrieval v0.1.0-wip + - Add geofencing v0.1.0-wip, after discussion in Commonalities is closed. + - geofencing has to be aligned with CloudEvents + +* Naming of the Release + - Issue opened in [Commonalities Issue #60](https://github.com/camaraproject/Commonalities/issues/60) + - Proposal to use date format, such as Release 2023-09, but no agreement so far. + - EdgeCloud API using v1, v2 ... + - What name should we choose? + - [Decision] Let's wait for next TSC outcome. + +### Behaviour when requesting too high precision + +* [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85) + - TEF provided a doc with a proposal and use cases for the implementation of 'Partial' and matchRate + +* No new comments +* Need a better name for Partial (Javier will work on it) + +### Administrative Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track + - Old [PR #47](https://github.com/camaraproject/DeviceLocation/pull/47) closed. + - Javier shared a proposal on this topic. + - **[Question]** How to map postal code to geolocation/coordinate? + - depending on the country - could be provided by local regulations + - [Action] Javier will share the proposal in the GIT. + +* No new comments or progress since last meeting, **no update or discussion during meeting**. Previous questions/doubts: + - How to handle the 'diversity' of the 'geo' code that we can have in a given country. + - How to discover what is implemented by each provider. + - Error scenario must be defined in CAMARA if the area type requested is not supported by the telco. + + +## AOB +N/A + +
+ +**Next call is on October 24th** diff --git a/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-10-24.md b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-10-24.md new file mode 100644 index 0000000000000000000000000000000000000000..48fb7ab8e684d02b608428fcc1b5eb753cc602ba --- /dev/null +++ b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-10-24.md @@ -0,0 +1,118 @@ +# CAMARA DeviceLocation meeting - 2023-10-24 + +*October 24th, 2023* + +## Attendees + +[x] José Luis Urien (Telefonica) +[] Foo Ming Hui (Singtel) +[x] Cetin Alpaycetin (Vodafone) +[x] Joachim Dahlgreen (Ericsson) +[x] Rafal Artych (DT) +[x] Akos Hunyadi (DT) +[] Sébastien Synold (Intersec) +[x] Ludovic Robert (Orange) +[x] Fernando Prado Cabrillo (Telefonica) +[] Jorge Garcia Hospital (Telefonica) +[] Javier Carro Calador (Telefonica) +[x] Ramesh Shanmugasundaram +[x] Amit Ajuha +[x] Parichaya Shrivastava + + +Device Location minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + + +## Open issues and PRs + + +### Geofencing v0.1-wip (Subscription for Location Area) + +* [Issue #18](https://github.com/camaraproject/DeviceLocation/issues/18), [PR #74](https://github.com/camaraproject/DeviceLocation/pull/74) + - Review last comments in PR + - Good progress - few comments left: + * Basepath should be enum and not default - Issue in Commonalities raised by José + * Move to openId for security schema + * Adding data in termination event + * Safer to include the information in the event body + + - Ludovic will update the commonalities on subscription/event after first usage in Device location, Device status & Sim Swap. + - Joachim raised the point about adding other area type --> will be done in future PR. + + +### New: Location retrieval - Allow additional area types in the response + +* [Issue #94](https://github.com/camaraproject/DeviceLocation/issues/94) + - Review last [PR #100](https://github.com/camaraproject/DeviceLocation/pull/100) adding polygon + - PR ready: + - limit to 15: OK for the team. + - [action] for Ludovic: + - Add precision about close shape in the documentation for polygon. This is not required to provide twiwe a point. + - Align with security schema (discussed in TSC but not finalized in the documentation) + - Align with basepath with an enum + + +### Roadmap to Release v0.2 + +* The proposed process for a version is to have a version x.y-wip then x.y-rc and then finally released as x.y. This pattern is used in QoD. + +* Align the Device Location API with the security schema as described in Unify specification of `securitySchemes`, `security` and scopes, [Commonalities Issue #53](https://github.com/camaraproject/Commonalities/issues/53), [PR #57](https://github.com/camaraproject/Commonalities/pull/57) + - [PR #95](https://github.com/camaraproject/DeviceLocation/pull/95) for location-verification, already merged after discussion in TSC. + - Apply the same to location-retrieval and geofencing? + +* Naming of the Release + - Issue opened in [Commonalities Issue #60](https://github.com/camaraproject/Commonalities/issues/60) + - Review discussion in TSC and agree on a name + - Discussed in TSC: + - DT will write a proposal on managing the proposal both for the API yaml(s) and family + - Have a global release for all CAMARA API for MWC 2024 + + +* Release content: + - location-verification v0.2-rc + - location-retrieval v0.1.0-wip + - geofencing v0.1.0-wip + - Changelog and Release notes. + +Points discussed: +* All this yaml will be under **0.2** family +* [action] For location-verification, José will fix the basepath with enum instead of default. + + +### Behaviour when requesting too high precision + +* [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85) + - TEF provided a doc with a proposal and use cases for the implementation of 'Partial' and matchRate + +* New comments in Github from Joachim + * 3 scenarios illustrated + * [action] Review this comment. + +### Administrative Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track + - New [document uploaded by TEF](https://github.com/camaraproject/DeviceLocation/files/12856149/AdminCode.Proposal.-.Draft_20230926.docx) with a proposal +* [action] Review this document. + +## AOB + +**Discussion on 3-legs pattern** raised by Joachim + * What is the third leg ? Is it always the flow going to the responsible 'party' for 'consent' grant? + * Let's take the example of a connected dog collar - The 'consent' should be provided by the user of the application tracking the dog. + * This management of the responsible 'party' for 'consent' grant is managed in the Authorization Server (AS). The AS for a given request for a device, a purpose and a data clain, compute the legal base and 'execute' it. Depending on the legal base there is not always a interaction with the responsible 'party' for 'consent' grant. + * Do we need to explictly provides in the request the device identifier as we can have it in the 'first leg'? + * This is relevant for some UC but we have UC where the Device A could trigger location request for another device. + * We mentioned the documentation provided in Identity&Consent management WG. + * We probably need to mention/point/refer this documentation in device location family API - We need to discuss how this information could be provided. + * The discussion will continue in following calls and depending on the work progress in Identity&Consent management WG. + +José will share the information to join the **Slack** + +
+ +**Next call is on November 7th** diff --git a/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-11-07.md b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-11-07.md new file mode 100644 index 0000000000000000000000000000000000000000..65cda0ea474c2537936fa5ff1cc07cd26c884a27 --- /dev/null +++ b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-11-07.md @@ -0,0 +1,93 @@ +# CAMARA DeviceLocation meeting - 2023-11-07 + +*November 7th, 2023* + +## Attendees + +- José Luis Urien (TEF) +- Joachim Dahlgreen (Ericsson) +- Jayant Nagaraj (Shabodi) +- Cetin Alpaycetin (Vodafone) +- Akos Hunyadi (DT) +- Nicholas Venezia (Centillion) +- Fernando Prado Cabrillo (TEF) +- Rafal Artych (DT) +- Ludovic Robert (Orange) +- Jorge Garcia Hospital (TEF) +- Javier Carro Calador (TEF) + +Device Location minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + +### Review Release Candidate v0.2 + +* Review [location-verification.yaml v0.2 Release Candidate](https://github.com/camaraproject/DeviceLocation/pull/104) + - The proposed process for a version is to have a version x.y-wip then x.y-rc and then finally released as x.y. This pattern is used in QoD. + - Doc updated + - basePath fixed in URL + - Examples updated + - Decide what to do with IPV6 pattern + - José triggered an isue in QoD to discuss IPV6 format and then will align. José suggests to remove pattern if not fully correct (As of now this pattern did nort work for some subnet mask definition) + - We are waiting for QoD outcome on this point. + - Joachim suggested to raise an issue in Commonalitiesa we have to align this in every API as this is a generic topic + - Akos explained that we can merge even as rc because it is valid to still update rc + +* Review new README and CHANGELOG + - [PR #106](https://github.com/camaraproject/DeviceLocation/pull/106) + - Inspired by model in QoD + - *Links will work after branch for Release-0.2.0 is created* + - Discussion on versinning name and use of wip & rc suffix + - Location-Verification is in Alpha version + - Discussion if location-retrieval should be also in Alpha version. + - Geofencing shouldn't stay in pre-Alpha as there are not open issue (_note that pre-alpha is not a defined state_). Joachim explained that for him if it's wip then we do no code it (which is a fair argument to move geofencing to rc) + +* Release content: + - location-verification v0.2-rc + - location-retrieval v0.1.0-wip -> Do we keep -wip? + - We should create also a rc and align with current work for location verification. + - Decision: should be promoted to v0.1-rc + - **Ludovic (for Orange) will create a PR** + - geofencing v0.1.0-wip -> Do we keep -wip? + - Decision: should be promoted v0.1-rc + - **Max (for DT) will create a PR** + - Changelog and Release notes. + - **José asked the team to take a close look on PR#106 as this is what the external public will see.** + + - Akos suggests to create an issue for tracking and the 3 PR will refer this one. + +### New Issues + +* security and scopes for the Device Location API [#105](https://github.com/camaraproject/DeviceLocation/issues/105) + * --> Probably good to rout to identity & consent management project + +### Open discussions + +#### Behaviour when requesting too high precision + +_Not enough time to discuss_ + +* [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85) + - TEF provided a doc with a proposal and use cases for the implementation of 'Partial' and matchRate + +* New comments in Github from Joachim + * 3 scenarios illustrated + * [action] Review this comment. + +#### Administrative Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track + - New [document uploaded by TEF](https://github.com/camaraproject/DeviceLocation/files/12856149/AdminCode.Proposal.-.Draft_20230926.docx) with a proposal +* [action] Review this document. + +## AOB + + +
+ +**Next call is on November 21th** diff --git a/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-11-21.md b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-11-21.md new file mode 100644 index 0000000000000000000000000000000000000000..c75f0836659656b8ce8d6fb3c2d0c595aedbbb54 --- /dev/null +++ b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-11-21.md @@ -0,0 +1,114 @@ +# CAMARA DeviceLocation meeting - 2023-11-21 + +*November 21st, 2023* + +## Attendees + +- José Luis Urien (TEF) +- Javier Carro Calador (TEF) +- Nicholas Venezia (Centillion) +- Ben Thomas (Vodafone) +- Foo Ming Hui (SingTel) +- Cetin Alpaycetin (Vodafone) +- Akos Hunyadi (DT) +- Jorge Garcia Hospital (TEF) +- Ludovic Robert (Orange) +- Fernando Prado Cabrillo (TEF) +- Sébastien Synold (Intersec) +- Rafal Artych (DT) +- Surajj Jaggernath (Vodacom) + + +Device Location minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + +### Review Release Candidate v0.2 + +* Review latest comments in ongoing PRs for APIs, and decide if ready to be merged: + - [location-verification.yaml v0.2 Release Candidate](https://github.com/camaraproject/DeviceLocation/pull/104) + - Point about Ipv6 still open in QoD (will be valid for all three APIs) + - Description comment from Cetin to be considered + - [location-retrieval.yaml v0.1 Release Candidate](https://github.com/camaraproject/DeviceLocation/pull/114) + - Error: Status & Code are 'normative' - message are open to modification by implementation + - [geofencing.yaml v0.1 Release Candidate](https://github.com/camaraproject/DeviceLocation/pull/116) + - Rafal proposed to align Notification source example list accordingly to the guidelines + +We're still in line to release before the end of the year. + - Resolve pending comments and merge current PRs as -rc + - Open testing and feedback period for RC versions + + We need also to align with the new working group about release management + + First training Nov 21th + Rafal, Ludovic and José will attend + + +* Review latest comments in PR for README and CHANGELOG, and decide if ready to be merged: + - [Release Notes](https://github.com/camaraproject/DeviceLocation/pull/106) + - *Links will work after branch for Release-0.2.0 is created* + +### Review other Issues and PRs + +* [Add Test Definition for location Retrieval #119](https://github.com/camaraproject/DeviceLocation/pull/119/files) + - Discussed during meeting + - To be discussed in Commonalities here: https://github.com/camaraproject/Commonalities/issues/94 + + - The team needs to be involved in this work + - Agreed to use Gherkin must we should have an alignement on the formal aspect + +* [Adjust IP Adresses device in device to use single IP adresses](https://github.com/camaraproject/DeviceLocation/issues/117) + - To be aligned with ongoing discussion and [PR in QoD](https://github.com/camaraproject/QualityOnDemand/pull/237) + +* [Geofencing API - Add "format: uri" to notificationUrl](https://github.com/camaraproject/DeviceLocation/issues/118) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/93) + +* [Geofencing API - Adding capability to manage max number of notification](https://github.com/camaraproject/DeviceLocation/issues/111) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/90) + +* [Geofencing API - Semantic error](https://github.com/camaraproject/DeviceLocation/issues/109) + - Solved & closed + +* [security and scopes for the Device Location API](https://github.com/camaraproject/DeviceLocation/issues/105) + - Discuss during meeting + +### Open discussions + +#### Behaviour when requesting too high precision + +* [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85) + - TEF provided a doc with a proposal and use cases for the implementation of 'Partial' and matchRate + +* New comments in Github from Joachim + * 3 scenarios illustrated + * [action] Review this comment. + +**[Decision]** Proposal is to use the formula defined in the Word document by Telefonica Team. + API documentation will be updated --> Add a document and have a link in each yaml to refer it. Telefonica will craft this document. + +#### Administrative Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track + - New [document uploaded by TEF](https://github.com/camaraproject/DeviceLocation/files/12856149/AdminCode.Proposal.-.Draft_20230926.docx) with a proposal +* [action] Review this document. + + - Question from José if we need to keep this function in a same API or in a distinct one. + - This feature is not top priority right now but will be discused next year. + +Question about API certification from Ludovic + - Location retrieval is a good candidate + - topic links to the Test definition + - Let's wait for test definition outcomes and then we will assess use of this asset for certification purpose. + +## AOB + + +
+ +**Next call is on December 5th** + José will be off - Fernando & Ludovic will host the call. diff --git a/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-12-05.md b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-12-05.md new file mode 100644 index 0000000000000000000000000000000000000000..74d1c7b0821f7b356348748fbe43dfd60c5ce50e --- /dev/null +++ b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-12-05.md @@ -0,0 +1,113 @@ +# CAMARA DeviceLocation meeting - 2023-12-5 + +*December 5th, 2023* + +## Attendees + + +- Ludovic Robert (Orange) +- Fernando Prado Cabrillo (TEF) +- Foo Ming Hui (SingTel) +- Cetin Alpaycetin (Vodafone) +- Akos Hunyadi (DT) +- Javier Carro (TEF) +- Rafal Artych (DT) +- Joachim Dahlgreen (Ericsson) +- Sönke Peters (Vodafone) +- Surajj Jaggernath (Vodacom) + + +Device Location minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs + * No new issue for last 2 weeks + * Cleaning for old issues +* Any other business + +## Open issues and PRs + +### Review Release Candidate v0.2 + +* Review latest comments in ongoing PRs for APIs, and decide if ready to be merged: + - [location-verification.yaml v0.2 Release Candidate](https://github.com/camaraproject/DeviceLocation/pull/104) + - Point about Ipv6 solved + - Description comments from Cetin considered + - Precision on date time accordingly to the commonalities guidelines + - MERGED during the meeting + - [location-retrieval.yaml v0.1 Release Candidate](https://github.com/camaraproject/DeviceLocation/pull/114) + - Point about Ipv6 solved (complete alignment with verification device structure) + - Ready to review + - [geofencing.yaml v0.1 Release Candidate](https://github.com/camaraproject/DeviceLocation/pull/116) + - Rafal aligned Notification source example list accordingly to the guidelines + - Alignment with IP v6 to be done. + - Akos will align ip addresses and device model as has been done with location retrieval and location verification + - Typo found in "expiresAt" subscription info. Akos will fix. + + +* Review latest comments in PR for README and CHANGELOG, and decide if ready to be merged: + - [Release Notes](https://github.com/camaraproject/DeviceLocation/pull/106) + - *Links will work after branch for Release-0.2.0 is created* + - No new comment since last meeting + +### Review other Issues and PRs + +* [Add Test Definition for location Retrieval #119](https://github.com/camaraproject/DeviceLocation/pull/119/files) + - Link with Commonalities here: https://github.com/camaraproject/Commonalities/issues/94 + - No progress + +* [Adjust IP Adresses device in device to use single IP adresses](https://github.com/camaraproject/DeviceLocation/issues/117) + - Aligned with ongoing discussion and [PR in QoD](https://github.com/camaraproject/QualityOnDemand/pull/237) + - Done for Location retrieval & location verification + - To be done for geofencing + +* [Geofencing API - Add "format: uri" to notificationUrl](https://github.com/camaraproject/DeviceLocation/issues/118) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/93) + - still open + +* [Geofencing API - Adding capability to manage max number of notification](https://github.com/camaraproject/DeviceLocation/issues/111) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/90) + - still open - no progress + +* [security and scopes for the Device Location API](https://github.com/camaraproject/DeviceLocation/issues/105) + - Ludovic answered. + +* [Documentation Updated](https://github.com/camaraproject/DeviceLocation/issues/102) + - part of https://github.com/camaraproject/DeviceLocation/pull/104 + +### Open discussions + +#### Behaviour when requesting too high precision + +* [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85) + - TEF provided a doc with a proposal and use cases for the implementation of 'Partial' and matchRate + - During previous meeting we agreed to use the formula defined in the Word document. + - Descriptions regarding partials and matchRate has been added in location-verification yaml + - As requested by Joachim, issue will remain open until TEF uploads the document with more detail or the information is added to an API_documentation file to keep in the repo for future references. + + +### Cleaning - issues closed +* [Does DeviceLocation itself really need to define all ways to identify a User equipment identifier](https://github.com/camaraproject/DeviceLocation/issues/51) - Tackled with https://github.com/camaraproject/DeviceLocation/issues/117 + +* [Include locationType as a request parameter](https://github.com/camaraproject/DeviceLocation/issues/43) - Request for Office/work location (most latched site/location in the day time) & Home location (most latched site/location in the night time). Managed in separate API request. + - Issue closed - Tackled with https://github.com/camaraproject/WorkingGroups/issues/336 + + [Accuracy Levels for Device Location APIs](https://github.com/camaraproject/DeviceLocation/issues/78) - nu update since July 31st José request for clarification to the issuer. + - Issue closed as there have been no updates in 3 months + +#### Administrative Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track + - New [document uploaded by TEF](https://github.com/camaraproject/DeviceLocation/files/12856149/AdminCode.Proposal.-.Draft_20230926.docx) with a proposal +* [action] Review this document. + - Not progress but during last call we agreed that this feature is not top priority right now but will be discussed next year. + + + +## AOB + + +
+ +**Next call is on December 19th** diff --git a/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-12-19.md b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-12-19.md new file mode 100644 index 0000000000000000000000000000000000000000..37f518c199523817a71b02a584869e01b341cc5c --- /dev/null +++ b/original/DeviceLocation/documentation/MeetingMinutes/2023/MoM-2023-12-19.md @@ -0,0 +1,117 @@ +# CAMARA DeviceLocation meeting - 2023-12-19 + +*December 19th, 2023* + +## Attendees +José Luis Urien Pinedo (Telefonica) +Ludovic Robert (Orange) +Surajj Jaggernath (Vodacom) +Cetin Alpaycetin (Vodafone) +Joachim Dahlgren (Ericsson) +Akos Hunyadi (DT) +Ravi Shekhar +Javier Carro Calabor (Telefonica) + + +Device Location minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + +### Review Release Candidate v0.2 + +* Review latest comments in ongoing PRs for APIs, and decide if ready to be merged: + - [location-verification.yaml v0.2 Release Candidate](https://github.com/camaraproject/DeviceLocation/blob/main/code/API_definitions/location-verification.yaml) + - Already merged + - Minor fix merged: [Fix MaxAge type](https://github.com/camaraproject/DeviceLocation/pull/126) + - Any further comment/bug found? + - [location-retrieval.yaml v0.1 Release Candidate](https://github.com/camaraproject/DeviceLocation/pull/114) + - PR approved + - Merged + - [geofencing.yaml v0.1 Release Candidate](https://github.com/camaraproject/DeviceLocation/pull/116) + - PR approved + - Merged + +* Review latest comments in PR for README and CHANGELOG, and decide if ready to be merged: + - [Release Notes](https://github.com/camaraproject/DeviceLocation/pull/106) + - *Links will work after branch for Release-0.2.0 is created* + - No new comment since last meeting + - José will take a last look and merge this PR. + +### Review other Issues and PRs + +#### New + +* [Implement use of linting rule set for Device Location API](https://github.com/camaraproject/DeviceLocation/issues/125) + - José tested locally for location verification + - José plans to do same for the other APIs + - No major issue identified (only warning). + +* [Geofencing API - Defining a standard behavior for first event](https://github.com/camaraproject/DeviceLocation/issues/124) + - Relevant question for possible enhancement. To be discussed. + - José took a look on google API implementation and they have a new input parameter to let client decide if she/he decide to get an event at subscription time. This is relevant only for entered area event. + - We can introduce a `initialTriggerAreaEntered` boolean - if it is true then a notification is sent if the mobile is within the area. + - Akos said that we can send the notification in every case (not requiring this attribute) + - Joachim raises the point about how we can distinct the fact that the device was already in the area vs it just entered in for this first event. + - A combination with Location retrieval could be also documented. Ludovic says that it can work except if the device just entered at subscription time. + - **We need to open an issue to discuss** about the compute rule for geofencing area match. We solved this for device verification API (for `matchRate`) but here this is different as it is dynamic. + - Recommendation to continue the discussion on the issue. + +#### From previous meeting + +* [Add Test Definition for location Retrieval #119](https://github.com/camaraproject/DeviceLocation/pull/119/files) + - Link with Commonalities here: https://github.com/camaraproject/Commonalities/issues/94 + - No progress + - DT Team has provided comment + - TEF team will also provide comments + - Discussion should continue in Commonalities + +* [Adjust IP Adresses device in device to use single IP adresses](https://github.com/camaraproject/DeviceLocation/issues/117) + - Already done, to be closed when merged + - **Closed** with PR merging. + +* [Geofencing API - Add "format: uri" to notificationUrl](https://github.com/camaraproject/DeviceLocation/issues/118) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/93) + - still open + +* [Geofencing API - Adding capability to manage max number of notification](https://github.com/camaraproject/DeviceLocation/issues/111) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/90) + - still open - no progress + +* [security and scopes for the Device Location API](https://github.com/camaraproject/DeviceLocation/issues/105) + - Ludovic answered. + - **Closed** + +* [Documentation Updated](https://github.com/camaraproject/DeviceLocation/issues/102) + - part of https://github.com/camaraproject/DeviceLocation/pull/104 + - **Closed** with PR merging. + +### Open discussions + +#### Behaviour when requesting too high precision + +* [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85) + - TEF provided a doc with a proposal and use cases for the implementation of 'Partial' and matchRate + - During previous meeting we agreed to use the formula defined in the Word document. + - Descriptions regarding partials and matchRate has been added in location-verification yaml + - As requested by Joachim, issue will remain open until TEF uploads the document with more detail or the information is added to an API_documentation file to keep in the repo for future references. + + +#### Administrative Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track + - New [document uploaded by TEF](https://github.com/camaraproject/DeviceLocation/files/12856149/AdminCode.Proposal.-.Draft_20230926.docx) with a proposal +* [action] Review this document. + - Not progress but during last call we agreed that this feature is not top priority right now but will be discussed next year. + + +## AOB + +- Next call will be **January 16th, 2024** + +
+ diff --git a/original/DeviceLocation/documentation/MeetingMinutes/MoM-2024-01-16.md b/original/DeviceLocation/documentation/MeetingMinutes/MoM-2024-01-16.md new file mode 100644 index 0000000000000000000000000000000000000000..aca10e9db3f83805a087f7f4b895b4111893f157 --- /dev/null +++ b/original/DeviceLocation/documentation/MeetingMinutes/MoM-2024-01-16.md @@ -0,0 +1,126 @@ +# CAMARA DeviceLocation meeting - 2024-01-16 + +*January 16th, 2024* + +## Attendees + +José Luis Urien Pinedo (Telefonica) +Joachim Dahlgren (Ericsson) +Akos Hunyadi (DT) +Cetin Alpaycetin (Vodafone) +Javier Carro Calador (Telefonica) +Ludovic Robert (Orange) +Nicholas Venezia (Centillion) +Jorge Garcia Hospital (Telefonica) +Foo Ming Hui (Singtel) +Fernando Prado Cabrillo (Tlefonica) + + + +Device Location minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + +### Review v0.2-rc2 + +- Release Candidate was created in [branch](https://github.com/camaraproject/DeviceLocation/tree/release-0.2.0-rc) +- Error detected after releasing, with enum values for Area, [already fixed](https://github.com/camaraproject/DeviceLocation/issues/131) +- [Prepare RC2](https://github.com/camaraproject/DeviceLocation/pull/134) PR already merged +- New errors reported, to be fixed in RC2: + - [Correct YAML examples to use upper case enum of areaType](https://github.com/camaraproject/DeviceLocation/issues/136) + - Create PR with fix + + - [Fix format for attribute lastLocationTime in location retrieval](https://github.com/camaraproject/DeviceLocation/issues/137) + - Create PR with fix + + - [Rename in the OAS SubscriptionEventType to NotificationEventType](https://github.com/camaraproject/DeviceLocation/issues/139) + - Create PR to change schema names + +- Create RC2 branch and release tag + - Ludovic will do for both API + - No change for the version in the yaml + +### Review other Issues and PRs + +#### New + + - [Geofencing API - Add Subscription type 'area-left-or-entered' to subscribe to both event in one time](https://github.com/camaraproject/DeviceLocation/issues/138) + - Review comments + - José answers in the PR + - Joachim agreed on the fact that make sense to have one event type both for left & entered + - Akos: The UC is clear - how we solve it + - One approach is to allow to subscribe to an array of event type + - Discussed in the past but adding an array of notification type will add a layer of complexity to manage a subscription + - Could be a problem if the server is not able to manago one kind of event type. + - **Keep it open to let the discussion open.** + - José will also check with development team + - Having both 'event' in one notification type could have an impact on the server managing the event + + - [Revise Description to Meet GDPR Compliance - REMOVAL OF " Location-based advertising" in Documentation](https://github.com/camaraproject/DeviceLocation/issues/135) + - Review comments + - Nicholas will propose a better wording for this sentence + - Could be integrated in rc2 + + - [Define guidelines for geofencing implementation](https://github.com/camaraproject/DeviceLocation/issues/133) + - Review comments + - Need more review from the team + - Correlation with issue [Geofencing API - Defining a standard behavior for first event](https://github.com/camaraproject/DeviceLocation/issues/124) + - **keep the discussion open** + +#### Ongoing + +* [Add Test Definition for location Retrieval #119](https://github.com/camaraproject/DeviceLocation/pull/119/files) + - Link with Commonalities here: https://github.com/camaraproject/Commonalities/issues/94 + - Review PR status + - Proposal to use this one as the 'model sample' for Commonalities + - **Keep in open but need to be prioritized** + +* [Implement use of linting rule set for Device Location API](https://github.com/camaraproject/DeviceLocation/issues/125) + - Next steps + - Integrate the linting in our CI as for QoD + - As codeowner we did not have the right to add it. + - José will comment and ping Markus & Rafal to ask them how we can move forward. + +* [Geofencing API - Defining a standard behavior for first event](https://github.com/camaraproject/DeviceLocation/issues/124) + - Review comments, next steps + - Probably same thing must be done for area left. + - Akos & Ludovic have UC where it could be necessary. + - Nicholas mentionned also ad-based UC (ad in a podcast location-based for example) where we want to control the time when the ad should be triggered for a device + +* [Geofencing API - Add "format: uri" to notificationUrl](https://github.com/camaraproject/DeviceLocation/issues/118) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/93) + - still open in Commonalities + +* [Geofencing API - Adding capability to manage max number of notification](https://github.com/camaraproject/DeviceLocation/issues/111) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/90) + - still open - no progress in Commonalities + + +### Open discussions + +#### Administrative Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track + - New [document uploaded by TEF](https://github.com/camaraproject/DeviceLocation/files/12856149/AdminCode.Proposal.-.Draft_20230926.docx) with a proposal +* [action] Review this document. + - Not progress but during last call we agreed that this feature is not top priority right now but will be discussed next year. + - Probably to keep it close with the (future) work for User Device count + - We can probably add our Area schemas in Commonalities + + +#### Behaviour when requesting too high precision + +* [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85) + - As requested by Joachim, issue will remain open until TEF uploads the document with more detail or the information is added to an API_documentation file to keep in the repo for future references. + +## AOB + +- Next call will be **January 30th, 2024** + +
+ diff --git a/original/DeviceLocation/documentation/MeetingMinutes/MoM-2024-01-30.md b/original/DeviceLocation/documentation/MeetingMinutes/MoM-2024-01-30.md new file mode 100644 index 0000000000000000000000000000000000000000..f573a8d45feef9c0c9c3f54b432be6cd9942d418 --- /dev/null +++ b/original/DeviceLocation/documentation/MeetingMinutes/MoM-2024-01-30.md @@ -0,0 +1,100 @@ +# CAMARA DeviceLocation meeting - 2024-01-30 + +*January 30th, 2024* + +## Attendees + +* Cetin Alpaycetin (Vodafone) +* Fernando Prado Cabrillo (Telefonica) +* Joachim Dahlgren (Ericsson) +* José Luis Urien Pinedo (Telefonica) +* Rafal Artych (DT) + +Device Location minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + +### Review v0.2-rc2 + +- [PR](https://github.com/camaraproject/DeviceLocation/pull/142) with fixes to: + - [Correct YAML examples to use upper case enum of areaType](https://github.com/camaraproject/DeviceLocation/issues/136) + - [Fix format for attribute lastLocationTime in location retrieval](https://github.com/camaraproject/DeviceLocation/issues/137) + - [Rename in the OAS SubscriptionEventType to NotificationEventType](https://github.com/camaraproject/DeviceLocation/issues/139) + - [Revise Description to Meet GDPR Compliance - REMOVAL OF " Location-based advertising" in Documentation](https://github.com/camaraproject/DeviceLocation/issues/135) + +- AP: Give one more day for review, merge and create RC2 + +### Review other Issues and PRs + +#### New + + - [Geofencing - Adding a value in Termination Reason value enum](https://github.com/camaraproject/DeviceLocation/issues/141) + - Review comments. Cetin agrees with Ludovic's comment. + - AP: We'lll wait for Commonalities to add it to Geofencing. + +#### Ongoing + +* [Add Test Definition for location Retrieval #119](https://github.com/camaraproject/DeviceLocation/pull/119/files) + - Link with Commonalities here: https://github.com/camaraproject/Commonalities/issues/94 + - Review PR status and new comments + - AP: Telefónica will provide a proposal updating a few aspects of Ludovic's proposal after checking with internal QA team. + +* [Geofencing API - Add Subscription type 'area-left-or-entered' to subscribe to both event in one time](https://github.com/camaraproject/DeviceLocation/issues/138) + - Review new comments + - AP: Get more opinions. + +* [Define guidelines for geofencing implementation](https://github.com/camaraproject/DeviceLocation/issues/133) + - Review new comments. + - AP: Get more opinions. + +* [Geofencing API - Adding capability to manage max number of notification](https://github.com/camaraproject/DeviceLocation/issues/111) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/90) + - still open - Review new comments + - AP: Wait for outcome in Commonalities + +* [Implement use of linting rule set for Device Location API](https://github.com/camaraproject/DeviceLocation/issues/125) + - José asked Markus & Rafal how we can move forward. + - Rafal explains that process will be: + - Merge PR in commonalities with the initial ruleset as an artifact. + - Possibly a discussion in TSC about how to add it in each WG in a common way. + - AP: We'll wait for the process. In the meantime we are able to test it locally and provide feedback before integrating. + +* [Geofencing API - Defining a standard behavior for first event](https://github.com/camaraproject/DeviceLocation/issues/124) + - No new comments + - AP: We are at a point where we can create a PR. Jose will ping Akos in case he wants to create the PR, otherwise Jose will create it to move the discussion to the PR. + +* [Geofencing API - Add "format: uri" to notificationUrl](https://github.com/camaraproject/DeviceLocation/issues/118) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/93) + - still open in Commonalities. No new comments. + - AP: Ping in the issue to reactivate the discussion + +### Open discussions + +- No new comments since last meeting. We keep these discussions on hold. + +#### Administrative Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track + - New [document uploaded by TEF](https://github.com/camaraproject/DeviceLocation/files/12856149/AdminCode.Proposal.-.Draft_20230926.docx) with a proposal +* [action] Review this document. + - Not progress but during last call we agreed that this feature is not top priority right now but will be discussed next year. + - Probably to keep it close with the (future) work for User Device count + - We can probably add our Area schemas in Commonalities + + +#### Behaviour when requesting too high precision + +* [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85) + - As requested by Joachim, issue will remain open until TEF uploads the document with more detail or the information is added to an API_documentation file to keep in the repo for future references. + +## AOB + +- Next call will be **February 13th, 2024** + +
+ diff --git a/original/DeviceLocation/documentation/MeetingMinutes/MoM-2024-02-13.md b/original/DeviceLocation/documentation/MeetingMinutes/MoM-2024-02-13.md new file mode 100644 index 0000000000000000000000000000000000000000..8f4b3bbab515da49493e4ad5c8625fd5784db4e1 --- /dev/null +++ b/original/DeviceLocation/documentation/MeetingMinutes/MoM-2024-02-13.md @@ -0,0 +1,143 @@ +# CAMARA DeviceLocation meeting - 2024-02-13 + +*February 13th, 2024* + +## Attendees + +* José Luis Urien (Telefonica) +* Akos Hunyadi (DT) +* Cetin Alpaycetin (Vodafone) +* Fernando Prado Cabrillo (Telefonica) +* Ludovic Robert (Orange) +* Rafal Artych (DT) +* Javier Caaro Calabor (Telefonica) + +Device Location minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + +### Review v0.2.0-rc3 + +- [PR](https://github.com/camaraproject/DeviceLocation/pull/150) with fixes to: + - [fix: correct $ref for SubscriptionEventType in geofencing](https://github.com/camaraproject/DeviceLocation/pull/149) + - Some other fixes and enhancements detected by linter (locally) + +- Give some time review, merge and create RC3 +- If nothing else is detected, then create release-0.2.0 + +Discussed during meeting: +Action: Team has to review the PR. We have to work offline to release the API before the MWC. +Minor typo fixes (on subscription) +Feedback on Linting tool run + + +### Review other Issues and PRs + +#### Ongoing + +* [Add Test Definition for location Retrieval #119](https://github.com/camaraproject/DeviceLocation/pull/119/files) + - Link with Commonalities here: https://github.com/camaraproject/Commonalities/issues/94 + - Review PR status and new comments + - AP: Telefónica will provide a proposal updating a few aspects of Ludovic's proposal after checking with internal QA team. -> Still pending + +Discussed during meeting: +- José explained that first we need to provide variable(s) + - First then 'given' to prepare this/these variable(s) + - Then the result with the expected responses + - +Additionnal step oculd be used (ad hoc for specific operation) +- GSMA will test this files as an input for Conformance & using Postman. +- José will contribut to commonalities for guidelines for Test Definition + - Ludovic agreed on José proposal and will adapt the Device location retrieval file once José made his proposal. + + +* [Geofencing - Adding a value in Termination Reason value enum](https://github.com/camaraproject/DeviceLocation/issues/141) + - Positive feedback + - How to proceed? Create PR and share with Commonalities or the open issue in Commonalities? + +Discussed during meeting: +- Ludovic will create an Issue in Commonalities. + + +* [Geofencing API - Add Subscription type 'area-left-or-entered' to subscribe to both event in one time](https://github.com/camaraproject/DeviceLocation/issues/138) + - No new comments + - Discuss next steps in meeting + +Discussed during meeting: +- we went through the proposal on the issue as 4 options are described +- We keep it open for discussion +- Alignement with device status was discussed. + + +* [Define guidelines for geofencing implementation](https://github.com/camaraproject/DeviceLocation/issues/133) + - No new comments. + - Discuss next steps in meeting + + Discussed during meeting: + - no progress - need team review + +* [Geofencing API - Adding capability to manage max number of notification](https://github.com/camaraproject/DeviceLocation/issues/111) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/90) + - New [PR](https://github.com/camaraproject/Commonalities/pull/131) + - Review status + +Discussed during meeting: +- in final step in commonalities - soon to be applied + +* [Implement use of linting rule set for Device Location API](https://github.com/camaraproject/DeviceLocation/issues/125) + - Tested locally before creating RC3 + - Review status in Commonalities + +Discussed during meeting: +- Rafal provided a briefting of the situation + - Still in discussion in commonalities + - Question to TSC if each projet has to be independant for applying the lintening. + - else José will apply the CI in our project + +* [Geofencing API - Defining a standard behavior for first event](https://github.com/camaraproject/DeviceLocation/issues/124) + - Moved to Commonalities [Issue 140](https://github.com/camaraproject/Commonalities/issues/140) + - No comments + +Discussed during meeting: +- No comments + +* [Geofencing API - Add "format: uri" to notificationUrl](https://github.com/camaraproject/DeviceLocation/issues/118) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/93) + - Recent comment to reactivate the discussion + +Discussed during meeting: +- Team has to provide comment +- Rafal mentionned another issue about duration + + +### Open discussions + +- No new comments since last meeting. + + +#### Administrative Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track + - New [document uploaded by TEF](https://github.com/camaraproject/DeviceLocation/files/12856149/AdminCode.Proposal.-.Draft_20230926.docx) with a proposal +* [action] Review this document. + - Not progress but during last call we agreed that this feature is not top priority right now but will be discussed next year. + - Probably to keep it close with the (future) work for User Device count + - We can probably add our Area schemas in Commonalities + +This item should be reopen after MWC. + +#### Behaviour when requesting too high precision + +* [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85) + - As requested by Joachim, issue will remain open until TEF uploads the document with more detail or the information is added to an API_documentation file to keep in the repo for future references. + +## AOB + +- Discuss if we keep next call for February 27th, 2024, as it is the MWC week. + - We keep it + +
diff --git a/original/DeviceLocation/documentation/MeetingMinutes/MoM-2024-02-27.md b/original/DeviceLocation/documentation/MeetingMinutes/MoM-2024-02-27.md new file mode 100644 index 0000000000000000000000000000000000000000..b7ac4b0fcafa25c20c90c34452c5c071a948174e --- /dev/null +++ b/original/DeviceLocation/documentation/MeetingMinutes/MoM-2024-02-27.md @@ -0,0 +1,115 @@ +# CAMARA DeviceLocation meeting - 2024-02-27 + +*February 27th, 2024* + +## Attendees + +* José Luis Urien (Telefonica) +* Akos Hunyadi (DT) +* Cetin Alpaycetin (Vodafone) +* Rafal Artych (DT) +* Javier Caaro Calabor (Telefonica) +* Foo Ming Hu (Singtel) + +Device Location minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + +### Release 0.2.0 + + +- No new comments or bugs reported for [RC3](https://github.com/camaraproject/DeviceLocation/issues/155) + +- Discuss release approval + - **Agreed to release 0.2.0** + - AP @Jose: Create PR and make adjustments in Github. Remove RCs from Changelog if possible. + +### Review other Issues and PRs + +No new comments or progress on the ongoing issues and PRs + +#### Ongoing + +* [Add Test Definition for location Retrieval #119](https://github.com/camaraproject/DeviceLocation/pull/119/files) + - Link with Commonalities here: https://github.com/camaraproject/Commonalities/issues/94 + - Review PR status and new comments + - AP: Telefónica will provide a proposal updating a few aspects of Ludovic's proposal after checking with internal QA team. + - Update by Jose, but still pending + + +* [Geofencing - Adding a value in Termination Reason value enum](https://github.com/camaraproject/DeviceLocation/issues/141) + + AP from previous meeting: + - Ludovic will create an Issue in Commonalities. -> Pending, double check with Ludovic + - Related issues in [DeviceStatus](https://github.com/camaraproject/DeviceStatus/issues/117) and QoD + + +* [Geofencing API - Add Subscription type 'area-left-or-entered' to subscribe to both event in one time](https://github.com/camaraproject/DeviceLocation/issues/138) + + Discussed during previous meeting: + - Alignement with device status was discussed. + + - No specific issue created so far in Commonalities, but mentioned in [issue](https://github.com/camaraproject/Commonalities/issues/140) about CloudEvents Subscription format. + - This is not an urgent issue as functionality can be covered with current events, so we may wait until discussions in Commonalities advance. + + +* [Define guidelines for geofencing implementation](https://github.com/camaraproject/DeviceLocation/issues/133) + - No new comments. + - Connected with [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85). A document with implementation guideline should cover this also. + + +* [Geofencing API - Adding capability to manage max number of notification](https://github.com/camaraproject/DeviceLocation/issues/111) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/90) + - New [PR](https://github.com/camaraproject/Commonalities/pull/131) -> Still nor merged but seems to have all LGTM. AP: Double check with Ludovic + +* [Implement use of linting rule set for Device Location API](https://github.com/camaraproject/DeviceLocation/issues/125) + - Tested locally before creating RC3 + - Review status in [Commonalities](https://github.com/camaraproject/Commonalities/issues/142) + - AP @Rafal to propose a PR adding linting to our subproject CI + +* [Geofencing API - Defining a standard behavior for first event](https://github.com/camaraproject/DeviceLocation/issues/124) + - Moved to Commonalities [Issue 140](https://github.com/camaraproject/Commonalities/issues/140) + - No comments in the issue in the last 2 weeks + - Discussed during the meeting if we should wait for Commonalities for a common format, or add parameters in our current model nad adapt later to approved guidelines. + - As we are starting cycle for a new release, we can wait for the moment. Eventually, if we are about to release something new and commonalities are not agreed, we can tale the lead. + +* [Geofencing API - Add "format: uri" to notificationUrl](https://github.com/camaraproject/DeviceLocation/issues/118) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/93) + - No comments in the last 2 weeks + - Wait for outcome + +### Open discussions + +- No new comments since last meeting. + +#### Administrative Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track + - [Document uploaded by TEF](https://github.com/camaraproject/DeviceLocation/files/12856149/AdminCode.Proposal.-.Draft_20230926.docx) with a proposal. + + This item should be reopen after MWC. + + - We should discussed approach on this for next release. Should we incorporate this to current operations, should we split this functionality to new endpoints or even separate APIs? + +#### Behaviour when requesting too high precision + +* [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85) + - As requested by Joachim, issue will remain open until TEF uploads the document with more detail or the information is added to an API_documentation file to keep in the repo for future references. + +## AOB + + - Joachim asked for plans or roadmap for R1.0 + - Jose commented that there is still no roadmap or time frame agreed for v1.0, but release plan for R1.0 should be agreed at CAMARA project level. + - At WG level we may discuss the content for next release, being 0.x or 1.x. So far we only have the requirement for Administrative Codes, but others may come from GSMA product track + +
+ +- Next call will be on **March 12th, 2024** + +
+ diff --git a/original/DeviceLocation/documentation/MeetingMinutes/MoM-2024-03-12.md b/original/DeviceLocation/documentation/MeetingMinutes/MoM-2024-03-12.md new file mode 100644 index 0000000000000000000000000000000000000000..fa1f2cc7f7238f685751fa0ca42bb98969ccee56 --- /dev/null +++ b/original/DeviceLocation/documentation/MeetingMinutes/MoM-2024-03-12.md @@ -0,0 +1,138 @@ +# CAMARA DeviceLocation meeting - 2024-03-12 + +*March 12th, 2024* + +## Attendees + +* José Luis Urien (Telefonica) +* Joachim Dahlgren (Ericsson) +* Cetin Alpaycetin (Vodafone) +* Akos Hunyadi (DT) +* Javier Carro Calabor (Telefonica) +* Katrina Griese (Vodafone) +* Ludovic Robert (Orange) +* Alexander Boraczynski (Vodafone) +* Fernando Prado Cabrillo (Telefonica) +* Rafal Artych (DT) +* Surajj Jaggernath (Vodacom) +* Toyeeb Rehman (GSMA) + +Device Location minutes: [https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceLocation/tree/main/documentation/MeetingMinutes) + + +> [!IMPORTANT] +> [Release 0.2.0](https://github.com/camaraproject/DeviceLocation/releases/tag/v0.2.0) official!! +> +> New merges to be consolidated towards next -wip versions + + +## Agenda + +* Open issues and PRs +* Any other business + +## Open issues and PRs + +### New + +#### Corrections + +* [[location-verification] Precise the description when matchRate needs to be set for PARTIAL-results](https://github.com/camaraproject/DeviceLocation/issues/158) + - Fixed in [PR 159](https://github.com/camaraproject/DeviceLocation/pull/159) + - Merged during the meeting. + +* [Add x-correlator as specified in the guideline](https://github.com/camaraproject/DeviceLocation/issues/160) + - PR to be created + - [Action] Ludovic will do + +* [subscriptionExpireTime is declared as "required" in the subscription-ends - note, but is optional currently](https://github.com/camaraproject/DeviceLocation/issues/161) +* Fixed along with old issue [Geofencing API - Adding capability to manage max number of notification](https://github.com/camaraproject/DeviceLocation/issues/111) + - Fixed in [PR 163](https://github.com/camaraproject/DeviceLocation/pull/163) + - Merged during the meeting + +* [[Geofencing]: Invalid area example for POST /subscriptions](https://github.com/camaraproject/DeviceLocation/issues/164) + - Fixed in [PR 165](https://github.com/camaraproject/DeviceLocation/pull/165) + -Merged during the meeting + +* [Remove API from info.title](https://github.com/camaraproject/DeviceLocation/issues/169) + - Remove API from the title + - [Action] José will create the PR + - Could be part of the linter rule but not yet + - action to standardize the info object + +#### Documentation + +* [Should 501 NOT_IMPLEMENTED be returned for unimplemented DeviceLocation APIs?](https://github.com/camaraproject/DeviceLocation/issues/168) + - Question related to the conformance + - Team agreed with José & Cetin comments + - Toyeeb aggreed + - Issue closed + + +#### Ongoing + +* [Implement use of linting rule set for Device Location API](https://github.com/camaraproject/DeviceLocation/issues/125) + - New PRs: [Introducing corrections for yamllint](https://github.com/camaraproject/DeviceLocation/pull/166) and [Adding configuration for Github Actions with linting ruleset](https://github.com/camaraproject/DeviceLocation/pull/167) + - PR#166 Rafal will regenerate the linter & once done the PR will be merge + - PR#167: to be merged after #166 + - Can be done offline + +* [Add Test Definition for location Retrieval #119](https://github.com/camaraproject/DeviceLocation/pull/119/files) + - New issue in Commonalities to discuss [Enhancement of the Testing Guidelines](https://github.com/camaraproject/Commonalities/issues/158) by TEF + - [Action] José propose to make an example to illustrate his proposal + - [Action] Toyeeb to check with GSMA conformance + +* [Geofencing - Adding a value in Termination Reason value enum](https://github.com/camaraproject/DeviceLocation/issues/141) + - Ludovic will create an Issue in Commonalities. -> Pending, double check with Ludovic + - [Action] Yes Ludovic will create the PR in Commponalities + - Related issues in [DeviceStatus](https://github.com/camaraproject/DeviceStatus/issues/117) and QoD + +* [Geofencing API - Add Subscription type 'area-left-or-entered' to subscribe to both event in one time](https://github.com/camaraproject/DeviceLocation/issues/138) + - New issue in Commonalities [Subscription-Issue2: Allow event consumers to subscribe to more than one event types with a single subscription](https://github.com/camaraproject/Commonalities/issues/154) + - Waiting for Commonalities outcomes + +* [Geofencing API - Defining a standard behavior for first event](https://github.com/camaraproject/DeviceLocation/issues/124) + - Moved to Commonalities [Issue 140](https://github.com/camaraproject/Commonalities/issues/140) + - No comments in the issue in the last 2 weeks + - Waiting for Commonalities outcomes + +* [Define guidelines for geofencing implementation](https://github.com/camaraproject/DeviceLocation/issues/133) + - No new comments. + - [Action] We need more comments from the team + - Connected with [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85). A document with implementation guideline should cover this also. + +* [Geofencing API - Add "format: uri" to notificationUrl](https://github.com/camaraproject/DeviceLocation/issues/118) + - Moved to [commonalities](https://github.com/camaraproject/Commonalities/issues/93) + - No comments in the last 2 weeks + - Wait for outcome + +### Long term discussions + +#### Administrative Code Area + +* New [Issue #83](https://github.com/camaraproject/DeviceLocation/issues/83), with formal requirements from GSMA Product track + - [Document uploaded by TEF](https://github.com/camaraproject/DeviceLocation/files/12856149/AdminCode.Proposal.-.Draft_20230926.docx) with a proposal. + + This item should be reopen after MWC. + + - We should discussed approach on this for next release. Should we incorporate this to current operations, should we split this functionality to new endpoints or even separate APIs? + - Need to be discussed + - Ludovic preference is for a separate API as for example in France this is not a request. + - For Javier this is not a top priority for Telefonica as of now. + - More generally probably we need to have feedback loop with GSMA team about API work (and review the priority as focus could change) + - Perhaps a point to be share in TSC. + +#### Behaviour when requesting too high precision + +* [Issue #85](https://github.com/camaraproject/DeviceLocation/issues/85) + - As requested by Joachim, issue will remain open until TEF uploads the document with more detail or the information is added to an API_documentation file to keep in the repo for future references. + - Joachim: Should be also aligned/synchronysed with Geofencing + +## AOB + +
+ +- Next call will be on **March 26th, 2024** +- Easter week, but we keep the meeting + +
diff --git a/original/DeviceLocation/documentation/SupportingDocuments/README.MD b/original/DeviceLocation/documentation/SupportingDocuments/README.MD
new file mode 100644
index 0000000000000000000000000000000000000000..f71c2a667b84b38512f5893a2240aef980329112
--- /dev/null
+++ b/original/DeviceLocation/documentation/SupportingDocuments/README.MD
@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.
diff --git a/original/DeviceMediaStreamingRate/README.md b/original/DeviceMediaStreamingRate/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..5b0d5d79348db258cbd4d11a4b1d354d3c8c28ec
--- /dev/null
+++ b/original/DeviceMediaStreamingRate/README.md
@@ -0,0 +1,41 @@
+
+
+
public | stable
public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
+| 1 | API definition | M | M | M | M | Y | [device-reachability-status.yaml](/code/API_definitions/device-reachability-status.yaml) |
+| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3) |
+| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3) |
+| 4 | API versioning convention applied | M | M | M | M | Y | |
+| 5 | API documentation | M | M | M | M | Y | inline in YAML |
+| 6 | User stories | O | O | O | M | Y | [device-reachability-status-User-Story.md](/documentation/API_documentation/device-reachability-status-User-Story.md) |
+| 7 | Basic API test cases & documentation | O | M | M | M | Y | [device-reachability-status.feature](/code/Test_definitions/device-reachability-status.feature) |
+| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [device-reachability-status.feature](/code/Test_definitions/device-reachability-status.feature) |
+| 9 | Test result statement | O | O | O | M | Y | See [here](https://github.com/camaraproject/DeviceReachabilityStatus/issues/44) |
+| 10 | API release numbering convention applied | M | M | M | M | Y | |
+| 11 | Change log updated | M | M | M | M | Y | [CHANGELOG.md](/CHANGELOG.md) |
+| 12 | Previous public release was certified | O | O | O | M | Y | See (1) |
+| 13 | API description (for marketing) | O | O | M | M | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/x/2wHWB) |
+
+(1) GSMA certified implementations of previous version by multiple operators (source: https://open-gateway.gsma.com/map as of 2025-03-11)
+
+Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.
+
+The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine).
diff --git a/original/DeviceReachabilityStatus/documentation/API_documentation/device-reachability-status-User-Story.md b/original/DeviceReachabilityStatus/documentation/API_documentation/device-reachability-status-User-Story.md
new file mode 100644
index 0000000000000000000000000000000000000000..6ad4c751c761baa12d65002a7aaf25c7decfe015
--- /dev/null
+++ b/original/DeviceReachabilityStatus/documentation/API_documentation/device-reachability-status-User-Story.md
@@ -0,0 +1,20 @@
+# Device Reachability Status User Story
+
+| Item | Description | Support Qualifier |
+|---------------------------|-------------|-------------------|
+| Summary | As an enterprise application developer, I want to query the reachability status of a user's device, so that I can determine whether the device is reachable via SMS, data (mobile internet), or both, enabling better communication or service management decisions based on real-time device availability. | M |
+| Roles, Actor(s) and scope | **Roles:** Customer:Developer
**Actors:** Application service providers (ASP), hyperscalers, application developers.
**Scope:** Order To Activate (OTA) - Get connectivity status of a device | M |
+| NF Requirements | - | O |
+| Pre-conditions | - The customer:developer has been successfully onboarded to the API platform of the service provider
- The customer application has requested and received an access token with the required scope for the API | M |
+| Begins when | The customer application server makes a POST request to retrieve the reachability status of a user's device | M |
+| Ends when | The service provider returns the reachability status of the device with a timestamp when the status information was updated. In case of the device is reachable, additionally, the type of the connectivity (data, sms or both) is returned as well. | |
+| Post-conditions | - | M |
+| Exceptions | Several exceptions might occur during the API operations:
- Unauthorized: Invalid credentials (e.g., expired access token).
- Incorrect input data (e.g., malformed phone number).
- Not found: The phone number is not associated with a CSP customer account | M |
+
+# Linking a user story to API design
+
+Once we have the user story, the next step is to clarify the **data journey** in the context of the target and source systems we are integrating:
+- Think about triggers for workflows: how and when does data need to be moved between the application and the service?
+- Think about dependencies of data objects: does the data in underlying objects need to be regularly kept in sync with another system?
+- Think about any parameters the user might need to configure or change. This is particularly important when building self-serve integrations for non-technical end users.
+- Think about privacy by design: does any data represent sensitive information, and how can this be safely shared/stored according to regulation (e.g., anonymisation, tokenisation, zero-trust principles)
diff --git a/original/DeviceReachabilityStatus/documentation/API_documentation/device-reachability-status-subscriptions-API-Readiness-Checklist.md b/original/DeviceReachabilityStatus/documentation/API_documentation/device-reachability-status-subscriptions-API-Readiness-Checklist.md
new file mode 100644
index 0000000000000000000000000000000000000000..74618a18cca106c1542cae2ff84457c8df521733
--- /dev/null
+++ b/original/DeviceReachabilityStatus/documentation/API_documentation/device-reachability-status-subscriptions-API-Readiness-Checklist.md
@@ -0,0 +1,23 @@
+# API Readiness Checklist
+
+Checklist for device-reachability-status-subscriptions 0.8.0 in r1.2
+
+| Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
+| 1 | API definition | M | M | M | M | Y | [device-reachability-status-subscriptions.yaml](/code/API_definitions/device-reachability-status-subscriptions.yaml) |
+| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3) |
+| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3) |
+| 4 | API versioning convention applied | M | M | M | M | Y | |
+| 5 | API documentation | M | M | M | M | Y | inline in YAML |
+| 6 | User stories | O | O | O | M | N | |
+| 7 | Basic API test cases & documentation | O | M | M | M | Y | [device-reachability-status-subscriptions.feature](/code/Test_definitions/device-reachability-status-subscriptions.feature) |
+| 8 | Enhanced API test cases & documentation | O | O | O | M | N | |
+| 9 | Test result statement | O | O | O | M | N | |
+| 10 | API release numbering convention applied | M | M | M | M | Y | |
+| 11 | Change log updated | M | M | M | M | Y | [CHANGELOG.md](/CHANGELOG.md) |
+| 12 | Previous public release was certified | O | O | O | M | N | |
+| 13 | API description (for marketing) | O | O | M | M | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/x/JAFmBQ) |
+
+Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.
+
+The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine).
diff --git a/original/DeviceReachabilityStatus/documentation/SupportingDocuments/README.MD b/original/DeviceReachabilityStatus/documentation/SupportingDocuments/README.MD
new file mode 100644
index 0000000000000000000000000000000000000000..f71c2a667b84b38512f5893a2240aef980329112
--- /dev/null
+++ b/original/DeviceReachabilityStatus/documentation/SupportingDocuments/README.MD
@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.
diff --git a/original/DeviceRoamingStatus/README.md b/original/DeviceRoamingStatus/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..8610b55f9112ee6d8d63035a73151098df3e5863
--- /dev/null
+++ b/original/DeviceRoamingStatus/README.md
@@ -0,0 +1,61 @@
+
+
public | stable
public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
+| 1 | API definition | M | M | M | M | Y | [device-roaming-status.yaml](/code/API_definitions/device-roaming-status.yaml) |
+| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3) |
+| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3) |
+| 4 | API versioning convention applied | M | M | M | M | Y | |
+| 5 | API documentation | M | M | M | M | Y | inline in YAML |
+| 6 | User stories | O | O | O | M | Y | [device-roaming-status-User-Story.md](/documentation/API_documentation/device-roaming-status-User-Story.md) |
+| 7 | Basic API test cases & documentation | O | M | M | M | Y | [device-roaming-status.feature](/code/Test_definitions/device-roaming-status.feature) |
+| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [device-roaming-status.feature](/code/Test_definitions/device-roaming-status.feature) |
+| 9 | Test result statement | O | O | O | M | Y | See [here](https://github.com/camaraproject/DeviceRoamingStatus/issues/46) |
+| 10 | API release numbering convention applied | M | M | M | M | Y | |
+| 11 | Change log updated | M | M | M | M | Y | [CHANGELOG.md](/CHANGELOG.md) |
+| 12 | Previous public release was certified | O | O | O | M | Y | See (1) |
+| 13 | API description (for marketing) | O | O | M | M | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/x/vYBmBQ) |
+
+(1) GSMA certified implementations of previous version by multiple operators (source: https://open-gateway.gsma.com/map as of 2025-03-11)
+
+Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.
+
+The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine).
diff --git a/original/DeviceRoamingStatus/documentation/API_documentation/device-roaming-status-User-Story.md b/original/DeviceRoamingStatus/documentation/API_documentation/device-roaming-status-User-Story.md
new file mode 100644
index 0000000000000000000000000000000000000000..605559aad78f50e8c137d358cc325cc070fe8070
--- /dev/null
+++ b/original/DeviceRoamingStatus/documentation/API_documentation/device-roaming-status-User-Story.md
@@ -0,0 +1,21 @@
+# Device Roaming Status User Story
+
+| Item | Description | Support Qualifier |
+|---------------------------|-------------|-------------------|
+| Summary | As an enterprise application developer, I want to query the roaming status of a user's device, so that I can determine whether a device is in a foreign network and in which country it is located. This API can be used to identify fraud, ensure regulatory compliance, or enforce territorial restrictions on video and audio content. | M |
+| Roles, Actor(s) and scope | **Roles:** Customer:Developer
**Actors:** Application service providers (ASP), hyperscalers, application developers.
**Scope:** Order To Activate (OTA) - Get roaming status of a device | M |
+| NF Requirements | - | O |
+| Pre-conditions | - The customer:developer has been successfully onboarded to the API platform of the service provider
- The customer application has requested and received an access token with the required scope for the API | M |
+| Begins when | The customer application server makes a POST request to retrieve the roaming status of a user's device | M |
+| Ends when | The service provider returns the roaming status of the device with a timestamp when the status information was updated. In case of a roaming situation also the roaming country name and code shall be returned. | |
+| Post-conditions | - | M |
+| Exceptions | Several exceptions might occur during the API operations:
- Unauthorized: Invalid credentials (e.g., expired access token).
- Incorrect input data (e.g., malformed phone number).
- Not found: The phone number is not associated with a CSP customer account | M |
+
+# Linking a user story to API design
+
+Once we have the user story, the next step is to clarify the **data journey** in the context of the target and source systems we are integrating:
+- Think about triggers for workflows: how and when does data need to be moved between the application and the service?
+- Think about dependencies of data objects: does the data in underlying objects need to be regularly kept in sync with another system?
+- Think about any parameters the user might need to configure or change. This is particularly important when building self-serve integrations for non-technical end users.
+- Think about privacy by design: does any data represent sensitive information, and how can this be safely shared/stored according to regulation (e.g., anonymisation, tokenisation, zero-trust principles)
+
diff --git a/original/DeviceRoamingStatus/documentation/API_documentation/device-roaming-status-subscriptions-API-Readiness-Checklist.md b/original/DeviceRoamingStatus/documentation/API_documentation/device-roaming-status-subscriptions-API-Readiness-Checklist.md
new file mode 100644
index 0000000000000000000000000000000000000000..f873e015c7d56f2ac8841d19ff46c8203aa032bc
--- /dev/null
+++ b/original/DeviceRoamingStatus/documentation/API_documentation/device-roaming-status-subscriptions-API-Readiness-Checklist.md
@@ -0,0 +1,23 @@
+# API Readiness Checklist
+
+Checklist for device-roaming-status-subscriptions 0.8.0 in r1.2
+
+| Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
+| 1 | API definition | M | M | M | M | Y | [device-roaming-status-subscriptions.yaml](/code/API_definitions/device-roaming-status-subscriptions.yaml) |
+| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3) |
+| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3) |
+| 4 | API versioning convention applied | M | M | M | M | Y | |
+| 5 | API documentation | M | M | M | M | Y | inline in YAML |
+| 6 | User stories | O | O | O | M | N | |
+| 7 | Basic API test cases & documentation | O | M | M | M | Y | [device-roaming-status-subscriptions.feature](/code/Test_definitions/device-roaming-status-subscriptions.feature) |
+| 8 | Enhanced API test cases & documentation | O | O | O | M | N | |
+| 9 | Test result statement | O | O | O | M | N | |
+| 10 | API release numbering convention applied | M | M | M | M | Y | |
+| 11 | Change log updated | M | M | M | M | Y | [CHANGELOG.md](/CHANGELOG.md) |
+| 12 | Previous public release was certified | O | O | O | M | N | |
+| 13 | API description (for marketing) | O | O | M | M | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/x/D4FlBQ) |
+
+Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.
+
+The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine).
diff --git a/original/DeviceRoamingStatus/documentation/SupportingDocuments/README.MD b/original/DeviceRoamingStatus/documentation/SupportingDocuments/README.MD
new file mode 100644
index 0000000000000000000000000000000000000000..f71c2a667b84b38512f5893a2240aef980329112
--- /dev/null
+++ b/original/DeviceRoamingStatus/documentation/SupportingDocuments/README.MD
@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.
diff --git a/original/DeviceStatus/README.md b/original/DeviceStatus/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..d917934091f384b6d285bdb9ae5d84ea3a26ae9c
--- /dev/null
+++ b/original/DeviceStatus/README.md
@@ -0,0 +1,82 @@
+
+
public | stable
public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
+| 1 | API definition | M | M | M | M | Y | [/code/API_definitions/connected-network-type.yaml](/code/API_definitions/connected-network-type.yaml) |
+| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r2.3](https://github.com/camaraproject/Commonalities/releases/tag/r2.3) |
+| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r2.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r2.3) |
+| 4 | API versioning convention applied | M | M | M | M | Y | |
+| 5 | API documentation | M | M | M | M | Y | inline in YAML |
+| 6 | User stories | O | O | O | M | N | |
+| 7 | Basic API test cases & documentation | O | M | M | M | Y | [/code/Test_definitions/connected-network-type.feature](/code/Test_definitions/connected-network-type.feature) |
+| 8 | Enhanced API test cases & documentation | O | O | O | M | N | |
+| 9 | Test result statement | O | O | O | M | N | |
+| 10 | API release numbering convention applied | M | M | M | M | Y | |
+| 11 | Change log updated | M | M | M | M | Y | [/CHANGELOG.md](/CHANGELOG.md) |
+| 12 | Previous public release was certified | O | O | O | M | N | |
+
+Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.
+
+The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine).
diff --git a/original/DeviceStatus/documentation/API_documentation/connected-network-type-subscriptions-API-Readiness-Checklist.md b/original/DeviceStatus/documentation/API_documentation/connected-network-type-subscriptions-API-Readiness-Checklist.md
new file mode 100644
index 0000000000000000000000000000000000000000..3b9f14cf5c91f6fe6d184a7d8da7a758bf45c61c
--- /dev/null
+++ b/original/DeviceStatus/documentation/API_documentation/connected-network-type-subscriptions-API-Readiness-Checklist.md
@@ -0,0 +1,22 @@
+# API Readiness Checklist
+
+Checklist for connected-network-type-subscriptions 0.1.0 in r2.2.
+
+| Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
+| 1 | API definition | M | M | M | M | Y | [/code/API_definitions/connected-network-type-subscriptions.yaml](/code/API_definitions/connected-network-type-subscriptions.yaml) |
+| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r2.3](https://github.com/camaraproject/Commonalities/releases/tag/r2.3) |
+| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r2.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r2.3) |
+| 4 | API versioning convention applied | M | M | M | M | Y | |
+| 5 | API documentation | M | M | M | M | Y | inline in YAML |
+| 6 | User stories | O | O | O | M | N | |
+| 7 | Basic API test cases & documentation | O | M | M | M | Y | [/code/Test_definitions/connected-network-type-subscriptions.feature](/code/Test_definitions/connected-network-type-subscriptions.feature) |
+| 8 | Enhanced API test cases & documentation | O | O | O | M | N | |
+| 9 | Test result statement | O | O | O | M | N | |
+| 10 | API release numbering convention applied | M | M | M | M | Y | |
+| 11 | Change log updated | M | M | M | M | Y | [/CHANGELOG.md](/CHANGELOG.md) |
+| 12 | Previous public release was certified | O | O | O | M | N | |
+
+Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.
+
+The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine).
diff --git a/original/DeviceStatus/documentation/API_documentation/device-reachability-status-API-Readiness-Checklist.md b/original/DeviceStatus/documentation/API_documentation/device-reachability-status-API-Readiness-Checklist.md
new file mode 100644
index 0000000000000000000000000000000000000000..9b88b214147b5cfaa5b37cc544d93c77b7d148e3
--- /dev/null
+++ b/original/DeviceStatus/documentation/API_documentation/device-reachability-status-API-Readiness-Checklist.md
@@ -0,0 +1,24 @@
+# API Readiness Checklist
+
+Checklist for device-reachability-status 1.0.0 in r2.2.
+
+| Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
+| 1 | API definition | M | M | M | M | Y | [/code/API_definitions/device-reachability-status.yaml](/code/API_definitions/device-reachability-status.yaml) |
+| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r2.3](https://github.com/camaraproject/Commonalities/releases/tag/r2.3) |
+| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r2.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r2.3) |
+| 4 | API versioning convention applied | M | M | M | M | Y | |
+| 5 | API documentation | M | M | M | M | Y | inline in YAML |
+| 6 | User stories | O | O | O | M | Y | [/documentation/API_documentation/device-reachability-status-User-Story.md](/documentation/API_documentation/device-reachability-status-User-Story.md) |
+| 7 | Basic API test cases & documentation | O | M | M | M | Y | [/code/Test_definitions/device-reachability-status.feature](/code/Test_definitions/device-reachability-status.feature) |
+| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [/code/Test_definitions/device-reachability-status.feature](/code/Test_definitions/device-reachability-status.feature) |
+| 9 | Test result statement | O | O | O | M | Y | [see issue #258](https://github.com/camaraproject/DeviceStatus/issues/258) |
+| 10 | API release numbering convention applied | M | M | M | M | Y | |
+| 11 | Change log updated | M | M | M | M | Y | [/CHANGELOG.md](/CHANGELOG.md) |
+| 12 | Previous public release was certified | O | O | O | M | Y | see (1) |
+
+(1) GSMA certified implementations of previous version by multiple operators (source: https://open-gateway.gsma.com/map as of 2025-03-11)
+
+Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.
+
+The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine).
diff --git a/original/DeviceStatus/documentation/API_documentation/device-reachability-status-User-Story.md b/original/DeviceStatus/documentation/API_documentation/device-reachability-status-User-Story.md
new file mode 100644
index 0000000000000000000000000000000000000000..6ad4c751c761baa12d65002a7aaf25c7decfe015
--- /dev/null
+++ b/original/DeviceStatus/documentation/API_documentation/device-reachability-status-User-Story.md
@@ -0,0 +1,20 @@
+# Device Reachability Status User Story
+
+| Item | Description | Support Qualifier |
+|---------------------------|-------------|-------------------|
+| Summary | As an enterprise application developer, I want to query the reachability status of a user's device, so that I can determine whether the device is reachable via SMS, data (mobile internet), or both, enabling better communication or service management decisions based on real-time device availability. | M |
+| Roles, Actor(s) and scope | **Roles:** Customer:Developer
**Actors:** Application service providers (ASP), hyperscalers, application developers.
**Scope:** Order To Activate (OTA) - Get connectivity status of a device | M |
+| NF Requirements | - | O |
+| Pre-conditions | - The customer:developer has been successfully onboarded to the API platform of the service provider
- The customer application has requested and received an access token with the required scope for the API | M |
+| Begins when | The customer application server makes a POST request to retrieve the reachability status of a user's device | M |
+| Ends when | The service provider returns the reachability status of the device with a timestamp when the status information was updated. In case of the device is reachable, additionally, the type of the connectivity (data, sms or both) is returned as well. | |
+| Post-conditions | - | M |
+| Exceptions | Several exceptions might occur during the API operations:
- Unauthorized: Invalid credentials (e.g., expired access token).
- Incorrect input data (e.g., malformed phone number).
- Not found: The phone number is not associated with a CSP customer account | M |
+
+# Linking a user story to API design
+
+Once we have the user story, the next step is to clarify the **data journey** in the context of the target and source systems we are integrating:
+- Think about triggers for workflows: how and when does data need to be moved between the application and the service?
+- Think about dependencies of data objects: does the data in underlying objects need to be regularly kept in sync with another system?
+- Think about any parameters the user might need to configure or change. This is particularly important when building self-serve integrations for non-technical end users.
+- Think about privacy by design: does any data represent sensitive information, and how can this be safely shared/stored according to regulation (e.g., anonymisation, tokenisation, zero-trust principles)
diff --git a/original/DeviceStatus/documentation/API_documentation/device-reachability-status-subscriptions-API-Readiness-Checklist.md b/original/DeviceStatus/documentation/API_documentation/device-reachability-status-subscriptions-API-Readiness-Checklist.md
new file mode 100644
index 0000000000000000000000000000000000000000..f250882838480180bc2110a5948b11fd12c0ebae
--- /dev/null
+++ b/original/DeviceStatus/documentation/API_documentation/device-reachability-status-subscriptions-API-Readiness-Checklist.md
@@ -0,0 +1,22 @@
+# API Readiness Checklist
+
+Checklist for device-reachability-status-subscriptions 0.7.0 in r2.2.
+
+| Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
+| 1 | API definition | M | M | M | M | Y | [/code/API_definitions/device-reachability-status-subscriptions.yaml](/code/API_definitions/device-reachability-status-subscriptions.yaml) |
+| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r2.3](https://github.com/camaraproject/Commonalities/releases/tag/r2.3) |
+| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r2.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r2.3) |
+| 4 | API versioning convention applied | M | M | M | M | Y | |
+| 5 | API documentation | M | M | M | M | Y | inline in YAML |
+| 6 | User stories | O | O | O | M | N | |
+| 7 | Basic API test cases & documentation | O | M | M | M | Y | [/code/Test_definitions/device-reachability-status-subscriptions.feature](/code/Test_definitions/device-reachability-status-subscriptions.feature) |
+| 8 | Enhanced API test cases & documentation | O | O | O | M | N | |
+| 9 | Test result statement | O | O | O | M | N | |
+| 10 | API release numbering convention applied | M | M | M | M | Y | |
+| 11 | Change log updated | M | M | M | M | Y | [/CHANGELOG.md](/CHANGELOG.md) |
+| 12 | Previous public release was certified | O | O | O | M | N | |
+
+Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.
+
+The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine).
diff --git a/original/DeviceStatus/documentation/API_documentation/device-roaming-status-API-Readiness-Checklist.md b/original/DeviceStatus/documentation/API_documentation/device-roaming-status-API-Readiness-Checklist.md
new file mode 100644
index 0000000000000000000000000000000000000000..e9d0cb68c7f74bfffa73750bbe4d0d373fb632fa
--- /dev/null
+++ b/original/DeviceStatus/documentation/API_documentation/device-roaming-status-API-Readiness-Checklist.md
@@ -0,0 +1,24 @@
+# API Readiness Checklist
+
+Checklist for device-roaming-status 1.0.0 in r2.2.
+
+| Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
+| 1 | API definition | M | M | M | M | Y | [/code/API_definitions/device-roaming-status.yaml](/code/API_definitions/device-roaming-status.yaml) |
+| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r2.3](https://github.com/camaraproject/Commonalities/releases/tag/r2.3) |
+| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r2.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r2.3) |
+| 4 | API versioning convention applied | M | M | M | M | Y | |
+| 5 | API documentation | M | M | M | M | Y | inline in YAML |
+| 6 | User stories | O | O | O | M | Y | [/documentation/API_documentation/device-roaming-status-User-Story.md](/documentation/API_documentation/device-roaming-status-User-Story.md) |
+| 7 | Basic API test cases & documentation | O | M | M | M | Y | [/code/Test_definitions/device-roaming-status.feature](/code/Test_definitions/device-roaming-status.feature) |
+| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [/code/Test_definitions/device-roaming-status.feature](/code/Test_definitions/device-roaming-status.feature) |
+| 9 | Test result statement | O | O | O | M | Y | [see issue #258](https://github.com/camaraproject/DeviceStatus/issues/258) |
+| 10 | API release numbering convention applied | M | M | M | M | Y | |
+| 11 | Change log updated | M | M | M | M | Y | [/CHANGELOG.md](/CHANGELOG.md) |
+| 12 | Previous public release was certified | O | O | O | M | Y | see (1) |
+
+(1) GSMA certified implementations of previous version by multiple operators (source: https://open-gateway.gsma.com/map as of 2025-03-11)
+
+Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.
+
+The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine).
diff --git a/original/DeviceStatus/documentation/API_documentation/device-roaming-status-User-Story.md b/original/DeviceStatus/documentation/API_documentation/device-roaming-status-User-Story.md
new file mode 100644
index 0000000000000000000000000000000000000000..605559aad78f50e8c137d358cc325cc070fe8070
--- /dev/null
+++ b/original/DeviceStatus/documentation/API_documentation/device-roaming-status-User-Story.md
@@ -0,0 +1,21 @@
+# Device Roaming Status User Story
+
+| Item | Description | Support Qualifier |
+|---------------------------|-------------|-------------------|
+| Summary | As an enterprise application developer, I want to query the roaming status of a user's device, so that I can determine whether a device is in a foreign network and in which country it is located. This API can be used to identify fraud, ensure regulatory compliance, or enforce territorial restrictions on video and audio content. | M |
+| Roles, Actor(s) and scope | **Roles:** Customer:Developer
**Actors:** Application service providers (ASP), hyperscalers, application developers.
**Scope:** Order To Activate (OTA) - Get roaming status of a device | M |
+| NF Requirements | - | O |
+| Pre-conditions | - The customer:developer has been successfully onboarded to the API platform of the service provider
- The customer application has requested and received an access token with the required scope for the API | M |
+| Begins when | The customer application server makes a POST request to retrieve the roaming status of a user's device | M |
+| Ends when | The service provider returns the roaming status of the device with a timestamp when the status information was updated. In case of a roaming situation also the roaming country name and code shall be returned. | |
+| Post-conditions | - | M |
+| Exceptions | Several exceptions might occur during the API operations:
- Unauthorized: Invalid credentials (e.g., expired access token).
- Incorrect input data (e.g., malformed phone number).
- Not found: The phone number is not associated with a CSP customer account | M |
+
+# Linking a user story to API design
+
+Once we have the user story, the next step is to clarify the **data journey** in the context of the target and source systems we are integrating:
+- Think about triggers for workflows: how and when does data need to be moved between the application and the service?
+- Think about dependencies of data objects: does the data in underlying objects need to be regularly kept in sync with another system?
+- Think about any parameters the user might need to configure or change. This is particularly important when building self-serve integrations for non-technical end users.
+- Think about privacy by design: does any data represent sensitive information, and how can this be safely shared/stored according to regulation (e.g., anonymisation, tokenisation, zero-trust principles)
+
diff --git a/original/DeviceStatus/documentation/API_documentation/device-roaming-status-subscriptions-API-Readiness-Checklist.md b/original/DeviceStatus/documentation/API_documentation/device-roaming-status-subscriptions-API-Readiness-Checklist.md
new file mode 100644
index 0000000000000000000000000000000000000000..8c7dc01307f776a5fa3ac17af90cef97e26fb4fd
--- /dev/null
+++ b/original/DeviceStatus/documentation/API_documentation/device-roaming-status-subscriptions-API-Readiness-Checklist.md
@@ -0,0 +1,22 @@
+# API Readiness Checklist
+
+Checklist for device-roaming-status-subscriptions 0.7.0 in r2.2.
+
+| Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
+| 1 | API definition | M | M | M | M | Y | [/code/API_definitions/device-roaming-status-subscriptions.yaml](/code/API_definitions/device-roaming-status-subscriptions.yaml) |
+| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r2.3](https://github.com/camaraproject/Commonalities/releases/tag/r2.3) |
+| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r2.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r2.3) |
+| 4 | API versioning convention applied | M | M | M | M | Y | |
+| 5 | API documentation | M | M | M | M | Y | inline in YAML |
+| 6 | User stories | O | O | O | M | N | |
+| 7 | Basic API test cases & documentation | O | M | M | M | Y | [/code/Test_definitions/device-roaming-status-subscriptions.feature](/code/Test_definitions/device-roaming-status-subscriptions.feature) |
+| 8 | Enhanced API test cases & documentation | O | O | O | M | N | |
+| 9 | Test result statement | O | O | O | M | N | |
+| 10 | API release numbering convention applied | M | M | M | M | Y | |
+| 11 | Change log updated | M | M | M | M | Y | [/CHANGELOG.md](/CHANGELOG.md) |
+| 12 | Previous public release was certified | O | O | O | M | N | |
+
+Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.
+
+The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine).
diff --git a/original/DeviceStatus/documentation/API_documentation/resources/README.MD b/original/DeviceStatus/documentation/API_documentation/resources/README.MD
new file mode 100644
index 0000000000000000000000000000000000000000..f71c2a667b84b38512f5893a2240aef980329112
--- /dev/null
+++ b/original/DeviceStatus/documentation/API_documentation/resources/README.MD
@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.
diff --git a/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-03-29.md b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-03-29.md
new file mode 100644
index 0000000000000000000000000000000000000000..d9922c384eaf2a126f270b8c5063007354e19398
--- /dev/null
+++ b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-03-29.md
@@ -0,0 +1,48 @@
+# Camara DeviceStatus meeting - MOM-2023-03-29
+
+*March 29th, 2023*
+
+## Attendees
+
+* Akos Hunyadi (Deutsche Telekom)
+* Eric Murray (Vodafone)
+* Joachim Dahlgreen (Ericsson)
+* Mona Mokhber (Telefonica)
+* Rafal Artych (Deutsche Telekom)
+* Robert Ludivic (Orange)
+* Sachin Kumar (Vodafone)
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open issues
+* Open PRs
+* AOB
+
+
+### Open issues:
+
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34)
+ - rewrite the issue to one time request
+ - start discussion
+* [#24 Tag version 0.2.0](https://github.com/camaraproject/DeviceStatus/issues/24)
+ - 0.2.0 release branch is created but it should be protected => this issue can be closed
+* [#17 Subscription Mode with new Eventtypes](https://github.com/camaraproject/DeviceStatus/issues/17)
+ - related to the PR about subscriptions: https://github.com/camaraproject/WorkingGroups/pull/173 . This issue should be discussed or modified after its approval.
+* [#15 Update commonalities glossary with subproject relevant terms](https://github.com/camaraproject/DeviceStatus/issues/15)
+ - update with camelcase names (Rafal)
+* [#14 Align error message with structure defined in the guideline](https://github.com/camaraproject/DeviceStatus/issues/14)
+ - Mona creates the PR, target 0.5.0-wip
+
+### Open PRs
+* [#33 Update MAINTAINERS.MD](https://github.com/camaraproject/DeviceStatus/pull/33)
+ - needs owner review
+* [#31 Adding notification/subscription for Device Status](https://github.com/camaraproject/DeviceStatus/pull/31)
+ - on hold
+
+## AOB
+* Create 0.4.0 release branch (Akos)
+* Further releases should be developed as proposed in Commonalities, using -wip in the version name during development of the next release
+
+* Next call will be on 12.04.2023 11:00 CET
diff --git a/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-04-12.md b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-04-12.md
new file mode 100644
index 0000000000000000000000000000000000000000..3d29fb7ff736047f8b1d45ef2f772a44b2df74d3
--- /dev/null
+++ b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-04-12.md
@@ -0,0 +1,47 @@
+# Camara DeviceStatus meeting - MOM-2023-04-12
+
+*April 12th, 2023*
+
+## Attendees
+
+* Akos Hunyadi (Deutsche Telekom)
+* Eric Murray (Vodafone)
+* Gareth Williams (GSMA)
+* Joachim Dahlgreen (Ericsson)
+* Jorge Garcia Hospital (Telefonica)
+* Ludovic Robert (Orange)
+* Mona Mokhber (Telefonica)
+* Murat Karabulut (Deutsche Telekom)
+* Rafal Artych (Deutsche Telekom)
+* Sachin Kumar (Vodafone)
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open issues
+* Open PRs
+* AOB
+
+
+### Open issues:
+
+* [#37 Create release 0.4.0](https://github.com/camaraproject/DeviceStatus/issues/37)
+ - Eric will create the release
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34)
+ - start discussion
+* [#24 Tag version 0.2.0](https://github.com/camaraproject/DeviceStatus/issues/24)
+ - 0.2.0 release branch is created but it should be protected => this issue can be closed
+ - codeowners have no rights for branch protection (Akos will contact Herbert about it)
+* [#17 Subscription Mode with new Eventtypes](https://github.com/camaraproject/DeviceStatus/issues/17)
+ - related to the PR about subscriptions: https://github.com/camaraproject/WorkingGroups/pull/173 . This issue should be discussed or modified after its approval.
+* [#14 Align error message with structure defined in the guideline](https://github.com/camaraproject/DeviceStatus/issues/14)
+
+### Open PRs
+* [#35 Errors definition alignment with guidelines](https://github.com/camaraproject/DeviceStatus/pull/35)
+ - additional approvals required
+* [#31 Adding notification/subscription for Device Status](https://github.com/camaraproject/DeviceStatus/pull/31)
+ - on hold
+
+## AOB
+* Next call will be on 26.04.2023 11:00 CET
diff --git a/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-06-21.md b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-06-21.md
new file mode 100644
index 0000000000000000000000000000000000000000..39d0bd3cfd9d2546d5fe32ae8577d083141ef0c7
--- /dev/null
+++ b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-06-21.md
@@ -0,0 +1,44 @@
+# Camara DeviceStatus meeting - MOM-2023-06-21
+
+*June 21st, 2023*
+
+## Attendees
+
+* Akos Hunyadi (Deutsche Telekom)
+* Eric Murray (Vodafone)
+* Joachim Dahlgreen (Ericsson)
+* Jorge Garcia Hospital (Telefonica)
+* Ludovic Robert (Orange)
+* Rafal Artych (Deutsche Telekom)
+* Sachin Kumar (Vodafone)
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open issues
+* Open PRs
+* AOB
+
+
+### Open issues:
+
+* [#52 Harmonize device object with QoD API](https://github.com/camaraproject/DeviceStatus/issues/52)
+Will be fixed in [PR31](https://github.com/camaraproject/DeviceStatus/pull/31)
+
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34)
+Open issue: which type of connectivity is needed.
+Input from Jorge: GSMA is already working on the use cases, which possible should be considered in CAMARA also. Decision: we wait until next DeviceStatus call.
+
+* [#17 Subscription Mode with new Eventtypes](https://github.com/camaraproject/DeviceStatus/issues/17)
+[PR31](https://github.com/camaraproject/DeviceStatus/pull/31) is open
+
+### Open PRs
+* [#31 Adding notification/subscription for Device Status](https://github.com/camaraproject/DeviceStatus/pull/31)
+
+
+## AOB
+* Create API roadmap draft => Akos
+* Create Issue for documentation => Akos
+
+* Next call will be on 05.07.2023 11:00 CET
diff --git a/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-07-05.md b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-07-05.md
new file mode 100644
index 0000000000000000000000000000000000000000..8ed2cd4440dc0ccb40596df1f568fd593da88991
--- /dev/null
+++ b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-07-05.md
@@ -0,0 +1,56 @@
+# Camara DeviceStatus meeting - MOM-2023-07-05
+
+*July 5th, 2023*
+
+## Attendees
+
+* Akos Hunyadi (Deutsche Telekom)
+* Eric Murray (Vodafone)
+* Fernando Prado Cabrillo (Telefonica)
+* Joachim Dahlgreen (Ericsson)
+* Jorge Garcia Hospital (Telefonica)
+* Ludovic Robert (Orange)
+* Mona Mokhber (Telefonica)
+
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open issues
+* Open PRs
+* API Roadmap
+* AOB
+
+
+## Open issues:
+
+* [#57 Add documentation into API definition](https://github.com/camaraproject/DeviceStatus/issues/57)
+
+* [#52 Harmonize device object with QoD API](https://github.com/camaraproject/DeviceStatus/issues/52)
+Will be fixed in [PR31](https://github.com/camaraproject/DeviceStatus/pull/31)
+
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34)
+No input from GSMA available. The PR can be created, based on the discussions.
+
+* [#17 Subscription Mode with new Eventtypes](https://github.com/camaraproject/DeviceStatus/issues/17)
+[PR31](https://github.com/camaraproject/DeviceStatus/pull/31) is open
+
+## Open PRs
+* [#31 Adding notification/subscription for Device Status](https://github.com/camaraproject/DeviceStatus/pull/31)
+
+## API Roadmap
+### Release 0.5.0
+* July-August 2023
+* [#57 Add documentation into API definition](https://github.com/camaraproject/DeviceStatus/issues/57)
+* [#52 Harmonize device object with QoD API](https://github.com/camaraproject/DeviceStatus/issues/52)
+* [#17 Subscription Mode with new Eventtypes](https://github.com/camaraproject/DeviceStatus/issues/17) /
+[PR#31](https://github.com/camaraproject/DeviceStatus/pull/31)
+
+### Release 0.6.0
+* September-Oktober 2023
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34)
+
+## AOB
+
+* Next call will be on 19.07.2023 11:00 CET
diff --git a/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-07-19.md b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-07-19.md
new file mode 100644
index 0000000000000000000000000000000000000000..10d58dc44fe2d2fc8ea58a6349c0c6c3e4bab513
--- /dev/null
+++ b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-07-19.md
@@ -0,0 +1,64 @@
+# Camara DeviceStatus meeting - MOM-2023-07-19
+
+*July 19th, 2023*
+
+## Attendees
+
+* Akos Hunyadi (Deutsche Telekom)
+* Eric Murray (Vodafone)
+* Fernando Prado Cabrillo (Telefonica)
+* Joachim Dahlgreen (Ericsson)
+* Ludovic Robert (Orange)
+* Masaharu Hattori (KDDI)
+* Mona Mokhber (Telefonica)
+* Rafal Artych (Deutsche Telekom)
+
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open issues
+* Open PRs
+* API Roadmap
+* AOB
+
+
+## Open issues:
+
+* [#57 Add documentation into API definition](https://github.com/camaraproject/DeviceStatus/issues/57)
+ [PR65](https://github.com/camaraproject/DeviceStatus/pull/65) is open.
+
+* [#52 Harmonize device object with QoD API](https://github.com/camaraproject/DeviceStatus/issues/52)
+Has been fixed by [PR31](https://github.com/camaraproject/DeviceStatus/pull/31), the issue can be closed.
+
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34)
+No input from GSMA available. The PR can be created, based on the discussions.
+
+* [#17 Subscription Mode with new Eventtypes](https://github.com/camaraproject/DeviceStatus/issues/17)
+[PR31](https://github.com/camaraproject/DeviceStatus/pull/31) is closed, the issue can be closed too.
+
+## Open PRs
+* [#65 Add documentation](https://github.com/camaraproject/DeviceStatus/pull/65)
+ The goal is to merge the PR by the end of CW29.
+
+## API Roadmap
+### Release 0.5.0
+* July-August 2023
+* [#65 Add documentation](https://github.com/camaraproject/DeviceStatus/pull/65)
+* [~~#52 Harmonize device object with QoD API~~](https://github.com/camaraproject/DeviceStatus/issues/52)
+* [~~#31 Adding notification/subscription for Device Status~~](https://github.com/camaraproject/DeviceStatus/pull/31)
+* After [PR#65](https://github.com/camaraproject/DeviceStatus/pull/65) has been merged, the release can be created (Eric).
+
+### Release 0.6.0
+* September-Oktober 2023
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34)
+
+## AOB
+
+* New issue: How to handle mandatory and optional features of each API
+ * Definition of minimum implementation of a Camara API
+ * How can a provider inform the ASP/aggregator about not implemented features in advance of the API call?
+ * An issue in commonalities should be created
+* Next call will be on 02.08.2023 11:00 CET
+
diff --git a/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-09-13.md b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-09-13.md
new file mode 100644
index 0000000000000000000000000000000000000000..5c2b02f01596dc5d30bd9f7d4def1fab8176c72e
--- /dev/null
+++ b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-09-13.md
@@ -0,0 +1,72 @@
+ # Camara DeviceStatus meeting - MOM-2023-09-13
+
+*September 13th, 2023*
+
+## Attendees
+
+* Akos Hunyadi (Deutsche Telekom)
+* Eric Murray (Vodafone)
+* Fernando Prado Cabrillo (Telefonica)
+* Joachim Dahlgreen (Ericsson)
+* Ludovic Robert (Orange)
+* Prashant Sidana (E&)
+* Rafal Artych (Deutsche Telekom)
+* Sachin Kumar (Vodafone)
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open issues
+* Open PRs
+* API Roadmap
+* AOB
+
+
+## Open issues:
+
+* [#71 Release plan&content](https://github.com/camaraproject/DeviceStatus/issues/71)
+The upcoming releases were agreed as described below.
+
+* [#70 Info required : API understanding](https://github.com/camaraproject/DeviceStatus/issues/70)
+The issue can be closed.
+
+* [#57 Add documentation into API definition](https://github.com/camaraproject/DeviceStatus/issues/57)
+ [PR65](https://github.com/camaraproject/DeviceStatus/pull/65) is open.
+
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34)
+[PR69](https://github.com/camaraproject/DeviceStatus/pull/69) is open.
+
+* [#17 Subscription Mode with new Eventtypes](https://github.com/camaraproject/DeviceStatus/issues/17)
+[PR31](https://github.com/camaraproject/DeviceStatus/pull/31) introduced a generic subscription endpoint.
+Currently with the roaming status types, but it can be extended, when e.g. connectivity status info is added to the API.
+
+## Open PRs
+* [#69 add /connectivity - endpoint to check the network status of a device](https://github.com/camaraproject/DeviceStatus/pull/69)
+
+* [#65 Add documentation](https://github.com/camaraproject/DeviceStatus/pull/65)
+ The PR should be adapted when CloudEvents will be introduced => status delayed.
+
+## API Roadmap
+
+### Release 0.5.0
+* September-October 2023
+* The release is delayed because of the planned switch to CloudEvents.
+* [~~#52 Harmonize device object with QoD API~~](https://github.com/camaraproject/DeviceStatus/issues/52)
+* [~~#31 Adding notification/subscription for Device Status~~](https://github.com/camaraproject/DeviceStatus/pull/31)
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34)
+* [#65 Add documentation](https://github.com/camaraproject/DeviceStatus/pull/65)
+
+
+## AOB
+
+* New issue: How to handle mandatory and optional features of each API
+ * Definition of minimum implementation of a Camara API
+ * How can a provider inform the ASP/aggregator about not implemented features in advance of the API call?
+ * An issue in commonalities should be created (Prashant)
+* New issue: Change notifications to be based on CloudEvents
+ The issue is linked to the related issues/PRs in Commonalities (add links).
+ The issue should also add missing event types for connectivity status. (after [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34) has been merged.)
+
+* Next call will be on 27.09.2023 11:00 CET
+
diff --git a/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-09-27.md b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-09-27.md
new file mode 100644
index 0000000000000000000000000000000000000000..9caa6d0d345febfc0e7c28541b8197f96c35889f
--- /dev/null
+++ b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-09-27.md
@@ -0,0 +1,70 @@
+ # Camara DeviceStatus meeting - MOM-2023-09-27
+
+*September 27th, 2023*
+
+## Attendees
+
+* Akos Hunyadi (Deutsche Telekom)
+* Eric Murray (Vodafone)
+* Fernando Prado Cabrillo (Telefonica)
+* Jorge Garcia Hospital (Telefonica)
+* Joachim Dahlgreen (Ericsson)
+* Ludovic Robert (Orange)
+* Rafal Artych (Deutsche Telekom)
+* Sachin Kumar (Vodafone)
+
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open issues
+* Open PRs
+* API Roadmap
+* AOB
+
+
+## Open issues:
+* [#74 Align event-subscriptions with updated design guidelines based on CloudEvents](https://github.com/camaraproject/DeviceStatus/issues/74)
+ [PR75](https://github.com/camaraproject/DeviceStatus/pull/75) is open.
+
+* [#71 Release plan&content](https://github.com/camaraproject/DeviceStatus/issues/71)
+The upcoming releases were agreed as described below. This issue can be closed.
+
+* [#70 Info required : API understanding](https://github.com/camaraproject/DeviceStatus/issues/70)
+The issue can be closed.
+
+* [#57 Add documentation into API definition](https://github.com/camaraproject/DeviceStatus/issues/57)
+ [PR75](https://github.com/camaraproject/DeviceStatus/pull/75) is open.
+
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34)
+[PR69](https://github.com/camaraproject/DeviceStatus/pull/69) is open.
+
+* [#17 Subscription Mode with new Eventtypes](https://github.com/camaraproject/DeviceStatus/issues/17)
+[PR31](https://github.com/camaraproject/DeviceStatus/pull/31) introduced a generic subscription endpoint.
+Currently with the roaming status types, but it can be extended, when e.g. connectivity status info is added to the API.
+
+## Open PRs
+* [#69 add /connectivity - endpoint to check the network status of a device](https://github.com/camaraproject/DeviceStatus/pull/69)
+Update the PR with connectivity-events based on CloudEvents. Based on [PR75](https://github.com/camaraproject/DeviceStatus/pull/75).
+
+* [#75 Added Notification management aligned with CloudEvents format](https://github.com/camaraproject/DeviceStatus/pull/75)
+
+## API Roadmap
+
+### Release 0.5.0
+* September-October 2023
+* The release is delayed because of switching to CloudEvents.
+* [~~#52 Harmonize device object with QoD API~~](https://github.com/camaraproject/DeviceStatus/issues/52)
+* [~~#31 Adding notification/subscription for Device Status~~](https://github.com/camaraproject/DeviceStatus/pull/31)
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34) => [PR69](https://github.com/camaraproject/DeviceStatus/pull/69)
+* [#74 Align event-subscriptions with updated design guidelines based on CloudEvents](https://github.com/camaraproject/DeviceStatus/issues/74) => [PR75](https://github.com/camaraproject/DeviceStatus/pull/75)
+* [#57 Add documentation into API definition](https://github.com/camaraproject/DeviceStatus/issues/57) => [PR75](https://github.com/camaraproject/DeviceStatus/pull/75)
+### Release 0.6.0
+* November-December 2023
+* OIDC
+
+## AOB
+* New issue to align with DG about security => Replace Client Credentials with OIDC (based on commonalities [PR57](https://github.com/camaraproject/Commonalities/pull/57))
+* Next call will be on 11.10.2023 11:00 CET
+
diff --git a/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-10-11.md b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-10-11.md
new file mode 100644
index 0000000000000000000000000000000000000000..cc52e0c5cf05a3f623723a6575acb1edbc43fb8e
--- /dev/null
+++ b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-10-11.md
@@ -0,0 +1,71 @@
+# Camara DeviceStatus meeting - MOM-2023-10-11
+
+*October 11th, 2023*
+
+## Attendees
+
+* Akos Hunyadi (Deutsche Telekom)
+* Eric Murray (Vodafone)
+* Fernando Prado Cabrillo (Telefonica)
+* Joachim Dahlgreen (Ericsson)
+* Ludovic Robert (Orange)
+* Noel Wirzius (Deutsche Telekom)
+* Prashant Sidana (E&)
+* Rafal Artych (Deutsche Telekom)
+* Sachin Kumar (Vodafone)
+
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open issues
+* Open PRs
+* API Roadmap
+* AOB
+
+
+## Open issues:
+* [#74 Align event-subscriptions with updated design guidelines based on CloudEvents](https://github.com/camaraproject/DeviceStatus/issues/74)
+ [PR75](https://github.com/camaraproject/DeviceStatus/pull/75) is open.
+
+* [#71 Release plan&content](https://github.com/camaraproject/DeviceStatus/issues/71)
+The upcoming releases were agreed as described below. This issue can be closed.
+
+* [#70 Info required : API understanding](https://github.com/camaraproject/DeviceStatus/issues/70)
+The issue can be closed.
+
+* [#57 Add documentation into API definition](https://github.com/camaraproject/DeviceStatus/issues/57)
+ [PR75](https://github.com/camaraproject/DeviceStatus/pull/75) is open.
+
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34)
+[PR69](https://github.com/camaraproject/DeviceStatus/pull/69) is open.
+
+* [#17 Subscription Mode with new Eventtypes](https://github.com/camaraproject/DeviceStatus/issues/17)
+[PR31](https://github.com/camaraproject/DeviceStatus/pull/31) introduced a generic subscription endpoint.
+Currently with the roaming status types, but it can be extended, when e.g. connectivity status info is added to the API.
+
+## Open PRs
+* [#69 add /connectivity - endpoint to check the network status of a device](https://github.com/camaraproject/DeviceStatus/pull/69)
+Update the PR with connectivity-events based on CloudEvents. Depending on [PR75](https://github.com/camaraproject/DeviceStatus/pull/75).
+
+* [#75 Added Notification management aligned with CloudEvents format](https://github.com/camaraproject/DeviceStatus/pull/75)
+Reviews are requested.
+
+## API Roadmap
+
+### Release 0.5.0
+* September-October 2023
+* The release is delayed because of switching to CloudEvents.
+* [~~#52 Harmonize device object with QoD API~~](https://github.com/camaraproject/DeviceStatus/issues/52)
+* [~~#31 Adding notification/subscription for Device Status~~](https://github.com/camaraproject/DeviceStatus/pull/31)
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34) => [PR69](https://github.com/camaraproject/DeviceStatus/pull/69)
+* [#74 Align event-subscriptions with updated design guidelines based on CloudEvents](https://github.com/camaraproject/DeviceStatus/issues/74) => [PR75](https://github.com/camaraproject/DeviceStatus/pull/75)
+* [#57 Add documentation into API definition](https://github.com/camaraproject/DeviceStatus/issues/57) => [PR75](https://github.com/camaraproject/DeviceStatus/pull/75)
+### Release 0.6.0
+* November-December 2023
+* OIDC
+
+## AOB
+* New issue to align with DG about security => Replace Client Credentials with OIDC (based on commonalities [PR57](https://github.com/camaraproject/Commonalities/pull/57))
+* Next call will be on 25.10.2023 11:00 CET
diff --git a/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-10-25.md b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-10-25.md
new file mode 100644
index 0000000000000000000000000000000000000000..a301d6d661d0d411434dee22008c2deab9b19d5b
--- /dev/null
+++ b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-10-25.md
@@ -0,0 +1,65 @@
+# Camara DeviceStatus meeting - MOM-2023-10-25
+
+*October 25th, 2023*
+
+## Attendees
+
+* Akos Hunyadi (Deutsche Telekom)
+* Fernando Prado Cabrillo (Telefonica)
+* Joachim Dahlgreen (Ericsson)
+* Ludovic Robert (Orange)
+* Ming Hui Foo (Singtel)
+* Rafal Artych (Deutsche Telekom)
+* Sachin Kumar (Vodafone)
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open issues
+* Open PRs
+* API Roadmap
+* AOB
+
+
+## Open issues:
+* [#74 Align event-subscriptions with updated design guidelines based on CloudEvents](https://github.com/camaraproject/DeviceStatus/issues/74)
+ [PR75](https://github.com/camaraproject/DeviceStatus/pull/75) is open.
+
+* [#70 Info required : API understanding](https://github.com/camaraproject/DeviceStatus/issues/70)
+The issue can be closed.
+
+* [#57 Add documentation into API definition](https://github.com/camaraproject/DeviceStatus/issues/57)
+ [PR75](https://github.com/camaraproject/DeviceStatus/pull/75) is open.
+
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34)
+[PR69](https://github.com/camaraproject/DeviceStatus/pull/69) is open.
+
+* [#17 Subscription Mode with new Eventtypes](https://github.com/camaraproject/DeviceStatus/issues/17)
+[PR31](https://github.com/camaraproject/DeviceStatus/pull/31) introduced a generic subscription endpoint.
+Currently with the roaming status types, but it can be extended, when e.g. connectivity status info is added to the API.
+
+## Open PRs
+* [#69 add /connectivity - endpoint to check the network status of a device](https://github.com/camaraproject/DeviceStatus/pull/69)
+Update the PR with connectivity-events based on CloudEvents. Depending on [PR75](https://github.com/camaraproject/DeviceStatus/pull/75).
+
+* [#75 Added Notification management aligned with CloudEvents format](https://github.com/camaraproject/DeviceStatus/pull/75)
+Reviews are requested.
+
+## API Roadmap
+
+### Release 0.5.0
+* September-October 2023
+* [~~#52 Harmonize device object with QoD API~~](https://github.com/camaraproject/DeviceStatus/issues/52)
+* [~~#31 Adding notification/subscription for Device Status~~](https://github.com/camaraproject/DeviceStatus/pull/31)
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34) => [PR69](https://github.com/camaraproject/DeviceStatus/pull/69)
+* [#74 Align event-subscriptions with updated design guidelines based on CloudEvents](https://github.com/camaraproject/DeviceStatus/issues/74) => [PR75](https://github.com/camaraproject/DeviceStatus/pull/75)
+* [#57 Add documentation into API definition](https://github.com/camaraproject/DeviceStatus/issues/57) => [PR75](https://github.com/camaraproject/DeviceStatus/pull/75)
+* After merging all PRs the first Releasecandidate should be created
+### Release 0.6.0
+* November-December 2023
+* OIDC
+
+## AOB
+* New issue to align with DG about security => Replace Client Credentials with OIDC (based on commonalities [PR57](https://github.com/camaraproject/Commonalities/pull/57))
+* Next call will be on 08.11.2023 11:00 CET
diff --git a/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-11-08.md b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-11-08.md
new file mode 100644
index 0000000000000000000000000000000000000000..5a7f52f880cee22b8178583de28c233816cc36fb
--- /dev/null
+++ b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-11-08.md
@@ -0,0 +1,54 @@
+# Camara DeviceStatus meeting - MOM-2023-11-08
+
+*November 8th, 2023*
+
+## Attendees
+
+* Akos Hunyadi (Deutsche Telekom)
+* Fernando Prado Cabrillo (Telefonica)
+* Joachim Dahlgreen (Ericsson)
+* Ludovic Robert (Orange)
+* Rafal Artych (Deutsche Telekom)
+* Sachin Kumar (Vodafone)
+* Sebastian Köller (Vodafone)
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open issues
+* Open PRs
+* API Roadmap
+* AOB
+
+
+## Open issues:
+
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34)
+[PR69](https://github.com/camaraproject/DeviceStatus/pull/69) is open.
+
+* [#17 Subscription Mode with new Eventtypes](https://github.com/camaraproject/DeviceStatus/issues/17)
+[PR31](https://github.com/camaraproject/DeviceStatus/pull/31) introduced a generic subscription endpoint.
+[PR69](https://github.com/camaraproject/DeviceStatus/pull/69) extends the API with connectivity related events.
+
+## Open PRs
+* [#69 add /connectivity - endpoint to check the network status of a device](https://github.com/camaraproject/DeviceStatus/pull/69)
+Update the PR with connectivity-events based on CloudEvents. Status: open for reviews.
+
+## API Roadmap
+
+### Release 0.5.0
+* November 2023
+* [~~#52 Harmonize device object with QoD API~~](https://github.com/camaraproject/DeviceStatus/issues/52)
+* [~~#31 Adding notification/subscription for Device Status~~](https://github.com/camaraproject/DeviceStatus/pull/31)
+* [#34 New Endtype Connectivity](https://github.com/camaraproject/DeviceStatus/issues/34) => [PR69](https://github.com/camaraproject/DeviceStatus/pull/69)
+* [~~#74 Align event-subscriptions with updated design guidelines based on CloudEvents~~](https://github.com/camaraproject/DeviceStatus/issues/74)
+* [~~#57 Add documentation into API definition~~](https://github.com/camaraproject/DeviceStatus/issues/57)
+* After merging all PRs the first Releasecandidate should be created
+### Release 0.6.0
+* Q1 2024
+* OIDC
+
+## AOB
+* New issue to align with DG about security => Replace Client Credentials with OIDC (based on commonalities [PR57](https://github.com/camaraproject/Commonalities/pull/57))
+* Next call will be on 22.11.2023 11:00 CET
diff --git a/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-11-22.md b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-11-22.md
new file mode 100644
index 0000000000000000000000000000000000000000..f90b88674318feec599eb9432e78df291247698d
--- /dev/null
+++ b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-11-22.md
@@ -0,0 +1,51 @@
+# Camara DeviceStatus meeting - MOM-2023-11-22
+
+*November 22nd, 2023*
+
+## Attendees
+
+* Akos Hunyadi (Deutsche Telekom)
+* Fernando Prado Cabrillo (Telefonica)
+* Ludovic Robert (Orange)
+* Ming Hui Foo (Singtel)
+* Rafal Artych (Deutsche Telekom)
+* Sachin Kumar (Vodafone)
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open issues
+* Open PRs
+* API Roadmap
+* AOB
+
+
+## Open issues:
+* [#82 Create release candidate 0.5.0](https://github.com/camaraproject/DeviceStatus/issues/82)
+ A PR should be created.
+
+* [#81 enhance v0.4.1 to follow latest CAMARA guidelines](https://github.com/camaraproject/DeviceStatus/issues/81)
+
+* [#17 Subscription Mode with new Eventtypes](https://github.com/camaraproject/DeviceStatus/issues/17)
+Almost all requirements have been implemented (except support for multiple devices), the issue should be closed.
+
+
+## Open PRs
+*
+
+## API Roadmap
+
+### Release 0.5.0
+* Planned release date: January 2024
+* Status: the planned release content has been merged, the first release candidate should be created.
+* Release content:
+ * [~~#52 Harmonize device object with QoD API~~](https://github.com/camaraproject/DeviceStatus/issues/52)
+ * [~~#31 Adding notification/subscription for Device Status~~](https://github.com/camaraproject/DeviceStatus/pull/31)
+ * [~~#34 New Endtype Connectivity~~](https://github.com/camaraproject/DeviceStatus/issues/34) => [PR69](https://github.com/camaraproject/DeviceStatus/pull/69)
+ * [~~#74 Align event-subscriptions with updated design guidelines based on CloudEvents~~](https://github.com/camaraproject/DeviceStatus/issues/74)
+ * [~~#57 Add documentation into API definition~~](https://github.com/camaraproject/DeviceStatus/issues/57)
+ * [#82 Create release candidate 0.5.0](https://github.com/camaraproject/DeviceStatus/issues/82)
+
+## AOB
+* Next call will be on 06.12.2023 11:00 CET
diff --git a/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-12-06.md b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-12-06.md
new file mode 100644
index 0000000000000000000000000000000000000000..fc3f53f53e0127638040df94c3bfb3fe11ad9377
--- /dev/null
+++ b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2023-12-06.md
@@ -0,0 +1,58 @@
+# Camara DeviceStatus meeting - MOM-2023-12-06
+
+*December 6th, 2023*
+
+## Attendees
+
+* Akos Hunyadi (Deutsche Telekom)
+* Ludovic Robert (Orange)
+* Ming Hui Foo (Singtel)
+* Rafal Artych (Deutsche Telekom)
+* Sachin Kumar (Vodafone)
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open issues
+* Open PRs
+* Open Discussions
+* API Roadmap
+* AOB
+
+
+## Open issues:
+* [#84 Minor corrections in Subscription model before release](https://github.com/camaraproject/DeviceStatus/issues/84)
+ We agreed, that the issue can be implemented as proposed.
+
+* [#82 Create release candidate 0.5.0](https://github.com/camaraproject/DeviceStatus/issues/82)
+PR is open.
+
+* [#81 enhance v0.4.1 to follow latest CAMARA guidelines](https://github.com/camaraproject/DeviceStatus/issues/81)
+
+* [#17 Subscription Mode with new Eventtypes](https://github.com/camaraproject/DeviceStatus/issues/17)
+Almost all requirements have been implemented (except support for multiple devices), the issue should be closed.
+
+## Open PRs
+* [#87 Create release candidate 0.5.0-rc](https://github.com/camaraproject/DeviceStatus/pull/87)
+The PR is blocked by [#84 Minor corrections in Subscription model before release](https://github.com/camaraproject/DeviceStatus/issues/84)
+
+## Open discussions
+*
+
+## API Roadmap
+
+### Release 0.5.0
+* Planned release date: January 2024
+* Status: the planned release content has been merged, the first release candidate should be created.
+* Release content:
+ * [~~#52 Harmonize device object with QoD API~~](https://github.com/camaraproject/DeviceStatus/issues/52)
+ * [~~#31 Adding notification/subscription for Device Status~~](https://github.com/camaraproject/DeviceStatus/pull/31)
+ * [~~#34 New Endtype Connectivity~~](https://github.com/camaraproject/DeviceStatus/issues/34) => [PR69](https://github.com/camaraproject/DeviceStatus/pull/69)
+ * [~~#74 Align event-subscriptions with updated design guidelines based on CloudEvents~~](https://github.com/camaraproject/DeviceStatus/issues/74)
+ * [~~#57 Add documentation into API definition~~](https://github.com/camaraproject/DeviceStatus/issues/57)
+ * [#84 Minor corrections in Subscription model before release](https://github.com/camaraproject/DeviceStatus/issues/84)
+ * [#82 Create release candidate 0.5.0](https://github.com/camaraproject/DeviceStatus/issues/82) => [PR#87](https://github.com/camaraproject/DeviceStatus/pull/87)
+
+## AOB
+* Next call will be on 20.12.2023 11:00 CET - However, when the 0.5.0-rc could be created earlier then this call should be skipped.
diff --git a/original/DeviceStatus/documentation/MeetingMinutes/MoM-2024-01-17.md b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2024-01-17.md
new file mode 100644
index 0000000000000000000000000000000000000000..30ca43bc7a7209e4043305120cf6fa0fb0b30901
--- /dev/null
+++ b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2024-01-17.md
@@ -0,0 +1,67 @@
+# Camara DeviceStatus meeting - MOM-2024-01-17
+
+*January 17th, 2024*
+
+## Attendees
+
+* Aishwarya Javkhedkar (Comviva)
+* Akos Hunyadi (Deutsche Telekom)
+* Fernando Prado Cabrillo (Telefonica)
+* Joachim Dahlgren (Ericsson)
+* Ludovic Robert (Orange)
+* Ming Hui Foo (Singtel)
+* Sachin Kumar (Vodafone)
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open issues
+* Open PRs
+* Open Discussions
+* API Roadmap
+* AOB
+
+
+## Open issues:
+* [#97 Update response codes to string, following other CAMARA APIs](https://github.com/camaraproject/DeviceStatus/issues/97)
+ The corresponding PR is open: [#95 Corrections resolving linting errors](https://github.com/camaraproject/DeviceStatus/pull/95)
+
+* [#96 Path update per Design Guideline](https://github.com/camaraproject/DeviceStatus/issues/96)
+The issue should be implemented after releasing the 0.5.0.
+
+* [#94 Corrections needed to resolve linting errors](https://github.com/camaraproject/DeviceStatus/issues/94)
+ The corresponding PR is open: [#95 Corrections resolving linting errors](https://github.com/camaraproject/DeviceStatus/pull/95)
+
+## Open PRs
+* [#95 Corrections resolving linting errors](https://github.com/camaraproject/DeviceStatus/pull/95)
+ The PR is ready to be merged.
+
+## Open discussions
+* [#98 Roaming Status - AgeOfInformation (or last_updated_timestamp)](https://github.com/camaraproject/DeviceStatus/discussions/98)
+ It should be converted to an issue to continue the discussion there.
+* [#89 Multi-Operator Demo Test Discussion](https://github.com/camaraproject/DeviceStatus/discussions/89)
+* [#72 CAMARA Compliant: Expose all end points](https://github.com/camaraproject/DeviceStatus/discussions/72)
+* [#48 Need support](https://github.com/camaraproject/DeviceStatus/discussions/48)
+
+## API Roadmap
+
+### Release 0.5.0
+* Planned release date: January 2024
+* Status: the release candidate 0.5.0-rc has been created. If no more bugs or findings in the 0.5.0-rc will be reported in the next 2 weeks, then the official release 0.5.0 can be created (no rc2 is necessary).
+* Release content 0.5.0-rc:
+ * [~~#52 Harmonize device object with QoD API~~](https://github.com/camaraproject/DeviceStatus/issues/52)
+ * [~~#31 Adding notification/subscription for Device Status~~](https://github.com/camaraproject/DeviceStatus/pull/31)
+ * [~~#34 New Endtype Connectivity~~](https://github.com/camaraproject/DeviceStatus/issues/34) => [PR69](https://github.com/camaraproject/DeviceStatus/pull/69)
+ * [~~#74 Align event-subscriptions with updated design guidelines based on CloudEvents~~](https://github.com/camaraproject/DeviceStatus/issues/74)
+ * [~~#57 Add documentation into API definition~~](https://github.com/camaraproject/DeviceStatus/issues/57)
+ * [~~#84 Minor corrections in Subscription model before release~~](https://github.com/camaraproject/DeviceStatus/issues/84)
+ * [~~#82 Create release candidate 0.5.0~~](https://github.com/camaraproject/DeviceStatus/issues/82) => [PR#87](https://github.com/camaraproject/DeviceStatus/pull/87)
+* Release content 0.5.0:
+ * [#95 Corrections resolving linting errors](https://github.com/camaraproject/DeviceStatus/pull/95)
+ * New issue&PR to prepare the release
+
+## AOB
+* Next call will be on 14.02.2024 11:00 CET
+* Since the API is already in a mature status, a v1.0.0 should be targeted. => Create an issue to discuss about the process and the necessary to-do's.
+* An issue for creation of the necessary feature file for testing should be created too.
diff --git a/original/DeviceStatus/documentation/MeetingMinutes/MoM-2024-02-14.md b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2024-02-14.md
new file mode 100644
index 0000000000000000000000000000000000000000..d0515b7786dd71dc894b8fe269281c19ec5e7a33
--- /dev/null
+++ b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2024-02-14.md
@@ -0,0 +1,82 @@
+# Camara DeviceStatus meeting - MOM-2024-02-14
+
+*February 14th, 2024*
+
+## Attendees
+
+* Akos Hunyadi (Deutsche Telekom)
+* Fernando Prado Cabrillo (Telefonica)
+* Jorge Garcia Hospital (Telefonica)
+* Ludovic Robert (Orange)
+* Rafal Artych (Deutsche Telekom)
+* Sachin Kumar (Vodafone)
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open PRs
+* Open Issues
+* Open Discussions
+* API Roadmap
+* AOB
+
+
+## Open PRs
+* [#111 Update device-status.yaml](https://github.com/camaraproject/DeviceStatus/pull/111)
+ * Renaming the POST endpoints according to the design guidelines. No discussion, can be merged after approvals.
+
+* [#109 fix: add missing "subscriptionId" in "RoamingStatus"-data for CloudEvent](https://github.com/camaraproject/DeviceStatus/pull/109)
+ * No discussion, can be merged after approvals.
+
+* [#108 feat: use simple String for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/pull/108)
+ * The enums for event-types include dots which causes problems at the code generation (Java) at DT.
+ * Additional feedback from dev teams would be helpful to priotize the issue.
+ * A possible change in the design guideline could be a solution.
+ * The PR has been marked as draft until an agreed solution is ellaborated.
+
+## Open issues:
+
+* [#110 Request for Addition of "last_updated_timestamp" Field in CAMARA DeviceStatus API](https://github.com/camaraproject/DeviceStatus/issues/110)
+ * The name should correlate with similar properties at other APIs
+ * Is the information on 3GPP available at all?
+
+* [#107 Use simple string for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/issues/107)
+ * The corresponding PR is open: [#108 feat: use simple String for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/pull/108)
+
+* [#104 Include x-correlator heade](https://github.com/camaraproject/DeviceStatus/issues/104)
+ * No discussion, a PR should be created.
+
+* [#102 Clarify API readiness status for v1.0.0](https://github.com/camaraproject/DeviceStatus/issues/102)
+
+* [#97 Update response codes to string, following other CAMARA APIs](https://github.com/camaraproject/DeviceStatus/issues/97)
+ * The corresponding PR is open: [#95 Corrections resolving linting errors](https://github.com/camaraproject/DeviceStatus/pull/95)
+
+* [#96 Path update per Design Guideline](https://github.com/camaraproject/DeviceStatus/issues/96)
+ * The corresponding PR is open: [#111 Update device-status.yaml](https://github.com/camaraproject/DeviceStatus/pull/111)
+
+
+
+## Open discussions
+* [#105 v0.5.0 - Difference between "subscriptionExpireTime" & "expiresAt" in "SubscriptionInfo"](https://github.com/camaraproject/DeviceStatus/discussions/105)
+* [#100 Granularity of the Test Definition feature file](https://github.com/camaraproject/DeviceStatus/discussions/100)
+* [#98 Roaming Status - AgeOfInformation (or last_updated_timestamp)](https://github.com/camaraproject/DeviceStatus/discussions/98)
+ * An issue [#110 Request for Addition of "last_updated_timestamp" Field in CAMARA DeviceStatus API](https://github.com/camaraproject/DeviceStatus/issues/110) has been created, the discussion can be closed.
+* [#89 Multi-Operator Demo Test Discussion](https://github.com/camaraproject/DeviceStatus/discussions/89)
+* [#72 CAMARA Compliant: Expose all end points](https://github.com/camaraproject/DeviceStatus/discussions/72)
+* [#48 Need support](https://github.com/camaraproject/DeviceStatus/discussions/48)
+
+## API Roadmap
+
+### Release 0.5.0
+* Status: release created on 31.01.2024
+
+### Release 0.6.0
+* Planned release date: tbd
+* Status: wip
+* Content:
+
+
+## AOB
+* Next call will be on 28.02.2024 11:00 CET
+* An issue for creation of the necessary feature file for testing should be created too.
diff --git a/original/DeviceStatus/documentation/MeetingMinutes/MoM-2024-02-28.md b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2024-02-28.md
new file mode 100644
index 0000000000000000000000000000000000000000..fa62ba2ccc66da5a8f32d80fb483789c5ac9acdd
--- /dev/null
+++ b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2024-02-28.md
@@ -0,0 +1,88 @@
+# Camara DeviceStatus meeting - MOM-2024-02-28
+
+*February 28th, 2024*
+
+## Attendees
+
+* Akos Hunyadi (Deutsche Telekom)
+* Fernando Prado Cabrillo (Telefonica)
+* Joachim Dahlgren (Ericsson)
+* Rafal Artych (Deutsche Telekom)
+* Sachin Kumar (Vodafone)
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open PRs
+* Open Issues
+* Open Discussions
+* API Roadmap
+* AOB
+
+
+## Open PRs
+* [#112 include x-correlator and fix typo in 400 error code](https://github.com/camaraproject/DeviceStatus/pull/112)
+ * No discussion
+ * Reviews are missing.
+
+* [#111 Update device-status.yaml](https://github.com/camaraproject/DeviceStatus/pull/111)
+ * Renaming the POST endpoints according to the design guidelines.
+ * No discussion, can be merged after approvals.
+
+* [#109 fix: add missing "subscriptionId" in "RoamingStatus"-data for CloudEvent](https://github.com/camaraproject/DeviceStatus/pull/109)
+ * No discussion, can be merged after approvals.
+
+* [#108 feat: use simple String for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/pull/108)
+ * The enums for event-types include dots which causes problems at the code generation (Java) at DT.
+ * Additional feedback from dev teams would be helpful to priotize the issue.
+ * A possible change in the design guideline could be a solution.
+ * The PR has been marked as draft until an agreed solution is ellaborated.
+
+## Open issues:
+
+* [#117 Send a CloudEvent when DELETE /subscriptions/{subscriptionId}](https://github.com/camaraproject/DeviceStatus/issues/117)
+ * Same issue exists in Device Location
+ * Should be addressed in Commonalities
+
+* [#116 subscriptionExpireTime is declared as "required" in the subscription-ends - note, but is optional currently](https://github.com/camaraproject/DeviceStatus/issues/116)
+
+* [#115 /Connectivity API there is no indication for which particular subscriber event (DATA/SMS)](https://github.com/camaraproject/DeviceStatus/issues/115)
+
+* [#110 Request for Addition of "last_updated_timestamp" Field in CAMARA DeviceStatus API](https://github.com/camaraproject/DeviceStatus/issues/110)
+ * The name should correlate with similar properties at other APIs
+
+* [#107 Use simple string for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/issues/107)
+ * The corresponding PR is open: [#108 feat: use simple String for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/pull/108)
+
+* [#104 Include x-correlator heade](https://github.com/camaraproject/DeviceStatus/issues/104)
+ * The corresponding PR is open: [#112 include x-correlator and fix typo in 400 error code](https://github.com/camaraproject/DeviceStatus/pull/112)
+
+* [#102 Clarify API readiness status for v1.0.0](https://github.com/camaraproject/DeviceStatus/issues/102)
+
+* [#96 Path update per Design Guideline](https://github.com/camaraproject/DeviceStatus/issues/96)
+ * The corresponding PR is open: [#111 Update device-status.yaml](https://github.com/camaraproject/DeviceStatus/pull/111)
+
+
+
+## Open discussions
+* **[#114 Test Data : Device Status](https://github.com/camaraproject/DeviceStatus/discussions/114)**
+* [#100 Granularity of the Test Definition feature file](https://github.com/camaraproject/DeviceStatus/discussions/100)
+* [#89 Multi-Operator Demo Test Discussion](https://github.com/camaraproject/DeviceStatus/discussions/89)
+* [#72 CAMARA Compliant: Expose all end points](https://github.com/camaraproject/DeviceStatus/discussions/72)
+* [#48 Need support](https://github.com/camaraproject/DeviceStatus/discussions/48)
+
+## API Roadmap
+
+### Release 0.5.0
+* Status: release created on 31.01.2024
+
+### Release 0.6.0
+* Planned release date: tbd
+* Status: wip
+* Content: A proposal for the content should be created (Ákos)
+
+
+## AOB
+* Next call will be on 13.03.2024 11:00 CET
+* An issue for creation of the necessary feature file for testing should be created.
diff --git a/original/DeviceStatus/documentation/MeetingMinutes/MoM-2024-03-13.md b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2024-03-13.md
new file mode 100644
index 0000000000000000000000000000000000000000..002a67d8ba10e75b9c98eae81cbf3305b26f40d5
--- /dev/null
+++ b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2024-03-13.md
@@ -0,0 +1,112 @@
+# Camara DeviceStatus meeting - MOM-2024-03-13
+
+*March 13th, 2024*
+
+## Attendees
+
+* Aishwarya Javkhedkar (Comviva)
+* Akos Hunyadi (Deutsche Telekom)
+* Fernando Prado Cabrillo (Telefonica)
+* Joachim Dahlgren (Ericsson)
+* Ludovic Robert (Orange)
+* Maximilian Laue (Deutsche Telekom)
+* Quanain Meghjee (Vonage)
+* Rafal Artych (Deutsche Telekom)
+* Sachin Kumar (Vodafone)
+* Toyeeb Rehmann (GSMA)
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open PRs
+* Open Issues
+* Open Discussions
+* API Roadmap
+* AOB
+
+
+## Open PRs
+
+* [#127 Updated in-line documentation for Roaming to clarify that country information can optionally be returned in the response](https://github.com/camaraproject/DeviceStatus/pull/127)
+
+* [#123 Adding configuration for Github Actions with linting ruleset](https://github.com/camaraproject/DeviceStatus/pull/123)
+ * No discussion
+ * Reviews are missing.
+
+* [#121 feat: add termination reason when subscription deleted](https://github.com/camaraproject/DeviceStatus/pull/121)
+ * Should be first clarified in Commonalities: camaraproject/Commonalities#153
+
+* [#112 include x-correlator and fix typo in 400 error code](https://github.com/camaraproject/DeviceStatus/pull/112)
+ * No discussion
+ * Reviews are missing.
+ * The fix for the typo should be covered in a separate PR.
+
+* [#111 Update device-status.yaml](https://github.com/camaraproject/DeviceStatus/pull/111)
+ * The PR has been merged accidentally, but then the change has been reverted. This PR should be merged after the bugfix release v0.5.1 has been created.
+ * A new PR should be opened.
+
+* [#108 feat: use simple String for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/pull/108)
+ * The enums for event-types include dots which causes problems at the code generation (Java) at DT.
+ * Additional feedback from dev teams would be helpful to priotize the issue.
+ * A possible change in the design guideline could be a solution.
+ * The PR has been marked as draft until an agreed solution is ellaborated.
+ * An issue in Commonalities has been opened camaraproject/DeviceLocation#149
+
+## Open issues:
+
+* [#125 Separate endpoints into different APIs](https://github.com/camaraproject/DeviceStatus/pull/125)
+ * Split the current API into 4 different APIs
+
+* [#124 When roaming status is true, is it mandatory to return both countryCode and countryName?](https://github.com/camaraproject/DeviceStatus/issues/124)
+
+* [#122 Bugfix release v0.5.1](https://github.com/camaraproject/DeviceStatus/issues/122)
+
+* [#119 How can a provider inform the ASP/aggregator about not implemented features in advance of the API call](https://github.com/camaraproject/DeviceStatus/issues/119)
+
+* [#117 Send a CloudEvent when DELETE /subscriptions/{subscriptionId}](https://github.com/camaraproject/DeviceStatus/issues/117)
+ * The corresponding PR is open: [#121 feat: add termination reason when subscription deleted](https://github.com/camaraproject/DeviceStatus/pull/121)
+
+* [#115 /Connectivity API there is no indication for which particular subscriber event (DATA/SMS)](https://github.com/camaraproject/DeviceStatus/issues/115)
+
+* [#110 Request for Addition of "last_updated_timestamp" Field in CAMARA DeviceStatus API](https://github.com/camaraproject/DeviceStatus/issues/110)
+ * The name should correlate with similar properties at other APIs
+
+* [#107 Use simple string for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/issues/107)
+ * The corresponding PR is open: [#108 feat: use simple String for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/pull/108)
+
+* [#104 Include x-correlator heade](https://github.com/camaraproject/DeviceStatus/issues/104)
+ * The corresponding PR is open: [#112 include x-correlator and fix typo in 400 error code](https://github.com/camaraproject/DeviceStatus/pull/112)
+
+* [#102 Clarify API readiness status for v1.0.0](https://github.com/camaraproject/DeviceStatus/issues/102)
+
+* [#96 Path update per Design Guideline](https://github.com/camaraproject/DeviceStatus/issues/96)
+ * A new PR should be created see [#111 Update device-status.yaml](https://github.com/camaraproject/DeviceStatus/pull/111)
+
+
+
+## Open discussions
+* [#114 Test Data : Device Status](https://github.com/camaraproject/DeviceStatus/discussions/114)
+* [#100 Granularity of the Test Definition feature file](https://github.com/camaraproject/DeviceStatus/discussions/100)
+* [#89 Multi-Operator Demo Test Discussion](https://github.com/camaraproject/DeviceStatus/discussions/89)
+* [#72 CAMARA Compliant: Expose all end points](https://github.com/camaraproject/DeviceStatus/discussions/72)
+* [#48 Need support](https://github.com/camaraproject/DeviceStatus/discussions/48)
+
+## API Roadmap
+
+### Release 0.5.x
+* The release v0.5.0 was created on 31.01.2024
+* The bugfix release 0.5.1 is planned [#122 Bugfix release v0.5.1](https://github.com/camaraproject/DeviceStatus/issues/122)
+
+### Release 0.6.0
+* Planned release date: tbd
+* Content:
+ * [#96 Path update per Design Guideline](https://github.com/camaraproject/DeviceStatus/issues/96)
+ * [#112 include x-correlator and fix typo in 400 error code](https://github.com/camaraproject/DeviceStatus/pull/112)
+ * [#123 Adding configuration for Github Actions with linting ruleset](https://github.com/camaraproject/DeviceStatus/pull/123)
+ * ?? [#125 Separate endpoints into different APIs](https://github.com/camaraproject/DeviceStatus/pull/125)
+
+
+## AOB
+* Next call will be on 27.03.2024 11:00 CET
+* An issue for creation of the necessary feature file for testing should be created.
diff --git a/original/DeviceStatus/documentation/MeetingMinutes/MoM-2024-03-27.md b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2024-03-27.md
new file mode 100644
index 0000000000000000000000000000000000000000..5e7d8fab6aabeaf77a8d3ba1ac9de46aed23dc4f
--- /dev/null
+++ b/original/DeviceStatus/documentation/MeetingMinutes/MoM-2024-03-27.md
@@ -0,0 +1,117 @@
+# Camara DeviceStatus meeting - MOM-2024-03-27
+
+*March 27th, 2024*
+
+## Attendees
+
+* Aishwarya Javkhedkar (Comviva)
+* Ankita ()
+* Akos Hunyadi (Deutsche Telekom)
+* Fernando Prado Cabrillo (Telefonica)
+* Joachim Dahlgren (Ericsson)
+* Quanain Meghjee (Vonage)
+* Sachin Kumar (Vodafone)
+
+
+DeviceStatus minutes: [https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/DeviceStatus/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Open PRs
+* Open Issues
+* Open Discussions
+* API Roadmap
+* AOB
+
+
+## Open PRs
+
+* [#131 Update device-status.yaml](https://github.com/camaraproject/DeviceStatus/pull/131)
+ * PR was recreated after accedentally merging too early
+ * Planned release v0.6.0
+
+* [#129 fix: change INVALID_INPUT for INVALID_ARGUMENT according to guidelines](https://github.com/camaraproject/DeviceStatus/pull/129)
+ * Review in progress
+ * Planned release v0.5.1
+
+* [#127 Updated in-line documentation for Roaming to clarify that country information can optionally be returned in the response](https://github.com/camaraproject/DeviceStatus/pull/127)
+ * Review in progress
+ * Planned release v0.5.1
+
+* [#123 Adding configuration for Github Actions with linting ruleset](https://github.com/camaraproject/DeviceStatus/pull/123)
+ * No discussion
+ * Reviews are missing.
+
+* [#121 feat: add termination reason when subscription deleted](https://github.com/camaraproject/DeviceStatus/pull/121)
+ * Should be first clarified in Commonalities: camaraproject/Commonalities#153
+
+* [#112 include x-correlator and fix typo in 400 error code](https://github.com/camaraproject/DeviceStatus/pull/112)
+ * No discussion
+ * Reviews are missing.
+ * Planned release v0.6.0
+
+* [#108 feat: use simple String for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/pull/108)
+ * The enums for event-types include dots which causes problems at the code generation (Java) at DT.
+ * Additional feedback from dev teams would be helpful to priotize the issue.
+ * A possible change in the design guideline could be a solution.
+ * The PR has been marked as draft until an agreed solution is ellaborated.
+ * An issue in Commonalities has been opened camaraproject/DeviceLocation#149
+
+## Open issues:
+
+* [#130 What should the API return if more than one device identifier is sent and they don't belong to the same device?](https://github.com/camaraproject/DeviceStatus/pull/130)
+
+* [#125 Separate endpoints into different APIs](https://github.com/camaraproject/DeviceStatus/pull/125)
+ * Split the current API into 4 different APIs
+
+* [#124 When roaming status is true, is it mandatory to return both countryCode and countryName?](https://github.com/camaraproject/DeviceStatus/issues/124)
+
+* [#122 Bugfix release v0.5.1](https://github.com/camaraproject/DeviceStatus/issues/122)
+
+* [#119 How can a provider inform the ASP/aggregator about not implemented features in advance of the API call](https://github.com/camaraproject/DeviceStatus/issues/119)
+
+* [#117 Send a CloudEvent when DELETE /subscriptions/{subscriptionId}](https://github.com/camaraproject/DeviceStatus/issues/117)
+ * The corresponding PR is open: [#121 feat: add termination reason when subscription deleted](https://github.com/camaraproject/DeviceStatus/pull/121)
+
+* [#115 /Connectivity API there is no indication for which particular subscriber event (DATA/SMS)](https://github.com/camaraproject/DeviceStatus/issues/115)
+
+* [#110 Request for Addition of "last_updated_timestamp" Field in CAMARA DeviceStatus API](https://github.com/camaraproject/DeviceStatus/issues/110)
+ * The name should correlate with similar properties at other APIs
+
+* [#107 Use simple string for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/issues/107)
+ * The corresponding PR is open: [#108 feat: use simple String for "type" in CloudEvent](https://github.com/camaraproject/DeviceStatus/pull/108)
+
+* [#104 Include x-correlator heade](https://github.com/camaraproject/DeviceStatus/issues/104)
+ * The corresponding PR is open: [#112 include x-correlator and fix typo in 400 error code](https://github.com/camaraproject/DeviceStatus/pull/112)
+
+* [#102 Clarify API readiness status for v1.0.0](https://github.com/camaraproject/DeviceStatus/issues/102)
+
+* [#96 Path update per Design Guideline](https://github.com/camaraproject/DeviceStatus/issues/96)
+ * The corresponding PR is open: [#131 Update device-status.yaml](https://github.com/camaraproject/DeviceStatus/pull/131)
+
+
+
+## Open discussions
+* [#114 Test Data : Device Status](https://github.com/camaraproject/DeviceStatus/discussions/114)
+* [#100 Granularity of the Test Definition feature file](https://github.com/camaraproject/DeviceStatus/discussions/100)
+* [#89 Multi-Operator Demo Test Discussion](https://github.com/camaraproject/DeviceStatus/discussions/89)
+* [#72 CAMARA Compliant: Expose all end points](https://github.com/camaraproject/DeviceStatus/discussions/72)
+* [#48 Need support](https://github.com/camaraproject/DeviceStatus/discussions/48)
+
+## API Roadmap
+
+### Release 0.5.x
+* The release v0.5.0 was created on 31.01.2024
+* The bugfix release 0.5.1 is planned [#122 Bugfix release v0.5.1](https://github.com/camaraproject/DeviceStatus/issues/122)
+
+### Release 0.6.0
+* Planned release date: tbd
+* Content:
+ * [#131 Update device-status.yaml](https://github.com/camaraproject/DeviceStatus/pull/131)
+ * [#112 include x-correlator and fix typo in 400 error code](https://github.com/camaraproject/DeviceStatus/pull/112)
+ * [#123 Adding configuration for Github Actions with linting ruleset](https://github.com/camaraproject/DeviceStatus/pull/123)
+ * ?? [#125 Separate endpoints into different APIs](https://github.com/camaraproject/DeviceStatus/pull/125)
+
+
+## AOB
+* Next call will be on 10.04.2024 11:00 CET
diff --git a/original/DeviceStatus/documentation/MeetingMinutes/MoM-DST-2022-12-12.md b/original/DeviceStatus/documentation/MeetingMinutes/MoM-DST-2022-12-12.md
new file mode 100644
index 0000000000000000000000000000000000000000..78fabc8e3e85f060d1a8ba29b1610523b441195e
--- /dev/null
+++ b/original/DeviceStatus/documentation/MeetingMinutes/MoM-DST-2022-12-12.md
@@ -0,0 +1,35 @@
+# Meeting Minutes: Device Status WG
+## Date: 12th December 2022
+## Attendees
+- Eric Murray / Vodafone
+- Sachin Kumar / Vodafone
+- Ludovic Robert / Orange
+- Joachim Dahlgren / Ericsson
+- Mona Mokhber / Telefonica
+## Pull Requests
+- PR #8: Add documentation / DT
+
+ It was agreed that:
+ - Final reviews of this PR should be undertaken this week
+ - Any comments to be raised by end of Friday 16th December, otherwise it will be approved
+- PR #9: v0.3.0 based on Telefónica proposal / Telefonica
+
+ It was agreed that:
+ - Outstanding issues / PRs in the Commonalities WG ([PR #68](https://github.com/camaraproject/WorkingGroups/pull/68), [Issue #101](https://github.com/camaraproject/WorkingGroups/issues/101), [Issue #105](https://github.com/camaraproject/WorkingGroups/issues/105)) need to be closed before this proposal can be progressed
+ - A separate API per status type (in this case, roaming status) was the best approach, and new APIs should be introduced for additional statuses (e.g. device connectivity state)
+ - If additional roaming status information was to be added (e.g. visited country, or PLMN ID), this should be implemented as additional paths to support different client access rights via scopes
+## Issues
+- Issue #6: Issues, branches, pull requests - cleaning up
+ - Issue closed
+- Issue #7: Meetings ?
+ - Agreed to keep open until Noel has scheduled ongoing bi-weekly meetings
+- Issue #2: Roaming Status API Proposal
+ - This was the original issue raised in the Commonalities WG, and now transferred to Device Status WG
+ - Agreed to revisit once PR #9 is resolved
+ - Link to original proposal is broken. Eric to copy over original proposal to Device Status WG and fix link.
+- Issue #10: Telefonica proposal post MWC
+ - Issue raised to introduce PR #9 (discussed above). Can be used to raise questions about the proposal.
+## Discussions
+- None
+## AOB
+- Ongoing meetings to be scheduled by Noel. Anyone wishing to join should subscribe to the [mailing list](https://lists.camaraproject.org/g/sp-dst).
diff --git a/original/DeviceStatus/documentation/MeetingMinutes/README.MD b/original/DeviceStatus/documentation/MeetingMinutes/README.MD
new file mode 100644
index 0000000000000000000000000000000000000000..f71c2a667b84b38512f5893a2240aef980329112
--- /dev/null
+++ b/original/DeviceStatus/documentation/MeetingMinutes/README.MD
@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.
diff --git a/original/DeviceStatus/documentation/SupportingDocuments/README.MD b/original/DeviceStatus/documentation/SupportingDocuments/README.MD
new file mode 100644
index 0000000000000000000000000000000000000000..f71c2a667b84b38512f5893a2240aef980329112
--- /dev/null
+++ b/original/DeviceStatus/documentation/SupportingDocuments/README.MD
@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.
diff --git a/original/DeviceStatus/documentation/SupportingDocuments/Roaming_API_Proposal_-_Vodafone.md b/original/DeviceStatus/documentation/SupportingDocuments/Roaming_API_Proposal_-_Vodafone.md
new file mode 100644
index 0000000000000000000000000000000000000000..a7fc4d67dffe8f6606448fe67cf01a93ad5459f2
--- /dev/null
+++ b/original/DeviceStatus/documentation/SupportingDocuments/Roaming_API_Proposal_-_Vodafone.md
@@ -0,0 +1,31 @@
+# Roaming Status API
+Device (i.e. UE) status indications are an important family of APIs where the API consumer is not the device itself. One status indication that has several use cases is the roaming status of the device. Roaming in this context is defined as being connected to a network other than the subscriber's home network, and so would include national roaming (where allowed) in addition to international roaming.
+
+For example, such information could be useful in the following scenarios:
+- For regulatory reasons, where a customer may need to be within a certain jurisdication, or outwith others, in order for transactions to be authorised
+- For security / fraud reasons, to establish that a customer is located where they claim to be
+- For service delivery reasons, to ensure that the customer has access to particular services, and will not incur roaming charges in accessing them
+
+### Inputs
+- The target UE whose roaming status is required should be explicitly identified by its GPSI (MSISDN or External Identifier). It is not expected that the UE itself will call this API, and hence OIDC will not identify the target UE.
+- When a boolean indication of whether or not a UE is in a specific country, the ISO country code for that country must be provided
+
+
+### Outputs
+It is proposed that a roaming status API is able to provide the following information to API consumers:
+- A boolean indicator of roaming state (i.e. roaming / not roaming)
+- if roaming, an indicator of whether that is national or international roaming (i.e. does the ISO country code for the home MCC equal that of the visited MCC or not)
+- The ISO country code corresponding to the MCC of the network the device is currently connected to or, where the MCC does not have a corresponding ISO country code, the MCC itself
+- The full PLMN of the network that the device is currently connected to (MCC + MNC)
+- A boolean indicator of whether a device is in a specified country (specified by ISO country code)
+
+### Notifications
+It should be possible for the API caller to be notified of any change in roaming status
+
+## Implementation
+UE roaming status information can be obtained either directly from the HSS, or via the SCEF/NEF "ROAMING_STATUS" monitoring capability
+
+## Notes
+- API consumers would be able to access all or only some of this information, depending on their level of authorisation
+- Some lucky countries (e.g. UK, USA, India, China) have multiple MCCs, hence care must be taken when deciding roaming status on the basis of the visited network MCC
+- A very few MCCs are shared between multiple countries (specifically, countries with different ISO country codes - for example, French DROMs or British Crown Dependencies). In these cases, the ISO country code needs to be determined from the full visited network PLMN.
diff --git a/original/DeviceStatus/documentation/SupportingDocuments/decision-support-1-or-2-apis.md b/original/DeviceStatus/documentation/SupportingDocuments/decision-support-1-or-2-apis.md
new file mode 100644
index 0000000000000000000000000000000000000000..2491967645ec1480383198019f4e40303b32eb08
--- /dev/null
+++ b/original/DeviceStatus/documentation/SupportingDocuments/decision-support-1-or-2-apis.md
@@ -0,0 +1,136 @@
+# Decision supporting document for the discussion 1 or 2(n) APIs
+
+## Current situation
+The device-status API has 1 endpoint: /roaming.
+There is a need to add new functionalities. At first 2 new endpoints: to get the connectivity status and to subscribe for status-events.
+Later other functionalities will follow.
+
+### Option 1
+Logically related endpoints are generally within 1 API, with 1 basepath. In special cases (e.g. compliance) splitting is possible.
+Example:
+{apiRoot}/device-status/v0/roaming
+{apiRoot}/device-status/v0/connectivity
+{apiRoot}/device-status/v0/subscriptions
+
+### Option 2
+Each device status subtype is handled in a separate API with different basepaths building an API-family.
+Example:
+API #1
+{apiRoot}/device-roaming-status/v0/roaming
+{apiRoot}/device-roaming-status/v0/subscriptions
+
+API #2
+{apiRoot}/device-connectivity-status/v0/connectivity
+{apiRoot}/device-connectivity-status/v0/subscriptions
+
+
+## Criterias
+
+### 1. API usage - client view
+
+Aspects of finding and using the API(s) for a specific use case of a client.
+
+**Separate basepath**
+
+Pros:
+- For a use case with a single area of interest (e.g. only roaming status is needed) a specific small API might be easier to be found and used
+
+Cons:
+- For more complex use cases many device status-APIs are needed (find, subscribe, integrate, etc.)
+
+
+**Common basepath**
+
+Pros:
+- For a use case with multiple areas of interest or the intention to extend the usage later a combined API with all device status related information is more comfortable
+- Only one API onboarding
+- In this very specific context, the 2 functions are very close.
+
+Cons:
+- If only one specific status is needed, then it might take longer to find the right information
+
+
+### 2. Service development and operation - provider view
+Aspects of the service implementation, testing, and operation on the provider side.
+
+**Separate basepath**
+
+Pros:
+- Independent implementation and testing of the different status functionalities
+- Fine-grade billing, scaling and monitoring is possible (however more effort)
+
+Cons:
+- Extra effort is needed to prevent doubled code
+- More overhead on developing and operating multiple services
+
+**Common basepath**
+
+Pros:
+- Efficient development (especially when all status information can be gathered from the same southbound service)
+- Model generation performed once
+
+Cons:
+- If different southbound services are used the service gets more complex
+- It might lead to partial implementations when there is an interest in some of the use cases and not the others
+
+
+### 3. API maintenance & releasing - Camara view
+Aspects of maintenance (add, delete, change functionality) and releasing (versioning, release planning, etc.)
+
+**Separate basepath**
+
+Pros:
+- A simple service is easier to maintain and release
+- Version changes are tightly related to the API functionality
+
+Cons:
+- The overall effort (discussions, YAML work, etc.) for the API family is higher
+- Additional synchronization within the API family is necessary (using common types could help)
+
+**Common basepath**
+
+Pros:
+- Bigger releases with higher value
+- Easy to add a new endpoint to an existing API
+
+Cons:
+- Longer release cycles (more content, more discussions)
+- Introducing changes/updates in one of the endpoints will result a version change affecting other unrelated endpoints (specially when they are not backward compatible)
+
+
+### 4. Harmonization - technical view
+Aspects of industry best practice, generic design guidelines and harmonization with other Camara APIs.
+
+**Some examples**
+- 3GPP APIs are simple on the path level (collection and collection\\
+
public | stable
public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
+| 1 | API definition | M | M | M | M | Y | [link](code/API_definitions/device-swap.yaml) |
+| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3) |
+| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3) |
+| 4 | API versioning convention applied | M | M | M | M | Y | v1.0.0 |
+| 5 | API documentation | M | M | M | M | Y | Embedded documentation into API spec - [link](/code/API_definitions/device-swap.yaml) |
+| 6 | User stories | O | O | O | M | Y | [check](/documentation/API_documentation/device-swap_check_User_Story.md) [retrieve](/documentation/API_documentation/device-swap_retrieve_User_Story.md) |
+| 7 | Basic API test cases & documentation | O | M | M | M | Y | [check](/code/Test_definitions/device-swap-checkDeviceSwap.feature) [retrieve](/code/Test_definitions/device-swap-retrieveDeviceSwapDate.feature) |
+| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [check](/code/Test_definitions/device-swap-checkDeviceSwap.feature) [retrieve](/code/Test_definitions/device-swap-retrieveDeviceSwapDate.feature) |
+| 9 | Test result statement | O | O | O | M | N | See issue [#68](https://github.com/camaraproject/DeviceSwap/issues/68) |
+| 10 | API release numbering convention applied | M | M | M | M | Y | r3.2 |
+| 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) |
+| 12 | Previous public release was certified | O | O | O | M | N | |
+| 13 | API description (for marketing) | O | O | M | M | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/81166764/DeviceSwap+API+description) |
+
+(*) If you encounter issues with the provided test files (.feature), please create an issue in the API Sub-Project to signal these issues so they can be fixed in a patch release.
+
+To fill the checklist:
+- in the line above the table, replace the api-name, api-version and the rx.y by their actual values for the current API version and release.
+- in the Status column, put "Y" (yes) if the release asset is available or fulfilled in the current release, a "N" (no) or a "tbd". Example use of "tbd" is in case an alpha or release-candidate API version does not yet provide all mandatory assets for the release.
+- in the Reference information column, provide the relative links (from the API repository home folder) to the release asset once available, the applicable release numbers (not versions) of Commonalities and ICM, and any other relevant links or information.
+- For the point 12: The Reference information comment shall reference a note (e.g. "see (1)") under the checklist table to be added that states the certified company(s) as can be found on the following link: [GSMA Open Gateway Portal](https://open-gateway.gsma.com/).
+
+Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.
+
+The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine).
diff --git a/original/DeviceSwap/documentation/API_documentation/device-swap_check_User_Story.md b/original/DeviceSwap/documentation/API_documentation/device-swap_check_User_Story.md
new file mode 100644
index 0000000000000000000000000000000000000000..0597786c3be3476facead9b7ee44a0b5b5db7d8d
--- /dev/null
+++ b/original/DeviceSwap/documentation/API_documentation/device-swap_check_User_Story.md
@@ -0,0 +1,11 @@
+# Device Swap Check API User Story
+
+
+| **Item** | **Details** |
+| ---- | ------- |
+| ***Summary*** | As an enterprise application developer, I want to check if a device swap has occurred within a specified period for a user's mobile number so that I can enhance security measures against account takeover fraud. |
+| ***Actors and Scope*** | **Actors:** Application service provider (ASP), ASP:User, ASP: BusinessManager, ASP:Administrator, Channel Partner, End-User, Communication Service Provider (CSP).
**Scope:**
- Checks if a device swap has occurred within a specified period for a given phone number. |
+| ***Pre-conditions*** |The preconditions are listed below:
**Ends when:** The CSP's Device Swap server responds indicating whether a Device Swap has been performed within the specified period. |
+| ***Post-conditions*** | The ASP:User could continue offering its service to the End-User with the confirmation of the validity of the End-User's line, based on the Device Swap information. |
+| ***Exceptions*** | Several exceptions might occur during the Device Swap API operations
- Unauthorized: Not valid credentials (e.g., use of already expired access token).
- Invalid input: Not valid input data to invoke operation (e.g., improperly formatted phone number).|
diff --git a/original/DeviceSwap/documentation/API_documentation/device-swap_retrieve_User_Story.md b/original/DeviceSwap/documentation/API_documentation/device-swap_retrieve_User_Story.md
new file mode 100644
index 0000000000000000000000000000000000000000..ede338eabba07224ce929e8e902b90a63ab71f15
--- /dev/null
+++ b/original/DeviceSwap/documentation/API_documentation/device-swap_retrieve_User_Story.md
@@ -0,0 +1,11 @@
+# Device Swap Retrieve API User Story
+
+
+| **Item** | **Details** |
+| ---- | ------- |
+| ***Summary*** | As an enterprise application developer, I want to verify the last device swap date for a user's mobile number so that I can enhance security measures against account takeover fraud. |
+|***Actors and Scope*** | **Actors:** Application service provider (ASP), ASP:User, ASP: BusinessManager, ASP:Administrator, Channel Partner, End-User, Communication Service Provider (CSP).
**Scope:**
- Retrieves the timestamp of the last device swap event for a given phone number. |
+| ***Pre-conditions*** |The preconditions are listed below:
|
+| Logistics | All | 1. In order to be able to continue this substream despite of vacations etc. the group agreed to appoint Kevin (VDF/5GFF) as Co-Lead with Thomas (EdgeXR) for this substream.
**Ends when:** The CSP's Device Swap server responds with the timestamp of the last device swap event, or the first SIM installation date if no device swap has occurred. |
+| ***Post-conditions*** | The ASP:User could continue offering its service to the End-User with the confirmation of the validity of the End-User's line, based on the Device Swap information. |
+| ***Exceptions*** | Several exceptions might occur during the Device Swap API operations
- Unauthorized: Not valid credentials (e.g., use of already expired access token).
- Invalid input: Not valid input data to invoke operation (e.g., improperly formatted phone number).
- Not able to provide: Legal restrictions or data retention policies preventing the retrieval of the requested information.|
diff --git a/original/DeviceSwap/documentation/MeetingMinutes/README.MD b/original/DeviceSwap/documentation/MeetingMinutes/README.MD
new file mode 100644
index 0000000000000000000000000000000000000000..f71c2a667b84b38512f5893a2240aef980329112
--- /dev/null
+++ b/original/DeviceSwap/documentation/MeetingMinutes/README.MD
@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.
diff --git a/original/DeviceSwap/documentation/SupportingDocuments/README.MD b/original/DeviceSwap/documentation/SupportingDocuments/README.MD
new file mode 100644
index 0000000000000000000000000000000000000000..f71c2a667b84b38512f5893a2240aef980329112
--- /dev/null
+++ b/original/DeviceSwap/documentation/SupportingDocuments/README.MD
@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.
diff --git a/original/DeviceVisitLocation/README.md b/original/DeviceVisitLocation/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..dd25d4c4593eddc7418a338aac60196dbc95eb4a
--- /dev/null
+++ b/original/DeviceVisitLocation/README.md
@@ -0,0 +1,41 @@
+
+
+
+
to operator network
+ Note over AP,OP: PRE App developer registered,
authenticated and authorised
+ AP->>OP: GET /edge-cloud-zone
+ OP->>AP: Returns the information about the Edge cloud zones (edgeCloudZoneInfo)
+ alt app has a local mapping of server endpoints to Edge Cloud Zones
+ AP->>OP: POST /app Information about app to be instantiate(appManifest)
+ OP->>AP: Returns the identificator of the submitted app (appId)
+ AP->>OP: GET /app?appId=UUID Information about app(appId) to be instantiate(appManifest)
+ OP->>AP: Returns the information requested (appManifest)
+ AP->>OP: DELETE /app (appId) Delete app for a given appId (Manifest and any related information)
+ OP->>AP: Request accepted
+ AP->>OP:POST /app Instantiate application (appId) in a determinated Edge Cloud Zone(edgeCloudZoneId)
+ OP->>EIP: Instantiate instance in a determinated Edge Cloud Zone(edgeCloudZoneId)
+ EIP->>OP: Application instantiated
+ OP->>AP:Returns the appInstance created
+ AP->>OP: GET /app (appId) /Instance?appID=UUID Information about app(appId) instantiated (appInstanceInfo)
+ OP->>AP: Returns the application instance information
+ AP->>OP: DELETE /app (appId) DELETE Running instance for a given appId.
+ alt delete only the instance related with the appId
+ OP->>EIP: Delete instance
+ EIP->>OP: Instance deleted
+ OP->>AP: Application instance deleted
+ end
+ end
+```
+
+
+
+
diff --git a/original/EdgeCloud/documentation/MeetingMinutes/2022/MOM_-_2020816.md b/original/EdgeCloud/documentation/MeetingMinutes/2022/MOM_-_2020816.md
new file mode 100644
index 0000000000000000000000000000000000000000..0a799fbe1f95dd51dc19a571326b6c96f2cd22c9
--- /dev/null
+++ b/original/EdgeCloud/documentation/MeetingMinutes/2022/MOM_-_2020816.md
@@ -0,0 +1,36 @@
+# MOM - 2020816
+
+**Date:** 16-July-2022
+
+## Attendees
+
+* Andrew Wajs (Scenera)
+* Christoph Neumann (Broadpeak)
+* Alexandru Ciinaru (Orange)
+* Deepak Gunjal (Capgemini)
+* Brett Hill (5GFF)
+* Landon Cox (MSFT)
+* Mark Cornall (GSMA)
+* Toshiyasu Wakayama (KDDI)
+* Jesse Bijl – (EdgeXR)
+* Thomas Vits – (EdgeXR)
+* Jon Gainsley – (EdgeXR)
+* Mahesh Chapalamadugu – (5GFF)
+* Raghuram Parvataneni - (5GFF)
+* Syed Rehman – (5GFF)
+* Kevin Smith (5GFF)
+* Urvika
+* David Ferreira Antoniello (TEF)
+* Aurelia Martinez Guerra (TEF)
+
+## Goals
+
+Go through last MoM action items Identify additional tasks, prepare upcoming ones
+
+| Item | Who | Description |
+| ---- | --- | ----------- |
+| EdgeXR API proposal | EdgeXR | EdgeXR generated 2 API pull requests for thisgroup: *App APIs* [#26](https://github.com/camaraproject/EdgeCloud/pull/26) and *App session and Discovery APIs* [#27](https://github.com/camaraproject/EdgeCloud/pull/27). Jon Gainsley made a general overview of each one. During the session, the possibility of sharing the call flow or sequence diagram of the APIs was requested. EdgeXR will fetch this information and share it. |
+| Comment - Pull Request [#21](https://github.com/camaraproject/EdgeCloud/pull/21) | 5GFF | [#21](https://github.com/camaraproject/EdgeCloud/pull/26) - Create EdgeCloudApi\_v0.0.5. yaml: Added a list of API questions today in the pull request. An additional specific session is proposed to discuss the points and questions. It was asked who would be interested in participating, the invitation will be sent to all participants. |
+| Comment - Pull Request [#24](https://github.com/camaraproject/EdgeCloud/pull/24) | 5GFF | [#24 - UNI API](https://github.com/camaraproject/EdgeCloud/pull/26): Comments from 5GFF about removing or not the UNI API in this CAMERA group. Mahesh gives first feedback indicating that it will not be very easy for non-Telco users to use the API. This argument is complemented with additional points in the pull request. On the part of Telefonica, it is internally evaluating to have an answer as soon as possible. If necessary, a specific session can be established to discuss this point. Kevin explained that the term 'UNI' is specifically defined in public GSMA materials as requiring a client SDK/middleware ('User Client') on the client UE; and that 5GFF does not require that User Client. 5GFF API allows an application in the UE to call HTTP(S) operator-hosted APIs directly without requiring any additional SDK to be on the UE. |
+| Draft Proposal for contributions and approval process in WG - Pull request by DT - [#20](https://github.com/camaraproject/EdgeCloud/pull/26) | DT | It is proposed to work with different subbranches. During the last two weeks, no comments have been received on what was proposed by DT, so it is assumed that all the members of this group agree with this proposal. The next step will be to move the 5GFF contribution to a sub-branch and work on different branches in order to push the proposal to the master branch for approval. In parallel, the way to work to validate the 3 current proposals (MEC Contribution, 5GFF Contribution and EdgeXR Contribution) will be having technical meetings to discuss each point and have the final decision. EdgeXR is interested in managing and organizing these activities. The proposal is that Thomas Vits prepare and elaborate a first proposal for the next technical meeting during the next 2 weeks and have a status in the next bi-weekly session. Different technical activities will be worked on in parallel. |
+| Next steps | EdgeXR & TEF | Telefonica and EdgeXR will discuss the next steps to follow will be discussed, beginning with the analysis with the superposition of each proposal and, as a second step, defining the Action Points to have the Edge Cloud API family with all the required functionalities, the discussion of adding or not the UNI API to the Edge Cloud API family |
diff --git a/original/EdgeCloud/documentation/MeetingMinutes/2022/MOM_-_20220719.md b/original/EdgeCloud/documentation/MeetingMinutes/2022/MOM_-_20220719.md
new file mode 100644
index 0000000000000000000000000000000000000000..951107a4d5839f2f914fa387042639636f2d6a30
--- /dev/null
+++ b/original/EdgeCloud/documentation/MeetingMinutes/2022/MOM_-_20220719.md
@@ -0,0 +1,43 @@
+## APMeting Information
+
+**Date:** 19-July-2022
+
+## Attendees
+
+*
+* Andrew Wajs (Scenera)
+* Babu Narayan (Nabstract)
+* Christoph Neumann (Broadpeak)
+* Alexandru Ciinaru (Orange)
+* Tuan Tran (Broadpeak)
+* Deepak Gunjal (Capgemini)
+* Brett Hill (5GFF)
+* Kevin Smith (5GFF)
+* Larry Homer (Intel)
+* Landon Cox (MSFT)
+* Sylvain Morel (Orange)
+* Raffaele Passannanti (TIM)
+* Fabrizio Moggio (TIM)
+* Tom van Pelt (GSMA)
+* Toshiyasu Wakayama (KDDI)
+* Yamina Kelm (DT)
+* Shilpa Padgaonkar (DT)
+* Eric Murray (Vodafone)
+* Jesse Bijl
+* Thomas Vits
+* Aurelia Martinez Guerra (TEF)
+* David Ferreira Antoniello (TEF)
+* Cristina Santana (TEF)
+* José Antonio Ordoñez (TEF)
+
+## Goals
+
+Go through last MoM action items Identify additional tasks, prepare upcoming ones
+
+| Item | Who | Description |
+| ---- | --- | ----------- |
+| API Deployment | Capgemini & TEF | TheYAML Swagger associated with the APIs proposed and created by Orange, DT,Capgemini and Telefonica was presented and detailed. It is the initial ideathat is presented as a starting point to be complemented, edited and reviewedby the participants. |
+| Edge API Family proposal | Capgemini & TEF | An analysis realizedby Telefonica associated with the 5GFF APIs and the Deployment APIs, and thepossible relationship between them, was presented.
https://github.com/camaraproject/EdgeCloud/blob/main/documentation/Presentation/EdgeXR\_forCAMARAEdgeCloudWG\_20220719.pdf |
+| EdgeXR Presentation | EdgeXR | Thomas Vitsintroduces EdgeXR and indicates that they want to support and be part of thedevelopment of the CAMARA APIs, taking advantage of the experience gainedduring the MobiledgeX stage. The presentation is included.
https://github.com/camaraproject/EdgeCloud/blob/main/documentation/Presentation/EdgeXR\_forCAMARAEdgeCloudWG\_20220719.pdf |
+| | | |
+| | | |
diff --git a/original/EdgeCloud/documentation/MeetingMinutes/2022/MOM_-_20220802.md b/original/EdgeCloud/documentation/MeetingMinutes/2022/MOM_-_20220802.md
new file mode 100644
index 0000000000000000000000000000000000000000..323539add50b44c12ff39c246ffea73761fd5d5e
--- /dev/null
+++ b/original/EdgeCloud/documentation/MeetingMinutes/2022/MOM_-_20220802.md
@@ -0,0 +1,41 @@
+## AP Meting Information
+
+Date: 02 –August - 2022
+
+## Attendees
+
+* Andrew Wajs (Scenera)
+* Alexandru Ciinaru (Orange)
+* Tuan Tran (Broadpeak)
+* Deepak Gunjal (Capgemini)
+* Brett Hill (5GFF)
+* Larry Homer (Intel)
+* Tom van Pelt (GSMA)
+* Toshiyasu Wakayama (KDDI)
+* Yamina Kelm (DT)
+* Shilpa Padgaonkar (DT)
+* Thomas Vits (EdgeXR)
+* Emil Zhang
+* Kevin Xu
+* Mahesh Chapalamadugu (5GFF)
+* Mark Cornall (GSMA)
+* Urvika
+* Larry Horner (Intel)
+* Vaibhav Mehta (Nabstract)
+* Alexandre Harmand (TEF)
+* David Ferreira Antoniello (TEF)
+* Aurelia Martinez Guerra (TEF
+
+
+
+## Goals
+
+Go through last MoM action items Identify additional tasks, prepare upcoming ones
+
+| Item | Who | Description |
+| ---- | --- | ----------- |
+| #21 API Deployment | Capgemini & TEF | Telefónica in collaboration with Capgemini, uploaded to GitHub as a “pull request” the Edge Deployment API (EdgeCloudApi\_v0.0.5.yaml - [https://github.com/camaraproject/EdgeCloud/pull/21](https://github.com/camaraproject/EdgeCloud/pull/21)
In this YAML it includes the 4 APIs proposed in the first meeting:
Participants can review it and give any additional comments. |
+| Edge API Family proposal | EdgeXR | The objective of Telefonica and Capgemini was to have for this meeting a first proposal about the analysis of the parameters to join the 5GFF APIs (Discovery) with the new APIs that were uploaded today (focused on the deployment of the APIs). It was not possible to have it for this week. Two options are proposed:
Thomas Vits (of EdgeXR) offers to collaborate with this point as another candidate. The objetive is to have a first proposal for the next meeting. |
+| #20 Proposal for contributions and approval process in WG | DT | DT has a "pull request" about the proposal for the Contribution and Approval process of this working group.
[https://github.com/camaraproject/EdgeCloud/pull/20](https://github.com/camaraproject/EdgeCloud/pull/20)
Shipa Padgaonkar presents the proposal located on the CAMARA GitHub.
It is important that everyone review and validate this proposal to make this way of working official.
This "pull request" will be maintained until Friday 08/12, if there are no additional comments, it will be validated.
It is important that everyone review and validate this proposal to make this way of working official. |
+| #25 Draft proposalEdge Cloud GitHub repository Organization | Capgemini & TEF | Deepak,from Capgemini, in conjunction with Telefónica, presented a draft with 3 options for organizing the Edge Cloud GitHub repository. https://github.com/camaraproject/EdgeCloud/pull/25 Initially, during the meeting,some of the participants indicated that option 1 could be the most appropriate.In any case, the presentation is attached and, in case of having additionalcomments, it is established as a deadline to receive them until Friday 08/12. |
+| #24 UNI API | Capgemini & TEF | Telefonica& Capgemini open a discussion about the Edge Cloud API Family scope.
This EdgeCloud API Family must include the Edge Discover UNI API, or no?
Telefonicaand Capgemini performed a first analysis of Pro and Cons.
Deepakpresented this first analysis.
[https://github.com/camaraproject/EdgeCloud/pull/24](https://github.com/camaraproject/EdgeCloud/pull/24)
It isnecessary that the participants can establish if it is important for CAMARA todefine this UNI APIs or must be 3GPP.
Theproposal will remain open for the next two weeks, until the next meeting, toestablish a conclusion.. |
diff --git a/original/EdgeCloud/documentation/MeetingMinutes/2022/MOM_-_20220827.md b/original/EdgeCloud/documentation/MeetingMinutes/2022/MOM_-_20220827.md
new file mode 100644
index 0000000000000000000000000000000000000000..7c90d0ae1566b539a017b53868b42a4f5a6fc7b7
--- /dev/null
+++ b/original/EdgeCloud/documentation/MeetingMinutes/2022/MOM_-_20220827.md
@@ -0,0 +1,40 @@
+# OM - 20220827
+
+Sun, Sep 4, 2022 8:19 AM
+
+## **Attendees**
+
+* Andrew Wajs – (Scenera)
+* Christoph Neumann – (Broadpeak)
+* Tim Epkes -
+* Prashant Goswami –
+* Deepak Gunjal – (Capgemini)
+* Brett Hill – (Telstra - 5GFF)
+* Kevin Smith – (Vodafone – 5GFF)
+* Landon Cox – (MSFT)
+* Mahesh Chapalamadugu - (Verizon – 5GFF)
+* Sylvain Morel - (Orange)
+* Fabrizio Moggio - (TIM)
+* Raffaele Passannanti - (TIM)
+* Raghuram Parvataneni - (Telstras – 5GFF)
+* Syed Rehman - (Verizon – 5GFF)
+* Thomas Vits - (EdgeXR)
+* Tom van Pelt - (GSMA)
+* Toshiyasu Wakayama (KDDI)
+* Urvika
+* Alexandre Harmand - (TEF)
+* José Antonio Ordoñez - (TEF)
+* David
+* Ferreira Antoniello - (TEF)
+* Aurelia Martínez Guerra - (TEF)
+
+## Goals
+
+Go through last MoM action items Identify additional tasks, prepare upcoming ones
+
+| Item | Who | Description |
+| ---- | --- | ----------- |
+| CAMRA - Roles | TEF | Markus has defined the differentroles in each CAMARA group in order to be clear about which members will makenew contributions, which members will validate these contributions, etc. This activity has been developed in parallel during these last two weeks and has dedicated part of the time.
The toles are:
|
+| Edge Cloud API family | EdgeXR | Analysis of the different contributions to the API (5GFF, OPAG, EdgeX
R, New DT contribution). This activity is assigned to a new group in order to analyze all the contributions, define which APIs we must have in this Edge Cloud family, analyze the different APIs to align them with the proposal.
In the last session, the EdgeXR team was established as responsible for organizing this small group and starting the activities.
Thomas presented the next steps: Have a Kick-off meeting to start working on the activities. A link is attached for those who want to participate and indicate the best option according to availability: ([https://doodle.com/meeting/participate/id/dBLrAQna](https://doodle.com/meeting/participate/id/dBLrAQna)).
It is necessary to include in the analyzes of this group the pull request about the questions, doubts and comments of each proposal. For this, it is proposed as the first point on the agenda of the first session to resolve all doubts and questions. |
+| ***Comment - Pull Request #24*** | All | #24 - UNI API: There are different options for this API: Should this API be included in CAMERA? Should 3GPP be used to define this UNI API? Should a part of the API be defined in CAMERA and a part in 3GPP? It is proposed to start a small group to discuss this topic, align and share status in these bi-weekly sessions. It is important to fix this issue, whether or not UNI API is part of the Edge Cloud group, as soon as possible.
Deepak (Capgemini) is goin to arrange a short group that is going to have as objetive aligne possiions in this isue |
+| Traffic Influence API | TIM | Fabrizio Moggio (TIM) opened a new discussion about the Traffic Influence API. He proposes to work on this API in EdgeCloug grou and that this new API be part og thi Edge Clud API family.
It was proposed to Fabrizio in the session that a point be opened in the Backlog group with all the details. This group will decide if it is better to create a new group in CAMARA specifically for Traffic Influence or if this functionality is part of one of the currently available groups. |
\ No newline at end of file
diff --git a/original/EdgeCloud/documentation/MeetingMinutes/2022/MOM_Convergence_-_202209160.md b/original/EdgeCloud/documentation/MeetingMinutes/2022/MOM_Convergence_-_202209160.md
new file mode 100644
index 0000000000000000000000000000000000000000..35cb2641a47dd9afe77139c8a36b97477d24742e
--- /dev/null
+++ b/original/EdgeCloud/documentation/MeetingMinutes/2022/MOM_Convergence_-_202209160.md
@@ -0,0 +1,28 @@
+# Meeting Minutes Convergence Substream - 20220916
+
+Fri, Sep 16, 2022 17:00 PM
+
+## **Attendees**
+
+* Andrew Wajs(Scenera)
+* Deepak Gunjal (Capgemini)
+* Kevin Smith (Vodafone – 5GFF)
+* Mahesh Chapalamadugu (Verizon - 5GFF)
+* Syed Rehman (Verizon - 5GFF)
+* Thomas Vits (EdgeXR)
+* Lev Shvarts (EdgeXR)
+* Alexandre Harmand (TEF)
+* Rebecca Odenwaelder (Deutsche Telekom)
+* Marc Cornall (GSMA)
+* Alexandru Ciinaru (Orange)
+* Toshiyasu Wakayama (KDDI)
+
+## Kickoff disucssion
+
+This call was to initiate the activity of the convergence substream.
+
+| Item | Who | Description |
+| ---- | --- | ----------- |
+| Substream Objectives and way of working| All | EdgeXR provided a suggestion on the objectives of this substream, below the aligned outcome after discussion
1. Situation: The EdgeCloud Project in CAMARA received already 3 API contributions (from 5GFF, Capgemini, EdgeXR) potentially addressing similar or same functionalities exposing edge cloud services
2. Challenge: (Assumption) The goal in CAMARA is to have single API set for a given developer intent (on a specific abstraction layer). <- This was a point of discussion whether that assumption actually holds true or whether different APIs could be feasible for the same intent. No final conclusion taken at this point.
3. Solution: Original proposal was to work on the assessment of the current/coming contributions but after discussion we concluded that the initial step to enable this would be to create an aligned taxonomy/terminology. This will ensure that we have the right vocabulary to actually do this assesment acknowledging that background of the distributions is diverse with having different taxonomy in mind.
2. Group agreed on a bi-weekly meeting cadence; as we have participants from literally all timezones we agreed to shift timeslots every 2 meetings to the next timzone (e.g. by around 8 hours)
3. Agreement that all discussions / documents shall be strictly happen in git|
+| Establish aligned Taxonomy| All | As agreed in the initial disucssion the first step is to establish an aligned taxonomy. It was suggested to use the OPG definitions as a basis and then iterate on it in git to come to a consensus. Once good enough (to be agreed by the group when this milestone is hit) the next step (i.e. making an assesment of the scope of the different contributions using that taxonomy) can be initiated. Deepak, Thomas and Mahesh volunteered to get the intitial commit going. |
diff --git a/original/EdgeCloud/documentation/MeetingMinutes/2024/EdgeCloud_MeetingMinuteslinksFromDecember2023.md b/original/EdgeCloud/documentation/MeetingMinutes/2024/EdgeCloud_MeetingMinuteslinksFromDecember2023.md
new file mode 100644
index 0000000000000000000000000000000000000000..cd25eee02cac810128b444969fdea014d5e4b790
--- /dev/null
+++ b/original/EdgeCloud/documentation/MeetingMinutes/2024/EdgeCloud_MeetingMinuteslinksFromDecember2023.md
@@ -0,0 +1,24 @@
+# Edgecloud - Meetings Minutes
+
+Meeting minutes are kept from December 2023 in https://wiki.camaraproject.org/display/CAM/Edge+Cloud, please refer to that page to follow last updates.
+
+## December 2023
+
+12/12/2024
+
+https://wiki.camaraproject.org/display/CAM/2023-12-12%3A+SP-EDC+Minutes
+
+19/12/2024
+
+https://wiki.camaraproject.org/display/CAM/2023-12-19%3A+SP-EDC+Minutes
+
+## January 2024
+
+09/01/2024
+
+https://wiki.camaraproject.org/display/CAM/2024-01-09%3A+SP-EDC+Minutes
+
+23/01/2024
+
+https://wiki.camaraproject.org/display/CAM/2024-01-23%3A+SP-EDC+Minutes
+
diff --git a/original/EdgeCloud/documentation/MeetingMinutes/README.MD b/original/EdgeCloud/documentation/MeetingMinutes/README.MD
new file mode 100644
index 0000000000000000000000000000000000000000..4b0cb36716f366a96ea3779687188fe6e28747a8
--- /dev/null
+++ b/original/EdgeCloud/documentation/MeetingMinutes/README.MD
@@ -0,0 +1,5 @@
+# Minutes archive
+
+From December 2023 the meeting minutes of EdgeCloud calls are within the CAMARA Wiki at [https://wiki.camaraproject.org/display/CAM/Edge+Cloud](https://wiki.camaraproject.org/display/CAM/Edge+Cloud)
+
+Meeting minutes before December 2023 are here in the repository.
diff --git a/original/EdgeCloud/documentation/SupportingDocuments/API_Documentation/README.md b/original/EdgeCloud/documentation/SupportingDocuments/API_Documentation/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..5f66de05e68b7b8ed3d8c3c7095c34e56ac620bd
--- /dev/null
+++ b/original/EdgeCloud/documentation/SupportingDocuments/API_Documentation/README.md
@@ -0,0 +1,3 @@
+# EdgeCloud – API\_Documentation
+
+In this folder will be all the documents about the Edge Cloud API Family
\ No newline at end of file
diff --git a/original/EdgeCloud/documentation/SupportingDocuments/API_Documentation/User_Stories/EdgeApplicationManagement_User_Story.md b/original/EdgeCloud/documentation/SupportingDocuments/API_Documentation/User_Stories/EdgeApplicationManagement_User_Story.md
new file mode 100644
index 0000000000000000000000000000000000000000..bd8a1431fad031d9e17de1640a0c8afe7de7f5df
--- /dev/null
+++ b/original/EdgeCloud/documentation/SupportingDocuments/API_Documentation/User_Stories/EdgeApplicationManagement_User_Story.md
@@ -0,0 +1,60 @@
+## Actors, Roles, and Scope
+| Actor | Role | Scope |
+|-------|------|-------|
+|Application Provider (AP) |API Consumer | API Requester |
+|Edge Service Provider (ESP)|Edge Cloud Provider|API Publisher |
+|MNO|Communications Service Provider|API Publisher |
+|User Client(UC)|API Consumer|API Requester |
+
+Note: the role of Edge Service Provider may be played by different entities, for example: MNOs, Hyperscalers, etc
+
+
+
+| Item | Description | Support Qualifier |
+|----|----|----|
+|Summary|Network operators offers a Multi-access Edge Computing platform in a given territory with several levels of abstraction being the Edge Cloud Zone the lowest one. Network operators offers a service through EdgeCloud APIs that permits application providers to deploy instances of an application in one or several Edge Cloud Zones, and to Applications Users the posibility to chose the most appropriate Edge Cloud Zone available at a given moment| M |
+|Pre-conditions|The AP has a resource usage agreement with the Operator Platform| M |
+|Begins when|The Application Provider (AP) invokes the Edge Application Management API to submit an application with references to obtain all needed data for their instantiation (container images or VM images and manifests describing required resources by an application)| M |
+|Step 1|The ESP stores the app information and returns an Id for reference (terminates with a notification to the AP if error)| M |
+|Step 2|The Application Provider (AP) request information of currently available Edge Cloud Zones and their status | M|
+|Step 3|The MNO provides the availables Edge Cloud Zones where the AP could instantiate the Application| M |
+|Step 4|The AP instantiates the application in one Edge Cloud Zone or in Severals| M|
+|Step 5|The ESP response to the AP appInstance created| M |
+|Step 6|The AP may request updated information of existing app instances of a given app. Possible status for app instantiation includes "ready" also information for endpoint info is provided for the app instance| O |
+|Step 7|App instance may provide service for end users | O |
+|Step 8|The AP request termination of one app instance (optionally all app instances in a given region) | M |
+|Step 9|The ESP validates the request (terminates with a notification to the UE if content is not valid e.g. given appId does not exist)| M|
+|Step 10|The ESP responds to the AP and starts the termination of the app instance, moving its status to terminating| M|
+|Ends when|The UC connects to the EAS| M |
+
+
+
+
+## Flow
+```mermaid
+sequenceDiagram
+ participant AP
+ participant MNO
+ participant ESP(Operator/Hyperscaler)
+
+ Note over AP,MNO: PRE App on device attached
to operator network
+ Note over AP,MNO: PRE App developer registered,
authenticated and authorised
+ Note over MNO,MNO: Edge Application Management API
+ AP->>ESP(Operator/Hyperscaler): POST/ AP Invokes Edge Application Management API to submit an application with references to obtain all needed data for their instantiation(appManifest)
+ ESP(Operator/Hyperscaler)->>AP: The Operator stores the app information and returns an Id for reference(appId)
+ alt app has a local mapping of server endpoints to Edge Cloud Zones
+ AP->>MNO: GET/edge-cloud-zones AP request information about available Edge cloud zones
+ MNO->>AP: Returns the name of the available Edge cloud zones for the Application
+ AP->>ESP(Operator/Hyperscaler):POST/ The AP request to instantiate the App in one or several Edge Clod Zones(Deployment).
+ ESP(Operator/Hyperscaler)->>AP:Returns the appInstance created
+ AP->>MNO: GET /app (appId) Information about app(appId) instantiated
+ MNO->>AP: Returns the application instance information
+ AP->>MNO: DELETE /app (appId) DELETE Running instance for a given appId.
+ alt delete only the instance related with the appId
+ MNO->>ESP(Operator/Hyperscaler): Delete instance
+ ESP(Operator/Hyperscaler)->>MNO: Instance deleted
+ MNO->>AP: Application instance deleted
+ end
+ end
+```
+
diff --git a/original/EdgeCloud/documentation/SupportingDocuments/API_Documentation/unotes/unotes_meta.json b/original/EdgeCloud/documentation/SupportingDocuments/API_Documentation/unotes/unotes_meta.json
new file mode 100644
index 0000000000000000000000000000000000000000..764820be8ef4d58c3a8b2af0a29d1ca64e838ad1
--- /dev/null
+++ b/original/EdgeCloud/documentation/SupportingDocuments/API_Documentation/unotes/unotes_meta.json
@@ -0,0 +1,8 @@
+{
+ "name": "",
+ "isOrdered": true,
+ "folders": {},
+ "files": {
+ "README": 0
+ }
+}
\ No newline at end of file
diff --git a/original/EdgeCloud/documentation/SupportingDocuments/EdgeCloud-Intents-and-API-Mapping-Harmonisation.md b/original/EdgeCloud/documentation/SupportingDocuments/EdgeCloud-Intents-and-API-Mapping-Harmonisation.md
new file mode 100644
index 0000000000000000000000000000000000000000..7145de5aa55ad87d6f205ea41afd9c52eebf242d
--- /dev/null
+++ b/original/EdgeCloud/documentation/SupportingDocuments/EdgeCloud-Intents-and-API-Mapping-Harmonisation.md
@@ -0,0 +1,183 @@
+# Edge Cloud Intents and API Mapping – Harmonisation Document
+
+_This document is based on the [CAMARA Commonalities template for User Stories](https://github.com/camaraproject/Commonalities/blob/main/documentation/Userstory-template.md) and references ITU-T Cloud Reference Architecture roles._
+
+---
+
+## 1. Summary
+
+This document provides a harmonised view of **EdgeCloud Intents** and their corresponding **CAMARA APIs**, consolidating the functional flow across discovery, deployment, runtime, and termination stages of the **Edge Cloud lifecycle**.
+
+The purpose is to bridge earlier MEC & Deployment API proposals with the current **CAMARA Edge Cloud family of APIs**, ensuring a unified lifecycle from **Zone discovery** to **Application endpoint registration and discovery**.
+
+---
+
+## 2. Objectives
+
+- To define the **intents** supporting the lifecycle of Edge-hosted applications.
+- To map these intents to existing and emerging **CAMARA APIs**.
+- To support interoperability between **Operator Platforms** and **Application Providers**.
+- To prepare the foundation for future harmonisation across **Edge, Application Management, and Network APIs** (e.g., Traffic Influence).
+
+---
+
+## 3. Roles, Actors, and Scope
+
+| Actor | Role | Scope |
+|-------|------|-------|
+| Application Provider (AP) | API Consumer | API requester, deploys applications and manages instances. |
+| Operator Platform (OP) | Edge Cloud Provider | API publisher, orchestrates resources and exposes APIs. |
+| Edge Infrastructure Provider (EIP) | Edge Cloud Provider | Hosts and manages the physical/virtual infrastructure. |
+| End User (UE) | Service Consumer | Interacts with applications hosted at the edge. |
+
+> Note: Edge Cloud Provider may be the Operator or a Hyperscaler.
+
+---
+
+## 4. EdgeCloud Lifecycle Intents Overview
+
+| **Intent ID** | **Intent Name** | **Purpose / Description** | **Mapped CAMARA API / Status** |
+|---------------|----------------|----------------------------|--------------------------------|
+| **Intent 1** | Discover EdgeCloud Zones | Discover the closest Edge Cloud Zone to a user device based purely on network topology (shortest network path). | `Simple Edge Discovery API` |
+| **Intent 2** | List Available Regions / Capabilities | Discover the best Edge Cloud Zone for an application, considering compute, storage, and network performance requirements beyond distance. | Planned extension of Optimal Edge Discovery |
+| **Intent 3** | Retrieve Zone Information | Obtain metadata, KPIs, and current resource availability of a specific Edge Cloud Zone. | `Simple Edge Discovery API` |
+| **Intent 4** | Filter / Select Preferred Zones | Apply filters (latency, region) for optimal zone selection. | Planned enhancement within Optimal Edge Discovery |
+| **Intent 5** | Register / Onboard Application | Upload manifests, metadata, and container images. | `Edge Cloud Lifecycle Management API` |
+| **Intent 6** | Validate Application Metadata | Validate manifests and dependencies before deployment. | Partially covered by Lifecycle Management |
+| **Intent 7** | Instantiate Application | Deploy application instances in selected Edge Zones. | `Edge Cloud Lifecycle Management API` |
+| **Intent 8** | Scale Application Instance | Adjust resources dynamically (horizontal/vertical). | Future – EdgeCloud Scaling API (proposed) |
+| **Intent 9** | Register Application Endpoints | Register deployed app endpoints (URLs, ports, zones). | `Application Endpoint Registration API` |
+| **Intent 10** | Update Endpoint Metadata | Modify endpoint details (status, performance). | Within `Application Endpoint Registration API` |
+| **Intent 11** | Discover Optimal Application Endpoints | Find best endpoint for a device based on latency or policy. | `Application Endpoint Discovery API` |
+| **Intent 12** | Client-Side Endpoint Selection | Allow clients to select among multiple available endpoints. | Optional behaviour of Endpoint Discovery |
+| **Intent 13** | Influence Network Traffic | Apply routing rules for premium users or optimisation. | `Traffic Influence API` |
+| **Intent 14** | Configure Network Policies | Manage slicing/routing preferences for traffic flows. | Evolution of Traffic Influence |
+| **Intent 15** | Monitor Application Performance | Retrieve runtime telemetry: latency, usage, etc. | SessionInsights API |
+| **Intent 16** | Retrieve Edge Metrics / Zone Health | Query Edge Zone health and operational metrics. | Under discussion – EdgeCloud Monitoring API |
+| **Intent 17** | Automate Policy or Scaling Actions | Enable closed-loop orchestration and scaling triggers. | Future – Edge Orchestration Intent API |
+| **Intent 18** | Terminate Application | Decommission instances and release resources. | `Edge Cloud Lifecycle Management API` |
+| **Intent 19** | Deregister Application Endpoints | Remove obsolete endpoints from registry. | `Application Endpoint Registration API` |
+| **Intent 20** | Audit and Logging | Track API operations, logs, and service usage. | Commonalities Cross-API Logging proposal |
+| **Intent 21** | Federated Edge Discovery | Discover edge zones from partner operators/hyperscalers. | Proposed – Edge Federation Discovery API |
+| **Intent 22** | Cross-Operator Application Placement | Deploy app instances across federated networks. | Future CAMARA/GSMA initiative |
+| **Intent 23** | Consent and Policy Management | Manage end-user consent during discovery/exposure. | Privacy & Consent WG |
+| **Intent 24** | Service Quality Enforcement | Apply QoS constraints dynamically per application. | Future – Edge QoS Policy API |
+| **Intent 25** | Edge Resource Reservation / Pre-Booking | Reserve compute/storage/network capacity pre-deployment. | Proposed – Edge Reservation API |
+
+---
+
+
+## 5. Harmonised EdgeCloud Lifecycle Flow
+
+```mermaid
+flowchart LR
+ A[Intent 1: Discover Edge Zones] --> B[Intent 3: Retrieve Zone Info]
+ B --> C[Intent 5: Register Application]
+ C --> D[Intent 7: Instantiate Application]
+ D --> E[Intent 9: Register Application Endpoints]
+ E --> F[Intent 11: Discover Optimal Endpoints]
+ F --> G[Intent 13: Apply Traffic Influence - optional]
+ G --> H[Intent 18: Terminate Application]
+```
+```mermaid
+sequenceDiagram
+ participant AP as Application Provider
+ participant OP as Operator Platform
+ participant EIP as Edge Infrastructure Provider
+ participant UE as User Equipment
+ participant AF as Application Function
+
+ Note over AP,OP: Phase 1 - Discovery
+ AP->>OP: POST /discover-optimal-edge-zones
+ OP-->>AP: EdgeCloudZone list ordered by proximity
+
+ Note over AP,OP: Phase 2 - Provisioning & Deployment
+ AP->>OP: POST /applications (Onboard Application)
+ OP-->>AP: Returns appId
+ AP->>OP: POST /applications/{appId}/instances
+ OP->>EIP: Instantiate app in target Edge Zone
+ EIP-->>OP: Instance ready
+ OP-->>AP: appInstanceId + status "RUNNING"
+
+ Note over AP,OP: Phase 3 - Endpoint Management
+ AP->>OP: POST /register (Application Endpoint)
+ OP-->>AP: endpointId confirmation
+
+ Note over UE,OP: Phase 4 - Runtime & Discovery
+ UE->>OP: POST /retrieve-optimal-app-endpoints {appId, device}
+ OP-->>UE: Returns optimal endpoint (EdgeCloudZoneId, endpointURL)
+
+ Note over AF,OP: Phase 5 - Network Optimisation
+ AF->>OP: POST /traffic-influence (toward EAS)
+ OP-->>AF: Returns routing configuration ID
+ UE->>EIP: Connect to optimal EAS endpoint
+```
+# CAMARA EdgeCloud Harmonisation Analysis
+
+## 7. Harmonisation Analysis
+
+### 7.1 API Relationship Summary
+
+- **Simple Edge Discovery**: Provides baseline nearest-zone discovery using network proximity.
+- **Optimal Edge Discovery**: Extends discovery with richer metadata (zone characteristics, latency, region).
+- **Edge Application Management**: Enables deployment and lifecycle control of applications in these zones.
+- **Application Endpoint Registration**: Establishes registry of deployed endpoints.
+- **Application Endpoint Discovery**: Allows clients or servers to dynamically retrieve optimal endpoints.
+- **Traffic Influence**: Complements discovery and lifecycle by providing routing enforcement at the network level.
+
+### 7.2 Common Design Principles
+
+- **Entity Alignment**: Shared objects (e.g., `edgeCloudZoneId`, `appId`, `endpointId`) across all APIs.
+- **Security Consistency**: All APIs assume OAuth2-based access with clear roles.
+- **Consent Integration**: Optional per API (explicit in Discovery and Endpoint APIs).
+- **Operator Neutrality**: APIs work across multiple operators via federated exposure models.
+
+**Conclusion**: CAMARA EdgeCloud APIs collectively address all intents from earlier MEC proposals, forming a continuous lifecycle from discovery → provisioning → runtime → termination.
+
+## 8. Harmonised Data Model Overview
+
+| Entity | Description | Referenced In |
+|--------|-------------|---------------|
+| `edgeCloudZoneId` | Identifier of Edge Cloud Zone | Discovery, Lifecycle, Endpoint APIs |
+| `appId` | Unique application identifier | Lifecycle, Endpoint Discovery |
+| `appInstanceId` | Deployed instance ID | Lifecycle API |
+| `endpointId` | Registered endpoint for a deployed instance | Endpoint Registration & Discovery |
+| `deviceId` | Device identifier or token | Discovery and Endpoint Discovery APIs |
+| `trafficInfluenceId` | Identifier for a network routing session | Traffic Influence API |
+
+## 9. Inter-API Dependencies
+
+| API | Depends On | Dependency Description |
+|-----|------------|------------------------|
+| Simple Edge Discovery | None | Can be used standalone for planning |
+| Optimal Edge Discovery | None | Can be used standalone for planning |
+| Edge Application Management | Optimal Edge Discovery | Uses discovered zones for deployment decisions |
+| Application Endpoint Registration | Edge Cloud Lifecycle Management | Registers endpoints of instantiated applications |
+| Application Endpoint Discovery | Endpoint Registration | Discovers registered endpoints |
+| Traffic Influence | Endpoint Discovery | Optimises routing to discovered endpoints |
+
+**Harmonised APIs together enable a complete closed loop**:
+Discovery → Deployment → Registration → Discovery (endpoint) → Influence → Termination.
+
+## 10. Open Harmonisation Topics
+
+| Area | Description | Next Step |
+|------|-------------|-----------|
+| Unified Discovery Schema | Align Simple and Optimal Edge Discovery response objects | Define a shared `EdgeCloudZoneInfo` schema |
+| Cross-API Security Scopes | Establish unified OAuth2 roles and scopes | Coordinate with Commonalities WG |
+| Consent Management | Define consistent consent-handling process across Discovery and Endpoint APIs | Align with Privacy & Consent WG |
+| Federated Operations | Support discovery and lifecycle across multi-operator environments | Introduce Edge Federation API concept |
+| Traffic Policy Automation | Enable dynamic network steering based on real-time metrics | Collaborate with Network API group |
+
+## 11. References
+
+- **CAMARA – Simple Edge Discovery API**: [User Story](https://github.com/camaraproject/SimpleEdgeDiscovery/blob/main/documentation/API_documentation/SimpleEdgeDiscovery_User_Story.md)
+- **CAMARA – Optimal Edge Discovery API**: [User Story](https://github.com/camaraproject/OptimalEdgeDiscovery/blob/main/documentation/API_documentation/optimal-edge-discovery-User-Story.md)
+- **CAMARA – Edge Application Management**: [User Story](https://github.com/camaraproject/EdgeCloud/blob/main/documentation/SupportingDocuments/API_Documentation/User%20Stories/Edge.Cloud.Lifecycle.Management.User.Story.md)
+- **CAMARA – Application Endpoint Registration API**: [User Story](https://github.com/camaraproject/ApplicationEndpointRegistration/blob/main/documentation/API_documentation/application-endpoint-registration-User-Story.md)
+- **CAMARA – Application Endpoint Discovery API**: [User Story](https://github.com/camaraproject/ApplicationEndpointDiscovery/blob/main/documentation/SupportingDocuments/API_Documentation/User%20Stories/Application%20Endpoint%20Discovery%20User%20Story.md)
+- **CAMARA – Traffic Influence API**: [User Story](https://github.com/camaraproject/TrafficInfluence/blob/main/documentation/API_documentation/traffic-influence-user-story-use-case-1.md)
+- **GSMA – Open Gateway & CAMARA Harmonisation Framework**: [Reference](https://www.hcltech.com/sites/default/files/documents/resources/whitepaper/files/2024/09/16/gsma-open-gateway.pdf?utm_source=chatgpt.com)
+
+
+
diff --git a/original/EdgeCloud/documentation/SupportingDocuments/README.MD b/original/EdgeCloud/documentation/SupportingDocuments/README.MD
new file mode 100644
index 0000000000000000000000000000000000000000..f71c2a667b84b38512f5893a2240aef980329112
--- /dev/null
+++ b/original/EdgeCloud/documentation/SupportingDocuments/README.MD
@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.
diff --git a/original/EnergyFootprintNotification/README.md b/original/EnergyFootprintNotification/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..8a7ccff6dab931f82341e96600e2878b62c53d26
--- /dev/null
+++ b/original/EnergyFootprintNotification/README.md
@@ -0,0 +1,53 @@
+
+
API Provider: role of EFN API provider
• Operator Platform ([EdgeCloud/documentation/SupportingDocuments/Edge terminology/edge_terminology.md at main · camaraproject/EdgeCloud](https://github.com/camaraproject/EdgeCloud/blob/main/documentation/SupportingDocuments/Edge%20terminology/edge_terminology.md)): role of Service host
• End User: both Teclo Operator's subscribers and Service Provider customer, role of Service consumer
• Scope: Computing Services (OGW Taxonomy)| M |
+|NF Requirements|NA| O |
+|Pre-conditions|• The Service Provider onboarded applications on the Operator Platform
• The Service Provider requested the deployment of some instances of those applications
• The Service Provider identifies the Services as collection of application instances
• The Service provided by those instances is up and running.
• The End Users are consuming the Service| M |
+|Begins when|The API Consumer invokes the EFN API to get the Energy consumption of the Service, composed by a set of application instances, in a specific time period.| M |
+|Step 2|The API Provider returns the overall Energy consumption of the Service in that specific time period.| M|
+|Step 4|The API Consumer invokes the EFN API to get the Carbon footprint of the Service, composed by a set of application instances, in a specific time period.| M |
+|Step 5|The API Provider returns the Carbon footprint of the Service in that specific time period.| M|
+|Post-conditions|The Service Provider is aware of the Energy consumption and of the Carbon footprint of the Service in the selected time periods| M |
diff --git a/original/EnergyFootprintNotification/documentation/API_documentation/README.MD b/original/EnergyFootprintNotification/documentation/API_documentation/README.MD
new file mode 100644
index 0000000000000000000000000000000000000000..f71c2a667b84b38512f5893a2240aef980329112
--- /dev/null
+++ b/original/EnergyFootprintNotification/documentation/API_documentation/README.MD
@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.
diff --git a/original/EnergyFootprintNotification/documentation/API_documentation/energy-footprint-API-Readiness-Checklist.md b/original/EnergyFootprintNotification/documentation/API_documentation/energy-footprint-API-Readiness-Checklist.md
new file mode 100644
index 0000000000000000000000000000000000000000..ced5257eb6d2b032dfb49925533c19a0f815fe49
--- /dev/null
+++ b/original/EnergyFootprintNotification/documentation/API_documentation/energy-footprint-API-Readiness-Checklist.md
@@ -0,0 +1,28 @@
+
+
+# API Readiness Checklist
+
+Checklist for API energy-footprint-notification 0.1.0 in r1.3
+
+
+
+| Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----|
+| 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/energy_footprint_notification.yaml) |
+| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3) |
+| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3) |
+| 4 | API versioning convention applied | M | M | M | M | Y | 0.1.0 |
+| 5 | API documentation | M | M | M | M | Y | inline in YAML |
+| 6 | User stories | O | O | O | M | Y | [link](/documentation/API_documentation/EFN_UserStory_UseCase_1.md) |
+| 7 | Basic API test cases & documentation | O | M | M | M | Y | [Test-EC](/code/Test_definitions/energy-footprint-notification-calculateEnergyConsumption.feature), [Test-CF](/code/Test_definitions/energy-footprint-notification-calculateCarbonFootprint.feature) |
+| 8 | Enhanced API test cases & documentation | O | O | O | M | N | |
+| 9 | Test result statement | O | O | O | M | N | |
+| 10 | API release numbering convention applied | M | M | M | M | Y | r1.3 |
+| 11 | Change log updated | M | M | M | M | Y | |
+| 12 | Previous public-release was certified | O | O | O | M | N | |
+| 13 | API description (for marketing) | O | O | M | M | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/81101707/EnergyFootprintNotification+API+description) |
+
+
+
+
+
diff --git a/original/EnergyFootprintNotification/documentation/SupportingDocuments/README.MD b/original/EnergyFootprintNotification/documentation/SupportingDocuments/README.MD
new file mode 100644
index 0000000000000000000000000000000000000000..f71c2a667b84b38512f5893a2240aef980329112
--- /dev/null
+++ b/original/EnergyFootprintNotification/documentation/SupportingDocuments/README.MD
@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.
diff --git a/original/HighThroughputElasticNetworks/README.md b/original/HighThroughputElasticNetworks/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..dd64bda19a35ea02830e637b4e39aab7b6f5f64d
--- /dev/null
+++ b/original/HighThroughputElasticNetworks/README.md
@@ -0,0 +1,39 @@
+
+
This API is designed for large enterprises requiring efficient network bandwidth management. It dynamically adjusts and optimizes bandwidth utilization to handle high-volume data transmission scenarios such as video conferences, large file transfers, and cloud resource access. By leveraging advanced technologies, it ensures seamless and efficient data flow across different time periods. This API is ideal for organizations that need robust solutions to manage substantial data transfers, ensuring high performance and reliability in demanding network environments.
This API is suitable for customers in industries with massive data transfer requirements, such as Cross-cloud backup, model training at intelligent compute centers, video editing, and scientific computing. For example, the Five-hundred-meter Aperture Spherical radio Telescope (FAST), located in GuiZhou province of China, could generate more than 10 PB of observational data per year. By calling this API, users can dynamically adjust bandwidth and elastically orchestrate network resources according to their specific requirements for bandwidth, latency, and file size. This capability facilitates the efficient and expedient transmission of large observational datasets within short timeframes. In subsequent applications of the API, developers can set multiple groups of input parameters as standard configuration files, enabling quick selection and application.
Input:
1. Bandwidth Requirement: Time-segmented bandwidth requirements (can include multiple time points)
2. Bandwidth Requirement Type: Upload bandwidth, download bandwidth, two-way bandwidth Service
3. Latency Requirement: Latency guarantee requirement range
4. File Requirements: Size of files to be transmitted
5. Guarantee Requirements: Bandwidth guarantee and load sharing requirements
Output:
1. Success or failure
2. Estimation of transmission rate by time segment
3. Estimated transmission duration,
4. Statistical conclusions after successful transmission1. Estimation of transmission rate by time segment
5. (optional) any conditions required for the operator to meet the request (e.g. a particular entry point to the network must be used).
+* Describe, develop, document, and test the APIs
+* Started: November 2024
+
+
+
+
+## Release Information
+
+The repository has no (pre)releases yet, work in progress is within the main branch.
+
+
+## Contributing
+* Meetings are held virtually
+ * Schedule: !! tbd
+ * [Registration / Join](https://wiki.camaraproject.org/x/TQAG) !! Update this link with your meeting registration/join link
+ * Minutes: Access [meeting minutes] !! update this link to your wiki page using the "Share" link
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project
+
public | stable
public | Status | Comments |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----|
+| 1 | API definition | M | M | M | M | Y | [home-devices-qod.yaml](/code/API_definitions/home-devices-qod.yaml) |
+| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | |
+| 3 | Guidelines from ICM applied | O | M | M | M | Y | |
+| 4 | API versioning convention applied | M | M | M | M | Y | |
+| 5 | API documentation | M | M | M | M | Y | Embedded in [API definition](/code/API_definitions/home-devices-qod.yaml) |
+| 6 | User stories | O | O | O | M | Y | [home-devices-qod-User-Stories.md](/documentation/API_documentation/home-devices-qod-User-Stories.md) |
+| 7 | Basic API test cases & documentation | O | M | M | M | Y | [home-devices-qod.feature](/code/Test_definitions/home-devices-qod.feature) |
+| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [home-devices-qod.feature](/code/Test_definitions/home-devices-qod.feature) |
+| 9 | Test result statement | O | O | O | M | N | |
+| 10 | API release numbering convention applied | M | M | M | M | Y | |
+| 11 | Change log updated | M | M | M | M | Y | [CHANGELOG.md](/CHANGELOG.md) |
+| 12 | Previous public release was certified | O | O | O | M | | |
+| 13 | API description (for marketing) | O | O | M | M | | [wiki link](https://lf-camaraproject.atlassian.net/wiki/xxx) |
+
+To fill the checklist:
+- in the line above the table, replace the api-name, api-version and the rx.y by their actual values for the current API version and release.
+- in the Status column, put "Y" (yes) if the release asset is available or fulfilled in the current release, a "N" (no) or a "tbd". Example use of "tbd" is in case an alpha or release-candidate API version does not yet provide all mandatory assets for the release.
+- in the Comments column, provide the link to the asset once available, and any other relevant comments.
+
+Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.
+
+The documentation for the content of the checklist is here: [API Readiness Checklist](https://wiki.camaraproject.org/x/HQBFAQ)
diff --git a/original/HomeDevicesQoD/documentation/API_documentation/home-devices-qod-User-Stories.md b/original/HomeDevicesQoD/documentation/API_documentation/home-devices-qod-User-Stories.md
new file mode 100644
index 0000000000000000000000000000000000000000..19ed9e19e7a054d14b78c6e402a0fc84a825e22e
--- /dev/null
+++ b/original/HomeDevicesQoD/documentation/API_documentation/home-devices-qod-User-Stories.md
@@ -0,0 +1,11 @@
+**User Story: Configure traffic profile (DSCP)**
+
+
+| **Item** | **Details** |
+| ---- | ------- |
+| ***Summary*** | As an application developer belonging to an enterprise, I want to request (using my application server/backend service) specific QoS behaviours (service classes) to be configured at my end-user's home WiFi access point to ensure the required quality of experience I need for my service/app. |
+| ***Roles, Actors and Scope*** | **Roles:** Customer:User
**Actors:** Application service providers, hyperscalers, application developers.
**Scope:** Configure QoS behaviours to ensure needed quality of experience for a given device within a residential LAN. The expected behaviour is that the target device is the same device where the app is running. |
+| ***Pre-conditions*** |The preconditions are listed below:
|
+| ***Activities/Steps*** | **Starts when:** The server/backend service calls the API specifying the service class required and the target device.
**Ends when:** The requested QoS behaviour (service class) has been configured and the server/backend has being informed about it.
|
+| ***Post-conditions*** | Service class is applied and customer (application developer) app/service continues.
Note that default QoS behaviour could be restored on back-end side at a given frequency (e.g. daily) or on demand by customer doing another call to the API.|
+| ***Exceptions*** | Several exceptions might occur during the Home Devices QoD API operations
|
diff --git a/original/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2022-11-17.md b/original/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2022-11-17.md
new file mode 100644
index 0000000000000000000000000000000000000000..6cccf4217734933ff7155f97d4734f6a55194b25
--- /dev/null
+++ b/original/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2022-11-17.md
@@ -0,0 +1,41 @@
+# Camara Home Devices QoD meeting
+
+*17/11/2022*
+
+## Attendees
+
+* Jesús Peña (Telefonica)
+* Josue Igual (Telefonica)
+* Eber Augusto (Telefonica)
+* Mona Mokhber (Telefonica)
+* Anne Matthieu (Orange)
+* Flury Thibaud (Orange)
+* Robert Ludovic (Orange)
+
+Home Devices QoD minutes: [https://github.com/camaraproject/HomeDevicesQoD/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/HomeDevicesQoD/tree/main/documentation/MeetingMinutes)
+
+## Agenda
+
+* Kick-off follow-up meetings
+* Recap & Recent Updates
+* Housekeeping
+* Update on issues
+* AOB
+
+## Discussion
+
+| Agenda Item | Description |
+| ----------- | ------------|
+| **Kick-off** | |
+| | Telefonica provides a general view of the API value proposition and a general review of the API YAML definition already uploaded to the github repository. Waiting feedback from partners |
+| **Recap & Recent Updates** | |
+| |
|
+| **Housekeeping** | |
+| | Mailinglist: Please subscribe if not yet done to the mailinglist of the subproject here: [https://lists.camaraproject.org/g/sp-hdp](https://lists.camaraproject.org/g/sp-hdp)
The list will be used for invitations and discussions between members of the sub project. The address is: sp-hdp@lists.camaraproject.org |
+| **Open Issues** | |
+| | [#2](https://github.com/camaraproject/HomeDevicesQoD/issues/2) Pending API update related to CAMARA commonalities issue [#101](https://github.com/camaraproject/WorkingGroups/issues/101). API design would include an anonymised ID is it is eventually agreed on the corresponding CAMARA Commonalities track. |
+| | [#3](https://github.com/camaraproject/HomeDevicesQoD/issues/3) Maintainers. Is anyone interested in joining the maintainers group? In case you are, please comment on this issue.
+Issues: [https://github.com/camaraproject/HomeDevicesQoD/issues](https://github.com/camaraproject/HomeDevicesQoD/issues)
+Pull Requests: [https://github.com/camaraproject/HomeDevicesQoD/pulls](https://github.com/camaraproject/HomeDevicesQoD/pulls)
+
+## Discussion Items
+
+| Agenda Item | Description |
+| ----------- | ------------|
+| **Recap/Updates** | |
+| |
|
+| **New Issues** | |
+| | N/A |
+| **AOB** | |
+| |
The list will be used for invitations and discussions between members of the sub project. The address is: sp-hdp@lists.camaraproject.org |
+| **Open Issues** | |
+| | [#2](https://github.com/camaraproject/HomeDevicesQoD/issues/2) Pending API update related to CAMARA commonalities issue [#101](https://github.com/camaraproject/WorkingGroups/issues/101). API design would include an anonymised ID is it is eventually agreed on the corresponding CAMARA Commonalities track. |
+| | [#3](https://github.com/camaraproject/HomeDevicesQoD/issues/3) Maintainers. Is anyone interested in joining the maintainers group? In case you are, please comment on this issue.
+Issues: [https://github.com/camaraproject/HomeDevicesQoD/issues](https://github.com/camaraproject/HomeDevicesQoD/issues)
+Pull Requests: [https://github.com/camaraproject/HomeDevicesQoD/pulls](https://github.com/camaraproject/HomeDevicesQoD/pulls)
+
+## Discussion Items
+
+| Agenda Item | Description |
+| ----------- | ------------|
+| **Recap/Updates** | |
+| |
|
+| **AOB** | |
+| |
The list will be used for invitations and discussions between members of the sub project. The address is: sp-hdp@lists.camaraproject.org |
+| **Open Issues** | |
+| | [#2](https://github.com/camaraproject/HomeDevicesQoD/issues/2) Pending API update related to CAMARA commonalities issue [#101](https://github.com/camaraproject/WorkingGroups/issues/101). API design would include an anonymised ID is it is eventually agreed on the corresponding CAMARA Commonalities track. |
+| | [#3](https://github.com/camaraproject/HomeDevicesQoD/issues/3) Maintainers. Is anyone interested in joining the maintainers group? In case you are, please comment on this issue.
Comments received from Orange (Robert Ludovic) already answered in the PR itself. It has been agreed to include [some additional clarifications](https://github.com/camaraproject/HomeDevicesQoD/pull/10#issuecomment-1333796244) in the user story doc before merge it. |
+| **AOB** | |
+| | Next Home Devices QoD community call on Dic 15th, UTC 16:00, CET 17:00 (Dic 8th is bank holiday in Spain) |
+
+## Next Steps
+
+* TEF to update PR [#10](https://github.com/camaraproject/HomeDevicesQoD/pull/10) with agreed changes.
diff --git a/original/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2023-01-12.md b/original/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2023-01-12.md
new file mode 100644
index 0000000000000000000000000000000000000000..f8f805071751025e68efa834b8044b96d179416d
--- /dev/null
+++ b/original/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2023-01-12.md
@@ -0,0 +1,56 @@
+# Camara Home Devices QoD meeting
+
+## Meeting Information
+
+> Meeting Date: 12/01/2023
+
+### Attendees
+
+* Jesús Peña (Telefonica)
+* Emilio Abraham Garrido García (Telefonica)
+* Eber Marins (Telefonica)
+* Christian Duran Gonzalez (Telefonica)
+* Robert Ludovic (Orange)
+* Rafal Artych (DT)
+
+### Agenda
+
+* Recap & Recent Updates
+* Update on issues
+* AOB
+
+Home Devices QoD minutes link:
+[https://github.com/camaraproject/HomeDevicesQoD/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/HomeDevicesQoD/tree/main/documentation/MeetingMinutes)
+
+## Discussion Items
+
+- Repo: [https://github.com/camaraproject/HomeDevicesQoD](https://github.com/camaraproject/HomeDevicesQoD)
+- Issues: [https://github.com/camaraproject/HomeDevicesQoD/issues](https://github.com/camaraproject/HomeDevicesQoD/issues)
+- Pull Requests: [https://github.com/camaraproject/HomeDevicesQoD/pulls](https://github.com/camaraproject/HomeDevicesQoD/pulls)
+
+
+| Agenda Item | Description |
+| ----------- | ------------|
+| **Recap/Updates** | |
+| |
API design would include an anonymised ID is it is eventually agreed on the corresponding CAMARA Commonalities track. |
+| | [#3](https://github.com/camaraproject/HomeDevicesQoD/issues/3) Maintainers.
To be CLOSED as soon DT contact/s are 100% confirmed.
|
+| | [#8](https://github.com/camaraproject/HomeDevicesQoD/issues/8) ~~Aligment with API Design Guidelines Commonality.~~
CLOSED. Addressed in PR [#13](https://github.com/camaraproject/HomeDevicesQoD/pull/13) already MERGED (which replaced PR [#7](https://github.com/camaraproject/HomeDevicesQoD/pull/7)).
|
+| | [#9](https://github.com/camaraproject/HomeDevicesQoD/issues/9) ~~Upload first version of user stories doc in API documentation~~
CLOSED. Addressed in PR [#10](https://github.com/camaraproject/HomeDevicesQoD/pull/10) already MERGED. |
+| **New Issues** | |
+| | [#16](https://github.com/camaraproject/HomeDevicesQoD/issues/16) ~~Upload first version of API documentation~~
CLOSED. Addressed in PR [#15](https://github.com/camaraproject/HomeDevicesQoD/pull/15) already MERGED. |
+| **AOB** | |
+| |
+
+> Mailinglist:
Please subscribe if not yet done to the mailing list of the subproject here: [https://lists.camaraproject.org/g/sp-hdp](https://lists.camaraproject.org/g/sp-hdp)
The list will be used for invitations and discussions between members of the sub project. The address is: sp-hdp@lists.camaraproject.org
\ No newline at end of file
diff --git a/original/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2023-01-19.md b/original/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2023-01-19.md
new file mode 100644
index 0000000000000000000000000000000000000000..4ae47803d9e537e3771dc4a2959b3ff02d51e296
--- /dev/null
+++ b/original/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2023-01-19.md
@@ -0,0 +1,52 @@
+# Camara Home Devices QoD meeting
+
+## Meeting Information
+
+> Meeting Date: 19/01/2023
+
+### Attendees
+
+* Jesús Peña (Telefonica)
+* Emilio Abraham Garrido García (Telefonica)
+* Eber Marins (Telefonica)
+* Christian Duran Gonzalez (Telefonica)
+* Rafal Artych (DT)
+
+### Agenda
+
+* Recap & Recent Updates
+* Update on issues
+* AOB
+
+Home Devices QoD minutes link:
+[https://github.com/camaraproject/HomeDevicesQoD/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/HomeDevicesQoD/tree/main/documentation/MeetingMinutes)
+
+## Discussion Items
+
+- Repo: [https://github.com/camaraproject/HomeDevicesQoD](https://github.com/camaraproject/HomeDevicesQoD)
+- Issues: [https://github.com/camaraproject/HomeDevicesQoD/issues](https://github.com/camaraproject/HomeDevicesQoD/issues)
+- Pull Requests: [https://github.com/camaraproject/HomeDevicesQoD/pulls](https://github.com/camaraproject/HomeDevicesQoD/pulls)
+
+
+| Agenda Item | Description |
+| ----------- | ------------|
+| **Recap/Updates** | |
+| |
CLOSED. The corresponding CAMARA Commonalities track has been closed with some agreements but not a unique traversal solution. Each API we work on will need to consider additional requirements (if any) to decide which identifiers makes the most sense. So far, in case of Home Devices QoD current definition, it's assumed user authentication (3-legged token). And the user and home network information are deducted from the information included in the access token. There is no user identifier filed included in the API request body. |
+| | [#3](https://github.com/camaraproject/HomeDevicesQoD/issues/3) Maintainers.
To be CLOSED as soon DT contact/s are 100% confirmed.
Working with Noel Wirzius to get technical contact/s from DT and to get them involved in github project and API design. He was expected to provide information during this days. Still no confirmation received from him. So far Rafal Artych (representing DT) is joining weekly calls. He has confirmed that he is speaking with Noel already and next week they hope to be able to confirm who the contact person/s will be. |
+| **New Issues** | |
+| | [#18](https://github.com/camaraproject/HomeDevicesQoD/issues/18) Update API documentation according to v0.2.0 API version
Being addressed in PR [#19](https://github.com/camaraproject/HomeDevicesQoD/pull/19). Updates included so far corresponds to:
|
+| | [#20](https://github.com/camaraproject/HomeDevicesQoD/issues/20) Update commonalities glossary with HomeDevicesQoD-subproject relevant terms
It is related to Commonalities issue [#120](https://github.com/camaraproject/WorkingGroups/pull/120).
+
+> Mailinglist:
Please subscribe if not yet done to the mailing list of the subproject here: [https://lists.camaraproject.org/g/sp-hdp](https://lists.camaraproject.org/g/sp-hdp)
The list will be used for invitations and discussions between members of the sub project. The address is: sp-hdp@lists.camaraproject.org
\ No newline at end of file
diff --git a/original/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2023-02-02.md b/original/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2023-02-02.md
new file mode 100644
index 0000000000000000000000000000000000000000..56fbcac8e80cb350e3ed3ce5883008c251778285
--- /dev/null
+++ b/original/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2023-02-02.md
@@ -0,0 +1,51 @@
+# Camara Home Devices QoD meeting
+
+## Meeting Information
+
+> Meeting Date: 02/02/2023
+
+### Attendees
+
+* Jesús Peña (Telefonica)
+* Emilio Abraham Garrido García (Telefonica)
+* Rafal Artych (DT)
+* "Mike" - Mihai Lazar (DELL)
+* Vaishali Gupta (DELL)
+
+### Agenda
+
+* Recap & Recent Updates
+* Update on issues
+* AOB
+
+Home Devices QoD minutes link:
+[https://github.com/camaraproject/HomeDevicesQoD/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/HomeDevicesQoD/tree/main/documentation/MeetingMinutes)
+
+## Discussion Items
+
+- Repo: [https://github.com/camaraproject/HomeDevicesQoD](https://github.com/camaraproject/HomeDevicesQoD)
+- Issues: [https://github.com/camaraproject/HomeDevicesQoD/issues](https://github.com/camaraproject/HomeDevicesQoD/issues)
+- Pull Requests: [https://github.com/camaraproject/HomeDevicesQoD/pulls](https://github.com/camaraproject/HomeDevicesQoD/pulls)
+
+
+| Agenda Item | Description |
+| ----------- | ------------|
+| **Recap/Updates** | |
+| |
To be CLOSED as soon DT contact/s are 100% confirmed.
Rafal can't confirm when the DT contact person(s) will be defined. He suggests to bring it up in the next SteerCo (next week). For the moment he will join the calls and keep the lights on. |
+| | [#18](https://github.com/camaraproject/HomeDevicesQoD/issues/18) Update API documentation according to v0.2.0 API version
Being addressed in PR [#19](https://github.com/camaraproject/HomeDevicesQoD/pull/19). Updates included so far corresponds to:
No further changes included last two weeks. |
+| | [#20](https://github.com/camaraproject/HomeDevicesQoD/issues/20) Update commonalities glossary with HomeDevicesQoD-subproject relevant terms
It is related to Commonalities issue [#120](https://github.com/camaraproject/WorkingGroups/pull/120).
No updates on this one. Still not clear how it is going to be handled in CAMARA Commonalities.(*)_To be confirmed depending on the call frequency re-evaluation_
|
+
+
+## Next Steps
+
+* Get the feedback DT may have about uses cases and API design.
(*)_It will most likely have to wait until DT technical contact(s) are confirmed._
+
+
+
+> Mailinglist:
Please subscribe if not yet done to the mailing list of the subproject here: [https://lists.camaraproject.org/g/sp-hdp](https://lists.camaraproject.org/g/sp-hdp)
The list will be used for invitations and discussions between members of the sub project. The address is: sp-hdp@lists.camaraproject.org
\ No newline at end of file
diff --git a/original/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2023-02-15.md b/original/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2023-02-15.md
new file mode 100644
index 0000000000000000000000000000000000000000..dabd35b4acb4c054c9c33bbd003cb8e87de147e6
--- /dev/null
+++ b/original/HomeDevicesQoD/documentation/MeetingMinutes/MOM-2023-02-15.md
@@ -0,0 +1,53 @@
+# Camara Home Devices QoD meeting
+
+## Meeting Information
+
+> Meeting Date: 15/02/2023
+
+### Attendees
+
+* Jesús Peña (Telefonica)
+* Emilio Abraham Garrido García (Telefonica)
+* Eber Marins (Telefonica)
+* Christian Duran Gonzalez (Telefonica)
+* Rafal Artych (DT)
+* "Mike" - Mihai Lazar (DELL)
+
+### Agenda
+
+* Recap & Recent Updates
+* Update on issues
+* AOB
+
+Home Devices QoD minutes link:
+[https://github.com/camaraproject/HomeDevicesQoD/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/HomeDevicesQoD/tree/main/documentation/MeetingMinutes)
+
+## Discussion Items
+
+- Repo: [https://github.com/camaraproject/HomeDevicesQoD](https://github.com/camaraproject/HomeDevicesQoD)
+- Issues: [https://github.com/camaraproject/HomeDevicesQoD/issues](https://github.com/camaraproject/HomeDevicesQoD/issues)
+- Pull Requests: [https://github.com/camaraproject/HomeDevicesQoD/pulls](https://github.com/camaraproject/HomeDevicesQoD/pulls)
+
+
+| Agenda Item | Description |
+| ----------- | ------------|
+| **Recap/Updates** | |
+| |
To be CLOSED as soon DT contact/s are 100% confirmed.
Rafal has no news in the matter of DT's technical contacts. No news is expected until after the Mobile World Congress. |
+| | [#18](https://github.com/camaraproject/HomeDevicesQoD/issues/18) Update API documentation according to v0.2.0 API version
Being addressed in PR [#19](https://github.com/camaraproject/HomeDevicesQoD/pull/19). Updates included so far corresponds to:
No further changes included in last two weeks. |
+| | [#20](https://github.com/camaraproject/HomeDevicesQoD/issues/20) Update commonalities glossary with HomeDevicesQoD-subproject relevant terms
It is related to Commonalities issue [#120](https://github.com/camaraproject/WorkingGroups/pull/120).
No updates on this one. Still not clear how it is going to be handled in CAMARA Commonalities.
+
+
+
+
+
+
+
+
+# InHomeDeviceManagement
+
+Sandbox API Repository to describe, develop, document, and test the InHomeDeviceManagement Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/AQCxGw)
+
+## Scope
+
+* Service API(s) “InHomeDeviceManagement” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * §Short API scope description§ !! Add here a scope description according to the API proposal
+* Describe, develop, document, and test the API(s)
+* Started: January 2026
+
+
+
+
+
+## Release Information
+
+The repository has no (pre)releases yet, work in progress is within the main branch.
+
+
+
+## Contributing
+
+* Meetings are held virtually
+
+ * Schedule: !! tbd
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meetings/telcoapi) !! Update this link with your meeting registration/join link and delete the task
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/EACpGw)
+ * Subscribe / Unsubscribe to the mailing list
+
+
+
+
+
+
+
+
+# IoTDeviceManagement
+
+Sandbox API Repository to describe, develop, document, and test the IoT Device Management Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/boCeBQ)
+
+## Scope
+
+* Service API(s) “IoTDeviceManagement” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * manage communication functions, like activation and deactivation of voice, SMS, data services, and specific APNs, ensuring precise traffic control to prevent overload.
+ * manage device subscription state, perform operations such as adding, activating, suspending, restoring, deactivating, and deleting IoT cards.
+ * support real-time monitoring, provide visibility into the status of IoT cards, enabling continuous supervision and efficient control of service usage and status.
+* Describe, develop, document, and test the API(s)
+* Started: March 2025
+
+
+
+
+
+## Release Information
+
+The repository has no (pre)releases yet, work in progress is within the main branch.
+
+
+## Contributing
+
+* Meetings are held virtually
+ * Schedule: bi-weekly, Tuesday, 13:00 UTC
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/99489769217?password=b970b062-a3ef-4a58-95ed-2b15610d84fb)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/p4CgBQ)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list
+
+
+
+
+
+
+
+
+# IoTNetworkOptimization
+
+Sandbox API Repository to describe, develop, document, and test the IoTNetworkOptimization Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/AYCzBw)
+* [Provider Implementation](https://github.com/camaraproject/IoTNetworkOptimization_PI)
+
+## Scope
+
+* Service API(s) “IoTNetworkOptimization” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * activate network features for that specific fleet of IoT devices, e.g., energy saving features.
+* Describe, develop, document, and test the API(s)
+* Started: April 2025
+
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> This repository has only pre-release versions available yet. Pre-releases are for testing and may change before public release.
+
+* **PREVIEW**: The latest pre-release is [r1.1](https://github.com/camaraproject/IoTNetworkOptimization/releases/tag/r1.1) (alpha), with the following API versions:
+ * **iot-network-optimization v0.1.0-alpha.1**
+ [[YAML]](https://github.com/camaraproject/IoTNetworkOptimization/blob/r1.1/code/API_definitions/iot-network-optimization.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/IoTNetworkOptimization/r1.1/code/API_definitions/iot-network-optimization.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/IoTNetworkOptimization/r1.1/code/API_definitions/iot-network-optimization.yaml)
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/IoTNetworkOptimization/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings are held virtually
+
+ * Schedule: bi-weekly, Wednesday 10:00 AM - 11:00 AM UTC (12:00 PM -13:00 PM CEST): [wiki Calandar](https://zoom-lfx.platform.linuxfoundation.org/meetings/telcoapi?view=week)
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meetings/telcoapi) !! Update this link with your meeting registration/join link and delete the task
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/T4CzBw)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list
+
+
+
+
+
+
+
+
+# IoTSIMFraudPrevention
+
+Sandbox API Repository to describe, develop, document, and test the IoT SIM Fraud Prevention Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/xwKaBQ)
+
+## Scope
+
+* Service API(s) “IoTSIMFraudPrevention” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * manage device-card binding, includes bindng/unbinding imei to the card, when the imei is not match with the bind information, operator will block the network, when the imei is match, resume the network..
+ * manage device-area binding, includes binding/unbinding area to the card, when the area is not match with the bind information, operator will block the network, when the area is match, resume the network.
+ * query risk control information related to IoT SIM cards, includes machine-card binding and region restriction.
+* Describe, develop, document, and test the API(s)
+* Started: March 2025
+
+
+
+
+## Release Information
+
+The repository has no (pre)releases yet, work in progress is within the main branch.
+
+
+## Contributing
+* Meetings are held virtually
+ * Schedule: Every 2 weeks on Wednesdays at 9:00 UTC (start from April 30th, 2025)
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/92159554978?password=c5c63329-3b55-4fe0-94d9-9091c51f2ef9)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/GwCfBQ)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list
+
+
+
+
+
+
+
+
+# KnowYourCustomer
+
+Incubating API Repository to evolve and maintain the definitions and documentation of KnowYourCustomer Service API(s) within the Sub Project [Know Your Customer](https://lf-camaraproject.atlassian.net/wiki/x/I4DGB)
+
+* API wiki page: [Know Your Customer](https://lf-camaraproject.atlassian.net/wiki/x/BjPe)
+
+
+> [!WARNING]
+> After the CAMARA Spring25 meta release this repository has been separated into 3 individual repositories:
+> - [KnowYourCustomerMatch](https://github.com/camaraproject/KnowYourCustomerMatch)
+> - [KnowYourCustomerFill-in](https://github.com/camaraproject/KnowYourCustomerFill-in)
+> - [KnowYourCustomerAgeVerification](https://github.com/camaraproject/KnowYourCustomerAgeVerification)
+>
+> This repository should be only used for maintenance of previous releases. For contributions to the API development please use exclusively the new repositories. Thanks!
+
+
+## Scope
+
+* Service APIs for “KnowYourCustomer” (see APIBacklog.md)
+* The APIs provide the API consumer with the ability to:
+ * compare the information it (Service Provider, SP) has for a particular user with that on file (and verified) by the user's Operator in their own KYC records, in order for the SP to confirm the accuracy of the information and provide a specific service to the user. (KYC Match)
+ * request and receive the information for a particular user, which on file (and verified) by the user's Operator in their own KYC records, in order for the SP to confirm the accuracy of the information and provide a specific service to the user. (KYC Fill-in)
+ * check if the user of the line is older than a provided age, in order to provide API customer's age-restricted services, access to its age-restricted website etc. (KYC Age Verification)
+* Describe, develop, document and test the APIs (with 1-2 Telcos)
+* Started: September 2023
+* Incubating stage since: February 2025
+
+## Release Information
+
+* Note: Please be aware that the project will have updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. For best results, use the latest available release
+
+* `NEW`:**The latest public release of CAMARA Know Your Customer is [r2.2](https://github.com/camaraproject/KnowYourCustomer/tree/r2.2)**. The Release Tag is [r2.2](https://github.com/camaraproject/KnowYourCustomer/releases/tag/r2.2).
+ - Contains the following API definitions **with inline documentation**:
+ - kyc-match: [YAML spec file](https://github.com/camaraproject/KnowYourCustomer/blob/r2.2/code/API_definitions/kyc-match.yaml) | [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r2.2/code/API_definitions/kyc-match.yaml&nocors) | [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r2.2/code/API_definitions/kyc-match.yaml&nocors)
+ - kyc-fill-in: [YAML spec file](https://github.com/camaraproject/KnowYourCustomer/blob/r2.2/code/API_definitions/kyc-fill-in.yaml) | [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r2.2/code/API_definitions/kyc-fill-in.yaml&nocors) | [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r2.2/code/API_definitions/kyc-fill-in.yaml&nocors)
+ - kyc-age-verification: [YAML spec file](https://github.com/camaraproject/KnowYourCustomer/blob/r2.2/code/API_definitions/kyc-age-verification.yaml) | [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r2.2/code/API_definitions/kyc-age-verification.yaml&nocors) | [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r2.2/code/API_definitions/kyc-age-verification.yaml&nocors)
+
+## Contributing
+
+* Meetings are held virtually
+ * Schedule: Bi-weekly, Tuesday, 09:00 CEST (07:00 UTC) (till October 27th 2024)
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/96235150735?password=7e3fea67-a76e-4941-8a70-392cf5545917)
+ * Access [Meeting Minutes](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14551060/KnowYourCustomer+Meeting+Minutes)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project https://lists.camaraproject.org/g/sp-kyc
+ * A message to the community of this Sub Project can be sent using
+
+ Note:
+
+ * Before calling this API, 3rd parties / enterprise customers who want to use this API should make contract with API provider/ Operator for use of this API. As that will depend on each API provider / MNO's business processes as well as GSMA Open Gateway standard process, it is out of scope of this API definition.
+
+ * When calling this API, at the beginning, there should be required processes for Authentication / Authorisation / End User Consent capturing. As those processes are to be defined as CAMARA commonality standards, they are out of scope of this API definition, however, use of the OpenID Connect (OIDC) is stated as security scheme. **As an important note**, capturing end user consent is necessary, because this API provides end user information (PII).
+
+ * The above mentioned AuthN/AuthZ/End User consent capturing processes can give the API provider/ MNO the 3rd party identity (with the Access Token) and the end user identity (with the ID Token), so the API provider/ MNO can identify the 3rd party / enterprise customer and the end user. Then, it is up to API provider/ MNO to decide which information the 3rd party will receive by calling the API, and also the API provider / MNO is responsible for security and privacy issues.
+
+ * For example, below is a potential operation:
+ * when making contract with API provider/ MNO, a 3rd party / enterprise customer receives its 3rd party identity and also decide which information (attributes) it will receive for its API call
+ * then, API provider / MNO will provide information (attributes) which the 3rd party / enterprise customer is allowed to receive by the contract.
+
+ ### Special Scopes
+
+ This API uses the following special scope kyc-fill-in:set-all which means that the API provider returns an API response as if all these scopes were specified in the scope value in the request:
+ `kyc-fill-in:phoneNumber kyc-fill-in:idDocument kyc-fill-in:name kyc-fill-in:givenName kyc-fill-in:familyName kyc-fill-in:nameKanaHankaku kyc-fill-in:nameKanaZenkaku kyc-fill-in:middleNames kyc-fill-in:familyNameAtBirth kyc-fill-in:address kyc-fill-in:streetName kyc-fill-in:streetNumber kyc-fill-in:postalCode kyc-fill-in:region kyc-fill-in:locality kyc-fill-in:country kyc-fill-in:houseNumberExtension kyc-fill-in:birthdate kyc-fill-in:email kyc-fill-in:gender`
+
+ ## Resources and Operations overview
+
+ The API provides the following endpoint:
+
+ * An endpoint to request information related to an end user against the account data bound to their phone number.
+
+ ## Authorization and authentication
+
+ The "Camara Security and Interoperability Profile" provides details of how an API consumer requests an access token. Please refer to Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the profile.
+
+ The specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst also being subject to the prevailing legal framework dictated by local legislation.
+
+ In cases where personal data is processed by the API and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design.
+
+
+ # Identifying the phone number from the access token
+
+ This API requires the API consumer to identify a phone number as the subject of the API as follows:
+ - When the API is invoked using a two-legged access token, the subject will be identified from the optional `phoneNumber` field, which therefore MUST be provided.
+
+ - When a three-legged access token is used however, this optional identifier MUST NOT be provided, as the subject will be uniquely identified from the access token.
+
+ This approach simplifies API usage for API consumers using a three-legged access token to invoke the API by relying on the information that is associated with the access token and was identified during the authentication process.
+
+ ## Error handling:
+ - If the subject cannot be identified from the access token and the optional `phoneNumber` field is not included in the request, then the server will return an error with the `422 MISSING_IDENTIFIER` error code.
+
+ - If the subject can be identified from the access token and the optional `phoneNumber` field is also included in the request, then the server will return an error with the `422 UNNECESSARY_IDENTIFIER` error code. This will be the case even if the same phone number is identified by these two methods, as the server is unable to make this comparison.
+
+ license:
+ name: Apache 2.0
+ url: https://www.apache.org/licenses/LICENSE-2.0.html
+
+ version: 0.3.0
+ x-camara-commonalities: 0.5
+
+
+servers:
+ - url: '{apiRoot}/kyc-fill-in/v0.3'
+
+ variables:
+ apiRoot:
+ default: http://localhost:9091
+ description: API root, defined by the service provider, e.g. `api.example.com` or `api.example.com/somepath`
+
+tags:
+ - name: Fill-in
+ description: Operations to provide information related to a customer identity stored the account data bound to the customer's phone number.
+
+paths:
+ /fill-in:
+ post:
+ tags:
+ - Fill-in
+ summary: Providing information related to a customer identity stored the account data bound to the customer's phone number.
+
+ operationId: KYC_Fill-in
+
+ security:
+ - openId:
+ - kyc-fill-in:set-all
+ - openId:
+ - kyc-fill-in:phoneNumber
+ - openId:
+ - kyc-fill-in:idDocument
+ - openId:
+ - kyc-fill-in:name
+ - openId:
+ - kyc-fill-in:givenName
+ - openId:
+ - kyc-fill-in:familyName
+ - openId:
+ - kyc-fill-in:nameKanaHankaku
+ - openId:
+ - kyc-fill-in:nameKanaZenkaku
+ - openId:
+ - kyc-fill-in:middleNames
+ - openId:
+ - kyc-fill-in:familyNameAtBirth
+ - openId:
+ - kyc-fill-in:address
+ - openId:
+ - kyc-fill-in:streetName
+ - openId:
+ - kyc-fill-in:streetNumber
+ - openId:
+ - kyc-fill-in:postalCode
+ - openId:
+ - kyc-fill-in:region
+ - openId:
+ - kyc-fill-in:locality
+ - openId:
+ - kyc-fill-in:country
+ - openId:
+ - kyc-fill-in:houseNumberExtension
+ - openId:
+ - kyc-fill-in:birthdate
+ - openId:
+ - kyc-fill-in:email
+ - openId:
+ - kyc-fill-in:gender
+
+ parameters:
+ - $ref: '#/components/parameters/x-correlator'
+
+ requestBody:
+ content:
+ application/json:
+
+ schema:
+ $ref: '#/components/schemas/KYC_FillinRequest'
+ examples:
+ KYC_FillInBodyExample:
+ value:
+ { "phoneNumber": "+34629255833" }
+
+ responses:
+ '200':
+ description: OK
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/KYC_FillinResponse'
+ examples:
+ KYC_Fillin200Example:
+ value:
+ phoneNumber: '+34629255833'
+ idDocument: 66666666q
+ name: Federica Sanchez Arjona
+ givenName: Federica
+ familyName: Sanchez Arjona
+ nameKanaHankaku: federica
+ nameKanaZenkaku: Ｆｅｄｅｒｉｃａ
+ middleNames: Sanchez
+ familyNameAtBirth: YYYY
+ address: Tokyo-to Chiyoda-ku Iidabashi 3-10-10
+ streetName: Nicolas Salmeron
+ streetNumber: 4
+ postalCode: 1028460
+ region: Tokyo
+ locality: ZZZZ
+ country: JP
+ houseNumberExtension: 36
+ birthdate: '1978-08-22'
+ email: abc@example.com
+ gender: male
+
+ "400":
+ $ref: '#/components/responses/Generic400'
+ "401":
+ $ref: '#/components/responses/Generic401'
+ "403":
+ $ref: '#/components/responses/Generic403'
+ "404":
+ $ref: '#/components/responses/Generic404'
+ "422":
+ $ref: '#/components/responses/Generic422'
+
+components:
+ securitySchemes:
+ openId:
+ type: openIdConnect
+ openIdConnectUrl: https://example.com/.well-known/openid-configuration
+
+ headers:
+ X-Correlator:
+ description: Correlation id for the different services
+ required: false
+ schema:
+ type: string
+ pattern: ^[a-zA-Z0-9-]{1,55}$
+ example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
+
+ parameters:
+ x-correlator:
+ name: x-correlator
+ in: header
+ description: Correlation id for the different services
+ schema:
+ type: string
+ pattern: ^[a-zA-Z0-9-]{1,55}$
+ example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
+
+ schemas:
+ KYC_FillinRequest:
+ type: object
+ properties:
+ phoneNumber:
+ type: string
+ description: 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, prefixed with '+'.
+ pattern: '^\+[1-9][0-9]{4,14}$'
+ example: "+123456789"
+
+ KYC_FillinResponse:
+ type: object
+ properties:
+
+ phoneNumber:
+ type: string
+ description: 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, prefixed with '+'.
+ pattern: '^\+[1-9][0-9]{4,14}$'
+ example: "+123456789"
+
+ idDocument:
+ type: string
+ description: Id number associated to the id_document of the customer stored on the Operator's system.
+
+ name:
+ type: string
+ description: Complete name of the customer stored on the Operator's system. It is usually composed of first/given name and last/family/sur- name in a country. Depending on the country, the order of first/give name and last/family/sur- name varies, and middle name could be included. It can use givenName, middleNames, familyName and/or familyNameAtBirth. For example, in ESP, name+familyName; in NLD, it can be name+middleNames+familyName or name+middleNames+familyNameAtBirth, etc.
+
+ givenName:
+ type: string
+ description: First/given name or compound first/given name of the customer on the Operator's system.
+
+ familyName:
+ type: string
+ description: Last name, family name, or surname of the customer stored on the Operator's system.
+
+ nameKanaHankaku:
+ type: string
+ description: Complete name of the customer in Hankaku-Kana format (reading of name) for Japan, stored on the Operator's system.
+
+ nameKanaZenkaku:
+ type: string
+ description: Complete name of the customer in Zenkaku-Kana format (reading of name) for Japan, stored on the Operator's system.
+
+ middleNames:
+ type: string
+ description: Middle name/s of the customer stored on the Operator's system.
+
+ familyNameAtBirth:
+ type: string
+ description: Last/family/sur- name at birth of the customer stored on the Operator's system.
+
+ address:
+ type: string
+ description: Complete address of the customer stored on the Operator's system. For some countries, it is built following the usual concatenation of parameters in a country, but for other countries, this is not the case. For some countries, it can use streetName, streetNumber and/or houseNumberExtension. For example, in ESP, streetName+streetNumber; in NLD, it can be streetName+streetNumber or streetName+streetNumber+houseNumberExtension.
+
+ streetName:
+ type: string
+ description: Name of the street of the customer's address on the Operator's system. It should not include the type of the street.
+
+ streetNumber:
+ type: string
+ description: The street number of the customer's address on the Operator's system. Number identifying a specific property on the 'streetName'.
+
+ postalCode:
+ type: string
+ description: The postal code or Zip code of the customer's address, stored on the Operator's system.
+
+ region:
+ type: string
+ description: Region/prefecture of the customer's address, stored on the Operator's system.
+
+ locality:
+ type: string
+ description: Locality of the customer's address, stored on the Operator's system.
+
+ country:
+ type: string
+ description: Country of the customer's address stored on the Operator's system. Format ISO 3166-1 alpha-2.
+
+ houseNumberExtension:
+ type: string
+ description: House number extension of the customer stored on the Operator's system. Specific identifier of the house needed depending on the property type. For example, number of apartment in an apartment building.
+
+ birthdate:
+ type: string
+ format: date
+ description: Birthdate of the customer, in ISO 8601 calendar date format (YYYY-MM-DD), stored on the Operator's system.
+
+ email:
+ type: string
+ format: email
+ description: Email address of the customer in the RFC specified format (local-part@domain), stored on the Operator's system.
+
+ gender:
+ type: string
+ description: Gender of the customer stored on the Operator's system (male/female/other).
+ enum:
+ - MALE
+ - FEMALE
+ - OTHER
+
+ ErrorInfo:
+ type: object
+ required:
+ - status
+ - code
+ - message
+ properties:
+ status:
+ type: integer
+ description: HTTP response status code
+ code:
+ type: string
+ description: Code given to this error
+ message:
+ type: string
+ description: Detailed error description
+
+ responses:
+ Generic400:
+ description: Bad Request
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 400
+ code:
+ enum:
+ - INVALID_ARGUMENT
+ examples:
+ GENERIC_400_INVALID_ARGUMENT:
+ description: Invalid Argument. Generic Syntax Exception
+ value:
+ status: 400
+ code: INVALID_ARGUMENT
+ message: Client specified an invalid argument, request body or query param.
+
+ Generic401:
+ description: Unauthorized
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 401
+ code:
+ enum:
+ - UNAUTHENTICATED
+ - AUTHENTICATION_REQUIRED
+ examples:
+ GENERIC_401_UNAUTHENTICATED:
+ description: Request cannot be authenticated
+ value:
+ status: 401
+ code: UNAUTHENTICATED
+ message: Request not authenticated due to missing, invalid, or expired credentials.
+ GENERIC_401_AUTHENTICATION_REQUIRED:
+ description: New authentication is needed, authentication is no longer valid
+ value:
+ status: 401
+ code: AUTHENTICATION_REQUIRED
+ message: New authentication is required.
+
+ Generic403:
+ description: Forbidden
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 403
+ code:
+ enum:
+ - PERMISSION_DENIED
+
+ examples:
+ GENERIC_403_PERMISSION_DENIED:
+ description: Permission denied. OAuth2 token access does not have the required scope or when the user fails operational security
+ value:
+ status: 403
+ code: PERMISSION_DENIED
+ message: Client does not have sufficient permissions to perform this action.
+
+ Generic404:
+ description: Not found
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 404
+ code:
+ enum:
+ - IDENTIFIER_NOT_FOUND
+ examples:
+ GENERIC_404_IDENTIFIER_NOT_FOUND:
+ description: The phone number is not associated with a CSP customer account
+ value:
+ status: 404
+ code: IDENTIFIER_NOT_FOUND
+ message: The phone number provided is not associated with a customer account
+
+ Generic422:
+ description: Unprocessable Content
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 422
+ code:
+ enum:
+ - SERVICE_NOT_APPLICABLE
+ - MISSING_IDENTIFIER
+ - UNNECESSARY_IDENTIFIER
+ examples:
+ GENERIC_422_SERVICE_NOT_APPLICABLE:
+ description: Service is not applicable for the provided phone number
+ value:
+ status: 422
+ code: SERVICE_NOT_APPLICABLE
+ message: The service is not applicable for the provided phone number
+ GENERIC_422_MISSING_IDENTIFIER:
+ description: No phone number has been provided either explicitly or associated with the access token
+ value:
+ status: 422
+ code: MISSING_IDENTIFIER
+ message: No phone number has been provided
+ GENERIC_422_UNNECESSARY_IDENTIFIER:
+ description: An explicit phone number has been provided when one is already associated with the access token
+ value:
+ status: 422
+ code: UNNECESSARY_IDENTIFIER
+ message: An explicit phone number has been provided when one is already associated with the access token
diff --git a/original/KnowYourCustomer/code/API_definitions/kyc-match.yaml b/original/KnowYourCustomer/code/API_definitions/kyc-match.yaml
new file mode 100644
index 0000000000000000000000000000000000000000..44cd5f6bc1d9ae308139c1193079ff0962a6998f
--- /dev/null
+++ b/original/KnowYourCustomer/code/API_definitions/kyc-match.yaml
@@ -0,0 +1,642 @@
+openapi: 3.0.3
+info:
+ title: Know Your Customer Match
+
+ description: |
+
+ This API provides the customer with the ability to compare the information it (Service Provider, SP) has for a particular mobile phone user with that on file (and verified) by the mobile phone user's Operator in their own KYC records, in order for the SP to confirm the accuracy of the information and provide a specific service to the mobile phone user.
+
+ ## Relevant Definitions and concepts
+
+ * **KYC**: stands for Know Your Customer and it is the process of a business verifying the identity of their clients and assessing their suitability, along with the potential risks of illegal intentions towards the business relationship.
+
+ * **Match Score**: a numerical value that quantifies the similarity between two pieces of text based on the words they contain. This score is often used in various applications like text comparison, plagiarism detection, information retrieval, and natural language processing. The score typically reflects how well the words in one text match the words in another text. In the context of this API, this score will be used to determine how much does the input information looks like the information stored in the Operator's system. Unless otherwise captured in the implementation notes which Operators may publish, score will use the Jaro-Winkler distance algorithm for all countries. This parameter, as optional, will be returned depending on the capability of the Operator to calculate the scoring value. This means that not all Operators will implement this functionality or won't have the requested parameter available. It can happen that an Operator implements the score functionality but, for whatever reason, is not able to calculate it based on the client's input or the related stored information. For these cases, the score property related won't be returned in the response.
+ The range of score values is between "0" and "100", where higher scores indicate a higher similarity between the two compared parameters.
+
+ ## API Functionality
+
+ This API allows API clients to verify the matching of a number of attributes related to a customer identity against the account data bound to their phone number. The API is intended to be used in the following scenarios, for example:
+
+ * To verify the user personal data during the digital registration of an account to a 3rd party service.
+
+ * To prevent fraud, wrong or imprecise information, and/or facilitate the onboarding of a mobile phone user to a 3rd party service.
+
+ The API supports a multi-level hierarchy of property validation. In addition to the initial verification of the `phoneNumber`, an additional `idDocument` validation may occur based on different Operator requirements. This means that, in those cases, if the value of `idDocument` is not provided or it does not match the one bound to the specific phone number in the Operator systems, the operation will return an error.
+
+ The following figure is the generic high-level flows of this API.
+
+
+
+ Note:
+
+ * Before calling this API, 3rd parties / enterprise customers who want to use this API should make contact with API provider/ MNO for use of this API. As that will depend on each API provider / MNO's business process as well as GSMA Open Gateway standard process, it is out of scope of this API definition.
+
+ * When calling this API, at the beginning, there should be required processes for Authentication / Authorisation / End User Consent capturing. As those processes are defined as CAMARA commonality standards, they are out of scope of this API definition, however, use of the OpenID Connect (OIDC) is stated as security scheme.
+
+ ## Resources and Operations overview
+
+ The API provides the following endpoint:
+
+ * An endpoint to verify the matching of a number of attributes related to a mobile phone user identity against the account data bound to their phone number.
+
+ # Identifying the phoneNumber from the access token
+
+ This API requires the API consumer to identify a phoneNumber as the subject of the API as follows:
+ - When the API is invoked using a two-legged access token, the subject will be identified from the optional phoneNumber field, which therefore MUST be provided.
+ - When a three-legged access token is used, the subject will be uniquely identified from the access token. So, the optional phoneNumber is not used for identifying the subject, but, if it is provided in the API request body, it needs to match with the one associated with the access token.
+
+ ## Error handling:
+
+ - If the subject cannot be identified from the access token and the optional phoneNumber field is not included in the request, then the server will return an error with the `422 MISSING_IDENTIFIER` error code. This is an error typically, but not uniquely, returned in 2-legged scenarios when the access token doesn't identify a single subscription.
+ - If there is a mismatch between the provided phone number in the request body and the phone number associated with the access token, the server will return an error with the `403 INVALID_TOKEN_CONTEXT` error code.
+
+ # Authorization and authentication
+
+ The "Camara Security and Interoperability Profile" provides details of how an API consumer requests an access token. Please refer to Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the profile.
+
+ The specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst also being subject to the prevailing legal framework dictated by local legislation.
+
+ In cases where personal data is processed by the API and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design.
+
+
+ license:
+ name: Apache 2.0
+ url: https://www.apache.org/licenses/LICENSE-2.0.html
+ version: 0.3.0
+
+ x-camara-commonalities: 0.5
+
+servers:
+ - url: '{apiRoot}/kyc-match/v0.3'
+ variables:
+ apiRoot:
+ default: http://localhost:9091
+ description: API root, defined by the service provider, e.g. `api.example.com` or `api.example.com/somepath`
+
+tags:
+ - name: Match
+ description: Operations to match a customer identity against the account data bound to their phone number.
+
+paths:
+ /match:
+ post:
+ tags:
+ - Match
+ summary: Matching a customer identity by checking a set of attributes related against the account data bound to their phone number.
+ description: |-
+ Verify matching of a number of attributes related to a customer identity against the verified data bound to their phone number in the Operator systems. Regardless of whether the `phoneNumber` is explicitly stated in the request body, at least one of the other fields must be provided, otherwise a `HTTP 400 - KNOW_YOUR_CUSTOMER.INVALID_PARAM_COMBINATION` error will be returned.
+
+ In order to proceed with the match check, some Operators may have the requirement to perform an additional level of validation based on the `idDocument` property. This means that, in those cases, the `idDocument` is required and the provided value needs to match the one stored in the Operator system associated with the indicated `phoneNumber`. This validation will be done before proceeding with the match check of the rest of the properties. The following two rules apply only in the cases where the Operator have the requirement to validate the `idDocument`:
+ - If no `idDocument` is provided, then a `HTTP 403 - KNOW_YOUR_CUSTOMER.ID_DOCUMENT_REQUIRED` error will be returned.
+ - If the provided `idDocument` does not match the one stored in the Operator systems, then a `HTTP 403 - KNOW_YOUR_CUSTOMER.ID_DOCUMENT_MISMATCH` error will be returned.
+
+ The API will return the result of the matching process for each requested attribute. This means that the response will **only** contain the attributes for which validation has been requested. Possible values are:
+ - **true**: the attribute provided matches with the one in the Operator systems.
+ - **false**: the attribute provided does not match with the one in the Operator systems.
+ - **not_available**: the attribute is not available to validate.
+ operationId: KYC_Match
+
+ security:
+ - openId:
+ - kyc-match:match
+
+
+ parameters:
+ - $ref: '#/components/parameters/x-correlator'
+
+ requestBody:
+ required: true
+ content:
+ application/json:
+
+ schema:
+ $ref: '#/components/schemas/KYC_MatchRequestBody'
+ examples:
+ Two-Legged and Three-leg Access Token Example:
+ value:
+ phoneNumber: '+34629255833'
+ idDocument: 66666666q
+ name: Federica Sanchez Arjona
+ givenName: Federica
+ familyName: Sanchez Arjona
+ nameKanaHankaku: federica
+ nameKanaZenkaku: Ｆｅｄｅｒｉｃａ
+ middleNames: Sanchez
+ familyNameAtBirth: YYYY
+ address: Tokyo-to Chiyoda-ku Iidabashi 3-10-10
+ streetName: Nicolas Salmeron
+ streetNumber: '4'
+ postalCode: '1028460'
+ region: Tokyo
+ locality: ZZZZ
+ country: JP
+ houseNumberExtension: VVVV
+ birthdate: '1978-08-22'
+ email: abc@example.com
+ gender: OTHER
+ Three-Legged Without Phone Number Example:
+ value:
+ idDocument: 66666666q
+ name: Federica Sanchez Arjona
+ givenName: Federica
+ familyName: Sanchez Arjona
+ nameKanaHankaku: federica
+ nameKanaZenkaku: Ｆｅｄｅｒｉｃａ
+ middleNames: Sanchez
+ familyNameAtBirth: YYYY
+ address: Tokyo-to Chiyoda-ku Iidabashi 3-10-10
+ streetName: Nicolas Salmeron
+ streetNumber: '4'
+ postalCode: '1028460'
+ region: Tokyo
+ locality: ZZZZ
+ country: JP
+ houseNumberExtension: VVVV
+ birthdate: '1978-08-22'
+ email: abc@example.com
+ gender: OTHER
+
+ responses:
+ '200':
+ description: OK
+ headers:
+ x-correlator:
+ $ref: '#/components/headers/x-correlator'
+
+ content:
+ application/json:
+
+ schema:
+ $ref: '#/components/schemas/KYC_MatchResponse'
+ examples:
+ KYC_Match200Example:
+ value:
+ idDocumentMatch: 'true'
+ nameMatch: 'true'
+ givenNameMatch: 'not_available'
+ familyNameMatch: 'not_available'
+ nameKanaHankakuMatch: 'true'
+ nameKanaZenkakuMatch: 'false'
+ middleNamesMatch: 'true'
+ familyNameAtBirthMatch: 'false'
+ familyNameAtBirthMatchScore: 90
+ addressMatch: 'true'
+ streetNameMatch: 'true'
+ streetNumberMatch: 'true'
+ postalCodeMatch: 'true'
+ regionMatch: 'true'
+ localityMatch: 'not_available'
+ countryMatch: 'true'
+ houseNumberExtensionMatch: 'not_available'
+ birthdateMatch: 'false'
+ emailMatch: 'false'
+ emailMatchScore: 87
+ genderMatch: 'false'
+
+ '400':
+ $ref: '#/components/responses/Generic400'
+
+ '401':
+ $ref: '#/components/responses/Generic401'
+
+ '403':
+ $ref: '#/components/responses/Generic403'
+
+ '404':
+ $ref: '#/components/responses/Generic404'
+
+ '422':
+ $ref: '#/components/responses/Generic422'
+
+components:
+ securitySchemes:
+ openId:
+ type: openIdConnect
+ openIdConnectUrl: https://example.com/.well-known/openid-configuration
+
+
+ headers:
+ x-correlator:
+ description: Correlation id for the different services
+ schema:
+ type: string
+ pattern: ^[a-zA-Z0-9-]{0,55}$
+
+ parameters:
+ x-correlator:
+ name: x-correlator
+ in: header
+ description: Correlation id for the different services
+ schema:
+ type: string
+ pattern: ^[a-zA-Z0-9-]{0,55}$
+ example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
+
+ schemas:
+ KYC_MatchRequestBody:
+ type: object
+ description: Payload to validate the customer data.
+
+ properties:
+ phoneNumber:
+ type: string
+ description: 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, prefixed with '+'.
+ pattern: '^\+[1-9][0-9]{4,14}$'
+ example: "+123456789"
+
+ idDocument:
+ type: string
+ description: Id number associated to the official identity document in the country. It may contain alphanumeric characters.
+
+ name:
+ type: string
+ description: Complete name of the customer, usually composed of first/given name and last/family/sur- name in a country. Depending on the country, the order of first/give name and last/family/sur- name varies, and middle name could be included. It can use givenName, middleNames, familyName and/or familyNameAtBirth. For example, in ESP, name+familyName; in NLD, it can be name+middleNames+familyName or name+middleNames+familyNameAtBirth, etc.
+
+ givenName:
+ type: string
+ description: First/given name or compound first/given name of the customer.
+
+ familyName:
+ type: string
+ description: Last name, family name, or surname of the customer.
+
+ nameKanaHankaku:
+ type: string
+ description: Complete name of the customer in Hankaku-Kana format (reading of name) for Japan.
+
+ nameKanaZenkaku:
+ type: string
+ description: Complete name of the customer in Zenkaku-Kana format (reading of name) for Japan.
+
+ middleNames:
+ type: string
+ description: Middle name/s of the customer.
+
+ familyNameAtBirth:
+ type: string
+ description: Last/family/sur- name at birth of the customer.
+
+ address:
+ type: string
+ description: Complete address of the customer. For some countries, it is built following the usual concatenation of parameters in a country, but for other countries, this is not the case. For some countries, it can use streetName, streetNumber and/or houseNumberExtension. For example, in ESP, streetName+streetNumber; in NLD, it can be streetName+streetNumber or streetName+streetNumber+houseNumberExtension.
+
+ streetName:
+ type: string
+ description: Name of the street of the customer's address. It should not include the type of the street.
+
+ streetNumber:
+ type: string
+ description: The street number of the customer's address. Number identifying a specific property on the 'streetName'.
+
+ postalCode:
+ type: string
+ description: Zip code or postal code
+
+ region:
+ type: string
+ description: Region/prefecture of the customer's address
+
+ locality:
+ type: string
+ description: Locality of the customer's address
+
+ country:
+ type: string
+ description: Country of the customer's address. Format ISO 3166-1 alpha-2
+
+ houseNumberExtension:
+ type: string
+ description: Specific identifier of the house needed depending on the property type. For example, number of apartment in an apartment building.
+
+ birthdate:
+ type: string
+ format: date
+ description: The birthdate of the customer, in RFC 3339 / ISO 8601 calendar date format (YYYY-MM-DD).
+
+ email:
+ type: string
+ format: email
+ description: Email address of the customer in the RFC specified format (local-part@domain).
+
+ gender:
+ type: string
+ description: Gender of the customer (Male/Female/Other).
+ enum:
+ - MALE
+ - FEMALE
+ - OTHER
+
+ MatchResult:
+ type: string
+ enum:
+ - 'true'
+ - 'false'
+ - 'not_available'
+
+ MatchScoreResult:
+ type: integer
+ description: Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator's system. This property shall only be returned when the value of the corresponding match field is `false`.
+ minimum: 0
+ maximum: 100
+
+ KYC_MatchResponse:
+ type: object
+ properties:
+ idDocumentMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether Id number associated to the ID document of the customer matches with the one on the Operator's system.
+ nameMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the complete name of the customer matches with the one on the Operator's system.
+ nameMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ givenNameMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether First name/given name of the customer matches with the one on the Operator's system.
+ givenNameMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ familyNameMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether last name/ family name/ surname of the customer matches with the one on the Operator's system.
+ familyNameMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ nameKanaHankakuMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether complete name of the customer in Hankaku-Kana format (reading of name) for Japan matches with the one on the Operator's system.
+ nameKanaHankakuMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ nameKanaZenkakuMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether complete name of the customer in Zenkaku-Kana format (reading of name) for Japan matches with the one on the Operator's system.
+ nameKanaZenkakuMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ middleNamesMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the middle names of the customer matches with the one on the Operator's system.
+ middleNamesMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ familyNameAtBirthMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the Family Name At Birth of the customer matches with the one on the Operator's system.
+ familyNameAtBirthMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ addressMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether complete address of the customer matches with the one on the Operator's system.
+ addressMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ streetNameMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the street name of the customer matches with the one on the Operator's system.
+ streetNameMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ streetNumberMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the street number of the customer matches with the one on the Operator's system.
+ streetNumberMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ postalCodeMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the postal code / zip code of the customer matches with the one on the Operator's system.
+ regionMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the region of the customer's address matches with the one on the Operator's system.
+ regionMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ localityMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the locality of the customer's address matches with the one on the Operator's system.
+ localityMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ countryMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the country of the customer's address matches with the one on the Operator's system.
+ houseNumberExtensionMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the house number extension of the customer's address with the one on the Operator's system.
+ birthdateMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the birthdate of the customer matches with the one on the Operator's system.
+ emailMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the email address of the customer matches with the one on the Operator's system.
+ emailMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ genderMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the gender of the customer matches with the one on the Operator's system.
+
+ ErrorInfo:
+ type: object
+ required:
+ - status
+ - code
+ - message
+ properties:
+ status:
+ type: integer
+ description: HTTP response status code
+ code:
+ type: string
+ description: Code given to this error
+ message:
+ type: string
+ description: Detailed error description
+
+ responses:
+ Generic400:
+ description: Bad Request
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 400
+ code:
+ enum:
+ - INVALID_ARGUMENT
+ - KNOW_YOUR_CUSTOMER.INVALID_PARAM_COMBINATION
+ examples:
+ GENERIC_400_INVALID_ARGUMENT:
+ description: Invalid Argument. Generic Syntax Exception
+ value:
+ status: 400
+ code: INVALID_ARGUMENT
+ message: Client specified an invalid argument, request body or query param.
+ KNOW_YOUR_CUSTOMER.INVALID_PARAM_COMBINATION:
+ description: Indicated param combination is invalid
+ value:
+ status: 400
+ code: KNOW_YOUR_CUSTOMER.INVALID_PARAM_COMBINATION
+ message: Indicated parameter combination is invalid
+
+ Generic401:
+ description: Unauthorized
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 401
+ code:
+ enum:
+ - UNAUTHENTICATED
+ - AUTHENTICATION_REQUIRED
+ examples:
+ GENERIC_401_UNAUTHENTICATED:
+ description: Request cannot be authenticated
+ value:
+ status: 401
+ code: UNAUTHENTICATED
+ message: Request not authenticated due to missing, invalid, or expired credentials.
+ GENERIC_401_AUTHENTICATION_REQUIRED:
+ description: New authentication is needed, authentication is no longer valid
+ value:
+ status: 401
+ code: AUTHENTICATION_REQUIRED
+ message: New authentication is required.
+
+ Generic403:
+ description: Forbidden
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 403
+ code:
+ enum:
+ - PERMISSION_DENIED
+ - INVALID_TOKEN_CONTEXT
+ - KNOW_YOUR_CUSTOMER.ID_DOCUMENT_REQUIRED
+ - KNOW_YOUR_CUSTOMER.ID_DOCUMENT_MISMATCH
+ examples:
+ GENERIC_403_PERMISSION_DENIED:
+ description: Permission denied. OAuth2 token access does not have the required scope or when the user fails operational security
+ value:
+ status: 403
+ code: PERMISSION_DENIED
+ message: Client does not have sufficient permissions to perform this action.
+ GENERIC_403_INVALID_TOKEN_CONTEXT:
+ description: Reflect some inconsistency between information in some field of the API and the related OAuth2 Token
+ value:
+ status: 403
+ code: INVALID_TOKEN_CONTEXT
+ message: "phoneNumber is not consistent with access token."
+ KNOW_YOUR_CUSTOMER.ID_DOCUMENT_REQUIRED:
+ description: The idDocument is required by the implementation
+ value:
+ status: 403
+ code: KNOW_YOUR_CUSTOMER.ID_DOCUMENT_REQUIRED
+ message: The idDocument is required to perform the properties validation
+ KNOW_YOUR_CUSTOMER.ID_DOCUMENT_MISMATCH:
+ description: idDocument mismatch
+ value:
+ status: 403
+ code: KNOW_YOUR_CUSTOMER.ID_DOCUMENT_MISMATCH
+ message: The idDocument needs to match the one associated with the provided phoneNumber
+
+ Generic404:
+ description: Not found
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 404
+ code:
+ enum:
+ - NOT_FOUND
+ - IDENTIFIER_NOT_FOUND
+ examples:
+ GENERIC_404_NOT_FOUND:
+ description: Resource is not found
+ value:
+ status: 404
+ code: NOT_FOUND
+ GENERIC_404_IDENTIFIER_NOT_FOUND:
+ description: The phone number is not associated with a CSP customer account
+ value:
+ status: 404
+ code: IDENTIFIER_NOT_FOUND
+ message: The phone number provided is not associated with a customer account
+
+ Generic422:
+ description: Unprocessable Content
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 422
+ code:
+ enum:
+ - SERVICE_NOT_APPLICABLE
+ - MISSING_IDENTIFIER
+ examples:
+ GENERIC_422_SERVICE_NOT_APPLICABLE:
+ description: Service is not applicable for the provided phone number
+ value:
+ status: 422
+ code: SERVICE_NOT_APPLICABLE
+ message: The service is not applicable for the provided phone number
+ GENERIC_422_MISSING_IDENTIFIER:
+ description: No phone number has been provided either explicitly or associated with the access token
+ value:
+ status: 422
+ code: MISSING_IDENTIFIER
+ message: No phone number has been provided
diff --git a/original/KnowYourCustomer/documentation/API_documentation/KYC-Fill-in.md b/original/KnowYourCustomer/documentation/API_documentation/KYC-Fill-in.md
new file mode 100644
index 0000000000000000000000000000000000000000..057d82b1f21a5bc0ecb72e51325139a83c113325
--- /dev/null
+++ b/original/KnowYourCustomer/documentation/API_documentation/KYC-Fill-in.md
@@ -0,0 +1,40 @@
+# CAMARA KnowYourCustomer KYC Fill-in API
+
+(NOTE: This API description is supposed to be incorporated into the YAML definition file in the future releases.)
+
+This API provides the customer with the ability request and receive the information for a particular user, which on file (and verified) by the user's Operator in their own KYC records, in order for the SP to confirm the accuracy of the information and provide a specific service to the user.
+
+## Relevant Definitions and concepts
+
+* **KYC**: stands for Know Your Customer and it is the process of a business verifying the identity of their clients and assessing their suitability, along with the potential risks of illegal intentions towards the business relationship.
+
+## API Functionality
+
+This API allows API clients to request for API provider / MNO to provide information related to a mobile phone user, derived from the account data bound to their phone number. The API is intended to be used in the following scenario, for example:
+
+* To fill-in the user personal data during the digital registration of an account to a 3rd party service.
+
+The following figure is the generic high-level flows of this API.
+
+
+
+
+
+
+
+
+
+
+# KnowYourCustomerAgeVerification
+
+Sandbox API Repository to describe, develop, document, and test the KnowYourCustomerAgeVerification Service API(s) within the Sub Project [Know Your Customer](https://lf-camaraproject.atlassian.net/wiki/x/I4DGB).
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/mYAzC)
+
+## Scope
+
+* Service API(s) “KnowYourCustomerAgeVerification” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * check if the user of the line is older than a provided age, in order to provide API customer's age-restricted services, access to its age-restricted website etc..
+* Describe, develop, document, and test the API(s)
+* Started: September 2023 (within [KnowYourCustomer](https://github.com/camaraproject/KnowYourCustomer))
+* Incubating stage since: February 2025
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r1.3](https://github.com/camaraproject/KnowYourCustomerAgeVerification/releases/tag/r1.3) (Fall25), with the following API versions:
+ * **kyc-age-verification v0.2.1**
+ [[YAML]](https://github.com/camaraproject/KnowYourCustomerAgeVerification/blob/r1.3/code/API_definitions/kyc-age-verification.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomerAgeVerification/r1.3/code/API_definitions/kyc-age-verification.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomerAgeVerification/r1.3/code/API_definitions/kyc-age-verification.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/KnowYourCustomerAgeVerification/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/KnowYourCustomerAgeVerification/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/KnowYourCustomerAgeVerification/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+* **Releases of the CAMARA KYC Age Verification API until Spring25 are available in [KnowYourCustomer](https://github.com/camaraproject/KnowYourCustomer).**
+
+## Contributing
+
+* Meetings are held virtually
+
+ * Schedule: bi-weekly, Tuesday, 08:00 UTC (09:00 CET, 10:00 CEST). For date/time of the next meeting, see previous meeting minutes.
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/96235150735?password=7e3fea67-a76e-4941-8a70-392cf5545917)
+ * Access [Meeting Minutes](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14551060/KnowYourCustomer+Meeting+Minutes)
+
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list
+
+
+
+
+
+
+
+
+# KnowYourCustomerFill-in
+
+Incubating API Repository to evolve and maintain the definitions and documentation of KnowYourCustomerFill-in Service API(s) within the Sub Project [Know Your Customer](https://lf-camaraproject.atlassian.net/wiki/x/I4DGB)
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/AYAzC)
+
+## Scope
+
+* Service API(s) “KnowYourCustomerFill-in” (see APIBacklog.md)
+* The API provides the API consumer with the ability to:
+ * request and receive the information for a particular end user, which is on file (and verified) by the end user's Operator in their own KYC records, in order for the service provider (API consumer) to confirm the accuracy of the information and provide a specific service to the end user.
+* Describe, develop, document, and test the API(s)
+* Started: September 2023 (within [KnowYourCustomer](https://github.com/camaraproject/KnowYourCustomer))
+* Incubating stage since: February 2025
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r1.3](https://github.com/camaraproject/KnowYourCustomerFill-in/releases/tag/r1.3) (Fall25), with the following API versions:
+ * **kyc-fill-in v0.4.1**
+ [[YAML]](https://github.com/camaraproject/KnowYourCustomerFill-in/blob/r1.3/code/API_definitions/kyc-fill-in.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomerFill-in/r1.3/code/API_definitions/kyc-fill-in.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomerFill-in/r1.3/code/API_definitions/kyc-fill-in.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/KnowYourCustomerFill-in/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/KnowYourCustomerFill-in/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/KnowYourCustomerFill-in/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+* Note: **Releases of the KnowYourCustomerFill-in API until Spring25 are available in [KnowYourCustomer](https://github.com/camaraproject/KnowYourCustomer).**
+
+## Contributing
+
+* Meetings are held virtually
+
+ * Schedule: bi-weekly, Tuesday, 08:00 UTC (09:00 CET, 10:00 CEST). For date/time of the next meeting, see previous meeting minutes.
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/96235150735?password=7e3fea67-a76e-4941-8a70-392cf5545917)
+ * Access [Meeting Minutes](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14551060/KnowYourCustomer+Meeting+Minutes)
+
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list
+
+ Note:
+
+ * Before calling this API, 3rd parties / enterprise customers who want to use this API should make contract with API provider/ Operator for use of this API. As that will depend on each API provider / MNO's business processes as well as GSMA Open Gateway standard process, it is out of scope of this API definition.
+
+ * When calling this API, at the beginning, there should be required processes for Authentication / Authorisation / End User Consent capturing. As those processes are to be defined as CAMARA commonality standards, they are out of scope of this API definition, however, use of the OpenID Connect (OIDC) is stated as security scheme. **As an important note**, capturing end user consent is necessary, because this API provides end user information (PII).
+
+ * The above mentioned AuthN/AuthZ/End User consent capturing processes can give the API provider/ MNO the 3rd party identity (with the Access Token) and the end user identity (with the ID Token), so the API provider/ MNO can identify the 3rd party / enterprise customer and the end user. Then, it is up to API provider/ MNO to decide which information the 3rd party will receive by calling the API, and also the API provider / MNO is responsible for security and privacy issues.
+
+ * For example, below is a potential operation:
+ * when making contract with API provider/ MNO, a 3rd party / enterprise customer receives its 3rd party identity and also decide which information (attributes) it will receive for its API call
+ * then, API provider / MNO will provide information (attributes) which the 3rd party / enterprise customer is allowed to receive by the contract.
+
+ ### Special Scopes
+
+ This API uses the following special scope `kyc-fill-in:set-all` which means that the API provider returns an API response as if all these scopes were specified in the scope value in the request:
+
+ `kyc-fill-in:phoneNumber kyc-fill-in:idDocument kyc-fill-in:idDocumentType kyc-fill-in:idDocumentExpiryDate kyc-fill-in:name kyc-fill-in:givenName kyc-fill-in:familyName kyc-fill-in:nameKanaHankaku kyc-fill-in:nameKanaZenkaku kyc-fill-in:middleNames kyc-fill-in:familyNameAtBirth kyc-fill-in:address kyc-fill-in:streetName kyc-fill-in:streetNumber kyc-fill-in:postalCode kyc-fill-in:region kyc-fill-in:locality kyc-fill-in:country kyc-fill-in:houseNumberExtension kyc-fill-in:birthdate kyc-fill-in:email kyc-fill-in:gender kyc-fill-in:cityOfBirth kyc-fill-in:countryOfBirth kyc-fill-in:nationality`
+
+ ## Resources and Operations overview
+
+ The API provides the following endpoint:
+
+ * An endpoint to request information related to an end user against the account data bound to their phone number.
+
+ ## Authorization and authentication
+
+ The "Camara Security and Interoperability Profile" provides details of how an API consumer requests an access token. Please refer to Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the profile.
+
+ The specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst also being subject to the prevailing legal framework dictated by local legislation.
+
+ In cases where personal data is processed by the API and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design.
+
+
+ # Identifying the phone number from the access token
+
+ This API requires the API consumer to identify a phone number as the subject of the API as follows:
+ - When the API is invoked using a two-legged access token, the subject will be identified from the optional `phoneNumber` field, which therefore MUST be provided.
+
+ - When a three-legged access token is used however, this optional identifier MUST NOT be provided, as the subject will be uniquely identified from the access token.
+
+ This approach simplifies API usage for API consumers using a three-legged access token to invoke the API by relying on the information that is associated with the access token and was identified during the authentication process.
+
+ ## Error handling:
+ - If the subject cannot be identified from the access token and the optional `phoneNumber` field is not included in the request, then the server will return an error with the `422 MISSING_IDENTIFIER` error code.
+
+ - If the subject can be identified from the access token and the optional `phoneNumber` field is also included in the request, then the server will return an error with the `422 UNNECESSARY_IDENTIFIER` error code. This will be the case even if the same phone number is identified by these two methods, as the server is unable to make this comparison.
+
+ ### Additional CAMARA error responses
+ The list of error codes in this API specification is not exhaustive. Therefore the API specification may not document some non-mandatory error statuses as indicated in `CAMARA API Design Guide`.
+
+ Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version.
+
+ As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API.
+
+ license:
+ name: Apache 2.0
+ url: https://www.apache.org/licenses/LICENSE-2.0.html
+
+ version: wip
+ x-camara-commonalities: 0.6
+
+externalDocs:
+ description: Product documentation at CAMARA.
+ url: https://github.com/camaraproject/KnowYourCustomerFill-in
+
+servers:
+ - url: '{apiRoot}/kyc-fill-in/vwip'
+
+ variables:
+ apiRoot:
+ default: http://localhost:9091
+ description: API root, defined by the service provider, e.g. `api.example.com` or `api.example.com/somepath`
+
+tags:
+ - name: Fill-in
+ description: Operations to provide information related to a customer identity stored the account data bound to the customer's phone number.
+
+paths:
+ /fill-in:
+ post:
+ tags:
+ - Fill-in
+ summary: Providing information related to a customer identity stored the account data bound to the customer's phone number.
+
+ operationId: KYC_Fill-in
+
+ security:
+ - openId:
+ - kyc-fill-in:set-all
+ - openId:
+ - kyc-fill-in:phoneNumber
+ - openId:
+ - kyc-fill-in:idDocument
+ - openId:
+ - kyc-fill-in:idDocumentType
+ - openId:
+ - kyc-fill-in:idDocumentExpiryDate
+ - openId:
+ - kyc-fill-in:name
+ - openId:
+ - kyc-fill-in:givenName
+ - openId:
+ - kyc-fill-in:familyName
+ - openId:
+ - kyc-fill-in:nameKanaHankaku
+ - openId:
+ - kyc-fill-in:nameKanaZenkaku
+ - openId:
+ - kyc-fill-in:middleNames
+ - openId:
+ - kyc-fill-in:familyNameAtBirth
+ - openId:
+ - kyc-fill-in:address
+ - openId:
+ - kyc-fill-in:streetName
+ - openId:
+ - kyc-fill-in:streetNumber
+ - openId:
+ - kyc-fill-in:postalCode
+ - openId:
+ - kyc-fill-in:region
+ - openId:
+ - kyc-fill-in:locality
+ - openId:
+ - kyc-fill-in:country
+ - openId:
+ - kyc-fill-in:houseNumberExtension
+ - openId:
+ - kyc-fill-in:birthdate
+ - openId:
+ - kyc-fill-in:email
+ - openId:
+ - kyc-fill-in:gender
+ - openId:
+ - kyc-fill-in:cityOfBirth
+ - openId:
+ - kyc-fill-in:countryOfBirth
+ - openId:
+ - kyc-fill-in:nationality
+
+ parameters:
+ - $ref: '#/components/parameters/x-correlator'
+
+ requestBody:
+ required: true
+ content:
+ application/json:
+
+ schema:
+ $ref: '#/components/schemas/KYC_FillinRequest'
+ examples:
+ KYC_FillInBodyExample:
+ value:
+ {"phoneNumber": "+34629255833"}
+
+ responses:
+ '200':
+ description: OK
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/KYC_FillinResponse'
+ examples:
+ KYC_Fillin200Example:
+ value:
+ phoneNumber: '+34629255833'
+ idDocument: 66666666q
+ idDocumentType: passport
+ idDocumentExpiryDate: '2027-07-12'
+ name: Federica Sanchez Arjona
+ givenName: Federica
+ familyName: Sanchez Arjona
+ nameKanaHankaku: federica
+ nameKanaZenkaku: Ｆｅｄｅｒｉｃａ
+ middleNames: Sanchez
+ familyNameAtBirth: YYYY
+ address: Tokyo-to Chiyoda-ku Iidabashi 3-10-10
+ streetName: Nicolas Salmeron
+ streetNumber: '4'
+ postalCode: '1028460'
+ region: Tokyo
+ locality: ZZZZ
+ country: JP
+ houseNumberExtension: '36'
+ birthdate: '1978-08-22'
+ email: abc@example.com
+ gender: MALE
+ cityOfBirth: Madrid
+ countryOfBirth: ES
+ nationality: ES
+
+ "400":
+ $ref: '#/components/responses/Generic400'
+ "401":
+ $ref: '#/components/responses/Generic401'
+ "403":
+ $ref: '#/components/responses/Generic403'
+ "404":
+ $ref: '#/components/responses/Generic404'
+ "422":
+ $ref: '#/components/responses/Generic422'
+
+components:
+ securitySchemes:
+ openId:
+ type: openIdConnect
+ openIdConnectUrl: https://example.com/.well-known/openid-configuration
+
+ headers:
+ X-Correlator:
+ description: Correlation id for the different services
+ required: false
+ schema:
+ $ref: "#/components/schemas/XCorrelator"
+
+ parameters:
+ x-correlator:
+ name: x-correlator
+ in: header
+ description: Correlation id for the different services
+ schema:
+ $ref: "#/components/schemas/XCorrelator"
+
+ schemas:
+ KYC_FillinRequest:
+ type: object
+ properties:
+ phoneNumber:
+ type: string
+ description: 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, prefixed with '+'.
+ pattern: '^\+[1-9][0-9]{4,14}$'
+ example: "+123456789"
+
+ KYC_FillinResponse:
+ type: object
+ properties:
+
+ phoneNumber:
+ type: string
+ description: 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, prefixed with '+'.
+ pattern: '^\+[1-9][0-9]{4,14}$'
+ example: "+123456789"
+
+ idDocument:
+ type: string
+ description: Id number associated to the id_document of the customer stored on the Operator's system.
+
+ idDocumentType:
+ type: string
+ enum: [passport, national_id_card, residence_permit, diplomatic_id, driver_licence, social_security_id, other]
+ description: Type of the official identity document provided.
+
+ idDocumentExpiryDate:
+ type: string
+ format: date
+ description: Expiration date of the identity document (ISO 8601).
+
+ name:
+ type: string
+ description: Complete name of the customer stored on the Operator's system. It is usually composed of first/given name and last/family/sur- name in a country. Depending on the country, the order of first/give name and last/family/sur- name varies, and middle name could be included. It can use givenName, middleNames, familyName and/or familyNameAtBirth. For example, in ESP, name+familyName; in NLD, it can be name+middleNames+familyName or name+middleNames+familyNameAtBirth, etc.
+
+ givenName:
+ type: string
+ description: First/given name or compound first/given name of the customer on the Operator's system.
+
+ familyName:
+ type: string
+ description: Last name, family name, or surname of the customer stored on the Operator's system.
+
+ nameKanaHankaku:
+ type: string
+ description: Complete name of the customer in Hankaku-Kana format (reading of name) for Japan, stored on the Operator's system.
+
+ nameKanaZenkaku:
+ type: string
+ description: Complete name of the customer in Zenkaku-Kana format (reading of name) for Japan, stored on the Operator's system.
+
+ middleNames:
+ type: string
+ description: Middle name/s of the customer stored on the Operator's system.
+
+ familyNameAtBirth:
+ type: string
+ description: Last/family/sur- name at birth of the customer stored on the Operator's system.
+
+ address:
+ type: string
+ description: Complete address of the customer stored on the Operator's system. For some countries, it is built following the usual concatenation of parameters in a country, but for other countries, this is not the case. For some countries, it can use streetName, streetNumber and/or houseNumberExtension. For example, in ESP, streetName+streetNumber; in NLD, it can be streetName+streetNumber or streetName+streetNumber+houseNumberExtension.
+
+ streetName:
+ type: string
+ description: Name of the street of the customer's address on the Operator's system. It should not include the type of the street.
+
+ streetNumber:
+ type: string
+ description: The street number of the customer's address on the Operator's system. Number identifying a specific property on the 'streetName'.
+
+ postalCode:
+ type: string
+ description: The postal code or Zip code of the customer's address, stored on the Operator's system.
+
+ region:
+ type: string
+ description: Region/prefecture of the customer's address, stored on the Operator's system.
+
+ locality:
+ type: string
+ description: Locality of the customer's address, stored on the Operator's system.
+
+ country:
+ type: string
+ description: Country of the customer's address stored on the Operator's system. Format ISO 3166-1 alpha-2.
+
+ houseNumberExtension:
+ type: string
+ description: House number extension of the customer stored on the Operator's system. Specific identifier of the house needed depending on the property type. For example, number of apartment in an apartment building.
+
+ birthdate:
+ type: string
+ format: date
+ description: Birthdate of the customer, in ISO 8601 calendar date format (YYYY-MM-DD), stored on the Operator's system.
+
+ email:
+ type: string
+ format: email
+ description: Email address of the customer in the RFC specified format (local-part@domain), stored on the Operator's system.
+
+ gender:
+ type: string
+ description: Gender of the customer stored on the Operator's system (Male/Female/Other).
+ enum:
+ - MALE
+ - FEMALE
+ - OTHER
+
+ cityOfBirth:
+ type: string
+ description: City where the customer was born.
+
+ countryOfBirth:
+ type: string
+ description: Country where the customer was born. Format ISO 3166-1 alpha-2.
+
+ nationality:
+ type: string
+ description: ISO 3166-1 alpha-2 code of the customer’s nationality. In the case a customer has more than one nationality, it is supposed to be the nationality related to the ID document provided in the match request.
+
+ ErrorInfo:
+ type: object
+ required:
+ - status
+ - code
+ - message
+ properties:
+ status:
+ type: integer
+ description: HTTP response status code
+ code:
+ type: string
+ description: A human-readable code to describe the error
+ message:
+ type: string
+ description: A human-readable description of what the event represents
+
+ XCorrelator:
+ type: string
+ pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
+ example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
+
+ responses:
+ Generic400:
+ description: Bad Request
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 400
+ code:
+ enum:
+ - INVALID_ARGUMENT
+ examples:
+ GENERIC_400_INVALID_ARGUMENT:
+ description: Invalid Argument. Generic Syntax Exception
+ value:
+ status: 400
+ code: INVALID_ARGUMENT
+ message: Client specified an invalid argument, request body or query param.
+
+ Generic401:
+ description: Unauthorized
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 401
+ code:
+ enum:
+ - UNAUTHENTICATED
+ examples:
+ GENERIC_401_UNAUTHENTICATED:
+ description: Request cannot be authenticated and a new authentication is required
+ value:
+ status: 401
+ code: UNAUTHENTICATED
+ message: Request not authenticated due to missing, invalid, or expired credentials. A new authentication is required.
+
+ Generic403:
+ description: Forbidden
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 403
+ code:
+ enum:
+ - PERMISSION_DENIED
+
+ examples:
+ GENERIC_403_PERMISSION_DENIED:
+ description: Permission denied. OAuth2 token access does not have the required scope or when the user fails operational security
+ value:
+ status: 403
+ code: PERMISSION_DENIED
+ message: Client does not have sufficient permissions to perform this action.
+
+ Generic404:
+ description: Not found
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 404
+ code:
+ enum:
+ - IDENTIFIER_NOT_FOUND
+ examples:
+ GENERIC_404_IDENTIFIER_NOT_FOUND:
+ description: The phone number is not associated with a CSP customer account
+ value:
+ status: 404
+ code: IDENTIFIER_NOT_FOUND
+ message: The phone number provided is not associated with a customer account
+
+ Generic422:
+ description: Unprocessable Content
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/X-Correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 422
+ code:
+ enum:
+ - SERVICE_NOT_APPLICABLE
+ - MISSING_IDENTIFIER
+ - UNNECESSARY_IDENTIFIER
+ examples:
+ GENERIC_422_SERVICE_NOT_APPLICABLE:
+ description: Service is not applicable for the provided phone number
+ value:
+ status: 422
+ code: SERVICE_NOT_APPLICABLE
+ message: The service is not applicable for the provided phone number
+ GENERIC_422_MISSING_IDENTIFIER:
+ description: No phone number has been provided either explicitly or associated with the access token
+ value:
+ status: 422
+ code: MISSING_IDENTIFIER
+ message: No phone number has been provided
+ GENERIC_422_UNNECESSARY_IDENTIFIER:
+ description: An explicit phone number has been provided when one is already associated with the access token
+ value:
+ status: 422
+ code: UNNECESSARY_IDENTIFIER
+ message: An explicit phone number has been provided when one is already associated with the access token
diff --git a/original/KnowYourCustomerFill-in/documentation/API_documentation/KnowYourCustomer_User_Story.md b/original/KnowYourCustomerFill-in/documentation/API_documentation/KnowYourCustomer_User_Story.md
new file mode 100644
index 0000000000000000000000000000000000000000..158abcbb16059c1c98cf16dbadb13873ee5afc02
--- /dev/null
+++ b/original/KnowYourCustomerFill-in/documentation/API_documentation/KnowYourCustomer_User_Story.md
@@ -0,0 +1,27 @@
+**User Story: KYC Match - verify customer information**
+
+
+
+
+
+
+
+
+
+# KnowYourCustomerMatch
+
+Incubating API Repository to evolve and maintain the definitions and documentation of KnowYourCustomerMatch Service API(s) within the Sub Project [Know Your Customer](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/80117795/Know+Your+Customer)
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/EQAzC)
+
+## Scope
+
+* Service API(s) “KnowYourCustomerMatch” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * compare the information that the Service Provider (SP) has for a particular user with that on file (and verified) by the user's Operator in their own KYC records, in order for the SP to confirm the accuracy of the information and provide a specific service to the user.
+* Describe, develop, document, and test the API(s)
+* Started: September 2023 (within [KnowYourCustomer](https://github.com/camaraproject/KnowYourCustomer))
+* Incubating stage since: February 2025
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r1.2](https://github.com/camaraproject/KnowYourCustomerMatch/releases/tag/r1.2) (Fall25), with the following API versions:
+ * **kyc-match v0.4.0**
+ [[YAML]](https://github.com/camaraproject/KnowYourCustomerMatch/blob/r1.2/code/API_definitions/kyc-match.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomerMatch/r1.2/code/API_definitions/kyc-match.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomerMatch/r1.2/code/API_definitions/kyc-match.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/KnowYourCustomerMatch/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/KnowYourCustomerMatch/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/KnowYourCustomerMatch/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+* Note: **Releases of the KnowYourCustomerMatch API until Spring25 are available in [KnowYourCustomer](https://github.com/camaraproject/KnowYourCustomer).**
+
+## Contributing
+
+* Meetings are held virtually
+
+ * Schedule: bi-weekly, Tuesday, 08:00 UTC (09:00 CET, 10:00 CEST). For date/time of the next meeting, see previous meeting minutes.
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/96235150735?password=7e3fea67-a76e-4941-8a70-392cf5545917)
+ * Access [Meeting Minutes](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14551060/KnowYourCustomer+Meeting+Minutes)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list
+
+ Note:
+
+ * Before calling this API, 3rd parties / enterprise customers who want to use this API should make contact with API provider/ MNO for use of this API. As that will depend on each API provider / MNO's business process as well as GSMA Open Gateway standard process, it is out of scope of this API definition.
+
+ * When calling this API, at the beginning, there should be required processes for Authentication / Authorisation / End User Consent capturing. As those processes are defined as CAMARA commonality standards, they are out of scope of this API definition, however, use of the OpenID Connect (OIDC) is stated as security scheme.
+
+ ## Resources and Operations overview
+
+ The API provides the following endpoint:
+
+ * An endpoint to verify the matching of a number of attributes related to a mobile phone user identity against the account data bound to their phone number.
+
+ # Identifying the phoneNumber from the access token
+
+ This API requires the API consumer to identify a phoneNumber as the subject of the API as follows:
+ - When the API is invoked using a two-legged access token, the subject will be identified from the optional phoneNumber field, which therefore MUST be provided.
+ - When a three-legged access token is used, the subject will be uniquely identified from the access token. So, the optional phoneNumber is not used for identifying the subject, but, if it is provided in the API request body, it needs to match with the one associated with the access token.
+
+ ## Error handling:
+
+ - If the subject cannot be identified from the access token and the optional phoneNumber field is not included in the request, then the server will return an error with the `422 MISSING_IDENTIFIER` error code. This is an error typically, but not uniquely, returned in 2-legged scenarios when the access token doesn't identify a single subscription.
+ - If there is a mismatch between the provided phone number in the request body and the phone number associated with the access token, the server will return an error with the `403 INVALID_TOKEN_CONTEXT` error code.
+
+ ### Additional CAMARA error responses
+ The list of error codes in this API specification is not exhaustive. Therefore the API specification may not document some non-mandatory error statuses as indicated in `CAMARA API Design Guide`.
+ Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version.
+ As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API.
+
+ # Authorization and authentication
+
+ The "Camara Security and Interoperability Profile" provides details of how an API consumer requests an access token. Please refer to Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the profile.
+
+ The specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst also being subject to the prevailing legal framework dictated by local legislation.
+
+ In cases where personal data is processed by the API and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design.
+
+ version: wip
+ x-camara-commonalities: 0.6
+
+ license:
+ name: Apache 2.0
+ url: https://www.apache.org/licenses/LICENSE-2.0.html
+
+externalDocs:
+ description: Product documentation at CAMARA
+ url: https://github.com/camaraproject/KnowYourCustomerMatch
+
+servers:
+ - url: '{apiRoot}/kyc-match/v0.4'
+ variables:
+ apiRoot:
+ default: http://localhost:9091
+ description: API root, defined by the service provider, e.g. `api.example.com` or `api.example.com/somepath`
+
+tags:
+ - name: Match
+ description: Operations to match a customer identity against the account data bound to their phone number.
+
+paths:
+ /match:
+ post:
+ tags:
+ - Match
+ summary: Matching a customer identity by checking a set of attributes related against the account data bound to their phone number.
+ description: |-
+ Verify matching of a number of attributes related to a customer identity against the verified data bound to their phone number in the Operator systems. Regardless of whether the `phoneNumber` is explicitly stated in the request body, at least one of the other fields must be provided, otherwise a `HTTP 400 - KNOW_YOUR_CUSTOMER.INVALID_PARAM_COMBINATION` error will be returned.
+
+ The API will return the result of the matching process for each requested attribute. This means that the response will **only** contain the attributes for which validation has been requested. Possible values are:
+ - **true**: the attribute provided matches with the one in the Operator systems, which is equal to a `match_score` of 100.
+ - **false**: the attribute provided does not match with the one in the Operator systems.
+ - **not_available**: the attribute is not available to validate.
+ operationId: KYC_Match
+
+ security:
+ - openId:
+ - kyc-match:match
+
+
+ parameters:
+ - $ref: '#/components/parameters/x-correlator'
+
+ requestBody:
+ required: true
+ content:
+ application/json:
+
+ schema:
+ $ref: '#/components/schemas/KYC_MatchRequestBody'
+ examples:
+ Two-Legged and Three-leg Access Token Example:
+ value:
+ phoneNumber: '+34629255833'
+ idDocument: 66666666q
+ idDocumentType: passport
+ idDocumentExpiryDate: '2027-07-12'
+ name: Federica Sanchez Arjona
+ givenName: Federica
+ familyName: Sanchez Arjona
+ nameKanaHankaku: federica
+ nameKanaZenkaku: Ｆｅｄｅｒｉｃａ
+ middleNames: Sanchez
+ familyNameAtBirth: YYYY
+ address: Tokyo-to Chiyoda-ku Iidabashi 3-10-10
+ streetName: Nicolas Salmeron
+ streetNumber: '4'
+ postalCode: '1028460'
+ region: Tokyo
+ locality: ZZZZ
+ country: JP
+ houseNumberExtension: VVVV
+ birthdate: '1978-08-22'
+ email: abc@example.com
+ gender: OTHER
+ cityOfBirth: Madrid
+ countryOfBirth: ES
+ nationality: ES
+ Three-Legged Without Phone Number Example:
+ value:
+ idDocument: 66666666q
+ idDocumentType: passport
+ idDocumentExpiryDate: '2027-07-12'
+ name: Federica Sanchez Arjona
+ givenName: Federica
+ familyName: Sanchez Arjona
+ nameKanaHankaku: federica
+ nameKanaZenkaku: Ｆｅｄｅｒｉｃａ
+ middleNames: Sanchez
+ familyNameAtBirth: YYYY
+ address: Tokyo-to Chiyoda-ku Iidabashi 3-10-10
+ streetName: Nicolas Salmeron
+ streetNumber: '4'
+ postalCode: '1028460'
+ region: Tokyo
+ locality: ZZZZ
+ country: JP
+ houseNumberExtension: VVVV
+ birthdate: '1978-08-22'
+ email: abc@example.com
+ gender: OTHER
+ cityOfBirth: Madrid
+ countryOfBirth: ES
+ nationality: ES
+
+ responses:
+ '200':
+ description: OK
+ headers:
+ x-correlator:
+ $ref: '#/components/headers/x-correlator'
+
+ content:
+ application/json:
+
+ schema:
+ $ref: '#/components/schemas/KYC_MatchResponse'
+ examples:
+ KYC_Match200Example:
+ value:
+ idDocumentMatch: 'true'
+ idDocumentTypeMatch: 'true'
+ idDocumentExpiryDateMatch: 'true'
+ nameMatch: 'true'
+ givenNameMatch: 'not_available'
+ familyNameMatch: 'not_available'
+ nameKanaHankakuMatch: 'true'
+ nameKanaZenkakuMatch: 'false'
+ middleNamesMatch: 'true'
+ familyNameAtBirthMatch: 'false'
+ familyNameAtBirthMatchScore: 90
+ addressMatch: 'true'
+ streetNameMatch: 'true'
+ streetNumberMatch: 'true'
+ postalCodeMatch: 'true'
+ regionMatch: 'true'
+ localityMatch: 'not_available'
+ countryMatch: 'true'
+ houseNumberExtensionMatch: 'not_available'
+ birthdateMatch: 'false'
+ emailMatch: 'false'
+ emailMatchScore: 87
+ genderMatch: 'false'
+ cityOfBirthMatch: 'false'
+ cityOfBirthMatchScore: 86
+ countryOfBirthMatch: 'true'
+ nationalityMatch: 'true'
+
+ '400':
+ $ref: '#/components/responses/Generic400'
+
+ '401':
+ $ref: '#/components/responses/Generic401'
+
+ '403':
+ $ref: '#/components/responses/Generic403'
+
+ '404':
+ $ref: '#/components/responses/Generic404'
+
+ '422':
+ $ref: '#/components/responses/Generic422'
+
+components:
+ securitySchemes:
+ openId:
+ type: openIdConnect
+ openIdConnectUrl: https://example.com/.well-known/openid-configuration
+
+
+ headers:
+ x-correlator:
+ description: Correlation id for the different services
+ required: false
+ schema:
+ $ref: "#/components/schemas/XCorrelator"
+
+ parameters:
+ x-correlator:
+ name: x-correlator
+ in: header
+ description: Correlation id for the different services
+ required: false
+ schema:
+ $ref: "#/components/schemas/XCorrelator"
+
+ schemas:
+
+ XCorrelator:
+ type: string
+ pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
+ example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
+
+ KYC_MatchRequestBody:
+ type: object
+ description: Payload to validate the customer data.
+
+ properties:
+ phoneNumber:
+ type: string
+ description: 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, prefixed with '+'.
+ pattern: '^\+[1-9][0-9]{4,14}$'
+ example: "+123456789"
+
+ idDocument:
+ type: string
+ description: Id number associated to the official identity document in the country. It may contain alphanumeric characters.
+
+ idDocumentType:
+ type: string
+ enum: [passport, national_id_card, residence_permit, diplomatic_id, driver_licence, social_security_id, other]
+ description: Type of the official identity document provided.
+
+ idDocumentExpiryDate:
+ type: string
+ format: date
+ description: Expiration date of the identity document (ISO 8601).
+
+ name:
+ type: string
+ description: Complete name of the customer, usually composed of first/given name and last/family/sur- name in a country. Depending on the country, the order of first/give name and last/family/sur- name varies, and middle name could be included. It can use givenName, middleNames, familyName and/or familyNameAtBirth. For example, in ESP, name+familyName; in NLD, it can be name+middleNames+familyName or name+middleNames+familyNameAtBirth, etc.
+
+ givenName:
+ type: string
+ description: First/given name or compound first/given name of the customer.
+
+ familyName:
+ type: string
+ description: Last name, family name, or surname of the customer.
+
+ nameKanaHankaku:
+ type: string
+ description: Complete name of the customer in Hankaku-Kana format (reading of name) for Japan.
+
+ nameKanaZenkaku:
+ type: string
+ description: Complete name of the customer in Zenkaku-Kana format (reading of name) for Japan.
+
+ middleNames:
+ type: string
+ description: Middle name/s of the customer.
+
+ familyNameAtBirth:
+ type: string
+ description: Last/family/sur- name at birth of the customer.
+
+ address:
+ type: string
+ description: Complete address of the customer. For some countries, it is built following the usual concatenation of parameters in a country, but for other countries, this is not the case. For some countries, it can use streetName, streetNumber and/or houseNumberExtension. For example, in ESP, streetName+streetNumber; in NLD, it can be streetName+streetNumber or streetName+streetNumber+houseNumberExtension.
+
+ streetName:
+ type: string
+ description: Name of the street of the customer's address. It should not include the type of the street.
+
+ streetNumber:
+ type: string
+ description: The street number of the customer's address. Number identifying a specific property on the 'streetName'.
+
+ postalCode:
+ type: string
+ description: Zip code or postal code
+
+ region:
+ type: string
+ description: Region/prefecture of the customer's address
+
+ locality:
+ type: string
+ description: Locality of the customer's address
+
+ country:
+ type: string
+ description: Country of the customer's address. Format ISO 3166-1 alpha-2
+
+ houseNumberExtension:
+ type: string
+ description: Specific identifier of the house needed depending on the property type. For example, number of apartment in an apartment building.
+
+ birthdate:
+ type: string
+ format: date
+ description: The birthdate of the customer, in RFC 3339 / ISO 8601 calendar date format (YYYY-MM-DD).
+
+ email:
+ type: string
+ format: email
+ description: Email address of the customer in the RFC specified format (local-part@domain).
+
+ gender:
+ type: string
+ description: Gender of the customer (Male/Female/Other).
+ enum:
+ - MALE
+ - FEMALE
+ - OTHER
+
+ cityOfBirth:
+ type: string
+ description: City where the customer was born.
+
+ countryOfBirth:
+ type: string
+ description: Country where the customer was born. Format ISO 3166-1 alpha-2.
+
+ nationality:
+ type: string
+ description: ISO 3166-1 alpha-2 code of the customer’s nationality. In the case a customer has more than one nationality, it is supposed to be the nationality related to the ID document provided in the match request.
+ MatchResult:
+ type: string
+ description: |
+ true - the attribute provided matches with the one in the Operator systems, which is equal to a `match_score` of 100.
+ false - the attribute provided does not match with the one in the Operator systems.
+ not_available - the attribute is not available to validate.
+ enum:
+ - 'true'
+ - 'false'
+ - 'not_available'
+
+ MatchScoreResult:
+ type: integer
+ description: |
+ Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator's system.
+ This property shall only be returned when the value of the corresponding match field is `false`.
+ A perfect match with a score of 100 is indicated by `match` being 'true' and no `matchScore` is returned in this case.
+ minimum: 0
+ maximum: 99
+
+ KYC_MatchResponse:
+ type: object
+ properties:
+ idDocumentMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether Id number associated to the ID document of the customer matches with the one on the Operator's system.
+ idDocumentTypeMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether document type associated to the ID document of the customer matches with the one on the Operator's system.
+ idDocumentExpiryDateMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether document expiration date associated to the ID document of the customer matches with the one on the Operator's system.
+ nameMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the complete name of the customer matches with the one on the Operator's system.
+ nameMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ givenNameMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether First name/given name of the customer matches with the one on the Operator's system.
+ givenNameMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ familyNameMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether last name/ family name/ surname of the customer matches with the one on the Operator's system.
+ familyNameMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ nameKanaHankakuMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether complete name of the customer in Hankaku-Kana format (reading of name) for Japan matches with the one on the Operator's system.
+ nameKanaHankakuMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ nameKanaZenkakuMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether complete name of the customer in Zenkaku-Kana format (reading of name) for Japan matches with the one on the Operator's system.
+ nameKanaZenkakuMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ middleNamesMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the middle names of the customer matches with the one on the Operator's system.
+ middleNamesMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ familyNameAtBirthMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the Family Name At Birth of the customer matches with the one on the Operator's system.
+ familyNameAtBirthMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ addressMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether complete address of the customer matches with the one on the Operator's system.
+ addressMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ streetNameMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the street name of the customer matches with the one on the Operator's system.
+ streetNameMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ streetNumberMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the street number of the customer matches with the one on the Operator's system.
+ streetNumberMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ postalCodeMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the postal code / zip code of the customer matches with the one on the Operator's system.
+ regionMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the region of the customer's address matches with the one on the Operator's system.
+ regionMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ localityMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the locality of the customer's address matches with the one on the Operator's system.
+ localityMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ countryMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the country of the customer's address matches with the one on the Operator's system.
+ houseNumberExtensionMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the house number extension of the customer's address with the one on the Operator's system.
+ birthdateMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the birthdate of the customer matches with the one on the Operator's system.
+ emailMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the email address of the customer matches with the one on the Operator's system.
+ emailMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ genderMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the gender of the customer matches with the one on the Operator's system.
+ cityOfBirthMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the city at birth of the customer matches with the one on the Operator's system
+ cityOfBirthMatchScore:
+ $ref: '#/components/schemas/MatchScoreResult'
+ countryOfBirthMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the country at birth of the customer matches with the one on the Operator's system
+ nationalityMatch:
+ allOf:
+ - $ref: '#/components/schemas/MatchResult'
+ - description: Indicates whether the nationality of the customer matches with the one on the Operator's system
+
+ ErrorInfo:
+ type: object
+ required:
+ - status
+ - code
+ - message
+ properties:
+ message:
+ type: string
+ description: A human-readable description of what the event represents
+ status:
+ type: integer
+ description: HTTP response status code
+ code:
+ type: string
+ description: A human-readable code to describe the error
+
+ responses:
+ Generic400:
+ description: Bad Request
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 400
+ code:
+ enum:
+ - INVALID_ARGUMENT
+ - KNOW_YOUR_CUSTOMER.INVALID_PARAM_COMBINATION
+ examples:
+ GENERIC_400_INVALID_ARGUMENT:
+ description: Invalid Argument. Generic Syntax Exception
+ value:
+ status: 400
+ code: INVALID_ARGUMENT
+ message: Client specified an invalid argument, request body or query param.
+ KNOW_YOUR_CUSTOMER.INVALID_PARAM_COMBINATION:
+ description: Indicated param combination is invalid
+ value:
+ status: 400
+ code: KNOW_YOUR_CUSTOMER.INVALID_PARAM_COMBINATION
+ message: Indicated parameter combination is invalid
+
+ Generic401:
+ description: Unauthorized
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 401
+ code:
+ enum:
+ - UNAUTHENTICATED
+
+ examples:
+ GENERIC_401_UNAUTHENTICATED:
+ description: Request cannot be authenticated and a new authentication is required
+ value:
+ status: 401
+ code: UNAUTHENTICATED
+ message: Request not authenticated due to missing, invalid, or expired credentials. A new authentication is required.
+
+ Generic403:
+ description: Forbidden
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 403
+ code:
+ enum:
+ - PERMISSION_DENIED
+ - INVALID_TOKEN_CONTEXT
+ examples:
+ GENERIC_403_PERMISSION_DENIED:
+ description: Permission denied. OAuth2 token access does not have the required scope or when the user fails operational security
+ value:
+ status: 403
+ code: PERMISSION_DENIED
+ message: Client does not have sufficient permissions to perform this action.
+ GENERIC_403_INVALID_TOKEN_CONTEXT:
+ description: Reflect some inconsistency between information in some field of the API and the related OAuth2 Token
+ value:
+ status: 403
+ code: INVALID_TOKEN_CONTEXT
+ message: "phoneNumber is not consistent with access token."
+
+ Generic404:
+ description: Not found
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 404
+ code:
+ enum:
+ - NOT_FOUND
+ - IDENTIFIER_NOT_FOUND
+ examples:
+ GENERIC_404_NOT_FOUND:
+ description: Resource is not found
+ value:
+ status: 404
+ code: NOT_FOUND
+ message: The specified resource is not found.
+ GENERIC_404_IDENTIFIER_NOT_FOUND:
+ description: The phone number is not associated with a CSP customer account
+ value:
+ status: 404
+ code: IDENTIFIER_NOT_FOUND
+ message: The phone number provided is not associated with a customer account
+
+ Generic422:
+ description: Unprocessable Content
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 422
+ code:
+ enum:
+ - SERVICE_NOT_APPLICABLE
+ - MISSING_IDENTIFIER
+ examples:
+ GENERIC_422_SERVICE_NOT_APPLICABLE:
+ description: Service is not applicable for the provided phone number
+ value:
+ status: 422
+ code: SERVICE_NOT_APPLICABLE
+ message: The service is not applicable for the provided phone number
+ GENERIC_422_MISSING_IDENTIFIER:
+ description: No phone number has been provided either explicitly or associated with the access token
+ value:
+ status: 422
+ code: MISSING_IDENTIFIER
+ message: No phone number has been provided
diff --git a/original/KnowYourCustomerMatch/documentation/API_documentation/KnowYourCustomer_User_Story.md b/original/KnowYourCustomerMatch/documentation/API_documentation/KnowYourCustomer_User_Story.md
new file mode 100644
index 0000000000000000000000000000000000000000..158abcbb16059c1c98cf16dbadb13873ee5afc02
--- /dev/null
+++ b/original/KnowYourCustomerMatch/documentation/API_documentation/KnowYourCustomer_User_Story.md
@@ -0,0 +1,27 @@
+**User Story: KYC Match - verify customer information**
+
+
+
+
+
+
+
+
+
+# ModelAsAService
+
+Sandbox API Repository to describe, develop, document, and test the ModelAsAService Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/_4AjAw)
+
+## Scope
+
+* Service APIs “ModelAsAService” (see APIBacklog.md)
+* MaaS (Model as a Services) refers to the packaging of AI models and their associated capabilities into reusable services, enabling users to quickly and efficiently build, deploy, monitor, and invoke models without the need to develop and maintain underlying foundational capabilities.
+* The API provides the API consumer with the ability to:
+ * build and manage personalized Knowledge Bases (knowledge-base)
+ * quickly construct unique Q&A Assistant applications (qa-assistant-manage)
+ * provide Q&A services to the users of the application (qa-assistant-service)
+ * NOTE: more model services to be added.
+* Describe, develop, document, and test the APIs
+* Started: November 2024
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r1.2](https://github.com/camaraproject/ModelAsAService/releases/tag/r1.2) (Fall25), with the following API versions:
+ * **knowledge-base v0.1.0**
+ [[YAML]](https://github.com/camaraproject/ModelAsAService/blob/r1.2/code/API_definitions/knowledge-base.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ModelAsAService/r1.2/code/API_definitions/knowledge-base.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ModelAsAService/r1.2/code/API_definitions/knowledge-base.yaml)
+ * **qa-assistant-manage v0.1.0**
+ [[YAML]](https://github.com/camaraproject/ModelAsAService/blob/r1.2/code/API_definitions/qa-assistant-manage.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ModelAsAService/r1.2/code/API_definitions/qa-assistant-manage.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ModelAsAService/r1.2/code/API_definitions/qa-assistant-manage.yaml)
+ * **qa-assistant-service v0.1.0**
+ [[YAML]](https://github.com/camaraproject/ModelAsAService/blob/r1.2/code/API_definitions/qa-assistant-service.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ModelAsAService/r1.2/code/API_definitions/qa-assistant-service.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ModelAsAService/r1.2/code/API_definitions/qa-assistant-service.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/ModelAsAService/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/ModelAsAService/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/ModelAsAService/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings are held virtually
+ * Schedule: Bi-weekly (odd weeks), Tuesday, 09:00 UTC (11:00 UTC+2, 17:00 UTC+8)
+ * [Join](https://teams.live.com/meet/9374614741908?p=QFhUf7b0SHZRdXSfA6)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/l/cp/GpKaVSqC)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project
+
+
+
+
+
+
+
+
+# MostFrequentLocation
+
+Sandbox API Repository to describe, develop, document, and test the MostFrequentLocation Service API(s). The repository does not yet belong to a CAMARA Sub Project, but works together with DeviceVisitLocation as Location Insights.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/XjPe)
+
+## Scope
+
+* Service APIs for “MostFrequentLocation” (see APIBacklog.md)
+* It provides the API Consumer with the ability to:
+ * "MostFrequentLocation": validate, in terms of scoring, of the user's expected home area
+ * NOTE: The scope of these APIs should be limited (at least at the first stage) to 4G and 5G.
+* Describe, develop, document and test the APIs (with 1-2 Telcos)
+* Started: May 2024
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r2.2](https://github.com/camaraproject/MostFrequentLocation/releases/tag/r2.2) (Fall25), with the following API versions:
+ * **most-frequent-location v0.2.0**
+ [[YAML]](https://github.com/camaraproject/MostFrequentLocation/blob/r2.2/code/API_definitions/most-frequent-location.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/MostFrequentLocation/r2.2/code/API_definitions/most-frequent-location.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/MostFrequentLocation/r2.2/code/API_definitions/most-frequent-location.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/MostFrequentLocation/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/MostFrequentLocation/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/MostFrequentLocation/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings are held virtually
+ * Schedule: On-demand
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/99479758031?password=c705dd6f-a1c5-44e4-af97-331a18395fb8)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14564467/MostFrequentLocation+2024+Minutes)
+ * Slack channel: [camara-project.slack.com](https://camara-project.slack.com/archives/C07BHCZ3XUY) #sp-location-insights
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project
+
+
+
+
+
+
+
+
+# MultiPointVPN
+
+Sandbox API Repository to describe, develop, document, and test the MultiPointVPN Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/AYD7Bw)
+
+## Scope
+
+* Service API(s) “MultiPointVPN” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * The MultiPoint VPN API transforms the process of ordering private or customized network services across multiple touchpoints. It enables users to create and configure on-demand edge connectivity services with guaranteed SLA and bandwidth with just one click, eliminating the need for manual orders through phone calls or customer managers. When the API is called with specific network SLA requirements, telecom operators can create non-public cloud leased network services by orchestrating IP VPN connections across various networks, including data centers, private clouds, operator networks, and satellite links
+* Describe, develop, document, and test the API(s)
+* Started: June 2025
+
+
+
+
+
+## Release Information
+
+The repository has no (pre)releases yet, work in progress is within the main branch.
+
+
+## Contributing
+
+* Meetings are held virtually
+ * Schedule: Bi-weekly meeting on Wednesday every 2 week(s), at 12:30 UTC
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meetings/telcoapi)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/AYD7Bw)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list
+
+
+
+
+
+
+
+
+# NetworkAccessManagement
+
+Sandbox API Repository to describe, develop, document, and test the NetworkAccessManagement Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/5wCzHQ)
+
+## Scope
+* Service APIs for “Network Access Management” of Home Devices (see APIBacklog.md)
+* It provides the customer with the ability to:
+ * manage fixed devices provided by network operators that reside at customer premises.
+* Describe, develop, document, and test the APIs (with 1-2 Telcos)
+* Started: May 2024
+
+
+
+
+## Release Information
+
+The repository has no (pre)releases yet, work in progress is within the main branch.
+
+
+## Contributing
+* Meetings
+ * [Registration/Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/96846363178?password=9ebebe6c-c59c-42be-a709-7d5fd42fb626)
+ * Schedule: Bi-weekly on Fridays at 8AM MDT / 4PM CEST
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/ez3e).
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project
+
+
+
+
+
+
+
+
+# NetworkInsights
+
+Sandbox API Repository to describe, develop, document, and test the NetworkInsights Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/fQCoBg)
+
+## Scope
+
+* Service API(s) “NetworkInsights” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * Network Insight offers a unified analytical platform for specific networks, such as private networks and slices, focusing exclusively on aggregated network-level data rather than individual device information. It empowers users to both evaluate the overall network health through a comprehensive, component-based scoring system and to analyze service traffic patterns with customizable granularity. By providing a holistic view — from infrastructure health to user traffic trends — this API suite delivers the critical, real-time data needed for comprehensive network monitoring, strategic performance optimization, and effective early warning systems.
+* Describe, develop, document, and test the API(s)
+* Started: May 2025
+
+
+
+
+
+## Release Information
+
+The repository has no (pre)releases yet, work in progress is within the main branch.
+
+
+## Contributing
+
+* Meetings are held virtually
+
+ * Schedule: !! tbd
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meetings/telcoapi) !! Update this link with your meeting registration/join link and delete the task
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/fQCoBg) !! update this link to your minutes archive page using the "Share" link and delete the task
+
+* Mailing List
+
+ * Subscribe / Unsubscribe to the mailing list
+
+
+
+
+
+
+
+
+# NetworkSliceBooking
+
+Sandbox API Repository to describe, develop, document, and test the NetworkSliceBooking Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/rDPe)
+
+## Scope
+* Service APIs for “Network Slice Booking” (see APIBacklog.md)
+* It provides the API consumer with the ability to:
+ * reserve, dynamically provisioning, query, dynamically delete a slice with customized SLA assurance capabilities, customized service duration, expected slice covered locations.
+ * manage user subscription to the network slices.
+* Describe, develop, document and test the APIs (with 1-2 Telcos)
+* Started: January 2024
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest pre-release is [r2.1](https://github.com/camaraproject/NetworkSliceBooking/releases/tag/r2.1), with the following API versions:
+ * **network-slice-booking v0.2.0-rc.1**
+ [[YAML]](https://github.com/camaraproject/NetworkSliceBooking/blob/r2.1/code/API_definitions/network-slice-booking.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r2.1/code/API_definitions/network-slice-booking.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r2.1/code/API_definitions/network-slice-booking.yaml)
+ * **network-slice-assignment v0.1.0-rc.1**
+ [[YAML]](https://github.com/camaraproject/NetworkSliceBooking/blob/r2.1/code/API_definitions/network-slice-assignment.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r2.1/code/API_definitions/network-slice-assignment.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r2.1/code/API_definitions/network-slice-assignment.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/NetworkSliceBooking/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/NetworkSliceBooking/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/NetworkSliceBooking/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings are held virtually
+ * Schedule: Bi-weekly on Fridays 16:00 CST / 10:00 CEST
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/92204181217?password=7ef83098-28d4-417c-95bc-3f0ab7904c8f)
+ * Minutes: Access [Meeting minutes](https://wiki.camaraproject.org/display/CAM/NetworkSliceBooking)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project
+
+
+
+
+
+
+
+
+# NumberRecycling
+
+Sandbox API Repository to describe, develop, document, and test the NumberRecycling API within the [Know Your Customer (KYC)](https://lf-camaraproject.atlassian.net/wiki/x/I4DGB) Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/ggCaBQ)
+
+## Scope
+
+* Service API “NumberRecycling” (see [APIBacklog.md](https://github.com/camaraproject/APIBacklog/blob/main/documentation/APIbacklog.md))
+* The API provides the API consumer with the ability to:
+ * Check whether the subscriber of the phone number has changed. A common scenario is when Application service provider (ASP) wants to check whether there has been a change in the user associated with the phone number after the specified date. This allows the ASP to ensure that a phone number is correctly linked to an user and prevent the mis-delivery of SMS messages.
+* Describe, develop, document, and test the API
+* Started: August 2024
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r2.2](https://github.com/camaraproject/NumberRecycling/releases/tag/r2.2) (Fall25), with the following API versions:
+ * **number-recycling v0.2.0**
+ [[YAML]](https://github.com/camaraproject/NumberRecycling/blob/r2.2/code/API_definitions/number-recycling.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberRecycling/r2.2/code/API_definitions/number-recycling.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NumberRecycling/r2.2/code/API_definitions/number-recycling.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/NumberRecycling/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/NumberRecycling/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/NumberRecycling/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings of KnowYourCustomer Sub Project are held virtually
+ * Schedule: Bi-weekly, Tuesday, 08:00 UTC (09:00 CET, 10:00 CEST)
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/96235150735?password=7e3fea67-a76e-4941-8a70-392cf5545917)
+ * Minutes: Access [meeting minutes](https://github.com/camaraproject/KnowYourCustomer/tree/main/documentation/MeetingMinutes)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list of this Sub Project
+
+ Note:
+ * When API receives a request with specified date on which a user signed a contract with MNO, the API respond sets to 'false'(e.g., 2023-10-09 in the Scenario 1 of the figure above).
+
+ * Scenario 2
+ * Pre-conditions
+ * User A signed a contract with MNO A for the phone number '+123456789' on October 9, 2023, and canceled it on February 25, 2024. Subsequently, User B signed a contract with MNO A for the same phone number on September 21, 2024, and is still using it.
+ * User A also signed contracts with ASP A on December 22, 2023 for its services.
+ * ASP A holds the contract date (2023-12-22) and the phone number (+123456789) for User A.
+ * Currently, on November 2, 2024, ASP A wishes to send a SMS message to User A.
+ * Potential operations
+ * ASP A sends a request with specified date (2023-12-22) and phone number (+123456789) to the Number Recycling API.
+ * The API response sets to 'true', indicating that there has been a change in the user associated with the phone number.
+ * Post-conditions
+ * ASP A decides to stop sending the SMS message to User A and contacts User A by mail.
+ * By following these steps, ASP A ensures that a phone number is not linked to User A and prevents the mis-delivery of the SMS message.
+
+
+
+ Note:
+ * When the API receives a request with specified date during which there is no contract with MNO for the phone number, the API respond sets to 'true'(e.g., the period between 2024-02-25 and 2024-09-20 in the Scenario 2 of the figure above).
+
+ # Authorization and authentication
+
+ The "Camara Security and Interoperability Profile" provides details of how an API consumer requests an access token. Please refer to Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the profile.
+
+ The specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst also being subject to the prevailing legal framework dictated by local legislation.
+
+ In cases where personal data is processed by the API and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design.
+
+ # Identifying the phone number from the access token
+
+ This API requires the API consumer to identify a phone number as the subject of the API as follows:
+ - When the API is invoked using a two-legged access token, the subject will be identified from the optional `phoneNumber` field, which therefore MUST be provided.
+ - When a three-legged access token is used however, this optional identifier MUST NOT be provided, as the subject will be uniquely identified from the access token.
+
+ This approach simplifies API usage for API consumers using a three-legged access token to invoke the API by relying on the information that is associated with the access token and was identified during the authentication process.
+
+ ## Error handling:
+
+ - If the subject cannot be identified from the access token and the optional `phoneNumber` field is not included in the request, then the server will return an error with the `422 MISSING_IDENTIFIER` error code.
+ - If the subject can be identified from the access token and the optional `phoneNumber` field is also included in the request, then the server will return an error with the `422 UNNECESSARY_IDENTIFIER` error code. This will be the case even if the same phone number is identified by these two methods, as the server is unable to make this comparison.
+
+ ### Additional CAMARA error responses
+ The list of error codes in this API specification is not exhaustive. Therefore the API specification may not document some non-mandatory error statuses as indicated in `CAMARA API Design Guide`.
+ Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version.
+ As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API.
+
+ version: wip
+ x-camara-commonalities: tbd
+
+ license:
+ name: Apache 2.0
+ url: https://www.apache.org/licenses/LICENSE-2.0.html
+externalDocs:
+ description: Product documentation at CAMARA
+ url: https://github.com/camaraproject/NumberRecycling
+servers:
+ - url: '{apiRoot}/number-recycling/vwip'
+ variables:
+ apiRoot:
+ default: http://localhost:9091
+ description: API root, defined by the service provider, e.g. `api.example.com` or `api.example.com/somepath`
+paths:
+ /check:
+ post:
+ security:
+ - openId:
+ - number-recycling:check
+ tags:
+ - Check Number Recycling
+ summary: Check whether the subscriber of the phone number has changed.
+ description: Check whether the subscriber of the phone number has changed.
+ operationId: checkNumberRecycling
+ parameters:
+ - $ref: '#/components/parameters/x-correlator'
+ requestBody:
+ description: |
+ Check whether the subscriber of the phone number has changed.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CreateCheckNumRecycling'
+ required: true
+ responses:
+ '200':
+ description: OK
+ headers:
+ x-correlator:
+ $ref: "#/components/headers/x-correlator"
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/CheckNumRecyclingInfo"
+ '400':
+ $ref: '#/components/responses/Generic400'
+ '401':
+ $ref: '#/components/responses/Generic401'
+ '403':
+ $ref: '#/components/responses/Generic403'
+ '404':
+ $ref: '#/components/responses/Generic404'
+ '422':
+ $ref: '#/components/responses/Generic422'
+components:
+ securitySchemes:
+ openId:
+ type: openIdConnect
+ openIdConnectUrl: https://example.com/.well-known/openid-configuration
+ parameters:
+ x-correlator:
+ name: x-correlator
+ in: header
+ description: Correlation id for the different services
+ schema:
+ $ref: "#/components/schemas/XCorrelator"
+ headers:
+ x-correlator:
+ description: Correlation id for the different services
+ schema:
+ $ref: "#/components/schemas/XCorrelator"
+ schemas:
+ CreateCheckNumRecycling:
+ type: object
+ required:
+ - specifiedDate
+ properties:
+ phoneNumber:
+ $ref: '#/components/schemas/PhoneNumber'
+ specifiedDate:
+ type: string
+ format: date
+ description: Specified date to check whether there has been a change in the subscriber associated with the specific phone number, in RFC 3339 calendar date format (YYYY-MM-DD).
+ example: "2024-10-31"
+ PhoneNumber:
+ description: 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, prefixed with '+'.
+ type: string
+ pattern: '^\+[1-9][0-9]{4,14}$'
+ example: "+123456789"
+ CheckNumRecyclingInfo:
+ type: object
+ required:
+ - phoneNumberRecycled
+ properties:
+ phoneNumberRecycled:
+ type: boolean
+ description: |
+ Set to true (Boolean, not string) when there has been a change in the subscriber associated with the specific phone number after “specifiedDate”.
+ ErrorInfo:
+ type: object
+ required:
+ - status
+ - code
+ - message
+ properties:
+ status:
+ type: integer
+ description: HTTP response status code
+ code:
+ type: string
+ description: A human-readable code to describe the error
+ message:
+ type: string
+ description: A human-readable description of what the event represents
+ XCorrelator:
+ type: string
+ pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
+ example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
+ responses:
+ Generic200:
+ description: OK
+ headers:
+ x-correlator:
+ $ref: '#/components/headers/x-correlator'
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CheckNumRecyclingInfo'
+
+ Generic400:
+ description: Problem with the client request
+ headers:
+ x-correlator:
+ $ref: '#/components/headers/x-correlator'
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 400
+ code:
+ enum:
+ - INVALID_ARGUMENT
+ - OUT_OF_RANGE
+ examples:
+ InvalidArgument:
+ description: Invalid Argument. Generic Syntax Exception
+ value:
+ status: 400
+ code: INVALID_ARGUMENT
+ message: Client specified an invalid argument, request body or query param.
+ OutOfRange:
+ description: Out of Range. Specific Syntax Exception used when a given field has a pre-defined range or a invalid filter criteria combination is requested
+ value:
+ status: 400
+ code: OUT_OF_RANGE
+ message: Client specified an invalid range.
+
+ Generic401:
+ description: Authentication problem with the client request
+ headers:
+ x-correlator:
+ $ref: '#/components/headers/x-correlator'
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 401
+ code:
+ enum:
+ - UNAUTHENTICATED
+ examples:
+ Unauthenticated:
+ description: Request cannot be authenticated and a new authentication is required
+ value:
+ status: 401
+ code: UNAUTHENTICATED
+ message: Request not authenticated due to missing, invalid, or expired credentials. A new authentication is required.
+
+ Generic403:
+ description: Client does not have sufficient permission
+ headers:
+ x-correlator:
+ $ref: '#/components/headers/x-correlator'
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 403
+ code:
+ enum:
+ - PERMISSION_DENIED
+ examples:
+ Permission Denied:
+ description: Permission denied. OAuth2 token access not have the required scope or when the user fails operational security
+ value:
+ status: 403
+ code: PERMISSION_DENIED
+ message: Client does not have sufficient permissions to perform this action
+
+ Generic404:
+ description: Resource Not Found
+ headers:
+ x-correlator:
+ $ref: '#/components/headers/x-correlator'
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 404
+ code:
+ enum:
+ - IDENTIFIER_NOT_FOUND
+ examples:
+ Phone Number Used By Different Network Operator:
+ description: Provided phone number is used by a different network operator
+ value:
+ status: 404
+ code: IDENTIFIER_NOT_FOUND
+ message: Phone number not found.
+
+ Generic422:
+ description: Unprocessable Content
+ headers:
+ x-correlator:
+ $ref: '#/components/headers/x-correlator'
+ content:
+ application/json:
+ schema:
+ allOf:
+ - $ref: "#/components/schemas/ErrorInfo"
+ - type: object
+ properties:
+ status:
+ enum:
+ - 422
+ code:
+ enum:
+ - SERVICE_NOT_APPLICABLE
+ - MISSING_IDENTIFIER
+ - UNNECESSARY_IDENTIFIER
+ examples:
+ Device Not Applicable:
+ description: Service not applicable for the provided phone number
+ value:
+ status: 422
+ code: SERVICE_NOT_APPLICABLE
+ message: The service is not available for the provided phone number
+ Unnecessary Identifier:
+ description: An explicit identifier is provided when a phone number has already been identified from the access token
+ value:
+ status: 422
+ code: UNNECESSARY_IDENTIFIER
+ message: The phone number is already identified by the access token
+ Missing Identifier:
+ description: An identifier is not included in the request and the phone number identification cannot be derived from the 3-legged access token
+ value:
+ status: 422
+ code: MISSING_IDENTIFIER
+ message: The phone number cannot be identified
diff --git a/original/NumberRecycling/documentation/API_documentation/Number_Recycling_User_Story.md b/original/NumberRecycling/documentation/API_documentation/Number_Recycling_User_Story.md
new file mode 100644
index 0000000000000000000000000000000000000000..e0650beaf0c2a160682a7683bdfdfafdc256dce3
--- /dev/null
+++ b/original/NumberRecycling/documentation/API_documentation/Number_Recycling_User_Story.md
@@ -0,0 +1,11 @@
+# Number Recycling API User Story
+
+
+| **Item** | **Details** |
+| ---- | ------- |
+| ***Summary*** | As an enterprise application developer, I want to check whether there has been a change in the user associated with the phone number after the specified date so that I can ensure that a phone number is correctly linked to an user and prevent mis-delivery before sending SMS messages to an user. |
+| ***Roles, Actors and Scope*** | **Actors:** Application service providers (ASP), ASP:User, ASP: BusinessManager, ASP:Administrator, Communication service Provider (CSP), Channel Partner.
+
+
+
+
+
+
+
+
+# NumberVerification
+
+Incubating API Repository to evolve and maintain the definitions and documentation of the NumberVerification Service API within the Sub Project [Number Insights](https://lf-camaraproject.atlassian.net/wiki/x/BYEpBQ).
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/XzTe)
+
+## Scope
+
+* Service API for “NumberVerification” (see APIBacklog.md)
+* It provides the API consumer with the ability to:
+ * verify the phone number associated with the SIM used in the device connected to the mobile data network.
+* Describe, develop, document and test the APIs (with 1-2 Telcos)
+* Started: October 2022
+* Incubating stage since: February 2025
+
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r3.2](https://github.com/camaraproject/NumberVerification/releases/tag/r3.2) (Fall25), with the following API versions:
+ * **number-verification v2.1.0**
+ [[YAML]](https://github.com/camaraproject/NumberVerification/blob/r3.2/code/API_definitions/number-verification.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r3.2/code/API_definitions/number-verification.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r3.2/code/API_definitions/number-verification.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/NumberVerification/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/NumberVerification/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/NumberVerification/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings are held virtually
+ * Schedule: Every 4 weeks, Thursday, 7:30 AM UTC (8:30 CET/9:30 CEST)
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/94893248838?password=05b2197d-309e-41ef-aadf-639f71ef7f38)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14564484/Minutes+-+Number+Insights)
+* Mailing list:
+ * To subscribe / unsubscribe to the mailing list of this Sub Project and thus be / resign as Contributor please visit
+
+
+
+
+
+
+
+
+# OTPValidation
+
+Incubating API Repository to evolve and maintain the definitions and documentation of OTPValidation Service API within the Sub Project [Number Insights](https://lf-camaraproject.atlassian.net/wiki/x/BYEpBQ)
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/yDXe)
+
+## Scope
+
+* Service APIs for “OTPValidation” (see APIBacklog.md)
+ * The OTP SMS API facilitates real-time verification of a user's device by sending a unique code via SMS to the specified mobile phone number. The process involves three key steps:
+1. **Code Generation and Delivery:**
+ The send-code operation is used by the API consumer (e.g., an application) to request a one-time code to be sent by SMS to the application user's mobile phone along with an message to the user's mobile device.
+2. **User Input:**
+ The user receives the SMS and enters the received code into the application.
+3. **Verification:**
+ The application submits the entered code using the validate-code operation, which then verifies its accuracy and responds with a confirmation indicating whether the code is valid.
+
+This process ensures secure, real-time validation of user possession of the specified device, enhancing authentication security.
+ * by delivering a one-time password (OTP) to it through SMS and validating the received code with the user's operator after the code is entered as requested.
+ * Started: October 2022
+ * Incubating stage since: February 2025
+
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r3.2](https://github.com/camaraproject/OTPValidation/releases/tag/r3.2) (Fall25), with the following API versions:
+ * **one-time-password-sms v1.1.1**
+ [[YAML]](https://github.com/camaraproject/OTPValidation/blob/r3.2/code/API_definitions/one-time-password-sms.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/OTPValidation/r3.2/code/API_definitions/one-time-password-sms.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/OTPValidation/r3.2/code/API_definitions/one-time-password-sms.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/OTPValidation/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/OTPValidation/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/OTPValidation/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings are held virtually
+ * Schedule: Every 4 weeks, Thursday, 7:30 AM UTC (8:30 CET/9:30 CEST)
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/94893248838?password=05b2197d-309e-41ef-aadf-639f71ef7f38)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14564484/Minutes+-+Number+Insights)
+* Mailing list
+ * Subscribe / Unsubscribe to the mailing list
+
+
+
+
+
+
+
+
+# OptimalEdgeDiscovery
+
+Sandbox API Repository to describe, develop, document, and test the OptimalEdgeDiscovery Service API(s) within the Sub Project [Edge Cloud](https://lf-camaraproject.atlassian.net/wiki/x/IwEpBQ).
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/AYAtC)
+
+## Scope
+
+* Service API(s) “OptimalEdgeDiscovery” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * Discover the optimal regions and zones for their edge cloud application
+* Describe, develop, document, and test the API(s)
+* Started: July 2022 (in [EdgeCloud](https://github.com/camaraproject/EdgeCloud) repository)
+
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r1.2](https://github.com/camaraproject/OptimalEdgeDiscovery/releases/tag/r1.2) (Fall25), with the following API versions:
+ * **optimal-edge-discovery v0.1.0**
+ [[YAML]](https://github.com/camaraproject/OptimalEdgeDiscovery/blob/r1.2/code/API_definitions/optimal-edge-discovery.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/OptimalEdgeDiscovery/r1.2/code/API_definitions/optimal-edge-discovery.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/OptimalEdgeDiscovery/r1.2/code/API_definitions/optimal-edge-discovery.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/OptimalEdgeDiscovery/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/OptimalEdgeDiscovery/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/OptimalEdgeDiscovery/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings are held virtually
+ * Schedule: Bi-weekly on Tuesdays 14:00 - 15:00 UTC
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/91868502920?password=a9ec9dff-ea92-4216-b0a1-ce152f49170f)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/8Tve)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list
+
+
+
+
+
+
+
+
+# PopulationDensityData
+
+Incubating API Repository to evolve and maintain the definitions and documentation of PopulationDensityData Service API(s) within the Sub Project [Population Density Data](https://lf-camaraproject.atlassian.net/wiki/x/LwAwC)
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/3DXe)
+
+## Scope
+* Service APIs for “Population Density Data” (see APIBacklog.md)
+* It provides the API consumer with the ability to:
+ * The service enables developers with the capability to get dynamic population density data in a specific area for a specified date&time, considering anonymized information of the network connected devices in the requested area at the flight time.
+ * Use Case (1): Providing BVLOS flight the data to meet SORA 2.5 requirements in terms of intrinsic Ground Risk Class (iGRC).
+ * Use Case (2): Providing data to identify if the ground risk class for a given drone flight is acceptable for the time of the flight, or an alternative time should be considered to lower the risk.
+ * Service Inputs: Area of the interest. Date & time range.
+ * Service Outputs: maximum, average and minimum population density value for the given area, and interval corresponding to the valid range of that value. (space and time maps).
+ * NOTE: The scope of these APIs should be limited (at least at a first stage) to 4G and 5G.
+* Describe, develop, document and test the APIs (with 1-2 Telcos)
+* Started: December 2023
+* Incubating stage since: June 2025
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r3.2](https://github.com/camaraproject/PopulationDensityData/releases/tag/r3.2) (Fall25), with the following API versions:
+ * **population-density-data v0.3.0**
+ [[YAML]](https://github.com/camaraproject/PopulationDensityData/blob/r3.2/code/API_definitions/population-density-data.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/PopulationDensityData/r3.2/code/API_definitions/population-density-data.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/PopulationDensityData/r3.2/code/API_definitions/population-density-data.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/PopulationDensityData/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/PopulationDensityData/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/PopulationDensityData/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings are held virtually
+ * Schedule: bi-weekly, Wednesday, 14:00 Europe/Amsterdam (CET) (13:00 UTC, 12:00 UTC during European DST).
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/95956472717?password=e4e7e889-ffb8-4fac-9e9d-d9adcaf2e711)
+ * For date/time of next meeting see previous [ meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/HwPe)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list \ No newline at end of file diff --git a/original/PopulationDensityData/documentation/MeetingMinutes/PopulationDensityDataAPI-KOmeeting_2024-01-24.md b/original/PopulationDensityData/documentation/MeetingMinutes/PopulationDensityDataAPI-KOmeeting_2024-01-24.md new file mode 100644 index 0000000000000000000000000000000000000000..75cd69dd36be669e242ea36320f75fc18e55cfa0 --- /dev/null +++ b/original/PopulationDensityData/documentation/MeetingMinutes/PopulationDensityDataAPI-KOmeeting_2024-01-24.md @@ -0,0 +1,65 @@ +# CAMARA Population Density Data API - KO meeting - 2024-01-24 + +*January 24th, 2024* + +## Attendees + +|| +| --- | +|Sachin Kumar (Vodafone)| +|Thomas Wana (Dimetor)| +|Thomas Neubauer (Dimetor)| +|Violeta Gonzalez Fernandez (Telefonica)| +|Jorge Garcia Hospital (Telefonica)| + + + +Population Density Data API minutes: [https://github.com/camaraproject/PopulationDensityData/tree/main/documentation/MeetingMinutes](https://github.com/camaraproject/PopulationDensityData/tree/main/documentation/MeetingMinutes) + +## Agenda + +* Presentation of the working group + * Density Population Data reference use cases +* Schedule and bi-weekly planification +* Timeline and next steps +* AoB + + +## Open Issues & PRs + + +Item | Who | Description +---- | ---- | ---- +N/A | N/A | N/A + +## Introduction to the working group + +Supporting material: [KO supporting material](https://github.com/camaraproject/PopulationDensityData/tree/main/documentation/SupportingDocuments/KO%20-%20Population%20Density%20Data%20Proposal%20for%20Camara%20Standarizationv3.pptx) + +### Scope + +**API definition:** The Population Density Data API enables developers with the capability to get population density estimations for a specific area at a future date and time, considering historical anonymized information of the network connected devices in the requested area. + +**API inputs (TBC):** Geographical area (2D map) and time range (future) + +**API outputs (TBC):** Max, min and average estimated statistics of population density for the required map, divided in uniform cells depending on the accuracy of the data. In a time series, to include information for the complete requested time range + + +### Density Population Data reference use cases + +For the reference use case, the API fills the need of assessing the ground risk to allow safe drone flights by providing estimations of the number of people under a drone flight path. This assessment will be needed every time a drone flight in the specific category need to conduct an operation and will help the operator to identify operational limitations, to develop the appropriate operational procedures and to identify mitigations and safety objectives. More information in [KO supporting material](https://github.com/camaraproject/PopulationDensityData/tree/main/documentation/SupportingDocuments/KO%20-%20Population%20Density%20Data%20Proposal%20for%20Camara%20Standarizationv3.pptx) + +## Discussion + +Item | Discussion +---- | ---- +Group Scope | Telefonica shares the proposal to include not only the specification of the API but also the agreement on the required algorithms of prediction and interpolation that are required in the API to provide a homogeneous response among operators. Aggrement reached. +Meeting Schedule | It's agreed to keep KO time schedule to be replicated in the following repetitions of the subgroup meetings. Be-weekly meeting on Wednesday, 14:00 Europe/Amsterdam (CET) (13:00 UTC, 12:00 UTC during European DST), starting February, 7th. +Timeline and next steps | Schedule to close scope, prepare innitial yaml proposal and close RC version is proposed. +AoB | N/A + + + +- Next call will be **February 7th, 2024** + +
diff --git a/original/PopulationDensityData/documentation/MeetingMinutes/README.MD b/original/PopulationDensityData/documentation/MeetingMinutes/README.MD new file mode 100644 index 0000000000000000000000000000000000000000..f71c2a667b84b38512f5893a2240aef980329112 --- /dev/null +++ b/original/PopulationDensityData/documentation/MeetingMinutes/README.MD @@ -0,0 +1 @@ +This README.MD can be deleted when the first file is added to this directory. diff --git a/original/PopulationDensityData/documentation/SupportingDocuments/Population_Density_API_-_Algorithm_Initial_Proposal.md b/original/PopulationDensityData/documentation/SupportingDocuments/Population_Density_API_-_Algorithm_Initial_Proposal.md new file mode 100644 index 0000000000000000000000000000000000000000..e8d97f71a9a0311500545d806f877167ceae4238 --- /dev/null +++ b/original/PopulationDensityData/documentation/SupportingDocuments/Population_Density_API_-_Algorithm_Initial_Proposal.md @@ -0,0 +1,30 @@ +# Population Density Data API +## Algorithm initial proposal + +This document serves as a reference model for the population density calculation algorithm. It provides an illustrative high-level overview of the steps proposed to determine population density. Designed for developers, this guide is created to enhance understanding and implementation of the algorithm. While it aims to enhance understanding and implementation, it is the responsibility of the developer to create their own algorithm to calculate population density. + +### Inputs for the algorithm: +* Devices connection records data is received pseudonymized or hashed. +* Requested Space is received in the API customers’ request. +### Process is as follows: +
+
+
+
+
+
+
+
+
+# PredictiveConnectivityData
+
+Sandbox API Repository to describe, develop, document, and test the PredictiveConnectivityData Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/AQAnBw)
+
+## Scope
+
+* Service API(s) “PredictiveConnectivityData” (see APIBacklog.md)
+* The API provides the capability to get the estimation of connectivity delivered by 4G/5G networks along a volume/area for a future date, time, and height.
+* Use Cases:
+ * Network Airspace Connectivity Information for Flight Planning: Provides mobile network coverage forecasts in specific geographic areas to help identify “black volumes” and mitigate the risk of losing drone control due to poor connectivity.
+ * Autonomous Car Routing: Delivers mobile network coverage forecasts along the planned route of an autonomous car to support decision-making in path planning and connectivity-dependent operations.
+* Describe, develop, document and test the APIs (with 1-2 Telcos)
+* Started: April 2025
+
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r1.2](https://github.com/camaraproject/PredictiveConnectivityData/releases/tag/r1.2) (Fall25), with the following API versions:
+ * **predictive-connectivity-data v0.1.0**
+ [[YAML]](https://github.com/camaraproject/PredictiveConnectivityData/blob/r1.2/code/API_definitions/predictive-connectivity-data.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/PredictiveConnectivityData/r1.2/code/API_definitions/predictive-connectivity-data.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/PredictiveConnectivityData/r1.2/code/API_definitions/predictive-connectivity-data.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/PredictiveConnectivityData/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/PredictiveConnectivityData/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/PredictiveConnectivityData/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings are held virtually
+
+* Schedule: Monthly on Tuesdays, 10:00–11:00 UTC
+ (corresponds to 12:00–13:00 CEST, 06:00–07:00 EDT during Daylight Saving Time)
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/95479380109?password=0386fbda-1fb5-4e1a-8687-7b81fe8cacfa&invite=true)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/PAAnBw)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list
+
+
+
+
+
+
+
+
+# QoSBooking
+
+Sandbox API Repository to describe, develop, document, and test the QoSBooking Service API(s) within the Sub Project [Connectivity Quality Management](https://lf-camaraproject.atlassian.net/wiki/x/XCPe)
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/SADHB)
+
+## Scope
+
+* Service API(s) “QoSBooking” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * book an assignment of a certain QoS Profile to a certain device with some conditions such as start time, duration and location in advance.
+ * update the booking, remove it, and get the information of it.
+* Describe, develop, document, and test the API(s)
+* Started: January 2025
+
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r1.2](https://github.com/camaraproject/QoSBooking/releases/tag/r1.2) (Fall25), with the following API versions:
+ * **qos-booking-and-assignment v0.1.0**
+ [[YAML]](https://github.com/camaraproject/QoSBooking/blob/r1.2/code/API_definitions/qos-booking-and-assignment.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/QoSBooking/r1.2/code/API_definitions/qos-booking-and-assignment.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/QoSBooking/r1.2/code/API_definitions/qos-booking-and-assignment.yaml)
+ * **qos-booking v0.1.0**
+ [[YAML]](https://github.com/camaraproject/QoSBooking/blob/r1.2/code/API_definitions/qos-booking.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/QoSBooking/r1.2/code/API_definitions/qos-booking.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/QoSBooking/r1.2/code/API_definitions/qos-booking.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/QoSBooking/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/QoSBooking/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/QoSBooking/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+* Meetings are held virtually
+ * Schedule: Bi-weekly on Friday at 13:00 UTC
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/94112812156?password=f238d6af-c959-48d7-a862-abdb3c648e40)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/ABje)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list
+
+
+
+
+
+
+
+
+# QualityOnDemand
+
+Incubating API Repository to evolve and maintain the definitions and documentation of QualityOnDemand Service API(s) within the Sub Project [Connectivity Quality Management](https://lf-camaraproject.atlassian.net/wiki/x/hAClB)
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/XCPe)
+
+## Scope
+
+* Service APIs for “Quality on Demand” (see APIBacklog.md)
+* The Service APIs provide the API consumer with the ability to:
+ * retrieve the possible quality options (profiles) from the network (qos-profiles)
+ * set the quality for a connection of a mobile device or a home device within the access network
+ * dynamically, for a selected session of a specific duration (quality-on-demand)
+ * provisioned, applying the same quality each time the device connects to the network (qod-provisioning)
+ * get a notification if the network cannot fulfill the requested quality profile (quality-on-demand, qod-provisioning)
+* Describe, develop, document and test the APIs (with 1–2 Service Providers)
+* Started: October 2021
+* Incubating stage since: February 2025
+
+
+
+
+## Release Information
+
+> [!NOTE]
+> Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**.
+
+* **NEW**: The latest public release is [r3.2](https://github.com/camaraproject/QualityOnDemand/releases/tag/r3.2) (Fall25), with the following API versions:
+ * **qos-profiles v1.1.0**
+ [[YAML]](https://github.com/camaraproject/QualityOnDemand/blob/r3.2/code/API_definitions/qos-profiles.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r3.2/code/API_definitions/qos-profiles.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r3.2/code/API_definitions/qos-profiles.yaml)
+ * **qos-provisioning v0.3.0**
+ [[YAML]](https://github.com/camaraproject/QualityOnDemand/blob/r3.2/code/API_definitions/qos-provisioning.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r3.2/code/API_definitions/qos-provisioning.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r3.2/code/API_definitions/qos-provisioning.yaml)
+ * **quality-on-demand v1.1.0**
+ [[YAML]](https://github.com/camaraproject/QualityOnDemand/blob/r3.2/code/API_definitions/quality-on-demand.yaml)
+ [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r3.2/code/API_definitions/quality-on-demand.yaml&nocors)
+ [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r3.2/code/API_definitions/quality-on-demand.yaml)
+* The latest public release is always available here: https://github.com/camaraproject/QualityOnDemand/releases/latest
+* Other releases of this repository are available in https://github.com/camaraproject/QualityOnDemand/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/QualityOnDemand/blob/main/CHANGELOG.md)
+
+_The above section is automatically synchronized by CAMARA project-administration._
+
+
+## Contributing
+
+* Meetings are held virtually
+ * Schedule: bi-weekly, Friday, 13:00 UTC (14:00 CET, 15:00 CEST). For date/time of the next meeting, see previous meeting minutes
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/94112812156?password=f238d6af-c959-48d7-a862-abdb3c648e40)
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/XCPe)
+* Mailing List
+ * Subscribe / unsubscribe to the mailing list of this Sub Project
+
+
+
+
+
+
+
+
+# RainfallIntensity
+
+Sandbox API Repository to describe, develop, document, and test the RainfallIntensity Service API(s). The repository does not yet belong to a CAMARA Sub Project.
+
+* API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/DYDEH)
+
+## Scope
+
+* Service API(s) “RainfallIntensity” (see APIBacklog.md)
+* The API(s) provide(s) the API consumer with the ability to:
+ * Obtain the power measurements for the communication links inside a geographical area for a specific time period. The data includes the time of measurement, the transmit and received power, and the link ID (which identifies each link uniquely).
+ * Obtain the metadata of the communication links within a geographical area. The metadata includes the link ID, time of update, signal frequecny, signal polarization (horizontal or vertical), and location (latetude and longitude) of the transmitter and the receiver.
+ * Obtain the rainfall data associated with communciation links inside a geographical are for a specific time. The rainfall data include the estimation of rainfall, time stamp, and link ID.
+* Describe, develop, document, and test the API(s)
+* Started: January 2026
+
+
+
+
+
+## Release Information
+
+The repository has no (pre)releases yet, work in progress is within the main branch.
+
+
+
+## Contributing
+
+* Meetings are held virtually
+
+ * Schedule: !! tbd
+ * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meetings/telcoapi) !! Update this link with your meeting registration/join link and delete the task
+ * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/AgDHH)
+* Mailing List
+ * Subscribe / Unsubscribe to the mailing list