3GPP NWDAF Context (Document) API

openapi: 3.2.0
info:
  version: 1.2.1
  title: Nnwdaf_AnalyticsInfo NWDAF Context (Document) API
  description: "Nnwdaf_AnalyticsInfo Service API.  \n© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  \nAll rights reserved.\n"
servers:
- url: '{apiRoot}/nnwdaf-analyticsinfo/v1'
  variables:
    apiRoot:
      default: https://example.com
      description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501.
security:
- {}
- oAuth2ClientCredentials:
  - nnwdaf-analyticsinfo
tags:
- name: NWDAF Context (Document)
paths:
  /context:
    get:
      summary: Get context information related to analytics subscriptions.
      operationId: GetNwdafContext
      tags:
      - NWDAF Context (Document)
      parameters:
      - name: context-ids
        in: query
        description: Identifies specific context information related to analytics subscriptions.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContextIdList'
      - name: req-context
        in: query
        description: 'Identfies the type(s) of the analytics context information the consumer wishes to receive.

          '
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestedContext'
      responses:
        '200':
          description: 'Contains context information related to analytics subscriptions corresponding with one or  more context identifiers.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContextData'
        '204':
          description: 'No Content. (\No context information could be retrieved for the requested context  Identifiers.

            '
        '400':
          $ref: TS29571_CommonData.yaml#/components/responses/400
        '401':
          $ref: TS29571_CommonData.yaml#/components/responses/401
        '403':
          $ref: TS29571_CommonData.yaml#/components/responses/403
        '404':
          $ref: TS29571_CommonData.yaml#/components/responses/404
        '406':
          $ref: TS29571_CommonData.yaml#/components/responses/406
        '414':
          $ref: TS29571_CommonData.yaml#/components/responses/414
        '429':
          $ref: TS29571_CommonData.yaml#/components/responses/429
        '500':
          $ref: TS29571_CommonData.yaml#/components/responses/500
        '503':
          $ref: TS29571_CommonData.yaml#/components/responses/503
        default:
          $ref: TS29571_CommonData.yaml#/components/responses/default
components:
  schemas:
    HistoricalData:
      description: Contains historical data related to an analytics subscription.
      type: object
      properties:
        startTime:
          $ref: TS29571_CommonData.yaml#/components/schemas/DateTime
        endTime:
          $ref: TS29571_CommonData.yaml#/components/schemas/DateTime
        subsWithSources:
          type: array
          items:
            $ref: '#/components/schemas/SpecificDataSubscription'
          minItems: 1
          description: Information about subscriptions with the data sources.
        data:
          type: array
          items:
            type: string
          minItems: 1
          description: Historical data related to the analytics.
      required:
      - data
    ContextType:
      anyOf:
      - type: string
        enum:
        - PENDING_ANALYTICS
        - HISTORICAL_ANALYTICS
        - AGGR_SUBS
        - DATA
        - AGGR_INFO
        - ML_MODELS
      - type: string
        description: 'This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.

          '
      description: 'Possible values are:

        - PENDING_ANALYTICS: Represents context information that relates to pending output analytics.

        - HISTORICAL_ANALYTICS: Represents context information that relates to historical output analytics.

        - AGGR_SUBS: Represents context information about the analytics subscriptions that an NWDAF has with other NWDAFs that collectively serve an analytics subscription.

        - DATA: Represents context information about historical data that is available.

        - AGGR_INFO: Represents context information that is related to aggregation of analytics from multiple NWDAF subscriptions.

        - ML_MODELS: Represents context information about used ML models.

        '
    RequestedContext:
      description: Contains types of analytics context information.
      type: object
      properties:
        contexts:
          type: array
          items:
            $ref: '#/components/schemas/ContextType'
          minItems: 1
          description: List of analytics context types.
      required:
      - contexts
    ContextData:
      description: 'Contains context information related to analytics subscriptions corresponding with one or  more context identifiers.

        '
      type: object
      properties:
        contextElems:
          type: array
          items:
            $ref: '#/components/schemas/ContextElement'
          minItems: 1
          description: 'List of items that contain context information corresponding with a context identifier.

            '
      required:
      - contextElems
    SpecificDataSubscription:
      description: 'Represents an existing subscription for data collection to a specific data source NF.

        '
      type: object
      properties:
        subscriptionId:
          type: string
        producerId:
          $ref: TS29571_CommonData.yaml#/components/schemas/NfInstanceId
        producerSetId:
          $ref: TS29571_CommonData.yaml#/components/schemas/NfSetId
        dataSub:
          type: string
      allOf:
      - oneOf:
        - required:
          - producerId
        - required:
          - producerSetId
      - required:
        - subscriptionId
      - required:
        - dataSub
    ContextElement:
      description: Contains context information corresponding with a specific context identifier.
      type: object
      properties:
        contextId:
          $ref: TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/AnalyticsContextIdentifier
        pendAnalytics:
          type: array
          items:
            $ref: TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/EventNotification
          minItems: 1
          description: 'Output analytics for the analytics subscription which have not yet been sent to the  analytics consumer.

            '
        histAnalytics:
          type: array
          items:
            $ref: TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/EventNotification
          minItems: 1
          description: Historical output analytics.
        lastOutputTime:
          $ref: TS29571_CommonData.yaml#/components/schemas/DateTime
        aggrSubs:
          type: array
          items:
            $ref: '#/components/schemas/SpecificAnalyticsSubscription'
          minItems: 1
          description: 'Information about analytics subscriptions that the NWDAF has with other NWDAFs to perform  aggregation.

            '
        histData:
          type: array
          items:
            $ref: '#/components/schemas/HistoricalData'
          minItems: 1
          description: Historical data related to the analytics subscription.
        adrfId:
          $ref: TS29571_CommonData.yaml#/components/schemas/NfInstanceId
        adrfDataTypes:
          type: array
          items:
            $ref: '#/components/schemas/AdrfDataType'
          minItems: 1
          description: Type(s) of data stored in the ADRF by the NWDAF.
        aggrNwdafIds:
          type: array
          items:
            $ref: TS29571_CommonData.yaml#/components/schemas/NfInstanceId
          minItems: 1
          description: 'NWDAF identifiers of NWDAF instances used by the NWDAF service consumer when aggregating  multiple analytics subscriptions.

            '
        modelInfo:
          type: array
          items:
            $ref: TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/ModelInfo
          minItems: 1
          description: 'Contains information identifying the ML model(s) that the consumer NWDAF is currently subscribing for the analytics.

            '
      required:
      - contextId
    ContextIdList:
      description: 'Contains a list of context identifiers of context information of analytics subscriptions.

        '
      type: object
      properties:
        contextIds:
          type: array
          items:
            $ref: TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/AnalyticsContextIdentifier
          minItems: 1
      required:
      - contextIds
    SpecificAnalyticsSubscription:
      description: 'Represents an existing subscription for a specific type of analytics to a specific NWDAF.

        '
      type: object
      properties:
        subscriptionId:
          type: string
        producerId:
          $ref: TS29571_CommonData.yaml#/components/schemas/NfInstanceId
        producerSetId:
          $ref: TS29571_CommonData.yaml#/components/schemas/NfSetId
        nwdafEvSub:
          $ref: TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEventsSubscription
      allOf:
      - oneOf:
        - required:
          - producerId
        - required:
          - producerSetId
      - required:
        - subscriptionId
      - required:
        - nwdafEvSub
    AdrfDataType:
      anyOf:
      - type: string
        enum:
        - HISTORICAL_ANALYTICS
        - HISTORICAL_DATA
      - type: string
        description: 'This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.

          '
      description: 'Possible values are:

        - HISTORICAL_ANALYTICS: Indicates that historical analytics are stored in the ADRF.

        - HISTORICAL_DATA: Indicates that historical data are stored in the ADRF.

        '
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: '{nrfApiRoot}/oauth2/token'
          scopes:
            nnwdaf-analyticsinfo: Access to the Nnwdaf_AnalyticsInfo API
externalDocs:
  description: 3GPP TS 29.520 V17.8.0; 5G System; Network Data Analytics Services.
  url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/