Global System for Mobile Communications Connectivity Insights Subscriptions API

Create and manage a subscription to receive periodic connectivity insights
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.0.3
info:
  title: Global System for Mobile Communications GSMA Camara Project Endpoint Discovery Application Connectivity Insights Subscriptions API
  version: 0.1.0-wip
  description: The Application Discovery API extends beyond the capabilities of the Simple Edge Discovery API by not only locating the nearest Edge Cloud Zone but also directly linking to the application endpoints within those Edge Cloud Zones.
  contact:
    email: sp-edc@lists.camaraproject.org
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: '{apiRoot}/{basePath}'
  variables:
    apiRoot:
      default: https://localhost:443
      description: API root.
    basePath:
      default: application-endpoint-discovery/vwip
      description: Base path for the Application Endpoint Discovery.
tags:
- name: Connectivity Insights Subscriptions
  description: 'Create and manage a subscription to receive periodic connectivity

    insights

    '
paths:
  /subscriptions:
    post:
      tags:
      - Connectivity Insights Subscriptions
      description: Create a Connectivity insights subscription for a device
      summary: Global System for Mobile Communications Create a Connectivity insights subscription for a device
      operationId: createSubscription
      parameters:
      - $ref: '#/components/parameters/x-correlator'
      security:
      - openId:
        - connectivity-insights-subscriptions:org.camaraproject.connectivity-insights-subscriptions.v0.network-quality:create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionRequest'
        required: true
      callbacks:
        notifications:
          '{$request.body#/sink}':
            post:
              summary: Subscription notification callback
              description: 'Important: this endpoint is to be implemented by the API

                consumer.The Connectivity Insights server will call this

                endpoint whenever a connectivity event occurs that changes

                the netowrk''s ability to meet the application''s demands for

                a given device.

                '
              operationId: postNotification
              parameters:
              - $ref: '#/components/parameters/x-correlator'
              requestBody:
                required: true
                content:
                  'application/cloudevents+json:':
                    schema:
                      $ref: '#/components/schemas/CloudEvent'
              responses:
                '204':
                  description: Successful notification
                  headers:
                    x-correlator:
                      $ref: '#/components/headers/x-correlator'
                '400':
                  $ref: '#/components/responses/Generic400'
                '401':
                  $ref: '#/components/responses/Generic401'
                '403':
                  $ref: '#/components/responses/Generic403'
                '410':
                  $ref: '#/components/responses/Generic410'
                '429':
                  $ref: '#/components/responses/Generic429'
                '500':
                  $ref: '#/components/responses/Generic500'
                '503':
                  $ref: '#/components/responses/Generic503'
              security:
              - {}
              - notificationsBearerAuth: []
      responses:
        '201':
          description: Created
          headers:
            x-correlator:
              $ref: '#/components/headers/x-correlator'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
        '202':
          description: 'Request accepted to be processed. It applies for async

            creation process.

            '
          headers:
            x-correlator:
              $ref: '#/components/headers/x-correlator'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionAsync'
        '400':
          $ref: '#/components/responses/CreateSubscriptionBadRequest400'
        '401':
          $ref: '#/components/responses/Generic401'
        '403':
          $ref: '#/components/responses/SubscriptionPermissionDenied403'
        '409':
          $ref: '#/components/responses/Generic409'
        '415':
          $ref: '#/components/responses/Generic415'
        '422':
          $ref: '#/components/responses/CreateSubscriptionUnprocessableEntity422'
        '429':
          $ref: '#/components/responses/Generic429'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
    get:
      tags:
      - Connectivity Insights Subscriptions
      summary: Global System for Mobile Communications Retrieve a list of apiName event subscription
      operationId: getSubscriptionList
      description: 'Operation to list subscriptions authorized to be retrieved by the

        provided access token.

        '
      parameters:
      - $ref: '#/components/parameters/x-correlator'
      security:
      - openId:
        - connectivity-insights-subscriptions:read
      responses:
        '200':
          description: List of event subscription details
          headers:
            x-correlator:
              $ref: '#/components/headers/x-correlator'
          content:
            application/json:
              schema:
                type: array
                minItems: 0
                items:
                  $ref: '#/components/schemas/Subscription'
        '400':
          $ref: '#/components/responses/Generic400'
        '401':
          $ref: '#/components/responses/Generic401'
        '403':
          $ref: '#/components/responses/Generic403'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
  /subscriptions/{subscriptionId}:
    get:
      tags:
      - Connectivity Insights Subscriptions
      summary: Global System for Mobile Communications Operation to retrieve a subscription based on the provided ID
      operationId: getSubscription
      description: Retrieve a given subscription by ID
      security:
      - openId:
        - connectivity-insights-subscriptions:read
      parameters:
      - $ref: '#/components/parameters/SubscriptionId'
      - $ref: '#/components/parameters/x-correlator'
      responses:
        '200':
          description: OK
          headers:
            x-correlator:
              $ref: '#/components/headers/x-correlator'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
        '400':
          $ref: '#/components/responses/SubscriptionIdRequired'
        '401':
          $ref: '#/components/responses/Generic401'
        '403':
          $ref: '#/components/responses/Generic403'
        '404':
          $ref: '#/components/responses/Generic404'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
    delete:
      tags:
      - Connectivity Insights Subscriptions
      summary: Global System for Mobile Communications Operation to delete a subscription
      operationId: deleteSubscription
      description: Delete a given subscription by ID
      security:
      - openId:
        - connectivity-insights-subscriptions:delete
      parameters:
      - $ref: '#/components/parameters/SubscriptionId'
      - $ref: '#/components/parameters/x-correlator'
      responses:
        '202':
          description: 'Request accepted to be processed. It applies for async deletion

            process.

            '
          headers:
            x-correlator:
              $ref: '#/components/headers/x-correlator'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionAsync'
        '204':
          description: apiName subscription deleted
          headers:
            x-correlator:
              $ref: '#/components/headers/x-correlator'
        '400':
          $ref: '#/components/responses/SubscriptionIdRequired'
        '401':
          $ref: '#/components/responses/Generic401'
        '403':
          $ref: '#/components/responses/Generic403'
        '404':
          $ref: '#/components/responses/Generic404'
        '500':
          $ref: '#/components/responses/Generic500'
        '503':
          $ref: '#/components/responses/Generic503'
components:
  responses:
    Generic503:
      description: Service unavailable. Typically the server is down.
      headers:
        x-correlator:
          $ref: '#/components/headers/x-correlator'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorInfo'
          examples:
            GENERIC_503_UNAVAILABLE:
              description: Service is not available. Temporary situation usually related to maintenance process in the server side
              value:
                status: 503
                code: UNAVAILABLE
                message: Service Unavailable.
    Generic500:
      description: Server error
      headers:
        x-correlator:
          $ref: '#/components/headers/x-correlator'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorInfo'
          examples:
            GENERIC_500_INTERNAL:
              description: Problem in Server side. Regular Server Exception
              value:
                status: 500
                code: INTERNAL
                message: Unknown server error. Typically a server bug.
    Generic415:
      description: Unsupported Media Type
      headers:
        X-Correlator:
          $ref: '#/components/headers/x-correlator'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorInfo'
          examples:
            GENERIC_415_UNSUPPORTED_MEDIA_TYPE:
              description: Payload format of the request is in an unsupported format by the Server. Should not happen
              value:
                status: 415
                code: UNSUPPORTED_MEDIA_TYPE
                message: The server refuses to accept the request because the payload format is in an unsupported format
    Generic410:
      description: Gone
      headers:
        x-correlator:
          $ref: '#/components/headers/x-correlator'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorInfo'
          examples:
            GENERIC_410_GONE:
              description: Use in notifications flow to allow API Consumer to indicate that its callback is no longer available
              value:
                status: 410
                code: GONE
                message: Access to the target resource is no longer available.
    Generic429:
      description: Too Many Requests
      headers:
        X-Correlator:
          $ref: '#/components/headers/x-correlator'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorInfo'
          examples:
            GENERIC_429_QUOTA_EXCEEDED:
              description: Request is rejected due to exceeding a business quota limit
              value:
                status: 429
                code: QUOTA_EXCEEDED
                message: Either out of resource quota or reaching rate limiting.
            GENERIC_429_TOO_MANY_REQUESTS:
              description: API Server request limit is overpassed
              value:
                status: 429
                code: TOO_MANY_REQUESTS
                message: Either out of resource quota or reaching rate limiting.
    CreateSubscriptionBadRequest400:
      description: Problem with the client request
      headers:
        x-correlator:
          $ref: '#/components/headers/x-correlator'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorInfo'
          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.
            GENERIC_400_INVALID_PROTOCOL:
              value:
                status: 400
                code: INVALID_PROTOCOL
                message: Only HTTP is supported
            GENERIC_400_INVALID_CREDENTIAL:
              value:
                status: 400
                code: INVALID_CREDENTIAL
                message: Only Access token is supported
            GENERIC_400_INVALID_TOKEN:
              value:
                status: 400
                code: INVALID_TOKEN
                message: Only bearer token is supported
    Generic400:
      description: Problem with the client request
      headers:
        x-correlator:
          $ref: '#/components/headers/x-correlator'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorInfo'
          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.
    Generic409:
      description: Conflict
      headers:
        x-correlator:
          $ref: '#/components/headers/x-correlator'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorInfo'
          examples:
            GENERIC_409_ABORTED:
              description: Concurreny of processes of the same nature/scope
              value:
                status: 409
                code: ABORTED
                message: Concurrency conflict.
            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.
    CreateSubscriptionUnprocessableEntity422:
      description: Unprocessable Entity
      headers:
        x-correlator:
          $ref: '#/components/headers/x-correlator'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorInfo'
          examples:
            GENERIC_422_MULTIEVENT_SUBSCRIPTION_NOT_SUPPORTED:
              value:
                status: 422
                code: MULTIEVENT_SUBSCRIPTION_NOT_SUPPORTED
                message: Multi event types subscription not managed
            GENERIC_422_DEVICE_IDENTIFIERS_MISMATCH:
              description: Inconsistency between device identifiers not pointing to the same device
              value:
                status: 422
                code: DEVICE_IDENTIFIERS_MISMATCH
                message: Provided device identifiers are not consistent.
            GENERIC_422_DEVICE_NOT_APPLICABLE:
              description: Service is not available for the provided device
              value:
                status: 422
                code: DEVICE_NOT_APPLICABLE
                message: The service is not available for the provided device.
    Generic401:
      description: Authentication problem with the client request
      headers:
        x-correlator:
          $ref: '#/components/headers/x-correlator'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorInfo'
          examples:
            GENERIC_401_UNAUTHENTICATED:
              description: Request cannot be authenticated
              value:
                status: 401
                code: UNAUTHENTICATED
                message: Request not authenticated due to missing, invalid, or expired credentials.
            GENERIC_401_AUTHENTICATION_REQUIRED:
              description: New authentication is needed, authentication is no longer valid
              value:
                status: 401
                code: AUTHENTICATION_REQUIRED
                message: New authentication is required.
    SubscriptionPermissionDenied403:
      description: Client does not have sufficient permission
      headers:
        x-correlator:
          $ref: '#/components/headers/x-correlator'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorInfo'
          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.'
            GENERIC_403_SUBSCRIPTION_MISMATCH:
              value:
                status: 403
                code: SUBSCRIPTION_MISMATCH
                message: Inconsistent access token for requested events subscription
    SubscriptionIdRequired:
      description: Problem with the client request
      headers:
        x-correlator:
          $ref: '#/components/headers/x-correlator'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorInfo'
          examples:
            Generic400:
              summary: Schema validation failed
              value:
                status: 400
                code: INVALID_ARGUMENT
                message: Client specified an invalid argument, request body or query param
            subscriptionIdRequired:
              summary: subscription id is required
              value:
                status: 400
                code: INVALID_ARGUMENT
                message: 'Expected property is missing: subscriptionId'
    Generic403:
      description: Client does not have sufficient permission
      headers:
        x-correlator:
          $ref: '#/components/headers/x-correlator'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorInfo'
          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: Resource Not Found
      headers:
        x-correlator:
          $ref: '#/components/headers/x-correlator'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorInfo'
          examples:
            GENERIC_404_NOT_FOUND:
              description: Resource is not found
              value:
                status: 404
                code: NOT_FOUND
                message: The specified resource is not found.
  schemas:
    PolicyFulfillmentConfidence:
      type: string
      description: 'a plain-language indicator of how confident the network is to meet a

        given network demand.

        '
      enum:
      - meets the application requirements
      - unable to meet the application requirements
    Protocol:
      type: string
      enum:
      - HTTP
      - MQTT3
      - MQTT5
      - AMQP
      - NATS
      - KAFKA
      description: 'Identifier of a delivery protocol. Only HTTP is allowed for now

        '
      example: HTTP
    SubscriptionId:
      type: string
      description: 'The unique identifier of the subscription in the scope of the

        subscription manager. When this information is contained within

        an event notification, this concept SHALL be referred as

        `subscriptionId` as per

        [Commonalities Event Notification Model](https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md#122-event-notification).

        '
      example: qs15-h556-rt89-1298
    SubscriptionAsync:
      description: 'Response for a event-type subscription request managed asynchronously

        (Creation or Deletion)

        '
      type: object
      properties:
        subscriptionId:
          $ref: '#/components/schemas/SubscriptionId'
    ApplicationProfileId:
      description: Identifier for the Application Profile
      type: string
      format: uuid
    NetworkQualityInsight:
      type: object
      description: 'the network''s confidence level at being able to meet the network

        demands of a given policy for a given terminal device.

        '
      properties:
        papplicationProfileId:
          $ref: '#/components/schemas/ApplicationProfileId'
        packetDelayBudget:
          $ref: '#/components/schemas/PolicyFulfillmentConfidence'
        targetMinDownstreamRate:
          $ref: '#/components/schemas/PolicyFulfillmentConfidence'
        targetMinUpstreamRate:
          $ref: '#/components/schemas/PolicyFulfillmentConfidence'
        packetlossErrorRate:
          $ref: '#/components/schemas/PolicyFulfillmentConfidence'
        jitter:
          $ref: '#/components/schemas/PolicyFulfillmentConfidence'
        additionalKpis:
          $ref: '#/components/schemas/AdditionalKpis'
    CloudEvent:
      description: The Cloud-Event used for the callback.
      required:
      - id
      - source
      - specversion
      - type
      - time
      properties:
        id:
          type: string
          description: 'identifier of this event, that must be unique in the source context.

            '
        source:
          $ref: '#/components/schemas/Source'
        type:
          $ref: '#/components/schemas/EventTypeNotification'
        specversion:
          type: string
          description: "Version of the specification to which this event conforms (must be\n 1.0 if it conforms to cloudevents 1.0.2 version)\n"
          enum:
          - '1.0'
        datacontenttype:
          type: string
          description: '''media-type that describes the event payload encoding,

            must be "application/json" for CAMARA APIs''

            '
          enum:
          - application/json
        data:
          $ref: '#/components/schemas/NetworkQualityInsight'
        time:
          $ref: '#/components/schemas/DateTime'
      discriminator:
        propertyName: type
        mapping:
          org.camaraproject.connectivity-insights-subscriptions.v0.network-quality: '#/components/schemas/EventNetworkQuality'
          org.camaraproject.connectivityinsights.v0.eventSubscriptionEnds: '#/components/schemas/EventSubscriptionEnds'
    SingleIpv4Addr:
      description: A single IPv4 address with no subnet mask
      type: string
      format: ipv4
      example: 84.125.93.10
    SubscriptionRequest:
      description: The request for creating a event-type event subscription
      type: object
      required:
      - sink
      - protocol
      - config
      - types
      properties:
        protocol:
          $ref: '#/components/schemas/Protocol'
        sink:
          type: string
          format: url
          description: 'The address to which events shall be delivered using the selected

            protocol.

            '
          example: https://endpoint.example.com/sink
        sinkCredential:
          $ref: '#/components/schemas/SinkCredential'
        types:
          description: 'Camara Event types eligible to be delivered by this subscription.

            Note: for the Commonalities meta-release v0.4 we enforce to have

            only event type per subscription then for following meta-release

            use of array MUST be decided at API project level.

            '
          type: array
          items:
            type: string
            example: org.camaraproject.connectivity-insights-subscriptions.v0.network-quality
        config:
          $ref: '#/components/schemas/Config'
    AdditionalKpis:
      description: additional information about connectivity quality
      type: object
      properties:
        signalStrength:
          description: 'rough indication of the end user device radio signal conditions

            '
          type: string
          enum:
          - excellent
          - good
          - fair
          - poor
          - no signal
        connectivityType:
          description: 'the access technology connecting the user device to the operator

            network

            '
          type: string
          enum:
          - 5G-SA
          - 5G-NSA
          - 4G
          - 3G
    PhoneNumber:
      description: 'A public identifier addressing a telephone subscription. In mobile

        networks it corresponds to the MSISDN (Mobile Station International

        Subscriber Directory Number). In order to be globally unique it has to

        be formatted in international format, according to E.164 standard,

        optionally prefixed with ''+''.

        '
      type: string
      pattern: ^\+?[0-9]{5,15}$
      example: '123456789'
    DeviceIpv4Addr:
      type: object
      description: 'The device should be identified by either the public (observed) IP

        address and port as seen by the application server, or the private

        (local) and any public (observed) IP addresses in use by the device

        (this information can be obtained by various means, for example from

        some DNS servers).


        If the allocated and observed IP addresses are the same (i.e. NAT is

        not in use) then  the same address should be specified for both

        publicAddress and privateAddress.


        If NAT64 is in use, the device should be identified by its

        publicAddress and publicPort, or separately by its allocated IPv6

        address (field ipv6Address of the Device object)


        In all cases, publicAddress must be specified, along with at least one

        of either privateAddress or publicPort, dependent upon which is known.

        In general, mobile devices cannot be identified by their public IPv4

        address alone.

        '
      properties:
        publicAddress:
          $ref: '#/components/schemas/SingleIpv4Addr'
        privateAddress:
          $ref: '#/components/schemas/SingleIpv4Addr'
        publicPort:
          $ref: '#/components/schemas/Port'
      anyOf:
      - required:
        - publicAddress
        - privateAddress
      - required:
        - publicAddress
        - publicPort
      example:
        publicAddress: 84.125.93.10
        publicPort: 59765
    ApplicationServer:
      description: 'A server hosting backend applications to deliver some business logic to

        clients.


        The developer can choose to provide the below specified device

        identifiers:


        * `ipv4Address`

        * `ipv6Address`


        The Operator will use this information to calculate the end to end

        network performance in scenarios where its feasible.

        '
      type: object
      properties:
        ipv4Address:
          $ref: '#/components/schemas/ApplicationServerIpv4Address'
        ipv6Address:
          $ref: '#/components/schemas/ApplicationServerIpv6Address'
      minProperties: 1
    Source:
      type: string
      format: uri-reference
      minLength: 1
      description: "Identifies the context in which an event happened, as a non-empty\n`URI-reference` like:\n- URI with a DNS authority:\n  * https://github.com/cloudevents\n  * mailto:cncf-wg-serverless@lists.cncf.io\n- Universally-unique URN with a UUID:\n  * urn:uuid:6e8bc430-9c3a-11d9-9669-0800200c9a66\n- Application-specific identifier:\n  * /cloudevents/spec/pull/123\n  * 1-555-123-4567\n"
      example: https://notificationSendServer12.supertelco.com
    Subscription:
      description: Represents a event-type subscription.
      type: object
      required:
      - sink
      - protocol
      - config
      - types
      - id
      - startsAt
      properties:
        protocol:
          $ref: '#/components/schemas/Protocol'
        sink:
          type: string
          format: url
          description: 'The address to which events shall be delivered using the selected

            protocol.

            '
          example: https://endpoint.example.com/sink
        sinkCredential:
          $ref: '#/components/schemas/SinkCredential'
        types:
          description: 'Camara Event types eligible to be delivered by this subscription.

            Note: for the Commonalities meta-release v0.4 we enforce to have

            only event type per subscription then for following meta-release

            use of array MUST be decided at API project level.

            '
          type: array
          items:
            type: string
        config:
          $ref: '#/components/schemas/Config'
        subscriptionId:
          type: string
          description: 'The unique identifier of the subscription in the scope of the

            subscription manager. When this information is contained within

            an event notification, this concept SHALL be referred as

            `subscriptionId` as per

            [Commonalities Event Notification Model](https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md#122-event-notification).

            '
          example: '1119920371'
        startsAt:
          type: string
          format: date-time
          description: Date when the event subscription will begin/began
        expiresAt:
          type: string
          format: date-time
          description: 'Date when the event subscription will expire. Only provided when

            `subscriptionExpireTime` is indicated by API client or Telco

            Operator has specific policy about that.

            '
        status:
          type: string
          description: "Current status of the subscription - Management of Subscription\nState engine is not mandatory for now. Note not all statuses may\nbe considered to be implemented. Details:\n  - `ACTIVATION_REQUESTED`: Subscription creation (POST) is\n  triggered but subscription creation process is not finished\n  yet.\n  - `ACTIVE`: Subscription creation process is completed.\n  Subscription is fully operative.\n  - `DEACTIVE`: Subscription is temporarily inactive, but its\n  workflow logic is not deleted.\n  - `EXPIRED`: Subscription is ended (no longer active).\n  This status applies when subscription is ended due to\n  `SUBSCRIPTION_EXPIRED` or `ACCESS_TOKEN_EXPIRED` event.\n  - `DELETED`: Subscription is ended as deleted (no longer\n  active). This status applies when subscription information is\n  kept (i.e. subscription workflow is no longer active but its\n  metainformation is kept)."
          enum:
          - ACTIVATION_REQUESTED
          - ACTIVE
          - EXPIRED
          - DEACTIVE
          - DELETED
      discriminator:
        propertyName: protocol
        mapping:
          HTTP: '#/components/schemas/HTTPSubscriptionResponse'
          MQTT3: '#/components/schemas/MQTTSubscriptionResponse'
          MQTT5: '#/components/schemas/MQTTSubscriptionResponse'
          AMQP: '#/components/schemas/AMQPSubscriptionResponse'
          NATS: '#/components/schemas/NATSSubscriptionResponse'
          KAFKA: '#/components/schemas/ApacheKafkaSubscriptionResponse'
    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
          descri

# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/global-system-for-mobile-communications/refs/heads/main/openapi/global-system-for-mobile-communications-connectivity-insights-subscriptions-api-openapi.yml
Global System for Mobile Communications Connectivity Insights Subscriptions API

Documentation

Specifications

SDKs

Other Resources

OpenAPI Specification
