Upload folder using huggingface_hub

STATUS.md

@@ -0,0 +1,7 @@
+# camara mirror status
+
+State: complete mirror
+
+- Original files: 760
+- Marked documents: 760
+- Missing marked documents: 0

marked/ApplicationEndpointDiscovery/README/raw.md

@@ -0,0 +1,53 @@
+<a href="https://github.com/camaraproject/ApplicationEndpointDiscovery/commits/" title="Last Commit"><img src="https://img.shields.io/github/last-commit/camaraproject/ApplicationEndpointDiscovery?style=plastic"></a>
+<a href="https://github.com/camaraproject/ApplicationEndpointDiscovery/issues" title="Open Issues"><img src="https://img.shields.io/github/issues/camaraproject/ApplicationEndpointDiscovery?style=plastic"></a>
+<a href="https://github.com/camaraproject/ApplicationEndpointDiscovery/pulls" title="Open Pull Requests"><img src="https://img.shields.io/github/issues-pr/camaraproject/ApplicationEndpointDiscovery?style=plastic"></a>
+<a href="https://github.com/camaraproject/ApplicationEndpointDiscovery/graphs/contributors" title="Contributors"><img src="https://img.shields.io/github/contributors/camaraproject/ApplicationEndpointDiscovery?style=plastic"></a>
+<a href="https://github.com/camaraproject/ApplicationEndpointDiscovery" title="Repo Size"><img src="https://img.shields.io/github/repo-size/camaraproject/ApplicationEndpointDiscovery?style=plastic"></a>
+<a href="https://github.com/camaraproject/ApplicationEndpointDiscovery/blob/main/LICENSE" title="License"><img src="https://img.shields.io/badge/License-Apache%202.0-green.svg?style=plastic"></a>
+<a href="https://github.com/camaraproject/ApplicationEndpointDiscovery/releases/latest" title="Latest Release"><img src="https://img.shields.io/github/release/camaraproject/ApplicationEndpointDiscovery?style=plastic"></a>
+<a href="https://github.com/camaraproject/Governance/blob/main/ProjectStructureAndRoles.md" title="Sandbox API Repository"><img src="https://img.shields.io/badge/Sandbox%20API%20Repository-yellow?style=plastic"></a>
+
+# 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)
+<!-- * Incubating stage since: {{incubation date}} --> 
+
+<!-- CAMARA:RELEASE-INFO:START -->
+<!-- The following section is automatically maintained by the CAMARA project-administration tooling: https://github.com/camaraproject/project-administration -->
+
+## 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._
+<!-- CAMARA:RELEASE-INFO:END -->
+
+## 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 <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>.

marked/ApplicationEndpointDiscovery/code/API_definitions/application-endpoint-discovery/raw.md

@@ -0,0 +1,912 @@
+# application-endpoint-discovery
+
+```yaml
+---
+openapi: 3.0.3
+info:
+  title: Application Endpoint Discovery
+  version: wip
+  description: |
+    The Application Endpoint Discovery API returns the optimal application
+    endpoint(s) that a given end-user's device can connect to.
+
+    # Introduction
+
+    Operators often host multiple Edge Cloud Zones across various territories.
+    Connecting an application directly to the optimal application instance
+    endpoint in an Edge Cloud Zone may minimize latency.
+
+    The Application Endpoint Discovery API extends beyond the capabilities of
+    the Simple Edge Discovery API by not only locating the optimal
+    Edge Cloud Zone but also providing the direct link to the specified
+    application's endpoint within that Edge Cloud Zone. This approach ensures
+    that developers can instantly integrate this endpoint into their
+    applications, improving user experience.
+
+    After identifying the optimal application endpoint(s) through the API,
+    API consumers can:
+    * Connect their application client directly to the chosen application
+    endpoint(s), enhancing the responsiveness of the service.
+    * If no suitable endpoints are available, the developer can use other APIs
+    to instantiate new instance and/or register new application endpoints.
+
+    The optimal endpoint(s) are calculated by the Edge Cloud Provider based on
+    the following factor: shortest network path to the network-attached
+    device identified in the API request. Future releases of this API might
+    add other factors to obtain them.
+
+    # Relevant terms and definitions
+
+    - `Application Profile:` A profile which represents an application's
+    networking demands (latency, jitter, bandwidth rates).
+    - `Application Provider:` The provider of the application that is deployed
+    on the Edge Cloud.
+    - `Application Endpoint:` An application server IP address or FQDN, and
+    port exposed by an application instance to allow connections from clients.
+    - `Application Instance:` An instantiation of an Application running on
+    an Edge Cloud Zone. It is assumed that for each application, a maximum of
+    one logical instance can run per Edge Cloud Zone.
+    - `Device:` End-user equipment able to connect to a mobile network (i.e.
+    smartphone, IoT sensor/actuator).
+    - `Edge Cloud Zone:` Availability Zone in an Edge Cloud. It is the lowest
+    level of abstraction exposed to an Application Provider who wants to
+    deploy an Application on Edge Cloud. Availability Zones exist within
+    a Region.
+
+    # API Functionality
+
+    The API can 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 service endpoint:
+
+    - `POST /retrieve-optimal-app-endpoints`
+
+    ## Inputs
+
+    The endpoint request body is a JSON object with the following parameters:
+    - `device:` End-user equipment able to connect to a mobile network. The
+    developer can choose to provide the below specified device identifiers:
+      - `ipv4Address:` Public IP address (IPv4) of the user device, which can be
+      fetched via external IP discovery services.
+      - `ipv6Address:` Public IP address (IPv6) of the user device, which can be
+      fetched via external IP discovery services.
+      - `phoneNumber:` The device's phone number in international E.164 format.
+      - `networkAccessIdentifier:` A unique identifier provided by the network
+    operator (where supported).
+    - One of the following application identifiers:
+      - `appId:` A unique identifier for an application onboarded on the Edge
+    Cloud. It is used when the application has been onboarded using the Edge
+    Application Management API.
+      - `applicationEndpointsId:` A unique identifier for the registered
+    application endpoint(s). It is used when the application has not been onboarded
+    using the Edge Application Management API, and available endpoints have been
+    registered by the Edge Application Registration API. Every endpoint registered
+    under the same `applicationEndpointsId` identifier belongs to the same
+    application.
+
+    ## Outputs
+
+    If successful, a `200 OK ` response code is returned with a JSON object
+    containing the following data:
+
+    - `applicationEndpoints:` An array containing at least one Application Endpoint
+    object. Each Application Endpoint object includes the following parameters:
+      - `port:` TCP or UDP port number exposed by the application instance.
+      - One of the following parameters which define the endpoint:
+        - `ipv4addresses:` Array of IPv4 addresses exposed by the application
+        instance.
+        - `ipv6addresses:` Array of IPv6 addresses exposed by the application
+        instance.
+        - `fqdn:` Fully Qualified Domain Name exposed by the application instance.
+      - `applicationEndpointDescription:` Optionally, a string that describes the
+      application endpoint.
+      - `edgeCloudZone:` Optionally, object that identifies the Edge Cloud Zone
+      the application endpoint belongs to, including: `edgeCloudZoneId`,
+      `edgeCloudZoneName`, `edgeCloudZoneStatus`, `edgeCloudRegion`, and
+      `edgeCloudProvider`.
+    - One of the following application identifiers (the one provided on the request)
+      - `appId:` A unique identifier for an application onboarded on the Edge
+      Cloud. It is used when the application has been onboarded using the Edge
+      Application Management API.
+      - `applicationEndpointsId:` A unique identifier for the registered
+      application endpoint(s). It is used when the application has not been onboarded
+      using the Edge Application Management API, and available endpoints have been
+      registered by the Edge Application Registration API. Every endpoint
+      registered under the same `applicationEndpointsId` identifier belongs to
+      the same application.
+    - `applicationServerProviderName:` Optionally, the Application Provider
+    identifier
+    - `applicationProfileId:` Optionally, the Application Profile identifier
+    - `device`: End-user equipment identifier used to obtain the optimal application
+      endpoint. It is only included when multiple device identifiers come in the
+      request.
+      - The `Device` object allows the API consumer to provide more than one device
+      identifier. No error will be returned when the supplied device identifiers
+      do not match with the same device. It is responsibility of the API consumer
+      to ensure that the identifiers they are using are associated with the same
+      device.
+      - Where an API consumer provides more than one device identifier, the
+      response will indicate which of these identifiers have been used to fulfil
+      the API, even if the identifiers do not match the same device. The
+      `DeviceResponse` object is defined for this purpose.
+
+
+    ## Errors
+
+    - If the API call contains a formatting or other any other syntatic error,
+    a `400 INVALID_ARGUMENT` error is returned.
+    - If the API call cannot be authenticated due to missing, invalid, or
+    expired credentials, a `401 UNAUTHENTICATED` error is returned.
+    - If the API call has a valid access token that does not have the
+    required scope, then a `403 PERMISSION_DENIED` error is returned.
+    - If the API call has a valid access token that does not identify
+    a single device, then a `404 IDENTIFIER_NOT_FOUND` error is returned.
+    - If the API call has an `appId` that does not identify a valid
+    application on the Edge Cloud, a `404 NOT_FOUND` error is returned.
+    - If the API call has an `applicationEndpointsId` that does not identify
+    any registered endpoint on the Edge Cloud, a `404 NOT_FOUND` error
+    is returned.
+
+    ### 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.
+
+    # 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.
+    - If the subject  cannot be identified from the access token and the
+    optional `device` object only includes device identifiers not supported
+    by the implementation, then the server will return an error with the
+    `422 UNSUPPORTED_IDENTIFIER` error  code.
+    - If the service is not applicable for the subject that is identified
+    from the access token or the optional `device` object, then the server
+    will return an error code with the `422 SERVICE_NOT_APPLICABLE` 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
+  x-camara-commonalities: 0.6
+externalDocs:
+  description: Product documentation at CAMARA
+  url: https://github.com/camaraproject/ApplicationEndpointDiscovery
+servers:
+  - url: "{apiRoot}/application-endpoint-discovery/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: Application Endpoint Discovery
+    description: |
+      Find the optimal Application Instance Endpoint(s) to the user device.
+paths:
+  /retrieve-optimal-app-endpoints:
+    post:
+      security:
+        - openId:
+            - application-endpoint-discovery:app-endpoints:read
+      operationId: getOptimalAppEndpoints
+      parameters:
+        - name: x-correlator
+          in: header
+          required: false
+          description: Correlation id for the different services
+          schema:
+            $ref: "#/components/schemas/XCorrelator"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/EndpointDiscoveryInfo"
+            examples:
+              Identify Device By 3-Legged Access Token and AppId:
+                $ref: '#/components/examples/IdentifyDeviceBy3LeggedTokenAppId'
+              Identify Device By Phone Number and AppId:
+                $ref: '#/components/examples/IdentifyDeviceByPhoneNumberAppId'
+              Identify Device By IP Address and ApplicationEndpointsId:
+                $ref: '#/components/examples/IdentifyDeviceByIPAddressAppEndpointsId'
+              Identify Device By Multiple Identifiers and AppId:
+                $ref: '#/components/examples/IdentifyDeviceByMultipleIdentifiersAppId'
+      responses:
+        "200":
+          description: |
+           Successful response, returning the optimal Application Instance
+           Endpoint(s) to the user device identified in the request body.
+           The response will include the endpoint(s) exposed by the Application
+           Instance(s) with the shortest network path to the end user device
+           identified in the request. There can be multiple application endpoints
+           returned in the response and the API consumer can choose the one that best
+           suits their needs.
+          headers:
+            x-correlator:
+              $ref: "#/components/headers/x-correlator"
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/EndpointDiscoveryResult"
+
+        "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"
+        "429":
+          $ref: "#/components/responses/Generic429"
+      tags:
+        - Application Endpoint Discovery
+      summary: |
+        Returns the Endpoint(s) of the optimal Application Instance(s) to the user
+        device identified in the request.
+      description: |
+        On receiving this request, the network will return the endpoint(s)
+        of the Application Instance(s) with the shortest network path to the
+        end user device identified in the request.
+components:
+  securitySchemes:
+    openId:
+      description: OpenID Provider Configuration Information.
+      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:
+    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`
+
+        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: 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/SingleIpv6Addr"
+      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
+
+    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
+
+    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
+
+    SingleIpv6Addr:
+      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:
+      description: Correlation id for the different services
+      type: string
+      pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
+      example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
+
+    EndpointDiscoveryInfo:
+      description: |
+        Element to retrieve the optimal application endpoint(s) for the
+        identified device.
+      type: object
+      anyOf:
+        - required: [applicationEndpointsId]
+        - required: [appId]
+      properties:
+        device:
+          $ref: "#/components/schemas/Device"
+        applicationEndpointsId:
+          $ref: "#/components/schemas/ApplicationEndpointsId"
+        appId:
+          $ref: "#/components/schemas/AppId"
+
+    ApplicationEndpointsId:
+      description: |
+        A system-defined string identifier representing
+        one or more registered Application Endpoints that belong
+        to the same application.
+      type: string
+      format: uuid
+      example: "4d596ac1-7822-4927-a3c5-d72e1f922c94"
+
+    AppId:
+      type: string
+      format: uuid
+      description: |
+        A globally unique identifier associated with the application.
+        This GUID will have been previously provided by the Edge Cloud Zone
+        provider.
+      example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
+
+    EndpointDiscoveryResult:
+      description: |
+        Endpoint Discovery result including optimal application endpoint(s)
+        for the requested identified device.
+      type: object
+      required:
+        - applicationEndpoints
+      anyOf:
+        - required: [applicationEndpointsId]
+        - required: [appId]
+      properties:
+        applicationEndpoints:
+          description: Array of Application Endpoints.
+          type: array
+          items:
+            $ref: "#/components/schemas/ApplicationEndpoint"
+          minItems: 1
+        appId:
+          $ref: "#/components/schemas/AppId"
+        applicationEndpointsId:
+          $ref: "#/components/schemas/ApplicationEndpointsId"
+        applicationServerProviderName:
+          type: string
+          description: Unique ID representing the Edge Application Provider
+        applicationProfileId:
+          $ref: "#/components/schemas/ApplicationProfileId"
+        device:
+          $ref: "#/components/schemas/DeviceResponse"
+
+    EdgeCloudZone:
+      type: object
+      description: |
+        An Edge Cloud Zone, uniquely identified by a
+        combination of the value of the Edge Cloud Zone Id object
+        and the value of the Edge Cloud Provider
+        object. This value is used to identify an Edge Cloud zone
+        between Edge Clouds from different Edge Cloud Providers.
+      required:
+        - edgeCloudZoneId
+        - edgeCloudZoneName
+        - edgeCloudProvider
+      properties:
+        edgeCloudZoneId:
+          $ref: "#/components/schemas/EdgeCloudZoneId"
+        edgeCloudZoneName:
+          $ref: "#/components/schemas/EdgeCloudZoneName"
+        edgeCloudZoneStatus:
+          $ref: "#/components/schemas/EdgeCloudZoneStatus"
+        edgeCloudProvider:
+          $ref: "#/components/schemas/EdgeCloudProvider"
+        edgeCloudRegion:
+          $ref: "#/components/schemas/EdgeCloudRegion"
+
+    EdgeCloudZoneId:
+      description: A unique identifier for the Edge Cloud Zone.
+      type: string
+      format: uuid
+      example: "123e4567-e89b-12d3-a456-426614174000"
+
+    EdgeCloudRegion:
+      description: |
+        The EdgeCloudProvider's name for the region where the Edge Cloud
+        Zone is located.
+      type: string
+      pattern: ^[A-Za-z0-9]([A-Za-z0-9-]{0,53}[A-Za-z0-9])?$
+      example: "us-west-1"
+
+    EdgeCloudZoneStatus:
+      description: Status of the Edge Cloud Zone (default is 'unknown')
+      type: string
+      enum:
+        - active
+        - inactive
+        - unknown
+      default: unknown
+
+    EdgeCloudProvider:
+      description: The provider of the Edge Cloud.
+      type: string
+      pattern: ^[A-Za-z0-9]([A-Za-z0-9-]{0,53}[A-Za-z0-9])?$
+      example: "ProviderA"
+
+    EdgeCloudZoneName:
+      description: The name of the Edge Cloud Zone.
+      type: string
+      pattern: ^[A-Za-z0-9]([A-Za-z0-9-]{0,53}[A-Za-z0-9])?$
+      example: "ZoneA"
+
+    ApplicationProfileId:
+      description: A unique identifier for the application profile.
+      type: string
+      format: uuid
+      example: "123e4567-e89b-12d3-a456-426614174000"
+
+    ApplicationEndpoint:
+      type: object
+      description: |
+        An application server IP address or FQDN with a port,
+        exposed by an application instance deployed on the Edge Cloud
+        provider.
+      required:
+        - port
+      anyOf:
+        - required: [fqdn]
+        - required: [ipv4Addresses]
+        - required: [ipv6Addresses]
+      properties:
+        fqdn:
+          $ref: "#/components/schemas/Fqdn"
+        ipv4Addresses:
+          description: Array of IPv4 addresses.
+          type: array
+          items:
+            $ref: "#/components/schemas/Ipv4Address"
+          minItems: 1
+        ipv6Addresses:
+          description: Array of IPv6 addresses.
+          type: array
+          items:
+            $ref: "#/components/schemas/Ipv6Address"
+          minItems: 1
+        port:
+          $ref: "#/components/schemas/Port"
+        edgeCloudZone:
+          $ref: "#/components/schemas/EdgeCloudZone"
+        applicationEndpointDescription:
+          type: string
+          description: Description of the application endpoint
+
+    Fqdn:
+      type: string
+      description: Fully Qualified Domain Name.
+
+    Ipv4Address:
+      type: string
+      description: |
+        A single IPv4 address specified in dotted-quad form like 1.2.3.4.
+      example: "198.51.100.1"
+
+    Ipv6Address:
+      type: string
+      description: |
+        A single IPv6 address, following IETF 5952 format like
+        2001:db8:85a3:8d3:1319:8a2e:370:7344.
+      example: "2001:db8:85a3::8a2e:370:7334"
+
+    ErrorInfo:
+      type: object
+      description: Error information
+      required:
+        - status
+        - code
+        - message
+      properties:
+        status:
+          type: integer
+          description: HTTP status code returned along with this error response
+        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
+                      - 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
+          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: "{{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:
+    IdentifyDeviceBy3LeggedTokenAppId:
+      description: Empty JSON when device is identified by access token
+      value:
+        appId: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
+
+    IdentifyDeviceByPhoneNumberAppId:
+      description: Identifying device by phone number
+      value:
+        device:
+          phoneNumber: "+123456789"
+        appId: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
+
+    IdentifyDeviceByIPAddressAppEndpointsId:
+      description: Identifying device by IP address
+      value:
+        device:
+          ipv4Address:
+            publicAddress: "84.125.93.10"
+            publicPort: 59765
+        applicationEndpointsId: "4d596ac1-7822-4927-a3c5-d72e1f922c94"
+
+    IdentifyDeviceByMultipleIdentifiersAppId:
+      description: Identifying device by multiple device identifiers
+      value:
+        device:
+          phoneNumber: "+123456789"
+          ipv4Address:
+            publicAddress: "84.125.93.10"
+            publicPort: 59765
+          networkAccessIdentifier: "123456789@domain.com"
+        appId: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
+```

marked/ApplicationEndpointDiscovery/documentation/API_documentation/Application-Endpoint-Discovery-API-Readiness-Checklist/raw.md

@@ -0,0 +1,19 @@
+# Application Endpoint Discovery API Readiness minimum criteria checklist
+
+Checklist for Application-Endpoint-Discovery v0.1.0
+
+| Nr | API release assets  | alpha | release-candidate |  initial<br>public | stable<br> public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----|
+|  1 | API definition                               |   M   |         M         |    M    |    M   | Y    | [link](/code/API_definitions/application-endpoint-discovery.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    | [link](/documentation/SupportingDocuments/API_Documentation/User%20Stories/Application%20Endpoint%20Discovery%20User%20Story.md) |
+|  7 | Basic API test cases & documentation         |   O   |         M         |    M    |    M   | Y    | [link](/code/Test_definitions/application-endpoint-discovery.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    | [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/137166903/ApplicationEndpointDiscovery+API+description) |

marked/ApplicationEndpointDiscovery/documentation/API_documentation/README/raw.md

@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.

marked/ApplicationEndpointDiscovery/documentation/SupportingDocuments/API_Documentation/User_Stories/Application_Endpoint_Discovery_User_Story/raw.md

@@ -0,0 +1,84 @@
+# Application Endpoint Discovery API  User Story
+
+_This document is based on the [CAMARA Commonalities template for User Stories](https://github.com/camaraproject/Commonalities/blob/main/documentation/Userstory-template.md)_
+
+| **Item** | **Details** |
+| ---- | ------- |
+| **_Summary_** | As an application developer belonging to an enterprise, I want to discover (using either my application server/backend service, or an HTTP application client on the end-user device) the optimal application instance running in an Edge Cloud Zone that a given end-user's device can connect to. |
+| **_Roles and Actors and Scope_** | **Roles:** Customer:User<br> **Actors:** Application service providers, network operators, application developers. The API allows a check to see if end-user consent is required: if consent is required, the end-user will be an actor in the consent flow. <br> **Scope:** Get the endpoint of the application hosted at the optimal Edge Cloud Zone |
+| **_Pre-conditions_** |The preconditions are listed below:<br><ol><li>The Customer:BusinessManager and Customer:Administrator have been onboarded to the CSP's API platform.</li><li>The Customer:BusinessManager has successfully subscribed to the Application Endpoint Discovery product from the product catalog.</li><li>The Customer:Administrator has onboarded the Customer:User to the platform.</li><li>The Customer:User has obtained a valid identifier for the target device, or, will make the API request from an application client on a device connected to the operator's network.</li>|
+| **_Begins when_** | The customer application server/client makes a POST request to the Application Endpoint Discovery API to query the optimal Application Endpoint to the target device (an end-user device). The target device is either identified either in a 3-legged consent flow including a device object, or by device identifier(s) in the request body.|
+| **_Ends when_** | The Application Endpoint Discovery API returns the endpoint(s) of the optimal application instance(s) for this user.|
+| **_Post-conditions_** | Optional - the customer may decide to act upon the information by connecting the end-user application client to the application server instance hosted at one of the received Application Endpoints. |
+| **_Exceptions_** | Several exceptions might occur during the API operations:<br>- Unauthorized: Invalid credentials (e.g., expired access token).<br>- Incorrect input data (e.g., malformed phone number). <br>- Not found: The phone number is not associated with a CSP customer account, the application does not have any running instances in the Edge Cloud, or the application endpoint ID received in the request is not registered in the Edge Cloud. |
+
+## API Workflows
+
+### Scenario 1: direct request from application client or end-user device
+
+Constraints:
+
+- Network: cellular (4G/5G) or fixed/Wi-Fi network with an Edge Cloud Zone deployment.
+- Application: browser or app calls API over HTTPS
+- Northbound Interface only (no 'UNI' client SDK required)
+- The call must include an application identifier (_appId_) which must be provided by the Application Provider.
+
+Note:
+
+- the Edge Cloud Zone platform may be hosted by the operator or a 3rd party hyperscaler (in which case the developer will need an account with that hyperscaler to create instances)
+
+```mermaid
+sequenceDiagram
+    autonumber
+    participant Application Client
+    participant Operator
+    participant Edge Cloud Zone
+    Note over Application Client, Operator: PRE developer has acquired an identifier for the device in question
+    Note over Application Client, Operator: PRE App developer registered, authenticated and authorised
+    Note over Application Client, Operator: PRE Application instances are up and running on one or several Edge Cloud Zones  
+
+    Application Client->>Operator: POST request `/retrieve-optimal-app-endpoints {RequestBody: device identifier(s), appId}`
+    Operator->>Operator: Calculate optimal Application Endpoint(s)
+    Operator->>Application Client: optimal Application Endpoint(s)
+    opt connect to optimal instance endpoint
+      Application Client->>Edge Cloud Zone: Connect to optimal instance endpoint
+    end
+```
+
+### Scenario 2: request from developer server
+
+Constraints:
+
+- Network: cellular (4G/5G) or fixed/Wi-Fi network with an Edge Cloud Zone deployment.
+- Application: none, browser or app calls API over HTTPs (no client SDK required)
+- Dependencies:
+  - the call must include an identifier for the device (device) for which 'optimal  MEC' is being calculated
+  - the call must include an application identifier:
+    - _appId_ (application identifier) in case the application is deployed by Edge Application Management API
+    - _applicationEndpointsId_ (registered endpoints identifier) for other cases. It requires previous registration of application endpoints using Application Endpoint Registration API.
+
+Note: the Edge CLoud Zone platform may be hosted by the operator or a 3rd party hyperscaler (in which case the developer will need an account with that hyperscaler to create instances)
+
+```mermaid
+sequenceDiagram
+    autonumber
+    participant Application Client
+    participant Application Server
+    participant Operator    
+    participant Edge Cloud Zone
+    Note over Application Server, Operator: PRE developer has acquired an identifier for the device in question
+    Note over Application Server, Operator: PRE App developer registered, authenticated and authorised
+    Note over Application Server, Operator: PRE Application instances are up and running on one or several Edge Cloud Zones
+    alt The application has been deployed with Edge Application Management API
+      Application Server->>Operator: POST request `/retrieve-optimal-app-endpoints {RequestBody: device identifier(s), appId}`
+    else The application has not been instantiated with Edge Application Management API
+      Note over Application Server,Operator: PRE Application Endpoints have been registered in Operator Platform
+      Application Server->>Operator: POST request `/retrieve-optimal-app-endpoints {RequestBody: device identifier(s), applicationEndpointsId}`
+    end   
+    Operator->>Operator: Calculate optimal Application Endpoint(s)
+    Operator->>Application Server: optimal Application Endpoint(s)
+    opt inform app so it connects to the instance endpoint
+      Application Server->>Application Client: report optimal Application Endpoint
+      Application Client->>Edge Cloud Zone: Connect to instance endpoint
+    end
+```

marked/ApplicationEndpointDiscovery/documentation/SupportingDocuments/README/raw.md

@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.

marked/ApplicationEndpointRegistration/README/raw.md

@@ -0,0 +1,53 @@
+<a href="https://github.com/camaraproject/ApplicationEndpointRegistration/commits/" title="Last Commit"><img src="https://img.shields.io/github/last-commit/camaraproject/ApplicationEndpointRegistration?style=plastic"></a>
+<a href="https://github.com/camaraproject/ApplicationEndpointRegistration/issues" title="Open Issues"><img src="https://img.shields.io/github/issues/camaraproject/ApplicationEndpointRegistration?style=plastic"></a>
+<a href="https://github.com/camaraproject/ApplicationEndpointRegistration/pulls" title="Open Pull Requests"><img src="https://img.shields.io/github/issues-pr/camaraproject/ApplicationEndpointRegistration?style=plastic"></a>
+<a href="https://github.com/camaraproject/ApplicationEndpointRegistration/graphs/contributors" title="Contributors"><img src="https://img.shields.io/github/contributors/camaraproject/ApplicationEndpointRegistration?style=plastic"></a>
+<a href="https://github.com/camaraproject/ApplicationEndpointRegistration" title="Repo Size"><img src="https://img.shields.io/github/repo-size/camaraproject/ApplicationEndpointRegistration?style=plastic"></a>
+<a href="https://github.com/camaraproject/ApplicationEndpointRegistration/blob/main/LICENSE" title="License"><img src="https://img.shields.io/badge/License-Apache%202.0-green.svg?style=plastic"></a>
+<a href="https://github.com/camaraproject/ApplicationEndpointRegistration/releases/latest" title="Latest Release"><img src="https://img.shields.io/github/release/camaraproject/ApplicationEndpointRegistration?style=plastic"></a>
+<a href="https://github.com/camaraproject/Governance/blob/main/ProjectStructureAndRoles.md" title="Sandbox API Repository"><img src="https://img.shields.io/badge/Sandbox%20API%20Repository-yellow?style=plastic"></a>
+
+# 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)
+<!-- * Incubating stage since: {{incubation date}} --> 
+
+<!-- CAMARA:RELEASE-INFO:START -->
+<!-- The following section is automatically maintained by the CAMARA project-administration tooling: https://github.com/camaraproject/project-administration -->
+
+## 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._
+<!-- CAMARA:RELEASE-INFO:END -->
+
+## 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 <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>.

marked/ApplicationEndpointRegistration/code/API_definitions/README/raw.md

@@ -0,0 +1 @@
+Here you can add your definition file(s). Delete this README.MD file after the first file is added.

marked/ApplicationEndpointRegistration/code/API_definitions/application-endpoint-registration/raw.md

@@ -0,0 +1,763 @@
+# application-endpoint-registration
+
+```yaml
+---
+openapi: 3.0.3
+info:
+  title: Application Endpoints Registration
+  version: wip
+  x-camara-commonalities: 0.6
+  description: |
+    The Application Endpoints Registration API provides a programmable
+    interface for developers to register the endpoints of an application
+    which is deployed across various Edge Cloud Zones.
+    It allows developers to retrieve, update, and delete those registrations.
+
+    # Introduction
+
+    The API registers the Application Endpoints.
+    This information can be used for various use cases like optimal endpoint
+    discovery to help end users connect to the most optimal instance of the
+    application which is distributed across various Edge Cloud Zones.
+    Additionally the information can be used to monitor the edge instances to
+    take decisions from a lifecycle management perspective. The API provides
+    the ability to register, read and manage the deployed edge instances of
+    the application.
+
+    # Relevant terms and definitions
+
+    * **Application Endpoint**:
+
+    The Endpoint on which the application is accessible.
+    It can be a FQDN, IPv4, or IPv6 address with a port number.
+
+    * **Application Profile**:
+
+    It represents the application's network and
+    compute characteristics. This helps distinguish between different
+    applications and their specific requirements.
+
+    * **Edge Cloud Zone**:
+
+    Availability Zone in an Edge Cloud. It is the lowest
+    level of abstraction exposed to an Application Provider who wants to
+    deploy an Application on Edge Cloud. Availability Zones exist within
+    a Region.
+
+    # API functionality
+
+    The API provides the following operations:
+    - POST registerApplicationEndpoints: Registers the Application Endpoints
+                    of a deployed application to a specified edge cloud zone.
+    - GET getAllRegisteredApplicationEndpoints: Returns endpoint information for
+      all registered Applications.
+    - GET getApplicationEndpointsByID: Returns endpoint information for all
+        Applications registered to a specified applicationEndpointListId.
+    - PUT updateApplicationEndpoint: Update registered application endpoint
+        information.
+    - DELETE deregisterApplicationEndpoint: Deregister an application's
+                          Endpoints.
+    ## Errors
+
+    - If the API call contains a formatting or any other syntactic error,
+    a `400 INVALID_ARGUMENT` error is returned.
+    - If the API call cannot be authenticated due to missing, invalid, or
+    expired credentials, a `401 UNAUTHENTICATED` error is returned.
+    - If the API call has a valid access token that does not have the
+    required scope, then a `403 PERMISSION_DENIED` error is returned.
+    - If the API call has an `applicationEndpointListId` that does not identify
+    any registered endpoint on the Edge Cloud, a `404 NOT_FOUND` error
+    is returned.
+
+    ### 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.
+
+    # Further info and support
+
+    [GSMA Mobile Connect Account Takeover Protection specification]
+    (https://www.gsma.com/identity/wp-content/uploads/2022/12/IDY.24-Mobile-
+    Connect-Account-Takeover-Protection-Definition-and-Technical-Requirements-
+    v2.0.pdf)
+    was used as source of input for this API. For more about Mobile Connect,
+    please see [Mobile Connect website](https://mobileconnect.io/).
+
+    (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
+externalDocs:
+  description: Project documentation at CAMARA
+  url: https://github.com/camaraproject/ApplicationEndpointRegistration
+
+servers:
+  - url: "{apiRoot}/application-endpoint-registration/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: Application Endpoint Registration
+    description: |
+      Operations to register, read and manage deployed instances of the
+      application.
+
+paths:
+  /application-endpoint-lists:
+    post:
+      security:
+        - openId:
+            - application-endpoint-registration:application-endpoints:write
+      tags:
+        - Application Endpoint Registration
+      summary: Register endpoints of a deployed application
+      description: |
+        Register the endpoints of a deployed application
+        to a specified edge cloud zone.
+      operationId: registerApplicationEndpoints
+      parameters:
+        - $ref: "#/components/parameters/x-correlator"
+      requestBody:
+        description: Array of Application Endpoints for an
+          application deployed across various Edge Cloud Zones.
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ApplicationEndpointsInfo"
+      responses:
+        "200":
+          description: Returns an applicationEndpointListId
+          headers:
+            x-correlator:
+              $ref: '#/components/headers/x-correlator'
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ApplicationEndpointListId"
+        "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"
+        "429":
+          $ref: "#/components/responses/Generic429"
+    get:
+      security:
+        - openId:
+            - application-endpoint-registration:application-endpoints:read
+      tags:
+        - Application Endpoint Registration
+      summary: Get all registered edge application endpoint information
+      description: |
+        Returns endpoint information for all
+        registered Applications.
+      operationId: getAllRegisteredApplicationEndpoints
+      parameters:
+        - $ref: "#/components/parameters/x-correlator"
+      responses:
+        "200":
+          description: Array of registered Application Endpoints
+          headers:
+            x-correlator:
+              $ref: '#/components/headers/x-correlator'
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/ApplicationEndpointList"
+        "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"
+        "429":
+          $ref: "#/components/responses/Generic429"
+
+  "/application-endpoint-lists/{applicationEndpointListId}":
+    parameters:
+      - name: applicationEndpointListId
+        in: path
+        description: The unique identifier for the application endpoints
+          that got created when registering the application endpoints.
+        required: true
+        schema:
+          $ref: "#/components/schemas/ApplicationEndpointListId"
+      - $ref: "#/components/parameters/x-correlator"
+    get:
+      security:
+        - openId:
+            - application-endpoint-registration:application-endpoints:read
+      tags:
+        - Application Endpoint Registration
+      summary: Get registered edge application endpoint information
+      description: |
+        Returns endpoint information of the application based on
+        applicationEndpointListId.
+      operationId: getApplicationEndpointsById
+      responses:
+        "200":
+          description: Application Endpoint information based on
+            given ApplicationEndpointListID
+          headers:
+            x-correlator:
+              $ref: '#/components/headers/x-correlator'
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ApplicationEndpointList"
+        "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"
+        "429":
+          $ref: "#/components/responses/Generic429"
+
+    put:
+      security:
+        - openId:
+            - application-endpoint-registration:application-endpoints:update
+      tags:
+        - Application Endpoint Registration
+      summary: Update an application Endpoint
+      description: |
+        Update registered application Endpoint information.
+      operationId: updateApplicationEndpoint
+      requestBody:
+        description: Application Endpoint information
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ApplicationEndpointsInfo"
+      responses:
+        "204":
+          description: Updates Application Endpoint Information
+          headers:
+            x-correlator:
+              $ref: '#/components/headers/x-correlator'
+        "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"
+        "429":
+          $ref: "#/components/responses/Generic429"
+
+    delete:
+      security:
+        - openId:
+            - application-endpoint-registration:application-endpoints:delete
+      tags:
+        - Application Endpoint Registration
+      summary: Deregister an application Endpoint
+      description: |
+        Deregister an application's
+        Endpoint from the edge cloud zone.
+      operationId: deregisterApplicationEndpoint
+      responses:
+        "204":
+          description: Deregister Application Endpoint
+          headers:
+            x-correlator:
+              $ref: '#/components/headers/x-correlator'
+        "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"
+        "429":
+          $ref: "#/components/responses/Generic429"
+
+components:
+  securitySchemes:
+    openId:
+      type: openIdConnect
+      description: Common security scheme for all CAMARA APIs
+      openIdConnectUrl: https://example.com/.well-known/openid-configuration
+  headers:
+    x-correlator:
+      description: Correlation id for the different services
+      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:
+    XCorrelator:
+      type: string
+      pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
+      example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
+
+    ApplicationEndpointsInfo:
+      description: Endpoint information of the Application
+        deployed across different Edge Cloud Zones.
+      type: object
+      properties:
+        applicationEndpoints:
+          type: array
+          description: List of endpoints of the application deployed across
+            various Edge Cloud Zones
+          items:
+            $ref: "#/components/schemas/ApplicationEndpoint"
+        applicationProviderName:
+          type: string
+          description: Name of the Application Provider
+          example: "AppProvider"
+        applicationDescription:
+          type: string
+          description: Description of the application.
+          example: "This is a V2X application."
+        applicationProfileId:
+          $ref: "#/components/schemas/ApplicationProfileId"
+      required:
+        - applicationEndpoints
+        - applicationProviderName
+        - applicationProfileId
+      example:
+        applicationEndpoints:
+          - domainName: "app.example.com"
+            port: 8080
+            applicationEndpointDescription: "V2X app deployed at ZoneA"
+            edgeCloudZone:
+              edgeCloudZoneId: "123e4567-e89b-12d3-a456-426614174000"
+              edgeCloudZoneName: "ZoneA"
+              edgeCloudProvider: "ProviderA"
+              edgeCloudRegion: "us-west-1"
+              edgeCloudZoneStatus: "active"
+        applicationProviderName: "AppProvider"
+        applicationDescription: "This is a V2X application."
+        applicationProfileId: "123e4567-e89b-12d3-a456-426614174000"
+
+    ApplicationEndpointList:
+      type: object
+      description: |
+        List of Application endpoints information
+        deployed across various cloud zones.
+      required:
+        - applicationEndpointListId
+        - applicationEndpointsInfo
+      properties:
+        applicationEndpointListId:
+          $ref: "#/components/schemas/ApplicationEndpointListId"
+        applicationEndpointsInfo:
+          $ref: "#/components/schemas/ApplicationEndpointsInfo"
+
+    ApplicationEndpoint:
+      type: object
+      description: |
+        An application server IP address or FQDN with a port,
+        exposed by an application instance deployed on the Edge Cloud
+        Zone.
+      required:
+        - port
+      anyOf:
+        - required: [domainName]
+        - required: [ipv4Address]
+        - required: [ipv6Address]
+      properties:
+        domainName:
+          $ref: "#/components/schemas/DomainName"
+        ipv4Address:
+          $ref: "#/components/schemas/SingleIpv4Addr"
+        ipv6Address:
+          $ref: "#/components/schemas/SingleIpv6Addr"
+        port:
+          $ref: "#/components/schemas/Port"
+        edgeCloudZone:
+          $ref: "#/components/schemas/EdgeCloudZone"
+        applicationEndpointDescription:
+          type: string
+          description: Description of the application endpoint
+          example: "V2X app deployed at ZoneA"
+
+    EdgeCloudZone:
+      type: object
+      description: |
+        An Edge Cloud Zone, uniquely identified by a
+        combination of the value of the Edge Cloud Zone Id object
+        and the value of the Edge Cloud Provider
+        object. This value is used to identify an Edge Cloud zone
+        between Edge Clouds from different Edge Cloud Providers.
+      required:
+        - edgeCloudZoneId
+        - edgeCloudZoneName
+        - edgeCloudProvider
+      properties:
+        edgeCloudZoneId:
+          $ref: "#/components/schemas/EdgeCloudZoneId"
+        edgeCloudZoneName:
+          $ref: "#/components/schemas/EdgeCloudZoneName"
+        edgeCloudZoneStatus:
+          $ref: "#/components/schemas/EdgeCloudZoneStatus"
+        edgeCloudProvider:
+          $ref: "#/components/schemas/EdgeCloudProvider"
+        edgeCloudRegion:
+          $ref: "#/components/schemas/EdgeCloudRegion"
+
+    EdgeCloudZoneId:
+      description: A unique identifier for the Edge Cloud Zone.
+      type: string
+      format: uuid
+      example: "123e4567-e89b-12d3-a456-426614174000"
+
+    EdgeCloudRegion:
+      description: |
+        The EdgeCloudProvider's name for the region where the Edge Cloud
+        Zone is located.
+      type: string
+      pattern: ^[A-Za-z0-9]([A-Za-z0-9-]{0,53}[A-Za-z0-9])?$
+      example: "us-west-1"
+
+    EdgeCloudZoneStatus:
+      description: Status of the Edge Cloud Zone (default is 'unknown')
+      type: string
+      enum:
+        - active
+        - inactive
+        - unknown
+      default: unknown
+
+    EdgeCloudProvider:
+      description: The provider of the Edge Cloud.
+      type: string
+      pattern: ^[A-Za-z0-9]([A-Za-z0-9-]{0,53}[A-Za-z0-9])?$
+      example: "ProviderA"
+
+    EdgeCloudZoneName:
+      description: The name of the Edge Cloud Zone.
+      type: string
+      pattern: ^[A-Za-z0-9]([A-Za-z0-9-]{0,53}[A-Za-z0-9])?$
+      example: "ZoneA"
+
+    ApplicationEndpointListId:
+      description: |
+        A system-defined string identifier representing
+        one or more registered Application Endpoints. This ID is generated
+        by the system upon successful registration of an application and is
+        used to reference the registered endpoints in subsequent operations.
+      type: string
+      format: uuid
+      readOnly: true
+      additionalProperties: false
+      example: "98765432-e89b-12d3-a456-426614174999"
+
+    ApplicationProfileId:
+      description: |
+        A unique identifier for the application profile. This represents
+        the application's network and compute characteristics.
+      type: string
+      format: uuid
+      example: "123e4567-e89b-12d3-a456-426614174000"
+
+    DomainName:
+      type: string
+      description: |
+        Application's Domain Name, which is a Fully Qualified Domain Name (FQDN).
+      pattern: ^[a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?)+$
+      maxLength: 253
+      minLength: 4
+      example: "app.example.com"
+
+    SingleIpv4Addr:
+      description: A single IPv4 address with no subnet mask
+      type: string
+      format: ipv4
+      example: "84.125.93.10"
+
+    SingleIpv6Addr:
+      description: |
+        Single IPv6 address with no subnet mask
+      type: string
+      format: ipv6
+      example: 2001:db8:85a3:8d3:1319:8a2e:370:7344
+
+    Port:
+      description: |
+        TCP or UDP port number for the application endpoint.
+        Valid range is 0-65535.
+      type: integer
+      minimum: 0
+      maximum: 65535
+      example: 8080
+
+    ErrorInfo:
+      description: Common schema for errors
+      type: object
+      required:
+        - status
+        - code
+        - message
+      properties:
+        status:
+          type: integer
+          description: HTTP status code returned along with this error response
+        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
+                      - 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
+          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: "{{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
+          examples:
+            GENERIC_404_NOT_FOUND:
+              description: Resource is not found
+              value:
+                status: 404
+                code: NOT_FOUND
+                message: The specified resource is 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
+                      - UNIDENTIFIABLE_APPLICATION_PROFILE
+          examples:
+            GENERIC_422_SERVICE_NOT_APPLICABLE:
+              description: Service not applicable for the provided identifier.
+              value:
+                status: 422
+                code: SERVICE_NOT_APPLICABLE
+                message: Service not supported for this applicationProfileId
+            UNIDENTIFIABLE_APPLICATION_PROFILE:
+              description: |
+                The Application Profile is not included in the request
+                and the profile information cannot be derived
+                from the 3-legged access token
+              value:
+                status: 422
+                code: UNIDENTIFIABLE_APPLICATION_PROFILE
+                message: The Application Profile cannot be identified
+
+    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.
+```

marked/ApplicationEndpointRegistration/documentation/API_documentation/Application-Endpoint-Registration-API-Readiness-Checklist/raw.md

@@ -0,0 +1,19 @@
+# Application Endpoints Registration API Readiness minimum criteria checklist
+
+Checklist for Application-Endpoint-Registration v0.1.0
+
+| Nr | API release assets  | alpha | release-candidate |  initial<br>public | stable<br> public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----|
+|  1 | API definition                               |   M   |         M         |    M    |    M   | Y    | [link](/code/API_definitions/application-endpoint-registration.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    | [link](/documentation/API_documentation/application-endpoint-registration-User-Story.md) |
+|  7 | Basic API test cases & documentation         |   O   |         M         |    M    |    M   | Y    | [link](/code/Test_definitions/application-endpoint-registration.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    | [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/x/dAAsC) |

marked/ApplicationEndpointRegistration/documentation/API_documentation/README/raw.md

@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.

marked/ApplicationEndpointRegistration/documentation/API_documentation/application-endpoint-registration-User-Story/raw.md

@@ -0,0 +1,10 @@
+# Application Endpoint Registration API User Story
+
+| **Item** | **Details** |
+| ---- | ------- |
+| ***Summary*** | As an application developer who has deployed my application across multiple Edge Cloud Zones, I need a way to register and manage the endpoints of my application instances. The Application Endpoint Registration API allows me to register my application endpoints across different Edge Cloud Zones, update their information when necessary, retrieve endpoint details, and remove endpoints when they are decommissioned. This registration process enables the discovery of these endpoints through the Application Endpoint Discovery API, ensuring users can connect to the optimal instance of my application. |
+| ***Roles, Actors and Scope*** | **Roles:** API Consumer:Developer<br> **Actors:** Application service providers, hyperscalers, application developers<br> **Scope:** <ul><li>Register application endpoints in various Edge Cloud Zones</li><li>Update existing application endpoint information</li><li>Retrieve application endpoint details</li><li>Delete application endpoints when no longer needed</li></ul> |
+| ***Pre-conditions*** |The preconditions are listed below:<br><ol><li>The API Consumer:BusinessManager and API Consumer:Administrator have been onboarded to the API Exposure Platform.</li><li>The API Consumer:BusinessManager has successfully subscribed to the Application Endpoint Registration product from the product catalog.</li><li>The API Consumer:Administrator has onboarded the developer:User to the platform.</li><li>The API Consumer has deployed application instances across various Edge Cloud Zones and has the necessary information about each endpoint.</li><li>The means to get the access token are known to the API Consumer:User to ensure secure access of the API.</li></ol> |
+| ***Activities/Steps*** | **Starts when:**<br>1. The API consumer application server makes requests to:<br>   - Register a new application endpoint by providing endpoint details.<br>   - Retrieve information about a specific registered endpoint.<br>   - Update the details of an existing registered endpoint.<br>   - Delete a registered endpoint that is no longer active.<br><br>**Ends when:**<br>1. The API endpoint successfully processes the registration, update, retrieval, or deletion request. |
+| ***Post-conditions*** | 1. For registration: A new application endpoint is registered and available for discovery.<br>2. For update: The application endpoint information is updated with the latest details.<br>3. For retrieval: The current information about the application endpoint is provided.<br>4. For deletion: The application endpoint is removed from the registration system and will no longer be discoverable. |
+| ***Exceptions*** | Several exceptions might occur <br>- Unauthorized: Not valid credentials (e.g. use of already expired access token).<br>- Invalid input: Not valid input data to register or update an endpoint (e.g. malformed URI).<br>- Conflict: An endpoint with the same identifier already exists during registration.<br>- Not Found: The requested endpoint doesn't exist during retrieval, update, or deletion operations. |

marked/ApplicationEndpointRegistration/documentation/SupportingDocuments/README/raw.md

@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.

marked/ApplicationProfiles/README/raw.md

@@ -0,0 +1,53 @@
+<a href="https://github.com/camaraproject/ApplicationProfiles/commits/" title="Last Commit"><img src="https://img.shields.io/github/last-commit/camaraproject/ApplicationProfiles?style=plastic"></a>
+<a href="https://github.com/camaraproject/ApplicationProfiles/issues" title="Open Issues"><img src="https://img.shields.io/github/issues/camaraproject/ApplicationProfiles?style=plastic"></a>
+<a href="https://github.com/camaraproject/ApplicationProfiles/pulls" title="Open Pull Requests"><img src="https://img.shields.io/github/issues-pr/camaraproject/ApplicationProfiles?style=plastic"></a>
+<a href="https://github.com/camaraproject/ApplicationProfiles/graphs/contributors" title="Contributors"><img src="https://img.shields.io/github/contributors/camaraproject/ApplicationProfiles?style=plastic"></a>
+<a href="https://github.com/camaraproject/ApplicationProfiles" title="Repo Size"><img src="https://img.shields.io/github/repo-size/camaraproject/ApplicationProfiles?style=plastic"></a>
+<a href="https://github.com/camaraproject/ApplicationProfiles/blob/main/LICENSE" title="License"><img src="https://img.shields.io/badge/License-Apache%202.0-green.svg?style=plastic"></a>
+<a href="https://github.com/camaraproject/ApplicationProfiles/releases/latest" title="Latest Release"><img src="https://img.shields.io/github/release/camaraproject/ApplicationProfiles?style=plastic"></a>
+<a href="https://github.com/camaraproject/Governance/blob/main/ProjectStructureAndRoles.md" title="Sandbox API Repository"><img src="https://img.shields.io/badge/Sandbox%20API%20Repository-yellow?style=plastic"></a>
+
+# 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)
+<!-- * Incubating stage since: §incubation date$ -->
+
+<!-- CAMARA:RELEASE-INFO:START -->
+<!-- The following section is automatically maintained by the CAMARA project-administration tooling: https://github.com/camaraproject/project-administration -->
+
+## 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._
+<!-- CAMARA:RELEASE-INFO:END -->
+
+## 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
+    <!-- Note: the $mailinglistname$ is either already existing (for API Repositories within a Sub Projects) or will be created by the CAMARA Admin Team. -->
+    * Subscribe / Unsubscribe to the mailing list <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>.

marked/ApplicationProfiles/code/API_definitions/README/raw.md

@@ -0,0 +1 @@
+Here you can add your definition file(s). Delete this README.MD file after the first file is added.

marked/ApplicationProfiles/code/API_definitions/application-profiles/raw.md

@@ -0,0 +1,687 @@
+# application-profiles
+
+```yaml
+openapi: 3.0.3
+info:
+  title: Connectivity Insights - Application Profiles
+  x-camara-commonalities: 0.6
+  version: wip
+  license:
+    name: Apache 2.0
+    url: https://www.apache.org/licenses/LICENSE-2.0.html
+  description: |
+    Application profiles allow developers to specify all relevant information about their application for both network and compute resource
+    requirements,supporting CAMARA APIs and network decision making.
+
+    This API enables defining, reading, and managing application requirements,including:
+    - Network quality thresholds (latency, jitter, loss, throughput)
+    - Compute resource thresholds (CPU, GPU, memory, storage)
+
+    The information captured as part of application profiles can be used in different usecases for decision making. Please refer connectivity insights and session insights for more details as a reference to see how the information in application profiles is used for decision making.
+    The scope will expand as new requirements from CAMARA APIs emerge.
+
+    ## Errors
+
+    If the authentication token is not valid, a `401 UNAUTHENTICATED` 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.
+
+    # 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.
+
+  contact:
+    email: sp-edc@lists.camaraproject.org
+externalDocs:
+  description: Project documentation at Camara
+  url: https://github.com/camaraproject/ApplicationProfiles
+servers:
+  - url: "{apiRoot}/application-profiles/vwip"
+    variables:
+      apiRoot:
+        default: https://localhost:9091
+        description: |
+          API root, defined by service provider, e.g.
+          `api.example.com` or `api.example.com/somepath`
+
+tags:
+  - name: Application Profiles
+    description: |
+      Operations to define, read and manage an application's thresholds
+      for network quality (latency, jitter, loss, throughput)
+
+paths:
+  /application-profiles:
+    post:
+      security:
+        - openId:
+            - application-profiles:create
+      tags:
+        - Application Profiles
+      summary: Create an Application Profile
+      description: |
+        Define network monitoring intents for optimal end user application
+        experience.
+      operationId: createApplicationProfile
+      parameters:
+        - $ref: "#/components/parameters/x-correlator"
+      requestBody:
+        description: List of user-defined network quality thresholds
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ApplicationProfileRequest"
+        required: true
+      responses:
+        "201":
+          description: Created
+          headers:
+            x-correlator:
+              $ref: "#/components/headers/x-correlator"
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ApplicationProfile"
+        "400":
+          $ref: "#/components/responses/Generic400"
+        "401":
+          $ref: "#/components/responses/Generic401"
+        "403":
+          $ref: "#/components/responses/Generic403"
+        "429":
+          $ref: "#/components/responses/Generic429"
+
+  /application-profiles/{applicationProfileId}:
+    patch:
+      security:
+        - openId:
+            - application-profiles:update
+      tags:
+        - Application Profiles
+      summary: Update an Application Profile
+      description: |
+        Update the complete set of network quality thresholds for an
+        application with the new set of thresholds to ensure good
+        end user experience
+      operationId: updateApplicationProfile
+      parameters:
+        - name: applicationProfileId
+          in: path
+          description: Identifier for the Application Profile
+          required: true
+          style: simple
+          explode: false
+          schema:
+            type: string
+            format: uuid
+        - $ref: "#/components/parameters/x-correlator"
+      requestBody:
+        description: |
+          network monitoring intents for optimal end user application
+          experience.
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ApplicationProfile"
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ApplicationProfile"
+        "400":
+          $ref: "#/components/responses/Generic400"
+        "401":
+          $ref: "#/components/responses/Generic401"
+        "403":
+          $ref: "#/components/responses/Generic403"
+        "404":
+          $ref: "#/components/responses/Generic404"
+        "429":
+          $ref: "#/components/responses/Generic429"
+
+    get:
+      security:
+        - openId:
+            - application-profiles:read
+      tags:
+        - Application Profiles
+      summary: Get an Application Profile
+      description: Read an Application Profile
+      operationId: readApplicationProfile
+      parameters:
+        - name: applicationProfileId
+          in: path
+          description: Identifier for the Application Profile
+          required: true
+          style: simple
+          explode: false
+          schema:
+            type: string
+            format: uuid
+        - $ref: "#/components/parameters/x-correlator"
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ApplicationProfile"
+        "400":
+          $ref: "#/components/responses/Generic400"
+        "401":
+          $ref: "#/components/responses/Generic401"
+        "403":
+          $ref: "#/components/responses/Generic403"
+        "404":
+          $ref: "#/components/responses/Generic404"
+        "429":
+          $ref: "#/components/responses/Generic429"
+
+    delete:
+      security:
+        - openId:
+            - application-profiles:delete
+      tags:
+        - Application Profiles
+      summary: Delete an Application Profile
+      description: Delete an application profile
+      operationId: deleteApplicationProfile
+      parameters:
+        - name: applicationProfileId
+          in: path
+          description: Identifier for the Application Profile
+          required: true
+          style: simple
+          explode: false
+          schema:
+            type: string
+            format: uuid
+        - $ref: "#/components/parameters/x-correlator"
+      responses:
+        "204":
+          description: Application profile has been deleted successfully.
+        "400":
+          $ref: "#/components/responses/Generic400"
+        "401":
+          $ref: "#/components/responses/Generic401"
+        "403":
+          $ref: "#/components/responses/Generic403"
+        "404":
+          $ref: "#/components/responses/Generic404"
+        "429":
+          $ref: "#/components/responses/Generic429"
+
+components:
+  securitySchemes:
+    openId:
+      type: openIdConnect
+      description: Common security scheme for all CAMARA APIs
+      openIdConnectUrl: https://example.com/.well-known/openid-configuration
+  headers:
+    x-correlator:
+      description: Correlation id for the different services
+      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:
+    XCorrelator:
+      type: string
+      pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
+      example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
+    Duration:
+      type: object
+      properties:
+        value:
+          type: integer
+          example: 12
+          format: int32
+          minimum: 1
+        unit:
+          allOf:
+            - $ref: "#/components/schemas/TimeUnitEnum"
+            - example: Minutes
+
+    TimeUnitEnum:
+      type: string
+      enum:
+        - Days
+        - Hours
+        - Minutes
+        - Seconds
+        - Milliseconds
+        - Microseconds
+        - Nanoseconds
+
+    Rate:
+      type: object
+      properties:
+        value:
+          type: integer
+          example: 10
+          format: int32
+          minimum: 0
+          maximum: 1024
+        unit:
+          $ref: "#/components/schemas/RateUnitEnum"
+
+    RateUnitEnum:
+      type: string
+      enum:
+        - Bps
+        - Kbps
+        - Mbps
+        - Gbps
+        - Tbps
+
+    Compute:
+      type: object
+      properties:
+        value:
+          type: integer
+          example: 10
+          format: int32
+          minimum: 0
+          maximum: 1024
+        unit:
+          $ref: "#/components/schemas/ComputeUnitEnum"
+
+    ComputeUnitEnum:
+      type: string
+      enum:
+        - Kb
+        - Mb
+        - Gb
+        - Tb
+
+    PacketDelayBudget:
+      description: |
+        The packet delay budget is the maximum allowable 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"
+
+    PacketErrorLossRate:
+      type: integer
+      description:
+        The exponential power of the allowable error loss rate 10^(-N).
+        For instance 3 would be an error loss rate of 10 to the power of -3
+        (0.001)
+
+        For 5G network the 3GPP specification TS 23.203 defines the packet
+        error loss rate QCI attribute. It describes the Quality of Service
+        (QoS) Class Identifier (QCI) parameters used to differentiate traffic
+        classes in mobile networks, ensuring appropriate resource
+        allocation and performance for various services.
+
+        The packet error loss rate is one of the QCI attributes, providing
+        information on the acceptable packet loss rate for a specific traffic
+        class. This attribute helps maintain the desired performance level for
+        services like voice calls, video streaming, or data transfers within
+        the 3GPP mobile network.
+      format: int32
+      minimum: 1
+      maximum: 10
+      example: 3
+
+    Jitter:
+      description:
+        The jitter requirement aims to limit the maximum 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"
+
+    TargetMinDownstreamRate:
+      description: |
+        This is the target minimum downstream rate.
+      allOf:
+        - $ref: "#/components/schemas/Rate"
+
+    TargetMinUpstreamRate:
+      description: |
+        This is the target minimum upstream rate.
+      allOf:
+        - $ref: "#/components/schemas/Rate"
+
+    targetMinCPU:
+      type: number
+      description:
+        Number of vCPUs required for the application. Fractional values are allowed (e.g., 0.5 = half a vCPU). The value represents the minimum amount of CPU resources to be allocated to the application instance.
+      example: 0.5
+
+    targetMinGPU:
+      description: |
+        This is the target minimun GPUs required by the application
+      format: integer
+      example: 1
+
+    gpuVendorType:
+      type: string
+      enum:
+        - Nvidia
+        - AMD
+      description: GPU vendor name e.g. NVIDIA, AMD etc.
+      example: Nvidia
+
+    gpuModelName:
+      type: string
+      description: Model name corresponding to vendorType may include info e.g. for NVIDIA, model name could be “Tesla M60”, “Tesla V100” etc.
+
+    targetMinMemory:
+      description: |
+        This is the target minimum memory required by the application
+      allOf:
+        - $ref: "#/components/schemas/Compute"
+
+    targetMinEphemeralStorage:
+      description: |
+        This is the target minimum ephemeral storage required by the application
+      allOf:
+        - $ref: "#/components/schemas/Compute"
+
+    targetMinPersistentStorage:
+      description: |
+        This is the target minimum persistent storage required by the
+        application
+      allOf:
+        - $ref: "#/components/schemas/Compute"
+
+    ApplicationProfile:
+      type: object
+      required:
+        - applicationProfileId
+      properties:
+        applicationProfileId:
+          type: string
+          format: uuid
+        networkQualityThresholds:
+          $ref: "#/components/schemas/NetworkQualityThresholds"
+        computeResources:
+          $ref: "#/components/schemas/ComputeResourcesThresholds"
+      anyOf:
+        - required: [networkQualityThresholds]
+        - required: [computeResources]
+
+    ApplicationProfileRequest:
+      type: object
+      anyOf:
+        - required: [networkQualityThresholds]
+        - required: [computeResources]
+      properties:
+        networkQualityThresholds:
+          $ref: "#/components/schemas/NetworkQualityThresholds"
+        computeResources:
+          $ref: "#/components/schemas/ComputeResourcesThresholds"
+
+    NetworkQualityThresholds:
+      type: object
+      properties:
+        packetDelayBudget:
+          $ref: "#/components/schemas/PacketDelayBudget"
+        targetMinDownstreamRate:
+          $ref: "#/components/schemas/TargetMinDownstreamRate"
+        targetMinUpstreamRate:
+          $ref: "#/components/schemas/TargetMinUpstreamRate"
+        packetLossErrorRate:
+          $ref: "#/components/schemas/PacketErrorLossRate"
+        jitter:
+          $ref: "#/components/schemas/Jitter"
+      minProperties: 1
+
+    ComputeResourcesThresholds:
+      type: object
+      properties:
+        targetMinCPU:
+          $ref: "#/components/schemas/targetMinCPU"
+        targetMinMemory:
+          $ref: "#/components/schemas/targetMinMemory"
+        gpuVendorType:
+          $ref: "#/components/schemas/gpuVendorType"
+        gpuModelName:
+          $ref: "#/components/schemas/gpuModelName"
+        targetMinGPU:
+          $ref: "#/components/schemas/targetMinGPU"
+        targetMinGPUMemory:
+          $ref: "#/components/schemas/targetMinMemory"
+        targetMinEphemeralStorage:
+          $ref: "#/components/schemas/targetMinEphemeralStorage"
+        targetMinPersistentStorage:
+          $ref: "#/components/schemas/targetMinPersistentStorage"
+      description: Compute resources of a Application Profile
+      minProperties: 1
+
+    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
+
+  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
+                      - 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
+          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: "{{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.
+    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.
+```

marked/ApplicationProfiles/documentation/API_documentation/README/raw.md

@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.

marked/ApplicationProfiles/documentation/API_documentation/application-profiles-API-Readiness-Checklist/raw.md

@@ -0,0 +1,29 @@
+# API Readiness Checklist
+
+Checklist for application-profiles v0.5.0 in r1.2
+
+| Nr | API release assets  | alpha | release-candidate |  initial<br>public | stable<br> public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----|
+|  1 | API definition                               |   M   |         M         |    M    |    M   | Y    | [link](/code/API_definitions/application-profiles.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    | [link](/documentation/API_documentation/application-profiles-User-Story.md) |
+|  7 | Basic API test cases & documentation         |   O   |         M         |    M    |    M   | Y  | [link](/code/Test_definitions/application-profiles.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  | [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/x/iQFmBQ) |
+
+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).

marked/ApplicationProfiles/documentation/API_documentation/application-profiles-User-Story/raw.md

@@ -0,0 +1,10 @@
+# Application profiles API User Story
+
+| **Item** | **Details** |
+| ---- | ------- |
+| ***Summary*** | As an application developer, I need to share key details about my application that are relevant for network-related decisions across various CAMARA APIs. Specifically, I need to define, store, and manage my application's network quality thresholds (latency, jitter, packet loss, and throughput) that represent my application's networking demands. These thresholds will serve as a baseline for determining whether the network can provide adequate performance for my application's users  |
+| ***Roles, Actors and Scope*** | **Roles:** API Consumer:Developer<br> **Actors:** Application service providers, hyperscalers, application developers. Currently the API does not explicitly handle consent management (expects that the API consumer either owns the device subscriptions or has agreed to manage consent as a part of general Terms and Conditions) and hence end users are not included as Actors. As this changes, the actor list will be extended with end users. <br> **Scope:** <ul><li>Create and manage application profiles</li><li>Perform network quality check againt the application profile for specific user sessions</li><li>Create subscriptions to recieve notifications if the network is not able to meet the application's requirements </li></ul> |
+| ***Pre-conditions*** |The preconditions are listed below:<br><ol><li>The API Consumer:BusinessManager and API Consumer:Administrator have been onboarded to the API Exposure Platform.</li><li>The API Consumer:BusinessManager has successfully subscribed to the Application Profiles product from the product catalog.</li><li>The API Consumer:Administrator has onboarded the developer:User to the platform.</li><li>The API Consumer either owns the device subscriptions or has agreed to the terms and conditions of the CSP for managing consent of subscription owners.</li><li>The means to get the access token are known to the API Consumer:User to ensure secure access of the API.|
+| ***Activities/Steps*** | **Starts when:** <br>1. The API consumer makes a POST request to /application-profiles with network quality thresholds including packetDelayBudget, targetMinDownstreamRate, targetMinUpstreamRate, packetlossErrorRate, and jitter.<br><br>**Additional Operatios:** <br>2. The API consumer can make a GET request to /application-profiles/{applicationProfileId} to retrieve an existing profile.<br>3. The API consumer can make a PATCH request to /application-profiles/{applicationProfileId} to update network quality thresholds for an existing profile.<br>4. The API consumer can make a DELETE request to /application-profiles/{applicationProfileId} to remove a profile that is no longer needed.<br><br> **Ends when:** <br>The application profile is either successfully created, updated, retrieved, or deleted based on the API consumer's request. |
+| ***Post-conditions*** | 1. For POST: A new application profile is created with a unique applicationProfileId and the specified network quality thresholds.<br>2. For GET: The details of the requested application profile are returned to the API consumer.<br>3. For PATCH: The application profile is updated with the new network quality thresholds.<br>4. For DELETE: The application profile is removed from the system.|
+| ***Exceptions*** | Several exceptions might occur <br>- Bad Request: Invalid argument or out-of-range values for network quality thresholds.<br>- Unauthorized: Invalid, missing, or expired access token.<br>- Forbidden: Insufficient permissions or invalid token context.<br>- Not Found: Requested application profile does not exist.<br>- Too Many Requests: Rate limit or quota exceeded.|

marked/ApplicationProfiles/documentation/SupportingDocuments/README/raw.md

@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.

marked/BlockchainPublicAddress/README/raw.md

@@ -0,0 +1,58 @@
+<a href="https://github.com/camaraproject/BlockchainPublicAddresscommits/" title="Last Commit"><img src="https://img.shields.io/github/last-commit/camaraproject/BlockchainPublicAddress?style=plastic"></a>
+<a href="https://github.com/camaraproject/BlockchainPublicAddress/issues" title="Open Issues"><img src="https://img.shields.io/github/issues/camaraproject/BlockchainPublicAddress?style=plastic"></a>
+<a href="https://github.com/camaraproject/BlockchainPublicAddress/pulls" title="Open Pull Requests"><img src="https://img.shields.io/github/issues-pr/camaraproject/BlockchainPublicAddress?style=plastic"></a>
+<a href="https://github.com/camaraproject/BlockchainPublicAddress/graphs/contributors" title="Contributors"><img src="https://img.shields.io/github/contributors/camaraproject/BlockchainPublicAddress?style=plastic"></a>
+<a href="https://github.com/camaraproject/BlockchainPublicAddress" title="Repo Size"><img src="https://img.shields.io/github/repo-size/camaraproject/BlockchainPublicAddress?style=plastic"></a>
+<a href="https://github.com/camaraproject/BlockchainPublicAddress/blob/main/LICENSE" title="License"><img src="https://img.shields.io/badge/License-Apache%202.0-green.svg?style=plastic"></a>
+<a href="https://github.com/camaraproject/BlockchainPublicAddress/releases/latest" title="Latest Release"><img src="https://img.shields.io/github/release/camaraproject/BlockchainPublicAddress?style=plastic"></a>
+<a href="https://github.com/camaraproject/Governance/blob/main/ProjectStructureAndRoles.md" title="Sandbox API Repository"><img src="https://img.shields.io/badge/Sandbox%20API%20Repository-yellow?style=plastic"></a>
+
+# 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
+
+<!-- CAMARA:RELEASE-INFO:START -->
+<!-- The following section is automatically maintained by the CAMARA project-administration tooling: https://github.com/camaraproject/project-administration -->
+
+## 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._
+<!-- CAMARA:RELEASE-INFO:END -->
+
+## 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 <https://lists.camaraproject.org/g/sp-bpa>.
+    * A message to the community of this Sub Project can be sent using <sp-bpa@lists.camaraproject.org>.

marked/BlockchainPublicAddress/code/API_definitions/blockchain-public-address-validation/raw.md

@@ -0,0 +1,258 @@
+# blockchain-public-address-validation
+
+```yaml
+openapi: 3.0.3
+info:
+  title: Blockchain Public Address Validation
+  description: |-
+    This API allows the API consumer to generate a one-time nonce for Enhanced Binding validation for Blockchain Public Address associated with a mobile phone number.
+
+    # Relevant Definitions and concepts
+    - **Blockchain Public Address**: Unique string of code used by individuals that can be used to send, receive, and store digital assets (e.g. payments in cryptocurrencies, smart contracts, NFT (Non-Fungible Tokens), etc.) on a blockchain network
+    to receive or request payments in cryptocurrency.
+
+    # API Functionality
+    This API allows to generate a one-time nonce to allow for enhanced validation procedure for Blockchain Public Address binding associated with a mobile phone number, as per defined in `bindBlockchainPublicAddress` operation of CAMARA Blockchain Public Address API.
+
+    # Resources and Operations overview
+    This API provides one endpoint:
+     - **Endpoint to generate a one-time nonce associated to a specific Blockchain Public Address**. It does not matter if the mobile phone number is already bound to a Blockchain Public Address, as this operation adds a new Blockchain Public Address. This operation MUST be used with a 3-legged Access Token
+
+    # 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.
+
+    # 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
+
+    (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
+  version: wip
+  x-camara-commonalities: wip
+externalDocs:
+  description: Product documentation at Camara
+  url: https://github.com/camaraproject/BlockchainPublicAddress
+servers:
+  - url: "{apiRoot}/blockchain-public-address-validation/vwip"
+    variables:
+      apiRoot:
+        default: http://localhost:9091
+        description: API root, defined by the service provider
+tags:
+  - name: Blockchain Public Address Validation Nonce
+    description: API operations to manage Blockchain Public Address Validation Nonce
+paths:
+  /nonce:
+    post:
+      tags:
+        - Blockchain Public Address Validation Nonce
+      summary: Generates a one-time nonce associated to a specific Blockchain Public Address
+      description: Generates a one-time nonce (i.e. challenge) associated to a specific Blockchain Public Address to allow for enhanced validation as per defined in `bindBlockchainPublicAddress` operation of CAMARA Blockchain Public Address API.
+      operationId: createBlockchainPublicAddressValidationNonce
+      security:
+        - openId:
+            - blockchain-public-address-validation:create
+      parameters:
+        - $ref: "#/components/parameters/x-correlator"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreateBlockchainPublicAddressValidationNonce"
+        required: true
+      responses:
+        "201":
+          description: Created
+          headers:
+            x-correlator:
+              $ref: "#/components/headers/x-correlator"
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/CreateBlockchainPublicAddressValidationNonceResponse"
+              examples:
+                CreateBlockchainPublicAddressValidationNonceResponse201Example:
+                  value:
+                    nonce: "abc626ce-5284-4a84-b85e-46e0ee3d0434"
+        "400":
+          $ref: "#/components/responses/Generic400"
+        "401":
+          $ref: "#/components/responses/Generic401"
+        "403":
+          $ref: "#/components/responses/Generic403"
+        "429":
+          $ref: "#/components/responses/Generic429"
+components:
+  securitySchemes:
+    openId:
+      type: openIdConnect
+      openIdConnectUrl: https://example.com/.well-known/openid-configuration
+  headers:
+    x-correlator:
+      description: Correlation id for the different services
+      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:
+    XCorrelator:
+      type: string
+      pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
+      example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
+    CreateBlockchainPublicAddressValidationNonce:
+      type: object
+      description: Payload to request the nonce generation associated to a given Blockchain Public Address
+      required:
+        - blockchainPublicAddress
+      properties:
+        blockchainPublicAddress:
+          type: string
+          description: User's Blockchain Public Address use for the latter binding to a specific `phoneNumber`.
+      example:
+        blockchainPublicAddress: "0x71C7656EC7ab88b098dafB451B2314C5f6d8932A"
+    CreateBlockchainPublicAddressValidationNonceResponse:
+      type: object
+      description: Nonce generation associated to a given Blockchain Public Address response
+      required:
+        - nonce
+      properties:
+        nonce:
+          type: string
+          description: |-
+            One-time challenge generated associated to indicated `blockchainPublicAddress`.
+    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: 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
+          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.
+    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:
+                      - TOO_MANY_REQUESTS
+          examples:
+            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.
+```

marked/BlockchainPublicAddress/code/API_definitions/blockchain-public-address/raw.md

@@ -0,0 +1,663 @@
+# blockchain-public-address
+
+```yaml
+openapi: 3.0.3
+info:
+  title: Blockchain Public Address
+  description: |-
+    This API allows the API consumer to manage Blockchain Public Address associated with a mobile phone number.
+
+    # Relevant Definitions and concepts
+    - **Blockchain Public Address**: Unique string of code used by individuals that can be used to send, receive, and store digital assets (e.g. payments in cryptocurrencies, smart contracts, NFT (Non-Fungible Tokens), etc.) on a blockchain network
+    to receive or request payments in cryptocurrency.
+
+    # API Functionality
+    This API allows the API consumer to manage a Blockchain Public Address associated with a mobile phone number, i.e.: to retrieve the Blockchain Public Address(es) and to bind/unbind a Blockchain Public Address.
+
+    # Resources and Operations overview
+    This API provides three endpoints:
+     - **Endpoint to retrieve the Blockchain Public Address(es) associated with a mobile phone number sent as input**. The Blockchain Public Address is information made available by the user, in association to their mobile phone number. Then, this endpoint may be accessed in 2-legged or in 3-legged mode. Even in 3-legged mode, the mobile phone number included as input field does not need to belong to the `sub` (representing the User) for which the Access Token is issued. This will enable a user to ask for the Blockchain Public Address(es) of any mobile phone number, in order to perform a transaction with one of the available ones (send or request).
+     - **Endpoint to associate a mobile phone number with a Blockchain Public Address**. It does not matter if the mobile phone number is already bound to a Blockchain Public Address, as this operation adds a new Blockchain Public Address. This operation MUST be used with a 3-legged Access Token, and the indicated mobile phone number must belong to the `sub` (representing the User) in the Access Token; this is because only the user of the mobile phone number must be able to perform a bind. As a consequence, this operation will only work with mobile phone numbers of the Telco Operator exposing the API.
+     - **Endpoint to remove the association of a mobile phone number with a Blockchain Public Address**. This operation MUST be used with a 3-legged Access Token; this is because only the user of the mobile phone number must be able to perform an unbind. Note: Due to this, the API Server must validate that the `id` included in the request refers to a bind for a mobile phone number belonging to the `sub` (representing the User) in the Access Token. As a consequence, this operation will only work with mobile phone numbers of the Telco Operator exposing the API.
+
+    ## Enforcement of the Blockchain Public Address ownership in binding process
+
+    The enforcement of the Blockchain Public Address ownership in the binding process is optional, and it is not mandatory to use the `nonce` and `signature` fields. If the API consumer does not want to enforce this, it can simply omit these fields in the request body.
+
+    This enforcement is aimed to ensure that the Blockchain Public Address being bound to a mobile phone number is indeed owned by the user (i.e. person behind) of that mobile phone number.
+    The API consumer can request the user to sign a `nonce` off-chain, and then include the `nonce` and `signature` in the request body when binding the Blockchain Public Address. The API Server will then verify that the `signature` is valid for the given `nonce` and `blockchainPublicAddress`.
+
+    The E2E procedure is depicted in below picture:
+    ![Binding Enforcement - Off-Chain Signature](https://raw.githubusercontent.com/camaraproject/BlockchainPublicAddress/r2.2/documentation/API_documentation/resources/blockchain-public-address-binding-enforcement-off-chain-signature.png)
+
+    LEGEND:
+    - `API Server`, `Challenge Module` and `Binding Database` are functional components that represent the underlying Backend API Logic in the Telco Operator. How this CAMARA API is implemented by a Telco Operator is out of scope of this specification.
+
+    It comprises four steps:
+    - **(A) Obtain 3-Legged Access Token**: This is the regular process of obtaining a CAMARA 3-legged Access Token. CAMARA OIDC Authorization Code Flow is mentioned for illustrative purposes, other CAMARA 3-legged Access Token flows may be used. Check CAMARA Identity and Consent Management WG for details.
+    - **(B) Request a nonce from the API Server**: This is the feature provided by **_CAMARA Blockchain Public Address Validation Nonce API_**, allowing the API consumer to request a `nonce` associated to the `blockchainPublicAddress` to be signed by the user.
+    - **(C) Ask the user to sign the nonce off-chain**: The API consumer will use this `nonce` to ask the user to sign it off-chain. The user will sign the `nonce` using their private key. The API consumer will then obtain a `signature`, which is a cryptographic proof that the user owns the `blockchainPublicAddress`.
+    - **(D) Bind the Blockchain Public Address to the mobile phone number**: This step includes the `nonce` and `signature` in the request body. For signature validation, there are many options (e.g. https://ecrecover.org/, tools like `ethers.js` or `web3.js`); that is an implementation topic out of scope of this CAMARA API specification.
+
+    # 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.
+
+    # 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
+
+    (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
+  version: wip
+  x-camara-commonalities: wip
+externalDocs:
+  description: Product documentation at Camara
+  url: https://github.com/camaraproject/BlockchainPublicAddress
+servers:
+  - url: "{apiRoot}/blockchain-public-address/vwip"
+    variables:
+      apiRoot:
+        default: http://localhost:9091
+        description: API root, defined by the service provider
+tags:
+  - name: Blockchain Public Address
+    description: API operations to manage Blockchain Public Addresses
+paths:
+  /blockchain-public-addresses/retrieve-blockchains:
+    post:
+      tags:
+        - Blockchain Public Address
+      summary: Retrieves Blockchain Public Address associated with a mobile phone number.
+      description:
+        Retrieves Blockchain Public Address associated with a mobile phone number. This operation can be accessed in 3-legged and in 2-legged, notice that the mobile phone number used as input need not be related with the user or mobile phone number to which the Access
+        Token is associated; this is because the operation is intended to be used to manage Blockchain Public Address of any mobile phone number, in order to perform send or request crypto operations.
+      operationId: retrieveBlockchainPublicAddress
+      security:
+        - openId:
+            - blockchain-public-address:read
+      parameters:
+        - $ref: "#/components/parameters/x-correlator"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/PhoneNumber"
+        required: true
+      responses:
+        "200":
+          description: OK
+          headers:
+            x-correlator:
+              $ref: "#/components/headers/x-correlator"
+          content:
+            application/json:
+              schema:
+                type: array
+                description: Array of Blockchain Public Addresses bound to the mobile phone number
+                items:
+                  $ref: "#/components/schemas/BlockchainPublicAddressResponse"
+              examples:
+                RetrieveBlockchainPublicAddressResponse200Example:
+                  value:
+                    - id: "90c626ce-5284-4a84-b85e-46e0ee3d0434"
+                      blockchainPublicAddress: "0x71C7656EC7ab88b098dafB451B2314C5f6d8932A"
+                      blockchainNetworkId: "evm:1"
+                      currency:
+                        - ETH
+                    - id: "5c179f50-db37-4d23-87e3-6f10c991899f"
+                      blockchainPublicAddress: "0x329CdCAAC31c934fe32322b111bE8fBd30b4FFA9"
+                      blockchainNetworkId: "evm:137"
+                      currency:
+                        - WETH
+        "400":
+          $ref: "#/components/responses/Generic400"
+        "401":
+          $ref: "#/components/responses/Generic401"
+        "403":
+          $ref: "#/components/responses/Generic403"
+        "404":
+          $ref: "#/components/responses/Generic404"
+        "429":
+          $ref: "#/components/responses/Generic429"
+  /blockchain-public-addresses:
+    post:
+      tags:
+        - Blockchain Public Address
+      summary: Binds Blockchain Public Address to a mobile phone number
+      description:
+        Binds Blockchain Public Address to a mobile phone number. If the mobile phone number is already bound to a Blockchain Public Address, this operation will add a new bound Blockchain Public Address to the mobile phone number. This operation is intended to be used
+        with a 3-legged Access Token, and the indicated mobile phone number must belong to the user identified by its `sub` in the Access Token; this is because only the user of the mobile phone number must be able to perform the bind.
+
+        Specifically for this functionality, when a binding operation indicates a `blockchainNetworkId` not allowed by Telco Operator exception `403 - BLOCKCHAIN_PUBLIC_ADDRESS.BLOCKCHAIN_NETWORK_IDENTIFIER_NOT_ALLOWED` will be generated.
+      operationId: bindBlockchainPublicAddress
+      security:
+        - openId:
+            - blockchain-public-address:create
+      parameters:
+        - $ref: "#/components/parameters/x-correlator"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/BindBlockchainPublicAddressRequest"
+        required: true
+      responses:
+        "201":
+          description: Created
+          headers:
+            x-correlator:
+              $ref: "#/components/headers/x-correlator"
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/BindBlockchainPublicAddressResponse"
+              examples:
+                BindBlockchainPublicAddressResponse201Example:
+                  value:
+                    id: "90c626ce-5284-4a84-b85e-46e0ee3d0434"
+        "400":
+          $ref: "#/components/responses/InvalidArgumentForBlockchain400"
+        "401":
+          $ref: "#/components/responses/Generic401"
+        "403":
+          $ref: "#/components/responses/PermissionDeniedForBlockchain403"
+        "404":
+          $ref: "#/components/responses/Generic404"
+        "409":
+          $ref: "#/components/responses/Generic409"
+        "422":
+          $ref: "#/components/responses/Generic422"
+        "429":
+          $ref: "#/components/responses/Generic429"
+  /blockchain-public-addresses/{id}:
+    delete:
+      tags:
+        - Blockchain Public Address
+      summary: Unbinds Blockchain Public Address association to a mobile phone number
+      description: |-
+        Unbinds Blockchain Public Address to a mobile phone number. This operation is intended to be used with a 3-legged Access Token; this is because only the user of the mobile phone number must be able to perform the unbind.
+        Note: Due to this, the API Server must validate that the `id` included in the request refers to a bind for a mobile phone number belonging to the user identified by its `sub` in the Access Token.
+      operationId: deleteBlockchainPublicAddress
+      security:
+        - openId:
+            - blockchain-public-address:delete
+      parameters:
+        - $ref: "#/components/parameters/Id"
+        - $ref: "#/components/parameters/x-correlator"
+      responses:
+        "204":
+          description: No Content
+          headers:
+            x-correlator:
+              $ref: "#/components/headers/x-correlator"
+        "400":
+          $ref: "#/components/responses/Generic400"
+        "401":
+          $ref: "#/components/responses/Generic401"
+        "403":
+          $ref: "#/components/responses/Generic403"
+        "404":
+          $ref: "#/components/responses/Generic404"
+        "429":
+          $ref: "#/components/responses/Generic429"
+components:
+  securitySchemes:
+    openId:
+      type: openIdConnect
+      openIdConnectUrl: https://example.com/.well-known/openid-configuration
+  headers:
+    x-correlator:
+      description: Correlation id for the different services
+      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"
+    Id:
+      name: id
+      in: path
+      description: Unique identifier given to the bind relationship of a mobile `phoneNumber` with a Blockchain Public Address.
+      required: true
+      schema:
+        type: string
+  schemas:
+    XCorrelator:
+      type: string
+      pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
+      example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
+    PhoneNumber:
+      type: object
+      description: Payload to retrieve the Blockchain Public Address(es) associated to a given Phone Number
+      required:
+        - phoneNumber
+      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}$'
+    BindBlockchainPublicAddressRequest:
+      type: object
+      description: Payload to request the Bind of the Blockchain Public Address
+      required:
+        - phoneNumber
+        - blockchainPublicAddress
+        - blockchainNetworkId
+      properties:
+        phoneNumber:
+          type: string
+          description: Mobile phone number to which the Blockchain Public Address will be bound. 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}$'
+        blockchainPublicAddress:
+          type: string
+          description: User's Blockchain Public Address to bind to the mobile `phoneNumber`
+        blockchainNetworkId:
+          type: string
+          pattern: ^[a-zA-Z0-9]+:?[a-zA-Z0-9]+$
+          description: |-
+            Identifier (i.e. name/type) of the blockchain whose address value is provided within `blockchainPublicAddress`. The model proposed aims to provide an extensible way to list/identify every blockchain ecosystems.
+            Proposed format is: `<L1_Ecosystem>:<sub_id>`, where:
+
+            - `<L1_Ecosystem>`: Represents a Layer 1 Blockchain Ecosystem (e.g. ethereum, bitcoin,...)
+            - `<sub_id>`: Represents subsequents L2 and Testnet Blockchain Ecosystems, whenever they apply (e.g. bitcoin is a monolithic blockchain so as this concept does not apply)
+
+            So far, in the scope of v0.2 of this specification, the following `<L1_Ecosystem>` values are covered:
+            - `evm`: Representing a common L1 Layer concept for EVM-based networks. Within this Ecosystem, `<sub_id>` concept is required and matches the value of chainId as per [EVM ChainId](https://chainid.network/). For instance:
+              - `ethereum` blockchain would be identified by `evm:1` value (i.e. ethereum mainnet).
+              - `polygon` blockchain would be identified by `evm:137` value (i.e. polygon mainnet).
+              - `celo` blockchain would be identified by `evm:42220` value (i.e. celo mainnet).
+              - `aleph zero` blockchain would be identified by `evm:41455` value (i.e. aleph zero evm).
+            - `bitcoin`: Representing Bitcoin L1 blockchain. No `<sub_id>` concept applies for this L1 Ecosystem
+            - `solana`: Representing Solana L1 blockchain. No `<sub_id>` concept applies for this L1 Ecosystem
+            - `cardano`: Representing Cardano L1 blockchain. No `<sub_id>` concept applies for this L1 Ecosystem
+        currency:
+          type: array
+          description: List of currencies for the blockchain. Optional field (generally not needed), only indicated when there are business needs to set one or a list on currencies supported.
+          minItems: 0
+          items:
+            type: string
+        nonce:
+          type: string
+          description: |-
+            One-time challenge generated by means of endpoint `createBlockchainPublicAddressValidationNonce` of CAMARA API Blockchain Public Address Challenge.
+
+            It is used along with `signature` to perform optional enhanced enforcement to ensure blockChainPublicAddress can be associated to the phoneNumber as it belongs to the owner of the blockChainPublicAddress.
+        signature:
+          type: string
+          description: |-
+            Unique distinctive generated as a result of asking the user to sign the nonce off-chain.
+
+            It is used along with `nonce` to perform optional enhanced enforcement to ensure blockChainPublicAddress can be associated to the the phoneNumber as it belongs to the owner of the blockChainPublicAddress.
+      example:
+        phoneNumber: "+346789990012"
+        blockchainPublicAddress: "0x71C7656EC7ab88b098dafB451B2314C5f6d8932A"
+        blockchainNetworkId: "evm:1"
+        currency:
+          - ETH
+    BindBlockchainPublicAddressResponse:
+      type: object
+      description: Bind Blockchain Public Address response
+      required:
+        - id
+      properties:
+        id:
+          type: string
+          description: Unique identifier given to the bind relationship of a mobile `phoneNumber` with a Blockchain Public Address.
+    BlockchainPublicAddressResponse:
+      type: object
+      description: Blockchain Public Address response
+      required:
+        - id
+        - blockchainPublicAddress
+        - blockchainNetworkId
+      properties:
+        id:
+          type: string
+          description: Unique identifier given to the bind relationship of a mobile `phoneNumber` with a Blockchain Public Address.
+        blockchainPublicAddress:
+          type: string
+          description: User's Blockchain Public Address
+        blockchainNetworkId:
+          type: string
+          description: |-
+            Identifier (i.e. name/type) of the blockchain whose address value is provided within `blockchainPublicAddress`. The model proposed aims to provide an extensible way to list/identify every blockchain ecosystems.
+            Proposed format is: `<L1_Ecosystem>:<sub_id>`, where:
+            - `<L1_Ecosystem>`: Represents a Layer 1 Blockchain Ecosystem (e.g. ethereum, bitcoin,...)
+            - `<sub_id>`: Represents subsequents L2 and Testnet Blockchain Ecosystems, whenever they apply (e.g. bitcoin is a monolithic blockchain so as this concept does not apply)
+
+            So far, in the scope of v0.2 of this specification, the following `<L1_Ecosystem>` values are covered:
+            - `evm`: Representing a common L1 Layer concept for EVM-based networks. Within this Ecosystem, `<sub_id>` concept is required and matches the value of chainId as per [EVM ChainId](https://chainid.network/). For instance:
+              - `ethereum` blockchain would be identified by `evm:1` value (i.e. ethereum mainnet).
+              - `polygon` blockchain would be identified by `evm:137` value (i.e. polygon mainnet).
+              - `celo` blockchain would be identified by `evm:42220` value (i.e. celo mainnet).
+              - `aleph zero` blockchain would be identified by `evm:41455` value (i.e. aleph zero evm).
+            - `bitcoin`: Representing Bitcoin L1 blockchain. No `<sub_id>` concept applies for this L1 Ecosystem
+            - `solana`: Representing Solana L1 blockchain. No `<sub_id>` concept applies for this L1 Ecosystem
+            - `cardano`: Representing Cardano L1 blockchain. No `<sub_id>` concept applies for this L1 Ecosystem
+        currency:
+          type: array
+          description: List of currencies for the blockchain. Optional field (generally not needed), only indicated when there are business needs to set one or a list on currencies supported.
+          minItems: 0
+          items:
+            type: string
+    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:
+    InvalidArgumentForBlockchain400:
+      description: |
+        Problem with the client request.
+        In addition to regular scenario of INVALID_ARGUMENT, other exceptions may exist.
+         - Indicated blockchainNetworkId is not valid ("code": "BLOCKCHAIN_PUBLIC_ADDRESS.INVALID_BLOCKCHAIN_NETWORK_IDENTIFIER","message": "Indicated blockchainNetworkId is not valid")
+         - Indicated currency is not valid for the Blockchain ("code": "BLOCKCHAIN_PUBLIC_ADDRESS.INVALID_CURRENCY","message": "Indicated currency is not found")
+         - Currency indication is required ("code": "BLOCKCHAIN_PUBLIC_ADDRESS.CURRENCY_REQUIRED","message": "One currency is required")
+         - Indicated nonce is not valid ("code": "BLOCKCHAIN_PUBLIC_ADDRESS.INVALID_NONCE","message": "Indicated nonce is not valid")
+         - Indicated signature is not valid ("code": "BLOCKCHAIN_PUBLIC_ADDRESS.INVALID_SIGNATURE","message": "Indicated signature is not valid")
+         - Both nonce and signature are required together to perform enhanced validation ("code": "BLOCKCHAIN_PUBLIC_ADDRESS.BOTH_NONCE_SIGNATURE_REQUIRED","message": "Both nonce and signature are required for enhanced validation")
+      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
+                      - BLOCKCHAIN_PUBLIC_ADDRESS.INVALID_BLOCKCHAIN_NETWORK_IDENTIFIER
+                      - BLOCKCHAIN_PUBLIC_ADDRESS.INVALID_CURRENCY
+                      - BLOCKCHAIN_PUBLIC_ADDRESS.CURRENCY_REQUIRED
+                      - BLOCKCHAIN_PUBLIC_ADDRESS.INVALID_NONCE
+                      - BLOCKCHAIN_PUBLIC_ADDRESS.INVALID_SIGNATURE
+                      - BLOCKCHAIN_PUBLIC_ADDRESS.BOTH_NONCE_SIGNATURE_REQUIRED
+          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_INVALID_BLOCKCHAIN_NETWORK_ID:
+              description: blockchainNetworkId is not valid
+              value:
+                status: 400
+                code: BLOCKCHAIN_PUBLIC_ADDRESS.INVALID_BLOCKCHAIN_NETWORK_IDENTIFIER
+                message: Indicated blockchainNetworkId is not valid
+            GENERIC_400_INVALID_CURRENCY_FOR_BLOCKCHAIN:
+              description: Invalid currency
+              value:
+                status: 400
+                code: BLOCKCHAIN_PUBLIC_ADDRESS.INVALID_CURRENCY
+                message: Indicated currency is not found
+            GENERIC_400_REQUIRED_CURRENCY_FOR_BLOCKCHAIN:
+              description: Currency is required
+              value:
+                status: 400
+                code: BLOCKCHAIN_PUBLIC_ADDRESS.CURRENCY_REQUIRED
+                message: One currency is required
+            GENERIC_400_INVALID_NONCE:
+              description: Invalid nonce
+              value:
+                status: 400
+                code: BLOCKCHAIN_PUBLIC_ADDRESS.INVALID_NONCE
+                message: Indicated nonce is not valid
+            GENERIC_400_INVALID_SIGNATURE:
+              description: Invalid signature
+              value:
+                status: 400
+                code: BLOCKCHAIN_PUBLIC_ADDRESS.INVALID_SIGNATURE
+                message: Indicated signature is not valid
+            GENERIC_400_BOTH_NONCE_SIGNATURE_REQUIRED:
+              description: Both nonce and signature are required together
+              value:
+                status: 400
+                code: BLOCKCHAIN_PUBLIC_ADDRESS.BOTH_NONCE_SIGNATURE_REQUIRED
+                message: Both nonce and signature are required for enhanced validation
+    PermissionDeniedForBlockchain403:
+      description: |
+        Forbidden.
+        In addition to regular scenario of PERMISSION_DENIED, other exceptions may exist.
+         - Blockchain identifier not allowed by business rules ("code": "BLOCKCHAIN_PUBLIC_ADDRESS.BLOCKCHAIN_NETWORK_IDENTIFIER_NOT_ALLOWED","message": "Indicated blockchainNetworkId is not allowed by business rules")
+      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
+                      - BLOCKCHAIN_PUBLIC_ADDRESS.BLOCKCHAIN_NETWORK_IDENTIFIER_NOT_ALLOWED
+          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_NOT_ALLOWED_BLOCKCHAIN_NETWORK_ID:
+              description: blockchainNetworkId not allowed by business rules
+              value:
+                status: 403
+                code: BLOCKCHAIN_PUBLIC_ADDRESS.BLOCKCHAIN_NETWORK_IDENTIFIER_NOT_ALLOWED
+                message: Indicated blockchainNetworkId is not allowed by business rules
+    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
+          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:
+                      - 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.
+    Generic409:
+      description: Conflict
+      headers:
+        x-correlator:
+          $ref: "#/components/headers/x-correlator"
+      content:
+        application/json:
+          schema:
+            allOf:
+              - $ref: "#/components/schemas/ErrorInfo"
+              - type: object
+                properties:
+                  status:
+                    enum:
+                      - 409
+                  code:
+                    enum:
+                      - ALREADY_EXISTS
+          examples:
+            GENERIC_409_ALREADY_EXISTS:
+              description: Trying to create an existing resource
+              value:
+                status: 409
+                code: ALREADY_EXISTS
+                message: The resource that a client tried to create already exists.
+    Generic422:
+      description: |-
+        Unprocessable content.
+         - Enhanced Binding validation procedure by means of nonce and signature verification is not supported ("code": "BLOCKCHAIN_PUBLIC_ADDRESS.UNSUPPORTED_ENHANCED_VALIDATION","message": "Enhanced Binding validation procedure is not supported")
+      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:
+                      - BLOCKCHAIN_PUBLIC_ADDRESS.UNSUPPORTED_ENHANCED_VALIDATION
+          examples:
+            GENERIC_422_UNSUPPORTED_ENHANCED_VALIDATION:
+              description: Enhanced Binding validation procedure by means of nonce and signature verification is not supported
+              value:
+                status: 422
+                code: BLOCKCHAIN_PUBLIC_ADDRESS.UNSUPPORTED_ENHANCED_VALIDATION
+                message: Enhanced Binding validation procedure is not supported
+    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:
+                      - TOO_MANY_REQUESTS
+          examples:
+            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.
+```

marked/BlockchainPublicAddress/documentation/API_documentation/blockchain-public-address-API-Readiness-Checklist/raw.md

@@ -0,0 +1,29 @@
+# API Readiness Checklist
+
+Checklist for BlockChain Public Address v0.3.0 in r2.2
+
+| Nr | API release assets  | alpha | release-candidate |  initial<br>public | stable<br> public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
+|  1 | API definition                               |   M   |         M         |    M    |    M   |  Y   | [link](/code/API_definitions/blockchain-public-address.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   | [link](/code/API_definitions/blockchain-public-address.yaml) |
+|  6 | User stories                                 |   O   |         O         |    O    |    M   |  Y   | [link](/documentation/API_documentation/blockchain-public-address-User-Story.md) |
+|  7 | Basic API test cases & documentation         |   O   |         M         |    M    |    M   |  Y   | [link](/code/Test_definitions) |
+|  8 | Enhanced API test cases & documentation      |   O   |         O         |    O    |    M   |  N   | link |
+|  9 | Test result statement                        |   O   |         O         |    O    |    M   |  N   | link |
+| 10 | API release numbering convention applied     |   M   |         M         |    M    |    M   |  Y   |      |
+| 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/x/noDWB) |
+
+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).

marked/BlockchainPublicAddress/documentation/API_documentation/blockchain-public-address-User-Story/raw.md

@@ -0,0 +1,26 @@
+# BlockchainPublicAddress API User Stories
+
+|  **Item**  |  **Details**  |
+| ---------- | ------------- |
+|  **US#1**  | User Story #1 |
+| ***Summary*** | As an application developer, I want a feature to fetch Telco Operator customers Blockchain Public Addresses in a user-friendly way, using Customers Mobile Subscription (i.e. phoneNumber), as a natural and regular pair for the public address of a blockchain. This way management of Blockchain Public Addresses can be perfomed by means of the phoneNumber, which is a natural concept within the OBs. |
+| ***Roles, Actors and Scope*** | **Roles:** Customer:User<br> **Actors:** Application service providers, hyperscalers, application developers.  <br> **Scope:** Obtain Blockchain Public Addresses associated to a given phoneNumber of the Customer |
+| ***Pre-conditions*** | N/A |
+| ***Activities/Steps*** | **Starts when:** The API Consumer makes a GET request to the Blockchain Public Address API to obtain the Blockchain Public Addresses associated to a given phoneNumber (generally such addresses are identified by a DID (Decentralised Identifier, which indeed is a public  address  of a blockchain), composed  of 26-35 alphanumeric  characters in length).<br>**Ends when:** The API Consumer receives GET response with the list of Blockchain Public Addresses associated to the phoneNumber, including this information: <br/> - Blockchain public address name.<br/> - Blockchain public address identifier (DID).<br/> - Blockchain public address identifier binding (for latter management).<br/> - Blockchain public address currency.<br/>Empty response will be received in case no Blockchain Public Address is linked to the phonNumber yet. |
+| ***Post-conditions*** | N/A |
+| ***Exceptions*** | Several exceptions might occur during the Blockchain Public Address(es) retrieval linked to a given phoneNumber<br>- Unauthorized: Not valid credentials (e.g. use of already expired access token).<br>- Invalid Argument: Not valid phoneNumber.<br>- Internal: Server Error when fetching information. |
+|  --------  | ------------- |
+|  **US#2**  | User Story #2 |
+| ***Summary*** | As an application developer, I want a feature to manage (bind/unbind) Telco Operator customers Blockchain Public Addresses in a user-friendly way, using Customers Mobile Subscription (i.e. phoneNumber), as a natural and regular pair for the public address of a blockchain. |
+| ***Roles, Actors and Scope*** | **Roles:** Customer:User<br> **Actors:** Application service providers, hyperscalers, application developers.  <br> **Scope:** Manage Blockchain Public Addresses binding/unbinding them to a given phoneNumber of the Customer |
+| ***Pre-conditions*** | Blockchain Public Address exists in advance |
+| ***Activities/Steps*** | **BINDING PROCESS**<br> **Starts when:** The API Consumer makes a POST request to the Blockchain Public Address API to bind a specific Blockchain Public Addresses to a provided phoneNumber.<br> **Ends when:** The API Consumer receives POST response with this unique binding identifier.<br><br/>**UNBINDING PROCESS**<br> **Starts when:** The API Consumer makes a DELETE request to the Blockchain Public Address API to unbind a specific Blockchain Public Addresses - phoneNumber relationship, providing the binding identifier that identifies such relationship.<br> **Ends when:** The API Consumer receives DELETE response indicating a successful process performed (i.e. deletion). |
+| ***Post-conditions*** | **BINDING PROCESS**<br/> Binding relationship between Blockchain Public Address and phoneNumber is created. If making GET request an item showing that binding is included.<br><br>**UNBINDING PROCESS**<br/> Binding relationship between Blockchain Public Address and phoneNumber is deleted. If making GET request the item showing that binding is no longer included. |
+| ***Exceptions*** | Several exceptions might occur during the Blockchain Public Address management<br><br>**BINDING PROCESS**<br>- Unauthorized: Not valid credentials (e.g. use of already expired access token).<br>- Invalid Argument: Not valid phoneNumber and/or BlockChain Public Address Information.<br>- Internal: Server Error when fetching information.<br><br>**UNBINDING PROCESS**<br>- Unauthorized: Not valid credentials (e.g. use of already expired access token).<br>- Invalid Argument: Not valid binding identifier.<br>- Internal: Server Error when fetching information.  |
+|  **US#3**  | User Story #3 |
+| ***Summary*** | As an application developer, I want a feature to manage bind Telco Operator customers Blockchain Public Addresses in a user-friendly way, using Customers Mobile Subscription (i.e. phoneNumber), as a natural and regular pair for the public address of a blockchain, and also performing Binding Enforcement by ensuring the phoneNumber and the blockchainPublicAddress belongs to the same owner |
+| ***Roles, Actors and Scope*** | **Roles:** Customer:User<br> **Actors:** Application service providers, hyperscalers, application developers.  <br> **Scope:** Manage Blockchain Public Addresses binding to a given phoneNumber of the Customer with Binding enforcement feature requested |
+| ***Pre-conditions*** | Blockchain Public Address exists in advance |
+| ***Activities/Steps*** | **BINDING PROCESS**<br> **Starts when:** The API Consumer makes a POST request to the Blockchain Public Address API to bind a specific Blockchain Public Addresses to a provided phoneNumber, also indicating the nonce and signature fields.<br> **Ends when:** The API Consumer receives POST response with this unique binding identifier. |
+| ***Post-conditions*** | **BINDING PROCESS**<br/> Binding relationship between Blockchain Public Address and phoneNumber is created. If making GET request an item showing that binding is included. |
+| ***Exceptions*** | Several exceptions might occur during the Blockchain Public Address management<br><br>**BINDING PROCESS**<br>- Unauthorized: Not valid credentials (e.g. use of already expired access token).<br>- Invalid Argument: Not valid phoneNumber, BlockChain Public Address, nonce or signature Information.<br>- Internal: Server Error when fetching information. |

marked/BlockchainPublicAddress/documentation/API_documentation/blockchain-public-address-validation-API-Readiness-Checklist/raw.md

@@ -0,0 +1,29 @@
+# API Readiness Checklist
+
+Checklist for BlockChain Public Address Validation v0.1.0 in r2.2
+
+| Nr | API release assets  | alpha | release-candidate |  initial<br>public | stable<br> public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
+|  1 | API definition                               |   M   |         M         |    M    |    M   |  Y   | [link](/code/API_definitions/blockchain-public-address-validation.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   | [link](/code/API_definitions/blockchain-public-address-validation.yaml) |
+|  6 | User stories                                 |   O   |         O         |    O    |    M   |  Y   | [link](/documentation/API_documentation/blockchain-public-address-validation-User-Story.md) |
+|  7 | Basic API test cases & documentation         |   O   |         M         |    M    |    M   |  Y   | [link](/code/Test_definitions) |
+|  8 | Enhanced API test cases & documentation      |   O   |         O         |    O    |    M   |  N   | link |
+|  9 | Test result statement                        |   O   |         O         |    O    |    M   |  N   | link |
+| 10 | API release numbering convention applied     |   M   |         M         |    M    |    M   |  Y   |      |
+| 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/x/AYASD) |
+
+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).

marked/BlockchainPublicAddress/documentation/API_documentation/blockchain-public-address-validation-User-Story/raw.md

@@ -0,0 +1,11 @@
+# BlockchainPublicAddress Validation API User Stories
+
+|  **Item**  |  **Details**  |
+| ---------- | ------------- |
+|  **US#1**  | User Story #1 |
+| ***Summary*** | As an application developer, I want a feature to generate a nonce (one-time challenge) associated to a blockchain public address, in order for the customer to be able to sign it off-chain, generating a signature. This will allow afterwards to perform binding enforment via Blockchain Public Address binding process. |
+| ***Roles, Actors and Scope*** | **Roles:** Customer:User<br> **Actors:** Application service providers, hyperscalers, application developers.<br> **Scope:** Obtain a nonce associated to a blockchainPublicAdress of the Customer |
+| ***Pre-conditions*** | N/A |
+| ***Activities/Steps*** | **Starts when:** The API Consumer makes a POST request to the Blockchain Public Address Validation API to obtain a nonce associated to a blockchainPublicAdress (indicated as an input) of the Customer.<br>**Ends when:** The API Consumer receives POST response with the nonce value. |
+| ***Post-conditions*** | N/A |
+| ***Exceptions*** | Several exceptions might occur during the nonce generation<br>- Unauthorized: Not valid credentials (e.g. use of already expired access token).<br>- Invalid Argument: Not valid blockchainPublicAddress.<br>- Internal: Server Error when fetching information. |

marked/BlockchainPublicAddress/documentation/MeetingMinutes/MOM-2023-07-06/raw.md

@@ -0,0 +1,43 @@
+# Meeting Minutes
+## Meeting Information
+**Meeting Date:** 06-jul-2023<br/>
+**Status:** FINAL
+
+
+## Attendees
+- Klaus Reifenrath (Vodafone)
+- Sebastian Köller (Vodafone)
+- Krzysztof Sielski (Deutsche Telekom)
+- Georgios Papadopoulos  (Deutsche Telekom)
+- Jose Antonio Ordoñez Lucena (Telefonica)
+- Pedro Díez (Telefonica)
+
+
+## Goals
+WG Kick-Off Meeting</br>
+
+
+Item | Who | Description
+---- | ---- | ----
+Members Presentation | WG | Members Presentation
+[Issue#2](https://github.com/camaraproject/BlockchainPublicAddress/issues/2) | Telefonica | Kick-Off 6th July
+[Issue#3](https://github.com/camaraproject/BlockchainPublicAddress/issues/3) | Telefonica | Initial Use Cases Proposal
+[PR#4](https://github.com/camaraproject/BlockchainPublicAddress/pull/4) | Telefonica | BlockChain Use Cases
+[Issue#6](https://github.com/camaraproject/BlockchainPublicAddress/issues/6) | Telefonica | Baseline Proposal
+[PR#5](https://github.com/camaraproject/BlockchainPublicAddress/pull/5) | Telefonica | Baseline Proposal (API YAML Code)
+ 
+
+### Items Discussion
+
+Item | Discussion
+---- | ---- 
+Members Presentation | Attendees from Deustche Telekom, Vodafone and Telefonica introduce themselves.
+[Issue#2](https://github.com/camaraproject/BlockchainPublicAddress/issues/2) | Introduced by Telefonica. Compiles the agenda for Kick-Off meeting points:<br/> • Meetings schedule: Agreed to have, in a bi-weekly basis, on Thursdays 13:00 - 14:00 CET/CEST<br/> • Kind request for Maintainers and Codeowners. Explained the roles and provided more info offline. As tentative candidates we have: Klaus (VF) and Georgios (DT) for maintainers; Klaus (VF) and Krzysztof (DT) for codeowners. To be confirmed in the next days.<br/> • Presenting initial proposal in the following item. 
+[Issue#3](https://github.com/camaraproject/BlockchainPublicAddress/issues/3), [PR#4](https://github.com/camaraproject/BlockchainPublicAddress/pull/4) | Presented Use Cases proposal, based on the rationale of providing some features to third parties to be able to manage Blockchains from end users via the phone numbers of the users. Features to fetch blockchain public addresses per phone number and to bind/unbind a Blockchain to/from a phone number.<br> • Comments raised by DT and VF that proposal is needed to be enhanced based on WG output in order to have some mentioned regarding AuthN/AuthZ and privacy considerations
+[Issue#6](https://github.com/camaraproject/BlockchainPublicAddress/issues/6),  [PR#5](https://github.com/camaraproject/BlockchainPublicAddress/pull/5) | Going through the Baseline API definition. Explaining the endpoints: <br/> - Endpoint to fetch blockchain public addresses linked for a given phoneNumber<br/> - Endpoint to bind a blockchain public address to a phoneNumber<br/> - Endpoint to unbind a blockhain public address <-> phoneNumber<br/> Rationale/Background of the proposal in this [PR-WG#154](https://github.com/camaraproject/WorkingGroups/pull/154)<br/><br/>Main comments provided:<br> • Vodafone: Concerns about the use of DID as blockchain identifier as other standards/identifiers also could be used. Also comments about AuthN/AuthZ model for this API.<br><br> • Deutsche Telekom: Need to work in AuthN/AuthZ model for this API as well as management of User Consent. DT indicated their concern about using the phone number of the user to have such an association. Also DT provided during the meeting information about other forums where work about blockchain is being made:<br/> - https://github.com/ChainAgnostic/CASA<br/> - https://chainagnostic.org/<br/> - https://chainagnostic.org/CAIPs/caip-2<br/> - https://github.com/UCRegistry/chain-registry<br><br> • Telefonica commented that they are good comments to start and bear in mind; also regarding consents that there is a WG (Identity and Consent Management) where this kind of topics are been addressed.
+
+
+### Next Steps
+- Next Meetings:<br/>
+  • 20th July - 13:00 - 14:00 CEST<br>
+  • 27th July - 13:00 - 14:00 CEST<br>

marked/BlockchainPublicAddress/documentation/MeetingMinutes/MOM-2023-07-20/raw.md

@@ -0,0 +1,38 @@
+# Meeting Minutes
+
+## Meeting Information
+**Meeting Date:** 20-jul-2023<br/>
+**Status:** FINAL
+
+
+## Attendees
+- Klaus Reifenrath (Vodafone)
+- Sebastian Köller (Vodafone)
+- Rafał Artych (Deutsche Telekom)
+- Pedro Díez (Telefonica)
+
+
+## Goals
+
+Review Members Access to WG </br>
+Next Actions </br>
+
+
+Item | Who | Description
+---- | ---- | ----
+Review Members Access to WG | WG | Check susbcription status of members
+Next Actions | WG | Actions for next meeting
+
+
+### Items Discussion
+
+Item | Discussion
+---- | ----
+Review Members Access to WG | Commented in the meeting, in order to be able to manage maintainers and code owners for the WG. Being checked by VF members (Sebastian, Klaus). Sebastian seems to have access, Klaus is managing it. Issue will be opened when members have access to WG in order to include them as maintainers/codeowners based on their github user.
+Next Actions | Commented about the following: <br/> • Adopting github templates as per Commonalities. To be more agile, Rafał (DT) will generate PR so it can be reviewed and merged (currently only Pedro as codeowner) [PR#8](https://github.com/camaraproject/BlockchainPublicAddress/pull/8). Generated after meeting. Reviewed and Merged.<br><br/> • Blockchain identification: Use of a DID is to ensure the "user identification" within a blockchain. The fact of binding it to a phoneNumber is to make a friendly way for Devs and Users to manage transactions between blockchains in a more natural way.<br><br/> • Comments raised by VF in order to provide more detail in Use Cases. Deeping into access to the functionality and privacy topics. Issue to be opened by TEF in order to provide information and begin discussion (that can be lead into Use Cases description enhancements and API spec adjustments).<br><br/> • Question raised by VF within [Issue#6](https://github.com/camaraproject/BlockchainPublicAddress/issues/6) about the need of indicating a currency in binding and fetch blockchain functionality. Within a given blockchain, several currencies may be used, so it might not be considered as mandatory in design. Also, Use Cases can guide in the inclusion of this metainformation. TEF will also check internally this.
+  
+
+### Next Steps
+
+- Next Meetings:<br/>
+• 27th July - 13:00 - 14:00 CEST<br>

marked/BlockchainPublicAddress/documentation/MeetingMinutes/MOM-2023-07-27/raw.md

@@ -0,0 +1,46 @@
+# Meeting Minutes
+
+## Meeting Information
+
+**Meeting Date:** 27-jul-2023<br/>
+**Status:** FINAL
+
+
+
+## Attendees
+
+- Klaus Reifenrath (Vodafone)
+- Sebastian Köller (Vodafone)
+- Georgios Papadopoulos (Deutsche Telekom)
+- Rafał Artych (Deutsche Telekom)
+- Pedro Díez (Telefonica)
+
+ 
+
+## Goals
+
+Review Members Access to WG </br>
+Open Issues </br>
+
+
+Item | Who | Description
+---- | ---- | ----
+Review Members Access to WG - [Issue#10](https://github.com/camaraproject/BlockchainPublicAddress/issues/10) | WG | Main WG participants have subscription enabled
+[Issue#11](https://github.com/camaraproject/BlockchainPublicAddress/issues/11) | TEF | Deep Into Use Cases
+[Issue#12](https://github.com/camaraproject/BlockchainPublicAddress/issues/12) | TEF | Required 'currency' information in API design
+
+
+### Items Discussion
+
+Item | Discussion
+---- | ----
+Review Members Access to WG - [Issue#10](https://github.com/camaraproject/BlockchainPublicAddress/issues/10) | Sebastian (VF) already has access to WG. Klaus (VF) is managing it. Georgios (DT) will manage it. After that, PR will be generated to indicate maintainers and codeowners.
+Deep Into Use Cases - [Issue#11](https://github.com/camaraproject/BlockchainPublicAddress/issues/11) | Telefonica provides more info about Use Cases. Vodafone comments the topic of how to manage the consent of accessing the information (GET List of Blockchains of a given phonenumber). If this endpoint can be accessed vía 2-legged how this access can be controlled in a way the user's phone owner can control the list of people they can view his blockchain addresses. Several initial options commented during the meeting (functionality to have whitelist option where indicate phonenumbers that can access blockchain of other phone numbers, hashing of blockchain and/or phone number). Need to have more discussion around the issue.
+Required 'currency' information in API design - [Issue#12](https://github.com/camaraproject/BlockchainPublicAddress/issues/12) | Issue opened to reflect the point raised by Vodafone regarding 'currency' as mandatory parameter. Vodafone indicates there are many use cases (e.g. smart contract tokens) where transactions within the same blockchain can be performed with different currencies. Deutsche Telekom also agrees on that. Telefonica needs to check internally (mentioned that initial proposal was to consider one currency but open to cover also other scenarios). TEF will provide feedback and proposal about this topic.
+AoB | Control of rate limit of requests, commented by Deustche Telekom. To have some rate control policy in Telco Operator API GW, needed to cover it in API design. There is some exception defined in commonalities: https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md#32-http-response-codes (HTTP 429). Agreed to include within API design. AP@Pedro to include in API Proposal
+
+### Next Steps
+
+- Next Meetings:<br/>
+• 10th August - 13:00 - 14:00 CEST<br>
+• 31th August - 13:00 - 14:00 CEST<br>

marked/BlockchainPublicAddress/documentation/MeetingMinutes/MOM-2023-08-10/raw.md

@@ -0,0 +1,49 @@
+# Meeting Minutes
+
+## Meeting Information
+
+**Meeting Date:** 10-ago-2023<br/>
+**Status:** FINAL
+
+
+
+## Attendees
+
+- Sebastian Köller (Vodafone)
+- Georgios Papadopoulos (Deutsche Telekom)
+- Krzysztof Sielski (Deutsche Telekom)
+- Rafał Artych (Deutsche Telekom)
+- Pedro Díez (Telefonica)
+
+ 
+
+## Goals
+
+Review Members Access to WG </br>
+Open Issues </br>
+
+
+Item | Who | Description
+---- | ---- | ----
+Review Members Access to WG - [Issue#10](https://github.com/camaraproject/BlockchainPublicAddress/issues/10) | WG | Main WG participants have subscription enabled
+[Issue#12](https://github.com/camaraproject/BlockchainPublicAddress/issues/12) | TEF | Required 'currency' information in API design
+Consent management in API | WG | Discussion about consent Management
+Baseline API Proposal | TEF | Ongoing API v0.1
+
+
+### Items Discussion
+
+Item | Discussion
+---- | ----
+Review Members Access to WG - [Issue#10](https://github.com/camaraproject/BlockchainPublicAddress/issues/10) | Sebastian (VF) and Georgios (DT) are fully operative. Klaus (VF) and Krzysztof (DT) are managing its access. PRs triggered to update [Maintaners](https://github.com/camaraproject/BlockchainPublicAddress/pull/14) and CodeOwners (pending) accordingly.
+Deep Into Use Cases - [Issue#11](https://github.com/camaraproject/BlockchainPublicAddress/issues/11) | Telefonica provides more info about Use Cases. Vodafone comments the topic of how to manage the consent of accessing the information (GET List of Blockchains of a given phonenumber). If this endpoint can be accessed vía 2-legged how this access can be controlled in a way the user's phone owner can control the list of people they can view his blockchain addresses. Several initial options commented during the meeting (functionality to have whitelist option where indicate phonenumbers that can access blockchain of other phone numbers, hashing of blockchain and/or phone number). Need to have more discussion around the issue. New [Issue#16](https://github.com/camaraproject/BlockchainPublicAddress/issues/16) created
+Required 'currency' information in API design - [Issue#12](https://github.com/camaraproject/BlockchainPublicAddress/issues/12) | Proposal presented by Telefonica in order to address this comment. VF(Sebastian) seems OK to this proposal. Georgios (DT) would like to check offline, to identify whether can be 'scam' scenarios that may need currency.
+Enhancement due to consent management | Explain the context of consent management within API. After meeting new [Issue#16](https://github.com/camaraproject/BlockchainPublicAddress/issues/16) opened, summarizing info. Main topic concern raised here are (DT, VF) the following:<br> • Whether this consent is "forever" or "one time use". Once User B gives consent, anyone could access to such info.<br> • Whether this consent has to be more fine-grained, so as provided only for the User A access (i.e. have granularity to be settled per user phoneNumber level). <br><br> TEF asks whether according to these comments it is being thinking in an UX where User B is prompted with a screen to give their consent for any API call for any User A's request, and response is yes. TEF will also check internally about its product view on that. Related to this, Rafał indicates that this has relationship with Identity&ConsentManagement WG and regarding picture provided just not to include (at least) within CAMARA API spec as it includes conventions outside CAMARA. It will be taken out and in future check if makes sense to add something GSMA OpenGateway agnostic.
+AoB | Control of rate limit of requests, commented by Deustche Telekom. To have some rate control policy in Telco Operator API GW, needed to cover it in API design. Exception 429 already considered into the proposal.
+Baseline API Proposal [PR#5](https://github.com/camaraproject/BlockchainPublicAddress/pull/5)| Points performed:<br> • Renamed OB to Telco Operator<br> • Adding Exception 429<br> • Removed Image.<br>Pending Points:<br> • `currency` topic <br>• Impacts in API derived from Consent Management
+
+
+### Next Steps
+
+- Next Meetings:<br/>
+• 31th August - 13:00 - 14:00 CEST<br>

marked/BlockchainPublicAddress/documentation/MeetingMinutes/MOM-2023-08-31/raw.md

@@ -0,0 +1,51 @@
+# Meeting Minutes
+
+## Meeting Information
+
+**Meeting Date:** 31-ago-2023<br/>
+**Status:** FINAL
+
+
+
+## Attendees
+
+- Stefan Engelbert (Aloaha)
+- Georgios Papadopoulos (Deutsche Telekom)
+- Krzysztof Sielski (Deutsche Telekom)
+- Rafał Artych (Deutsche Telekom)
+- Sebastian Köller (Vodafone)
+- Pedro Díez (Telefonica)
+
+ 
+
+## Goals
+
+Review Members Access to WG </br>
+Next Actions </br>
+
+
+Item | Who | Description
+---- | ---- | ----
+MOM-2023-08-10 - [PR#17](https://github.com/camaraproject/BlockchainPublicAddress/pull/17) | WG | MOM-2023-08-10
+Review Members Access to WG - [Issue#10](https://github.com/camaraproject/BlockchainPublicAddress/issues/10) | WG | Main WG participants have subscription enabled
+Baseline Proposal [Issue#6](https://github.com/camaraproject/BlockchainPublicAddress/issues/6), [PR#5](https://github.com/camaraproject/BlockchainPublicAddress/pull/5) | TEF | Basline API Proposal
+[Issue#12](https://github.com/camaraproject/BlockchainPublicAddress/issues/12) | TEF | Required 'currency' information in API design
+[Issue#16](https://github.com/camaraproject/BlockchainPublicAddress/issues/16) | TEF, WG | API Enhancement due to Consent Management
+
+
+### Items Discussion
+
+Item | Discussion
+---- | ----
+Welcome to new members | Stefan Engelbert (Aloaha) joins the WG.
+MOM-2023-08-10 - [PR#17](https://github.com/camaraproject/BlockchainPublicAddress/pull/17) | Pending Approval, reviewed by Georgios and Sebastian. Will ask Jose Antonio Lucena (TEF) in the meantime other codeowners are added to approve them, so it can be merged. CODEOWNERS and Maintainers files cannot be updated until involved people has WG access. Also Krzysztof will trigger PR to include as a codeowner so Pedro can approve it and therefore have codeowners in the short-term from two companies at least.
+Review Members Access to WG - [Issue#10](https://github.com/camaraproject/BlockchainPublicAddress/issues/10) | No news about Klaus status. Asked him offline. Check again next week.
+Baseline Proposal [Issue#6](https://github.com/camaraproject/BlockchainPublicAddress/issues/6), [PR#5](https://github.com/camaraproject/BlockchainPublicAddress/pull/5) | Pedro comments TEF has intention to perform an MVP based on initial proposal and asks WG if we can merge it in order to be able to indicate CAMARA compliance. This does not enter in contradiction with the fact that API can and will be evolved based on output of discussions and future requirements. This version will be set as "v0.1". Also we will have a reference to evolve from it. It is understood within the WG and it is OK to move forward and merge. Pedro will check and make some refinements and advise for review. Intention is to merge (if possible) during 4th September week. 
+Required 'currency' information in API design - [Issue#12](https://github.com/camaraproject/BlockchainPublicAddress/issues/12) | Georgios comments it will be needed more time to have a view about currency relationship with the Public Address. Then this issue will be KEPT OPEN. Also comments from Stefan, Krzysztof (topic of having some model to signal/identify chain_id), mentioning [https://chainagnostic.org/CAIPs/caip-2](https://chainagnostic.org/CAIPs/caip-2) (this reference was also provided during July) and Sebastian about potential anidated blockchain "type" model. Summary gathered within then issue and participants will comment over this.
+API Enhancement due to Consent Management - [Issue#16](https://github.com/camaraproject/BlockchainPublicAddress/issues/16) | Pedro comments that this topic has raised internally but no feedback yet due to holidays period. In two directions:<br> • About product perspective to manage consent in every GET access to the blockchain information of a given user<br> • In the way of "having" API functionality to manage some kind of whitelists to "allow trusted contacts" the access without request consent.
+AoB | Next Meetings, next meeting scheduled for 28th September. Pedro is on holidays next weeks and comments to the WG if any meeting would like to be managed in the meantime, 14th September could be an option (up to WG in case other members consider suitable) 
+
+### Next Steps
+
+- Next Meetings:<br/>
+• 28th September - 13:00 - 14:00 CEST<br>

marked/BlockchainPublicAddress/documentation/MeetingMinutes/MOM-2023-09-28/raw.md

@@ -0,0 +1,39 @@
+# Meeting Minutes
+## Meeting Information
+**Meeting Date:** 28-sep-2023<br/>
+**Status:** FINAL
+
+## Attendees
+
+- Stefan Engelbert (Aloaha/CodeB)
+- Rafał Artych (Deutsche Telekom)
+- Sebastian Köller (Vodafone)
+- Pedro Díez (Telefonica)
+
+
+## Goals
+Review of Issues/PRs and next steps</br>
+
+
+Item | Who | Description
+---- | ---- | ----
+WG Status | WG | WG current status
+[Issue#10](https://github.com/camaraproject/BlockchainPublicAddress/issues/10) | WG | Main WG participants have subscription enabled
+[Issue#12](https://github.com/camaraproject/BlockchainPublicAddress/issues/12) | TEF | Required 'currency' information in API design
+[Issue#16](https://github.com/camaraproject/BlockchainPublicAddress/issues/16) | TEF, WG | API Enhancement due to Consent Management
+[Issue#19](https://github.com/camaraproject/BlockchainPublicAddress/issues/19) | VF | Solving the chain identification issue
+
+### Items Discussion
+
+Item | Discussion
+---- | ---- 
+WG Status | Currently, initial baseline version (v0.1) is generated. A tag will be generated to track this baseline version (PR to be generated). Next steps are to progress in open issues and after that review Use Stories description. After meeting, Pedro (TEF) synchronized status with Krzysztof (DT) that joined later. Also bi-weekly meetings will be scheduled.
+Review Members Access to WG - [Issue#10](https://github.com/camaraproject/BlockchainPublicAddress/issues/10) | Klaus (VF) and Krzysztof (DT) pending to enable their subscription to the WG. Sebastian (VF) will comment internally to Klaus and Pedro (TEF) comments offline to Krzysztof.
+Required 'currency' information in API design - [Issue#12](https://github.com/camaraproject/BlockchainPublicAddress/issues/12) | Pending comments by Georgios, issue is kept OPEN and to be reviewed in next meeting.
+API Enhancement due to Consent Management - [Issue#16](https://github.com/camaraproject/BlockchainPublicAddress/issues/16) | Pedro comments it will be reviewed internally with Product next week in order to have feedback. Initially, Use Case addressed by TEF is to set up consent once per user.
+Solving the chain identification issue - [Issue#19](https://github.com/camaraproject/BlockchainPublicAddress/issues/19) | Sebastian (VF) explains rationale for this topic. Underlying idea is to have a (reduced) set of manually defined layer 1 blockchains and optionally use the chainId for layer 2 blockchains or testnets within that ecosystem. For instance for EVM-based chains, there is an already defined chainId for them in https://chainlist.org/. Stefan (CodeB) agrees with this proposal baseline. Pedro (TEF) will check in detail.
+
+
+### Next Steps
+- Next Meetings:<br/>
+	• Next meeting: 5th October - 13:00 - 14:00 CEST<br/>

marked/BlockchainPublicAddress/documentation/MeetingMinutes/MOM-2023-10-05/raw.md

@@ -0,0 +1,42 @@
+# Meeting Minutes
+## Meeting Information
+**Meeting Date:** 05-oct-2023<br/>
+**Status:** FINAL
+
+## Attendees
+
+- Stefan Engelbert (Aloaha/CodeB)
+- Rene Reinsberg (Celo Foundation)
+- Kevin Tharayil (Celo Foundation)
+- Rafał Artych (Deutsche Telekom)
+- Georgios Papadopoulos (Deutsche Telekom)
+- Sebastian Köller (Vodafone)
+- Pedro Díez (Telefonica)
+
+
+## Goals
+Review of Issues/PRs and next steps</br>
+
+
+Item | Who | Description
+---- | ---- | ----
+WG Status | WG | WG current status 
+[Issue#10](https://github.com/camaraproject/BlockchainPublicAddress/issues/10) | WG | Main WG participants have subscription enabled
+[Issue#12](https://github.com/camaraproject/BlockchainPublicAddress/issues/12) | TEF | Required 'currency' information in API design
+[Issue#16](https://github.com/camaraproject/BlockchainPublicAddress/issues/16) | TEF, WG | API Enhancement due to Consent Management
+[Issue#19](https://github.com/camaraproject/BlockchainPublicAddress/issues/19) | VF | Solving the chain identification issue
+
+### Items Discussion
+
+Item | Discussion
+---- | ---- 
+WG Status | New members from Celo Foundation joined the meeting (Rene, Kevin). They refer during the meeting to some initiatives they have been involved: [Minipay](https://www.opera.com/de/products/minipay) and [Valora](https://valoraapp.com/)<br><br> With regards to WG status, next step is to generate a release for the initial version v0.1.0, [PR#23](https://github.com/camaraproject/BlockchainPublicAddress/pull/23) to generate `CHANGELOG.md` is ready and will be merged after meeting.<br> Work done after the meeting.<br> • New Release tag [v0.1.0](https://github.com/camaraproject/BlockchainPublicAddress/releases/tag/v0.1.0) generated.<br> •  Release content [release-0.1.0](https://github.com/camaraproject/BlockchainPublicAddress/tree/release-0.1.0)
+Review Members Access to WG - [Issue#10](https://github.com/camaraproject/BlockchainPublicAddress/issues/10) | To make more agile WG work, Georgios (DT) and Sebastian (VF) are settled as both maintainers [PR#14](https://github.com/camaraproject/BlockchainPublicAddress/pull/14) and codeowners [PR#24](https://github.com/camaraproject/BlockchainPublicAddress/pull/24). When Klaus (VF) and Krzysztof (DT) enable their subscription we will comment to include as maintainers and codeowners. Both PRs are `MERGED` and the Issue is `CLOSED`. 
+Required 'currency' information in API design - [Issue#12](https://github.com/camaraproject/BlockchainPublicAddress/issues/12) | Agreed to be closed. `CLOSED` after the meeting.
+API Enhancement due to Consent Management - [Issue#16](https://github.com/camaraproject/BlockchainPublicAddress/issues/16) | Pedro (TEF) illustrates the topic for anyone to have some background and also indicates have internally address this with their product team and their concern is that the checking for the permission for every transaction may be a stopper for business cases as it is not the best performance, also indicates that probably some product guidance from GSMA OGW would be helpful. Sebastian indicates that it should be avoided that personal information can be leaked by anyone and we should ensure the restricted access to this information. Georgios also comments not only the access to blockchain info but the knowledge of phone numbers that can be used for spaming services. In this context, Celo comments about some work they have performed in [user identity in blockchain](https://docs.celo.org/protocol/identity/odis-use-case-phone-number-privacy).
+Solving the chain identification issue - [Issue#19](https://github.com/camaraproject/BlockchainPublicAddress/issues/19) | Rationale of the proposal explained by Sebastian is understood. Georgios comments the proposal is in line with the objective of a better blockchain identification scheme. Pedro also comments it is a good way forward and asks some clarification questions, about the identification of ethereum mainnet in this model (blockchain=evm, chainId=1) and to check this proposal does not enter in contradiction with the use of DID for the identification of the blockchain address, where Sebastian indicates there is no constrain/restriction. Pedro will draft a proposal within the issue to get a consensus on this.
+
+
+### Next Steps
+- Next Meetings:<br/>
+	• Next meeting: 19th October - 13:00 - 14:00 CEST<br/>

marked/BlockchainPublicAddress/documentation/MeetingMinutes/MOM-2023-10-19/raw.md

@@ -0,0 +1,42 @@
+# Meeting Minutes
+## Meeting Information
+**Meeting Date:** 19-oct-2023<br/>
+**Status:** FINAL
+
+
+## Attendees
+
+- Kevin Tharayil (Celo Foundation)
+- Rafał Artych (Deutsche Telekom)
+- Krzysztof Sielski (Deutsche Telekom)
+- Georgios Papadopoulos  (Deutsche Telekom)
+- Klaus Reifenrath (Vodafone)
+- Sebastian Köller (Vodafone)
+- Pedro Díez (Telefonica)
+
+
+## Goals
+WG Kick-Off Meeting</br>
+
+
+
+Item | Who | Description
+---- | ---- | ----
+WG Status | WG | WG current status 
+[Issue#11](https://github.com/camaraproject/BlockchainPublicAddress/issues/11) | TEF | Deep Into Use Cases
+[Issue#16](https://github.com/camaraproject/BlockchainPublicAddress/issues/16) | TEF, WG | API Enhancement due to Consent Management
+[Issue#19](https://github.com/camaraproject/BlockchainPublicAddress/issues/19) | VF | Solving the chain identification issue
+
+### Items Discussion
+
+Item | Discussion
+---- | ---- 
+WG Status | Two topics commented:<br> • WG repository information after release generation and merging of [PR#25](https://github.com/camaraproject/BlockchainPublicAddress/pull/25). New release is available [Release v0.1.0](https://github.com/camaraproject/BlockchainPublicAddress/releases/tag/v0.1.0) and [CHANGELOG.md](https://github.com/camaraproject/BlockchainPublicAddress/blob/main/CHANGELOG.md) and [README.md](https://github.com/camaraproject/BlockchainPublicAddress/blob/main/README.md) are updated.<br> • Manage members subscription: Klaus and Krzysztof will re-trigger the WG subscription request so as they will enable their subscription and link their github user. Later on, it will be possible to manage them as maintainers/codeowners.
+Solving the chain identification issue - [Issue#19](https://github.com/camaraproject/BlockchainPublicAddress/issues/19) | Sebastian presented a proposal in order to manage every type of blockchain. Relying in one parameter to identify L1 Ecoystems and other one for identifying L2 and subsequent levels. Pedro and George seems initially OK. Latest comment of using `ethereum` instead of `evm` was in line to indicate real L1 ecosystems within 'blockchain' field, so the reason to also indicate other ecosystems like Avalanch even they have a chainId in evm naming format. This was explained in the meeting as asked by Krzysztof as a doubt. Krzysztof also mentioned whether the list of supported chainIds has to be restricted, Klaus comments that should be left open (initially no restriction in API input); Pedro indicates that in principle API design can support all and to deal with those business scenarios where a given chainId is not supported (a user wallt that does not manage specific blockchains) an exception may be defined. There is more discussion around this topic ( Krzysztof refers to CAIP - https://chainagnostic.org/CAIPs/caip-2, Klaus also mention to other scheme https://eips.ethereum.org/EIPS/eip-3220), in order to have a flexible way to identify a huge amount of blockchain ecosystems. There is certainty about evm chainId (https://chainid.network/, https://chainid.network/chains.json) is unique for evm based chains. After some discussion, Klaus comment the idea of having the identification in a common parameter (name to be decided, WG thinks offline) and that parameter indicates the L1-"sub-id" in a flexible way. It seems a way forward and WG will think about a name. In the meantime Pedro will trigger WIP PR to begin to detail this proposal and also improve/evolve with comments received.
+Deep Into Use Cases - [Issue#11](https://github.com/camaraproject/BlockchainPublicAddress/issues/11) | TEF (Pedro) explains this topic can be resumed in order to improve/enhance description of Use Cases with the context discussed these months. Also provides information about Use Cases TEF business is thinking about. To be checked offline and provide feedback by WG members.
+API Enhancement due to Consent Management - [Issue#16](https://github.com/camaraproject/BlockchainPublicAddress/issues/16) | Not covered during this meeting.
+
+
+### Next Steps
+- Next Meetings:<br/>
+	• Next meeting: 2nd November - 13:00 - 14:00 CEST<br/>

marked/BlockchainPublicAddress/documentation/MeetingMinutes/MOM-2023-11-02/raw.md

@@ -0,0 +1,41 @@
+# Meeting Minutes
+## Meeting Information
+**Meeting Date:** 02-nov-2023<br/>
+**Status:** FINAL
+
+
+## Attendees
+
+- Rafał Artych (Deutsche Telekom)
+- Krzysztof Sielski (Deutsche Telekom)
+- Georgios Papadopoulos  (Deutsche Telekom)
+- Sebastian Köller (Vodafone)
+- Pedro Díez (Telefonica)
+
+
+## Goals
+Review of Issues/PRs and next steps</br>
+
+
+Item | Who | Description
+---- | ---- | ----
+[PR#29](https://github.com/camaraproject/BlockchainPublicAddress/pull/29) | WG | Create MOM-2023-10-19
+[PR#31](https://github.com/camaraproject/BlockchainPublicAddress/pull/31) | DT | Alignment with changes in https://github.com/camaraproject/Template_Lead_Repository
+[Issue#11](https://github.com/camaraproject/BlockchainPublicAddress/issues/11) | TEF | Deep Into Use Cases
+[Issue#16](https://github.com/camaraproject/BlockchainPublicAddress/issues/16) | TEF, WG | API Enhancement due to Consent Management
+[Issue#19](https://github.com/camaraproject/BlockchainPublicAddress/issues/19) | VF | Solving the chain identification issue
+
+### Items Discussion
+
+Item | Discussion
+---- | ---- 
+Create MOM-2023-10-19 - [PR#29](https://github.com/camaraproject/BlockchainPublicAddress/pull/29) | Meeting Minutes of 19th October Meeting ready for review. Commented during the meeting the review of them to have the approval and merge them.
+Alignment with changes in https://github.com/camaraproject/Template_Lead_Repository - [PR#31](https://github.com/camaraproject/BlockchainPublicAddress/pull/31) | PR triggered by DT (Rafał) in order to align WG repository with the guidelines of CAMARA regarding [Testing Folder](https://github.com/camaraproject/Template_Lead_Repository/pull/1). Reviewed and approved. `MERGED` after the meeting
+Solving the chain identification issue - [Issue#19](https://github.com/camaraproject/BlockchainPublicAddress/issues/19) | As commented during last meeting, Pedro triggered a PR to compile the output of the Issue. The proposal is under [PR#30](https://github.com/camaraproject/BlockchainPublicAddress/pull/30), along with other Commonalities alignments and editorial enhancements. The target name of the parameter to identify the blockchain is still TBD (currently appears as `blockchain`). Pedro (TEF) indicates it is still pending to add the exception to manage the scenario mentioned by Krzysztof (DT) in the last meeting, but generated in advance to receive comments from the participants. Georgios (DT) gave an OK to the proposal in terms of the description provided. Krzysztof (DT) and Sebastian (VF) will review offline. Sebastian also asks two points:<br/> • If Issue#19 will be closed after the merging of this PR, and Pedro indicates that this is the objective (keeping v0.2.0-wip, just to discuss later within the WG the next steps).<br/> • The meaning of `<sub_id>` within the blockchain identification model, where Pedro answers it is the name given to the concept under L2 and Testnets blockchain identification (in EVM it matches the concept of chainId), and it is open to receive inputs if other name is considered more suitable, and for sure it can be reviewed in the future.
+Deep Into Use Cases - [Issue#11](https://github.com/camaraproject/BlockchainPublicAddress/issues/11) | Commented during the meeting to check this issue by participants in order to receive comments and see if further description is incorporated into Use cases description document. 
+API Enhancement due to Consent Management - [Issue#16](https://github.com/camaraproject/BlockchainPublicAddress/issues/16) | TEF indicates next week will synchronize this point internally with Business and comment back to the issue.
+
+
+### Next Steps
+- Next Meetings:<br/>
+	• Next meeting: 16th November - 13:00 - 14:00 CEST<br/>

marked/BlockchainPublicAddress/documentation/MeetingMinutes/MOM-2023-11-16/raw.md

@@ -0,0 +1,38 @@
+# Meeting Minutes
+## Meeting Information
+**Meeting Date:** 16-nov-2023<br/>
+**Status:** FINAL
+
+
+## Attendees
+
+- Rafał Artych (Deutsche Telekom)
+- Georgios Papadopoulos (Deutsche Telekom)
+- Jorge Ordovas (Telefónica)
+- Pedro Díez (Telefónica)
+
+
+## Goals
+Review of Issues/PRs and next steps</br>
+
+
+Item | Who | Description
+---- | ---- | ----
+WG Status | WG | BlockchainPublicAddress WG Status
+[Issue#11](https://github.com/camaraproject/BlockchainPublicAddress/issues/11) | TEF | Deep Into Use Cases
+[Issue#16](https://github.com/camaraproject/BlockchainPublicAddress/issues/16) | TEF, WG | API Enhancement due to Consent Management
+[Issue#19](https://github.com/camaraproject/BlockchainPublicAddress/issues/19) | VF | Solving the chain identification issue
+
+### Items Discussion
+
+Item | Discussion
+---- | ---- 
+WG Status | Today joins meeting Jorge Ordovas (TEF, Business Unit Web3 proyects). Currently main focus within WG is an aligment in Blockchain Identification Model. Meeting Minutes from [19/OCT](https://github.com/camaraproject/BlockchainPublicAddress/blob/main/documentation/MeetingMinutes/MOM-2023-10-19.md) and [02/NOV](https://github.com/camaraproject/BlockchainPublicAddress/blob/main/documentation/MeetingMinutes/MOM-2023-11-02.md) are available.
+Solving the chain identification issue - [Issue#19](https://github.com/camaraproject/BlockchainPublicAddress/issues/19) | Proposal is under [PR#30](https://github.com/camaraproject/BlockchainPublicAddress/pull/30), some wording comments provided by Rafał (DT), already fixed. Also he refers to Commonalities Issues [camaraproject/Commonalities#77](https://github.com/camaraproject/Commonalities/issues/77) and [camaraproject/Commonalities#80](https://github.com/camaraproject/Commonalities/issues/80), which are noted to be addressed in this PR or a future one, based on their respective output.<br>Some background context is provided for Jorge (TEF) also understands the rationale of this track.<br>Pending point is to agree on a field name for this concept, some suggestions provided by Pedro (TEF) within the Issue. Georgios (DT) indicates his preference is `blockchainNetworkId`   and also asks whether makes sense to have some alignment in the wording for the BlockChainPublicAddress. Pedro (TEF) comments doesn't think so as this field is to indicate which Blockchain Network the BlockchainPublicAddress belongs to. Some days will be given to provide preferences among participants and selected name will be updated within PR, so as setting for final review.
+Deep Into Use Cases - [Issue#11](https://github.com/camaraproject/BlockchainPublicAddress/issues/11) | Will be closed during this week if no further comment provided. It can be also discussed in the future.
+API Enhancement due to Consent Management - [Issue#16](https://github.com/camaraproject/BlockchainPublicAddress/issues/16) | Feedback from TEF. Business Unit is performing Privacy Assesment about this funcionality, therefore will be kept On-Hold until having their input about this.
+
+
+### Next Steps
+- Next Meetings:<br/>
+	• Next meeting: 30th November - 13:00 - 14:00 CEST<br/>

marked/BlockchainPublicAddress/documentation/MeetingMinutes/MOM-2023-11-30/raw.md

@@ -0,0 +1,38 @@
+# Meeting Minutes
+## Meeting Information
+**Meeting Date:** 30-nov-2023<br/>
+**Status:** FINAL
+
+
+## Attendees
+
+- Rafał Artych (Deutsche Telekom)
+- Georgios Papadopoulos (Deutsche Telekom)
+- Sebastian Köller (Vodafone)
+- Pedro Díez (Telefónica)
+
+
+## Goals
+Review of Issues/PRs and next steps</br>
+
+
+Item | Who | Description
+---- | ---- | ----
+WG Status | WG | BlockchainPublicAddress WG Status
+[Issue#16](https://github.com/camaraproject/BlockchainPublicAddress/issues/16) | TEF, WG | API Enhancement due to Consent Management
+[Issue#19](https://github.com/camaraproject/BlockchainPublicAddress/issues/19) | VF | Solving the chain identification issue
+AoB | WG | Other topics
+
+### Items Discussion
+
+Item | Discussion
+---- | ---- 
+WG Status | After [PR#30](https://github.com/camaraproject/BlockchainPublicAddress/pull/30) merge, v0.2.0-wip is available in code folder. So far, it will be kept `ON-HOLD`, until some Commonalities guidance are being resolved (i.e. AuthN/AuthZ section), so it can take advantage before generating a new release if required.
+Solving the chain identification issue - [Issue#19](https://github.com/camaraproject/BlockchainPublicAddress/issues/19) | `CLOSED` after review and approval of [PR#30](https://github.com/camaraproject/BlockchainPublicAddress/pull/30) by Georgios (DT) and Sebastian (VF) respectively. [PR#30](https://github.com/camaraproject/BlockchainPublicAddress/pull/30) is `MERGED` during the meeting.
+API Enhancement due to Consent Management - [Issue#16](https://github.com/camaraproject/BlockchainPublicAddress/issues/16) | Feedback from Pedro (TEF). Business Unit Privacy Assesment is still pending and probably will happen next year. Will be kept `ON-HOLD` until it.
+AoB | Some topics during the meeting:<br> • Georgios (DT) asks whether implementation topics are discussed within CAMARA WG scope. Pedro (TEF) comments implementation is not under the scope of CAMARA but probably hosted in the context of Operators meetings within each country, where alignment about implementation of different APIs/features is taking place  (a.k.a. local champions). <br> • Pedro (TEF) indicates it will trigger a new PR to add Krzysztof as codeowner.  <br> • Sebastian (VF) shares with the WG he will be leaving it by the end of this year. WG appreciates the effort and contribution from Sebastian during these months. A PR will be triggered to removed him as a maintainer and codeowner.<br> • Agreed to have next meeting on 12th December (same slot), being the latest during this year.
+
+
+### Next Steps
+- Next Meetings:<br/>
+	• Next meeting: 12th December - 13:00 - 14:00 CEST<br/>

marked/BlockchainPublicAddress/documentation/MeetingMinutes/MOM-2023-12-12/raw.md

@@ -0,0 +1,39 @@
+# Meeting Minutes
+## Meeting Information
+**Meeting Date:** 12-dec-2023<br/>
+**Status:** FINAL
+
+
+## Attendees
+
+- Rafał Artych (Deutsche Telekom)
+- Georgios Papadopoulos (Deutsche Telekom)
+- Krzysztof Sielski (Deutsche Telekom)
+- Jorge Ordovas (Telefónica)
+- Pedro Díez (Telefónica)
+
+
+## Goals
+Review of Issues/PRs and next steps</br>
+
+
+Item | Who | Description
+---- | ---- | ----
+WG Status | WG | BlockchainPublicAddress WG Status
+Maintainers and Codeowners | WG | Update Maintainers and Codeowners
+[Issue#16](https://github.com/camaraproject/BlockchainPublicAddress/issues/16) | TEF, WG | API Enhancement due to Consent Management
+AoB | WG | Other topics
+
+### Items Discussion
+
+Item | Discussion
+---- | ---- 
+WG Status | API specification v0.2.0-wip is available in code folder. Kept `ON-HOLD`, until some Commonalities guidance are being resolved (i.e. AuthN/AuthZ section), so it can take advantage before generating a new release if required. To be reviewed next year.
+Maintainers and Codeowners | Update of maintainers and codeowners:<br> • Maintainers - [PR#35](https://github.com/camaraproject/BlockchainPublicAddress/pull/35) `MERGED`: Removed Jose Antonio (TEF) and Sebastian (VF).<br> • Codeowners  - [PR#36](https://github.com/camaraproject/BlockchainPublicAddress/pull/36) `MERGED`: Removed Jose Antonio (TEF) and Sebastian (VF). Added Krzysztof (DT).
+API Enhancement due to Consent Management - [Issue#16](https://github.com/camaraproject/BlockchainPublicAddress/issues/16) | Kept `ON-HOLD` until next year.
+AoB | Some topics during the meeting:<br> • Pedro (TEF) will ping offline Klaus (VF) to check whether is going to participate within the WG next year as Sebastian has leaved the WG.<br> • Pedro (TEF) comments WG about existance of slack channel that may help to be more agile in tech discussions. [Link](https://join.slack.com/t/camara-project/shared_invite/zt-23bjzwes5-4aLBtE_E1sO0BJhCLBdZVQ). <br> • Rafał (DT) comments about traversal work regarding CAMARA linting rules. Main contributions are [Commonalities/PR#74](https://github.com/camaraproject/Commonalities/pull/74) and [Commonalities/PR#110](https://github.com/camaraproject/Commonalities/pull/110). Ask for volunteers to apply in Blockchain (Pedro offers as volunteer, will open an issue to track it). Krzysztof (DT) asks about the WoW and Rafał comments the initial intention is to test these linting rules in every CAMARA WG to check its behaviour and make refinements if any.
+
+
+### Next Steps
+- Next Meetings:<br/>
+	• Next meeting: 11th January - 13:00 - 14:00 CEST<br/>

marked/BlockchainPublicAddress/documentation/MeetingMinutes/MOM-2024-01-25/raw.md

@@ -0,0 +1,38 @@
+# Meeting Minutes
+## Meeting Information
+**Meeting Date:** 25-jan-2024<br/>
+**Status:** FINAL
+
+
+## Attendees
+
+- Rafał Artych (Deutsche Telekom)
+- Georgios Papadopoulos (Deutsche Telekom)
+- Jorge Ordovás (Telefónica)
+- Pedro Díez (Telefónica)
+
+
+## Goals
+Review of Issues/PRs and next steps</br>
+
+
+Item | Who | Description
+---- | ---- | ----
+WG Status | WG | BlockchainPublicAddress WG Status
+[Issue#16](https://github.com/camaraproject/BlockchainPublicAddress/issues/16) | TEF, WG | API Enhancement due to Consent Management
+[Issue#38](https://github.com/camaraproject/BlockchainPublicAddress/issues/38) | WG | Linting rule set for Blockchain Public Address API
+AoB | WG | Other topics
+
+### Items Discussion
+
+Item | Discussion
+---- | ---- 
+WG Status | The meeting was a brief update on some administrative and technical topics of the blockchain working group. The main points discussed were:<br> • Asked Georgios as codeowner to review and approve the minutes of the last meeting.<br> • Pedro said that he will be contacting Klaus to know if he is planning to attend again the working group.<br> • Pedro proposed to have meetings based on demand and to use the blockchain slack channel to communicate the topics of the next meetings. Georgios and Rafał agreed with Pedro's approach.<br> • Pedro suggested to keep the current evolution of the justification until the discussions on the blockchain identification and the commonalities were resolved.
+[Issue#16](https://github.com/camaraproject/BlockchainPublicAddress/issues/16) | Still `ON-HOLD` waiting for the business feedback on a privacy evaluation/assesment.
+[Issue#38](https://github.com/camaraproject/BlockchainPublicAddress/issues/38) | Pedro shared that he already applied the linter in a fork. Thanks to Rafał support and guidelines to enable this. A thread will be opened in the Issue#38 to comment on the results and the necessary particularizations for blockchain. Rafał added that the linter rules might need some changes or updates comming from Commonalities track.
+AoB | Next pending points are:<br> • Review the output of the linter and make the necessary adjustments in the API specification.<br> • Follow the thread of the Issue#38 and provide comments or suggestions.<br> • Consult with the business team if there was any new requirement or prioritization for the new year.<br> • Be attentive to the business feedback on the issue #16 and decide how to proceed.<br> • Join the slack channel of blockchain for participants and be aware of the calls for the next meetings.
+
+
+### Next Steps
+- Next Meetings:<br/>
+	• Next meeting: TBD, on demand<br/>

marked/BlockchainPublicAddress/documentation/MeetingMinutes/MOM-2024-02-22/raw.md

@@ -0,0 +1,39 @@
+# Meeting Minutes
+## Meeting Information
+**Meeting Date:** 22-feb-2024<br/>
+**Status:** FINAL
+
+
+## Attendees
+
+- Rafał Artych (Deutsche Telekom)
+- Georgios Papadopoulos (Deutsche Telekom)
+- Krzysztof Sielski (Deutsche Telekom)
+- Jorge Ordovás (Telefónica)
+- Pedro Díez (Telefónica)
+
+
+## Goals
+Review of Issues/PRs and next steps</br>
+
+
+Item | Who | Description
+---- | ---- | ----
+WG Status | WG | BlockchainPublicAddress WG Status
+[Issue#16](https://github.com/camaraproject/BlockchainPublicAddress/issues/16) | TEF, WG | API Enhancement due to Consent Management
+[Issue#38](https://github.com/camaraproject/BlockchainPublicAddress/issues/38) | WG | Linting rule set for Blockchain Public Address API
+AoB | WG | Other topics
+
+### Items Discussion
+
+Item | Discussion
+---- | ---- 
+WG Status | **Linter Rules**: The linter rules from commonalities have been tested successfully and will be applied to the working group repository. New Issue and related PR will be triggered in the next weeks. AP@Pedro<br> **New Topic**: An issue will be created to discuss how to handle the scenario of requesting a binding for a configuration that already exists. The proposed solution is to use the 409 conflict error code. AP@Pedro
+[Issue#16](https://github.com/camaraproject/BlockchainPublicAddress/issues/16) | The issue of consent management and privacy will be resumed in the next meeting, as there is no clear business feedback yet. Pedro wants to have some guidelines or conclusions to move forward with this topic. Agreed by Jorge, Georgios, Krzysztof, Rafał.
+[Issue#38](https://github.com/camaraproject/BlockchainPublicAddress/issues/38) | Linter tested OK, then issue is `CLOSED`.
+AoB | Pedro contacted Klaus (VF) offline and informed that Klaus will not join the working group for the time being (short-term). Maybe in the mid-term. He will follow offline the progress.<br> Next meetings (next two months due to Pedro personal matter) will be moved temporarily to 11:00 - 12:00 CET Time. Agreed by the team. NOTE: Changed after the meeting to 11:30 - 12:30 for Jorge to be able to attend.<br><br>Pending points for the next meeting are:<br>• Discuss the issue of consent management and privacy and try to reach a conclusion or a way-forward. <br>• Review the issue and the pull request for the 409 conflict error code scenario.
+
+
+### Next Steps
+- Next Meetings:<br/>
+	• Next meeting: 7th March, 11:30 - 12:30 CET<br/>

marked/BlockchainPublicAddress/documentation/MeetingMinutes/MOM-2024-03-07/raw.md

@@ -0,0 +1,36 @@
+# Meeting Minutes
+## Meeting Information
+**Meeting Date:** 07-mar-2024<br/>
+**Status:** FINAL
+
+
+## Attendees
+
+- Rafał Artych (Deutsche Telekom)
+- Pedro Díez (Telefónica)
+
+
+## Goals
+Review of Issues/PRs and next steps</br>
+
+
+Item | Who | Description
+---- | ---- | ----
+WG Status | WG | BlockchainPublicAddress WG Status
+[Issue#16](https://github.com/camaraproject/BlockchainPublicAddress/issues/16) | TEF, WG | API Enhancement due to Consent Management
+[Issue#46](https://github.com/camaraproject/BlockchainPublicAddress/issues/46) | TEF | Manage Duplicated Bindings and Improve Description
+AoB | WG | Other topics
+
+### Items Discussion
+
+Item | Discussion
+---- | ---- 
+WG Status | **Linter Rules**: Linter rules applied and working successfully. Thanks to all support from Rafał.<br> **Meeting Minutes 22th/February**: [Minutes](https://github.com/camaraproject/BlockchainPublicAddress/pull/43) approved and `MERGED`.
+[Issue#16](https://github.com/camaraproject/BlockchainPublicAddress/issues/16) | Georgios, Rafal and Jorge cannot attend the meeting. The issue is postponed until the next meeting.
+[Issue#46](https://github.com/camaraproject/BlockchainPublicAddress/issues/46) | Manage Duplicated Bindings and Improve Description. Issue opened by Telefonica, to address the case when a binding with a specific configuration (phoneNumber, blockchainNetworkId, blockchainPublicAddress and optionally currency) already exists, and a new one (POST) with the same configuration is triggered. The proposed exception is `HTTP 409 - CONFLICT`. Also some description rewording and fixing is proposed. Commented during the meeting to be reviewed offline and talk in the next meeting. Generated related [PR#47](https://github.com/camaraproject/BlockchainPublicAddress/pull/47).
+AoB | Pedro indicates he is not able to attend next meeting (21th March). Rafał also cannot. Then the next meeting will be held on 4th April.
+
+
+### Next Steps
+- Next Meetings:<br/>
+	• Next meeting: 4th April, 11:30 - 12:30 CET<br/>

marked/BlockchainPublicAddress/documentation/MeetingMinutes/README/raw.md

@@ -0,0 +1,3 @@
+## RELEVANT INFORMATION
+
+Since 4th April WG Meeting, meeting minutes are placed in [CAMARA Blockchain Public Address WG Wiki Confluence site](https://lf-camaraproject.atlassian.net/wiki/x/thDe)

marked/BlockchainPublicAddress/documentation/SupportingDocuments/README/raw.md

@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.

marked/CallForwardingSignal/README/raw.md

@@ -0,0 +1,53 @@
+<a href="https://github.com/camaraproject/CallForwardingSignal/commits/" title="Last Commit"><img src="https://img.shields.io/github/last-commit/camaraproject/CallForwardingSignal?style=plastic"></a>
+<a href="https://github.com/camaraproject/CallForwardingSignal/issues" title="Open Issues"><img src="https://img.shields.io/github/issues/camaraproject/CallForwardingSignal?style=plastic"></a>
+<a href="https://github.com/camaraproject/CallForwardingSignal/pulls" title="Open Pull Requests"><img src="https://img.shields.io/github/issues-pr/camaraproject/CallForwardingSignal?style=plastic"></a>
+<a href="https://github.com/camaraproject/CallForwardingSignal/graphs/contributors" title="Contributors"><img src="https://img.shields.io/github/contributors/camaraproject/CallForwardingSignal?style=plastic"></a>
+<a href="https://github.com/camaraproject/CallForwardingSignal" title="Repo Size"><img src="https://img.shields.io/github/repo-size/camaraproject/CallForwardingSignal?style=plastic"></a>
+<a href="https://github.com/camaraproject/CallForwardingSignal/blob/main/LICENSE" title="License"><img src="https://img.shields.io/badge/License-Apache%202.0-green.svg?style=plastic"></a>
+<a href="https://github.com/camaraproject/CallForwardingSignal/releases/latest" title="Latest Release"><img src="https://img.shields.io/github/release/camaraproject/CallForwardingSignal?style=plastic"></a>
+<a href="https://github.com/camaraproject/Governance/blob/main/ProjectStructureAndRoles.md" title="Incubating API Repository"><img src="https://img.shields.io/badge/Incubating%20API%20Repository-green?style=plastic"></a>
+
+# 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
+
+<!-- CAMARA:RELEASE-INFO:START -->
+<!-- The following section is automatically maintained by the CAMARA project-administration tooling: https://github.com/camaraproject/project-administration -->
+
+## 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._
+<!-- CAMARA:RELEASE-INFO:END -->
+
+## 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 <https://lists.camaraproject.org/g/sp-cfs>.
+  * A message to all Contributors of this Sub Project can be sent using <sp-cfs@lists.camaraproject.org>.

marked/CallForwardingSignal/code/API_definitions/call-forwarding-signal/raw.md

@@ -0,0 +1,603 @@
+# call-forwarding-signal
+
+```yaml
+---
+openapi: 3.0.3
+############################################################################
+#                                     API info                             #
+############################################################################
+info:
+  title: Call Forwarding Signal
+  description: |
+    # Overview
+    The Call Forwarding Signal API provides the API Consumer with
+    information about the status of the Call Forwarding Service on a specific
+    phone number. 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.
+    # Introduction
+    The Call Forwarding Service is provided by the Network to a phone
+    number. This service redirects the incoming call to that phone number
+    to an alternative destination such as another phone number or a voice mail
+    system. There are two main types of call forwarding settings:
+    unconditional and conditional.
+    The Call Forwarding Signal API can be invoked to detect if the unconditional
+    call forwarding service is active. The Call Forwarding Signal API can also
+    be invoked to
+    get the general status of the Call Forwarding Service (inactive,
+    conditional, unconditional). If conditional call forwarding is active,
+    the different type of settings are returned ('conditional_busy',
+    'conditional_not_reachable', 'conditional_no_answer').
+
+    **Example use cases:**
+
+    [**Bank Frauds**](https://github.com/camaraproject/CallForwardingSignal/discussions/3#discussioncomment-8694420)
+
+    [**Alert Interception**](https://github.com/camaraproject/CallForwardingSignal/discussions/3#discussioncomment-8701847)
+
+    [**Call Forwarding Verification**](https://github.com/camaraproject/CallForwarding\Signal/discussions/3#discussioncomment-8915595)
+    # Quick Start
+    The Call Forwarding Signal API is a REST API based on the
+    CreateCallForwardingSignal resource.
+    This resource can be used, by the API Consumer, to specify the phone number
+    on which the Call Forwarding Service status must be verified, in case of
+    two-legged authentication. If three-legged authentication is used the phone
+    number is instead detected, by the API Producer, from the access token.
+
+    Before starting to use the Call Forwarding API, the developer needs to know
+    about the below specified details:
+
+    **phoneNumber**
+    This is the end user phone number. The Call Forwarding Signal API verifies
+    if a call forwarding
+    service is active on this phone number. Note: this parameter must be
+    must be provided/valued only in case of two-legged authentication.
+    In case of three-legged authentication the phone number is retrieved by
+    the access token.
+
+    **CreateCallForwardingSignal**
+    This is the resource the API Consumer uses to define the phone number to
+    be verified about the status of the Network Call Forwarding service.
+
+    **UnconditionalCallForwardingSignal**
+    This is the resource the API Consumer gets back, containing the information
+    about the Unconditional Call Forwarding Service status for the given phone
+    number (PhoneNumber).
+
+    **CallForwardingSignal**
+    This is the resource the API Consumer gets back, containing the information
+    about the general status of the Network Call Forwarding service for the
+    specified phone number.
+
+    The Call Forwarding Signal API provides two endpoints fulfilling the
+    following intents:
+    - **unconditional-call-forwardings**: Is the unconditional call fwd service
+    active on a specific phone number?
+    - **call-forwardings**: Which is the status of the call forwarding for a
+    specific phone number?
+    # API Documentation
+    ## Details
+    The Call Forwarding Signal API is invoked by an API Consumer after the
+    Consent Management flow.
+
+    The API Consumer can request the API Producer for the status of the
+    Unconditional Call Forwarding service using the
+    unconditional-call-forwardings POST method. A boolean, with the information
+    about the activation status of the call forwarding service, will be
+    provided back via the UnconditionalCallForwardingSignal resource.
+
+    The API Consumer can also request the API Producer for the generic status of
+    the Call Forwarding service using the call-forwardings POST method. An array
+    of strings with the information of the type of active call forwarding
+    services will be provided back via the CallForwardingSignal resource.
+    # 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` object 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` object 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` object 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 device 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.
+    # FAQ's
+    (FAQs will be added in a later version of the documentation)
+
+  version: wip
+  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/CallForwardingSignal
+############################################################################
+#                                     Servers                              #
+############################################################################
+servers:
+  - url: "{apiRoot}/call-forwarding-signal/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                                #
+############################################################################
+tags:
+  - name: Unconditional Call Forwarding information retrieval
+    description: Provides information on Unconditional Call Forwarding
+     settings for the provided phone number (PhoneNumber)
+  - name: Call Forwarding information retrieval
+    description: Provides information on Call Forwarding settings for the
+     provided phone number (PhoneNumber).
+############################################################################
+#                                     Paths                                #
+############################################################################
+paths:
+  /unconditional-call-forwardings:
+    post:
+      tags:
+        - Unconditional Call Forwarding information retrieval
+      security:
+        - openId:
+            - 'call-forwarding-signal:unconditional-call-forwardings:read'
+      summary: Retrieve the information about the status of the
+       unconditional call forwarding service on a phone number (PhoneNumber)
+      description: This endpoint provides information about the status
+       of the unconditional call forwarding, being active or not.
+      operationId: retrieveUnconditionalCallForwarding
+      parameters:
+        - $ref: '#/components/parameters/x-correlator'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CreateCallForwardingSignal'
+        required: true
+      responses:
+        '200':
+          description: OK.
+          headers:
+            x-correlator:
+              $ref: '#/components/headers/x-correlator'
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UnconditionalCallForwardingSignal'
+        "400":
+          $ref: "#/components/responses/Generic400"
+        '404':
+          $ref: '#/components/responses/Generic404'
+        "401":
+          $ref: "#/components/responses/Generic401"
+        "403":
+          $ref: "#/components/responses/Generic403"
+        "422":
+          $ref: "#/components/responses/Generic422"
+        "429":
+          $ref: "#/components/responses/Generic429"
+  /call-forwardings:
+    post:
+      tags:
+        - Call Forwarding information retrieval
+      security:
+        - openId:
+            - 'call-forwarding-signal:call-forwardings:read'
+      summary: Retrieve the information about the type of call forwarding
+       service active on a phone number (PhoneNumber)
+      description: This endpoint provides information about which type of
+       call forwarding service is active. More than one service can be
+       active, e.g. conditional and unconditional. This endpoint exceeds
+       the main scope of the Call Forwarding Signal API, for this reason
+       an error code 501 can be returned.
+      operationId: retrieveCallForwarding
+      parameters:
+        - $ref: '#/components/parameters/x-correlator'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CreateCallForwardingSignal'
+        required: true
+      responses:
+        '200':
+          description: OK.
+          headers:
+            x-correlator:
+              $ref: '#/components/headers/x-correlator'
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/CallForwardingSignal'
+        "400":
+          $ref: "#/components/responses/Generic400"
+        '404':
+          $ref: '#/components/responses/Generic404'
+        "401":
+          $ref: "#/components/responses/Generic401"
+        "403":
+          $ref: "#/components/responses/Generic403"
+        "422":
+          $ref: "#/components/responses/Generic422"
+        "429":
+          $ref: "#/components/responses/Generic429"
+        "501":
+          $ref: "#/components/responses/Generic501"
+############################################################################
+#                                 Components                               #
+############################################################################
+components:
+  securitySchemes:
+    openId:
+      description: to support Consent Management
+      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"
+  ############################################################################
+  #                                 Resources                                #
+  ############################################################################
+  schemas:
+    UnconditionalCallForwardingSignal:
+      description: resource containing the information about the Unconditional
+       Call Forwarding Service for the given phone number (PhoneNumber)
+      type: object
+      properties:
+        active:
+          type: boolean
+          description: Indicates if the unconditional call forwarding service
+           is active.
+    CallForwardingSignal:
+      description: resource containing the list of the Call
+       Forwarding Services active for the given phone number (PhoneNumber). The
+       possible states are, 'inactive' (no call forwarding service activated),
+       'unconditional' (call forwarded independently from the device status),
+       'conditional_busy' (call forwarded if the device is on an active call),
+       'conditional_not_reachable' (call forwarded if the device is not
+       reachable), 'conditional_no_answer' (call forwarded if the device doesn't
+       answer the incoming call).
+      type: array
+      items:
+        type: string
+        enum:
+          - 'inactive'
+          - 'unconditional'
+          - 'conditional_busy'
+          - 'conditional_not_reachable'
+          - 'conditional_no_answer'
+      example:
+        - 'unconditional'
+        - 'conditional_busy'
+        - 'conditional_no_answer'
+      minItems: 1
+    XCorrelator:
+      type: string
+      pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
+      example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
+    ############################################################################
+    #                                 Request                                  #
+    ############################################################################
+    CreateCallForwardingSignal:
+      description: resource containing the phone number (PhoneNumber) regarding
+       which the Call Forwarding Service must be checked. To be provided/valued
+       only in case of two-legged authentication. If provided/valued with
+       three-legged authentication a 422-UNNECESSARY_IDENTIFIER error code is
+       returned.
+      type: object
+      properties:
+        phoneNumber:
+          $ref: "#/components/schemas/PhoneNumber"
+    ############################################################################
+    #                                 Types                                    #
+    ############################################################################
+    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"
+    ############################################################################
+    #                                 Responces                                #
+    ############################################################################
+    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
+  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:
+                      - 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: Call forwarding check can't be done because the
+                  phone number is unknown.
+              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
+                      - 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 phone number cannot be identified.
+            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 phone number 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.
+    Generic501:
+      description: Not Implemented
+      headers:
+        x-correlator:
+          $ref: "#/components/headers/x-correlator"
+      content:
+        application/json:
+          schema:
+            allOf:
+              - $ref: "#/components/schemas/ErrorInfo"
+              - type: object
+                properties:
+                  status:
+                    enum:
+                      - 501
+                  code:
+                    enum:
+                      - NOT_IMPLEMENTED
+          examples:
+            GENERIC_501_NOT_IMPLEMENTED:
+              description: Service not implemented. The use of this code
+                should be avoided as far as possible to get the objective
+                to reach aligned implementations
+              value:
+                status: 501
+                code: NOT_IMPLEMENTED
+                message: This functionality is not implemented yet.
+```

marked/CallForwardingSignal/documentation/API_documentation/Call-Forwarding-Signal-UserStory-UseCase-1/raw.md

@@ -0,0 +1,15 @@
+
+| Item | Description | Support Qualifier |
+|----|----|----|
+|Summary|Banks offer the option for end users to receive telephone calls to solve problems, e.g. in case of issues with the bank App, issues with Smartphones, the bank website or any tool providing access to the online bank account management system.  How does the fraudster operate? <br>•  Through social engineering, the fraudster gathers information about bank end users who are engaged in such a situation, needing the bank to contact them.<br>• Once they identify the service provider and the phone number of an end user, they manage to successfully activate, on the end user's profile, the 'unconditional call forwarding' to a phone number they control.<br>• After successfully setting up 'unconditional call forwarding,' the fraudster then contacts the bank, claiming an inability to access online banking services and requesting a call from a bank representative.<br>• When the bank calls the registered contact number of the end user, the active 'unconditional call forwarding' diverts the call directly to the fraudster, thus completing their scheme.<br> The Bank Application, before contacting the end user's phone number, invokes the Call Forwarding Signal API to verify if a "unconditional call forwarding" option is active on the end user's phone, avoiding such a fraud| M |
+|Roles, Actor(s) and scope|Bank Application: role of Call Forwarding Signal API consumer<br>API Provider: role of Call Forwarding Signal API provider<br>End User: role of owner of the phone number to be verified<br>Scope: Anti fraud| M |
+|NF Requirements|| O |
+|Pre-conditions|• The Bank Application is aware of the End User's phone number<br>• The End User gave the consent to check for the Call Forwarding Service activation on his phone number.| M |
+|Begins when|The Bank Application invokes the Call Forwarding Signal API to get the information on the status of the Unconditional Call Forwarding Service for his End User's phone number.| M |
+|Step 1|The API Provider identifies the Bank Application as a valid Call Forwarding Signal API Consumer| M |
+|Step 2|The API Provider verifies the User Consent| M|
+|Step 3|The Bank Application invokes the Call Forwarding Signal API Producer providing the End User's phone number asking for the status of the Unconditional Call Forwarding Service | M |
+|Step 4|The Call Forwarding Signal API Producer checks if the End User's phone number has an active Unconditional Call Forwarding Service| M |
+|Ends when|The Call Forwarding Signal API Producer notifies the Bank Application about the status of the Unconditional Call Forwarding Service| M |
+|Post-conditions|The Bank Application is aware of the status for the Unconditional Call Forwarding Service for the End User's phone number | M |
+|Exceptions|Step 4 can generate an exception to be notified to the Bank Application| M | 

marked/CallForwardingSignal/documentation/API_documentation/call-forwarding-signal-API-Readiness-Checklist/raw.md

@@ -0,0 +1,23 @@
+
+# API Readiness Checklist
+
+Checklist for API call-forwarding-signal v0.4.0 in r3.3
+
+
+| Nr | API release assets  | alpha | release-candidate |  initial<br>public | stable<br> public | Status | Reference information |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----|
+|  1 | API definition                               |   M   |         M         |    M    |    M   |   Y  | [link](/code/API_definitions/call-forwarding-signal.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  | v0.4.0 |
+|  5 | API documentation                            |   M   |         M         |    M    |    M   |   Y  | inline in YAML |
+|  6 | User stories                                 |   O   |         O         |    O    |    M   |   Y  | [link](/documentation/API_documentation/CFS_UserStory_UseCase-1.md) |
+|  7 | Basic API test cases & documentation         |   O   |         M         |    M    |    M   |   Y  | [call-forwarding-signal-every-forwarding](/code/Test_definitions/call-forwarding-signal-every-forwarding.feature), [call-forwarding-signal-unconditional](/code/Test_definitions/call-forwarding-signal-unconditional.feature) |
+|  8 | Enhanced API test cases & documentation      |   O   |         O         |    O    |    M   |   Y  | [call-forwarding-signal-every-forwarding](/code/Test_definitions/call-forwarding-signal-every-forwarding.feature), [call-forwarding-signal-unconditional](/code/Test_definitions/call-forwarding-signal-unconditional.feature) |
+|  9 | Test result statement                        |   O   |         O         |    O    |    M   |   N  |      |
+| 10 | API release numbering convention applied     |   M   |         M         |    M    |    M   |   Y  | r3.3 |
+| 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/x/uoDVB) |
+
+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).