TS29673_Nucmf_UERCM.yaml

openapi: 3.0.0

info:
  title: Nucmf_UECapabilityManagement
  version: 1.2.0-alpha.2
  description: |
    Nucmf_UECapabilityManagement Service.  
    © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  
    All rights reserved.

externalDocs:
  description: 3GPP TS 29.673 V18.3.0; 5G System; UE Radio Capability Management Services
  url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.673/'

servers:
  - url: '{apiRoot}/nucmf-uecm/v1'
    variables:
      apiRoot:
        default: https://example.com
        description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501

security:
  - {}
  - oAuth2ClientCredentials:
    - nucmf-uecm

paths:
  /dic-entries:
    get:
      summary: retrieve a dictionary entry matching query parameters
      operationId: RetrieveDictionaryEntry
      tags:
        - Dictionary Entry (Store)
      security:
        - {}
        - oAuth2ClientCredentials:
          - nucmf-uecm
        - oAuth2ClientCredentials:
          - nucmf-uecm
          - nucmf-uecm:dictionary:read
      parameters:
        - name: ue-radio-capa-id
          in: query
          required: true
          description: UE Radio Capability ID, either PLMN Assigned or Manufacturer Assigned
          schema:
            $ref: '#/components/schemas/UeRadioCapaId'
        - name: rac-format
          in: query
          description: Encoding format of RAC Info
          schema:
            $ref: '#/components/schemas/RacFormat'
        - name: supported-features
          in: query
          description: supported features of the NF consumer
          schema:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
      responses:
        '200':
          description: Expected response to a valid request
          content:
            multipart/related:  # message with binary body part(s)
              schema:
                type: object
                properties: # Request parts
                  jsonData:
                    $ref: '#/components/schemas/DicEntryData'
                  binaryDataUeRadioCapability5GS:
                    type: string
                    format: binary
                  binaryDataUeRadioCapabilityEPS:
                    type: string
                    format: binary
                  binaryDataUeRadioCap5GSForPaging:
                    type: string
                    format: binary
                  binaryDataUeRadioCapEPSForPaging:
                    type: string
                    format: binary
              encoding:
                jsonData:
                  contentType:  application/json
                binaryDataUeRadioCapability5GS:
                  contentType:  application/vnd.3gpp.ngap
                  headers:
                    Content-Id:
                      schema:
                        type: string
                binaryDataUeRadioCapabilityEPS:
                  contentType:  application/vnd.3gpp.s1ap
                  headers:
                    Content-Id:
                      schema:
                        type: string
                binaryDataUeRadioCap5GSForPaging:
                  contentType:  application/vnd.3gpp.ngap
                  headers:
                    Content-Id:
                      schema:
                        type: string
                binaryDataUeRadioCapEPSForPaging:
                  contentType:  application/vnd.3gpp.s1ap
                  headers:
                    Content-Id:
                      schema:
                        type: string
        '307':
          $ref: 'TS29571_CommonData.yaml#/components/responses/307'
        '308':
          $ref: 'TS29571_CommonData.yaml#/components/responses/308'
        '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'
        '411':
          $ref: 'TS29571_CommonData.yaml#/components/responses/411'
        '413':
          $ref: 'TS29571_CommonData.yaml#/components/responses/413'
        '415':
          $ref: 'TS29571_CommonData.yaml#/components/responses/415'
        '429':
          $ref: 'TS29571_CommonData.yaml#/components/responses/429'
        '500':
          $ref: 'TS29571_CommonData.yaml#/components/responses/500'
        '501':
          $ref: 'TS29571_CommonData.yaml#/components/responses/501'
        '502':
          $ref: 'TS29571_CommonData.yaml#/components/responses/502'
        '503':
          $ref: 'TS29571_CommonData.yaml#/components/responses/503'
        default:
          $ref: 'TS29571_CommonData.yaml#/components/responses/default'

    post:
      summary: Create a dictionary entry in the UCMF
      tags:
        - a dictionary entry (Document)
      operationId: CreateDictionaryEntry
      security:
        - {}
        - oAuth2ClientCredentials:
          - nucmf-uecm
        - oAuth2ClientCredentials:
          - nucmf-uecm
          - nucmf-uecm:dictionary:create
      requestBody:
        content:
          multipart/related:  # message with binary body part(s)
            schema:
              type: object
              properties: # Request parts
                jsonData:
                  $ref: '#/components/schemas/DicEntryCreateData'
                binaryDataUeRadioCapability5GS:
                  type: string
                  format: binary
                binaryDataUeRadioCapabilityEPS:
                  type: string
                  format: binary
                binaryDataUeRadioCap5GSForPaging:
                  type: string
                  format: binary
                binaryDataUeRadioCapEPSForPaging:
                  type: string
                  format: binary
            encoding:
              jsonData:
                contentType:  application/json
              binaryDataUeRadioCapability5GS:
                contentType:  application/vnd.3gpp.ngap
                headers:
                  Content-Id:
                    schema:
                      type: string
              binaryDataUeRadioCapabilityEPS:
                contentType:  application/vnd.3gpp.s1ap
                headers:
                  Content-Id:
                    schema:
                      type: string
              binaryDataUeRadioCap5GSForPaging:
                contentType:  application/vnd.3gpp.ngap
                headers:
                  Content-Id:
                    schema:
                      type: string
              binaryDataUeRadioCapEPSForPaging:
                contentType:  application/vnd.3gpp.s1ap
                headers:
                  Content-Id:
                    schema:
                      type: string
      responses:
        '201':
          description: Dictionary Created
          headers:
            Location:
              description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nucmf-uecm/<apiVersion>/dic-entries/{dicEntryId}'
              required: true
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DicEntryCreatedData'
        '307':
          $ref: 'TS29571_CommonData.yaml#/components/responses/307'
        '308':
          $ref: 'TS29571_CommonData.yaml#/components/responses/308'
        '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'
        '411':
          $ref: 'TS29571_CommonData.yaml#/components/responses/411'
        '413':
          $ref: 'TS29571_CommonData.yaml#/components/responses/413'
        '415':
          $ref: 'TS29571_CommonData.yaml#/components/responses/415'
        '429':
          $ref: 'TS29571_CommonData.yaml#/components/responses/429'
        '500':
          $ref: 'TS29571_CommonData.yaml#/components/responses/500'
        '501':
          $ref: 'TS29571_CommonData.yaml#/components/responses/501'
        '502':
          $ref: 'TS29571_CommonData.yaml#/components/responses/502'
        '503':
          $ref: 'TS29571_CommonData.yaml#/components/responses/503'
        default:
          $ref: 'TS29571_CommonData.yaml#/components/responses/default'

  /dic-entries/{dicEntryId}:
    get:
      summary: Get an individual dictionary entry via dicEntryId
      operationId: GetDicEntry
      tags:
        - dic Entry Id (Document)
      security:
        - {}
        - oAuth2ClientCredentials:
          - nucmf-uecm
        - oAuth2ClientCredentials:
          - nucmf-uecm
          - nucmf-uecm:dictionary:read
      parameters:
        - name: dicEntryId
          in: path
          description: the ID of a dictionary entry in the UCMF
          required: true
          schema:
            $ref: '#/components/schemas/DicEntryId'
        - name: rac-format
          in: query
          description: Encoding format of of RAC Info
          schema:
            $ref: '#/components/schemas/RacFormat'
        - name: supported-features
          in: query
          description: supported features of the NF consumer
          schema:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
      responses:
        '200':
          description: Expected response to a valid request
          content:
            multipart/related:  # message with binary body part(s)
              schema:
                type: object
                properties: # Request parts
                  jsonData:
                    $ref: '#/components/schemas/DicEntryData'
                  binaryDataUeRadioCapability5GS:
                    type: string
                    format: binary
                  binaryDataUeRadioCapabilityEPS:
                    type: string
                    format: binary
                  binaryDataUeRadioCap5GSForPaging:
                    type: string
                    format: binary
                  binaryDataUeRadioCapEPSForPaging:
                    type: string
                    format: binary
              encoding:
                jsonData:
                  contentType:  application/json
                binaryDataUeRadioCapability5GS:
                  contentType:  application/vnd.3gpp.ngap
                  headers:
                    Content-Id:
                      schema:
                        type: string
                binaryDataUeRadioCapabilityEPS:
                  contentType:  application/vnd.3gpp.s1ap
                  headers:
                    Content-Id:
                      schema:
                        type: string
                binaryDataUeRadioCap5GSForPaging:
                  contentType:  application/vnd.3gpp.ngap
                  headers:
                    Content-Id:
                      schema:
                        type: string
                binaryDataUeRadioCapEPSForPaging:
                  contentType:  application/vnd.3gpp.s1ap
                  headers:
                    Content-Id:
                      schema:
                        type: string
        '307':
          $ref: 'TS29571_CommonData.yaml#/components/responses/307'
        '308':
          $ref: 'TS29571_CommonData.yaml#/components/responses/308'
        '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'
        '411':
          $ref: 'TS29571_CommonData.yaml#/components/responses/411'
        '413':
          $ref: 'TS29571_CommonData.yaml#/components/responses/413'
        '415':
          $ref: 'TS29571_CommonData.yaml#/components/responses/415'
        '429':
          $ref: 'TS29571_CommonData.yaml#/components/responses/429'
        '500':
          $ref: 'TS29571_CommonData.yaml#/components/responses/500'
        '501':
          $ref: 'TS29571_CommonData.yaml#/components/responses/501'
        '502':
          $ref: 'TS29571_CommonData.yaml#/components/responses/502'
        '503':
          $ref: 'TS29571_CommonData.yaml#/components/responses/503'
        default:
          $ref: 'TS29571_CommonData.yaml#/components/responses/default'


  /subscriptions:
    post:
      summary: Nucmf_UECapabilityManagement Subscribe service Operation
      operationId: CreateIndividualSubcription
      tags:
        - Subscriptions (Collection)
      security:
        - {}
        - oAuth2ClientCredentials:
          - nucmf-uecm
        - oAuth2ClientCredentials:
          - nucmf-uecm
          - nucmf-uecm:subscription:create
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSubscription'
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedSubscription'
          headers:
            Location:
              description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/nucmf-uecm/<apiVersion>/subscriptions/{subscriptionId}'
              required: true
              schema:
                type: string
        '307':
          $ref: 'TS29571_CommonData.yaml#/components/responses/307'
        '308':
          $ref: 'TS29571_CommonData.yaml#/components/responses/308'
        '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'
        '411':
          $ref: 'TS29571_CommonData.yaml#/components/responses/411'
        '413':
          $ref: 'TS29571_CommonData.yaml#/components/responses/413'
        '415':
          $ref: 'TS29571_CommonData.yaml#/components/responses/415'
        '429':
          $ref: 'TS29571_CommonData.yaml#/components/responses/429'
        '500':
          $ref: 'TS29571_CommonData.yaml#/components/responses/500'
        '502':
          $ref: 'TS29571_CommonData.yaml#/components/responses/502'
        '503':
          $ref: 'TS29571_CommonData.yaml#/components/responses/503'
        default:
          $ref: 'TS29571_CommonData.yaml#/components/responses/default'
      callbacks:
        myNotification:
          '{$request.body#/ucmfNotificationUri}':
            post:
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/UcmfNotification'
              responses:
                '204':
                  description: No Content, Notification was succesfull
                '307':
                  $ref: 'TS29571_CommonData.yaml#/components/responses/307'
                '308':
                  $ref: 'TS29571_CommonData.yaml#/components/responses/308'
                '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'
                '411':
                  $ref: 'TS29571_CommonData.yaml#/components/responses/411'
                '413':
                  $ref: 'TS29571_CommonData.yaml#/components/responses/413'
                '415':
                  $ref: 'TS29571_CommonData.yaml#/components/responses/415'
                '429':
                  $ref: 'TS29571_CommonData.yaml#/components/responses/429'
                '500':
                  $ref: 'TS29571_CommonData.yaml#/components/responses/500'
                '502':
                  $ref: 'TS29571_CommonData.yaml#/components/responses/502'
                '503':
                  $ref: 'TS29571_CommonData.yaml#/components/responses/503'
                default:
                  $ref: 'TS29571_CommonData.yaml#/components/responses/default'

  /subscriptions/{subscriptionId}:
    delete:
      summary: unsubscribe from notifications
      operationId: DeleteIndividualSubcription
      tags:
        - IndividualSubscription (Document)
      security:
        - {}
        - oAuth2ClientCredentials:
          - nucmf-uecm
        - oAuth2ClientCredentials:
          - nucmf-uecm
          - nucmf-uecm:subscription:modify
      parameters:
        - name: subscriptionId
          in: path
          description: Event Subscription ID
          required: true
          schema:
            type: string
      responses:
        '204':
          description: No Content. Resource was succesfully deleted
        '307':
          $ref: 'TS29571_CommonData.yaml#/components/responses/307'
        '308':
          $ref: 'TS29571_CommonData.yaml#/components/responses/308'
        '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'
        '429':
          $ref: 'TS29571_CommonData.yaml#/components/responses/429'
        '500':
          $ref: 'TS29571_CommonData.yaml#/components/responses/500'
        '502':
          $ref: 'TS29571_CommonData.yaml#/components/responses/502'
        '503':
          $ref: 'TS29571_CommonData.yaml#/components/responses/503'
        default:
          $ref: 'TS29571_CommonData.yaml#/components/responses/default'


components:
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: '{nrfApiRoot}/oauth2/token'
          scopes:
            nucmf-uecm: Access to the Nucmf_UECapabilityManagement API
            nucmf-uecm:dictionary:read: Access to read dictionaries
            nucmf-uecm:dictionary:create: Access to create dictionary entitries
            nucmf-uecm:subscription:create: Access to create subscriptions
            nucmf-uecm:subscription:modify: Access to update subscriptions

  schemas:
    DicEntryData:
      description: A dictionary entry for a UE radio capability ID in the UCMF
      type: object
      required:
        - typeAllocationCode
      properties:
        dicEntryId:
          $ref: '#/components/schemas/DicEntryId'
        typeAllocationCode:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/TypeAllocationCode'
        plmnAssiUeRadioCapId:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnAssiUeRadioCapId'
        manAssiUeRadioCapId:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/ManAssiUeRadioCapId'
        ueRadioCapability5GS:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
        ueRadioCapabilityEPS:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
        ueRadioCap5GSForPaging:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
        ueRadioCapEPSForPaging:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'

    DicEntryCreateData:
      description: Data for a creating a dictionary entry request
      type: object
      required:
        - typeAllocationCode
      properties:
        typeAllocationCode:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/TypeAllocationCode'
        ueRadioCapability5GS:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
        ueRadioCapabilityEPS:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
        supportedFeatures:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
        ueRadioCap5GSForPaging:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
        ueRadioCapEPSForPaging:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'

    DicEntryCreatedData:
      description: Data for a creating a dictionary entry response
      type: object
      required:
        - plmnAssiUeRadioCapId
      properties:
        plmnAssiUeRadioCapId:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnAssiUeRadioCapId'


    UeRadioCapaId:
      description: UE Radio Capability ID
      type: object
      properties:
        plmnAssiUeRadioCapId:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnAssiUeRadioCapId'
        manAssiUeRadioCapId:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/ManAssiUeRadioCapId'


    CreateSubscription:
      description: Data for a creating a subscription request
      type: object
      required:
        - ucmfNotificationUri
      properties:
        nfId:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
        ucmfNotificationUri:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
        suggestedExpires:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
        supportedFeatures:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

    CreatedSubscription:
      description: Data for a creating a subscription response
      type: object
      required:
        - dicEntryId
      properties:
        dicEntryId:
          $ref: '#/components/schemas/DicEntryId'
        confirmedExpires:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
        supportedFeatures:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

    UcmfNotification:
      description: Data for a notification request from a UCMF
      type: object
      required:
        - dicEntryId
        - eventType
      properties:
        dicEntryId:
          $ref: '#/components/schemas/DicEntryId'
        eventType:
          $ref: '#/components/schemas/EventType'
        manAssOpRequestlist:
          $ref: '#/components/schemas/ManAssOpRequestlist'
          minItems: 1
        versionId:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
        newDicEntries:
          type: array
          items:
            $ref: '#/components/schemas/DicEntryData'
          minItems: 1

    ManAssOpRequestlist:
      description: Manufacturer Assigned operation requested list
      type: object
      oneOf:
        - required: [plmnAssiUeRadioCapId]
        - required: [typeAllocationCode]
      properties:
        plmnAssiUeRadioCapId:
          type: array
          items:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnAssiUeRadioCapId'
        typeAllocationCode:
          type: array
          items:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/TypeAllocationCode'


#
# SIMPLE DATA TYPES
#
    DicEntryId:
      type: integer
      minimum: 0
      maximum: 4294967295

#
# ENUMERATIONS
#

    EventType:
      anyOf:
      - type: string
        enum:
          - CREATION_OF_DICTIONARY_ENTRY
          - DELETION_OF_PLMN_ASSIGNED_IDS
          - NEW_VERSION_ID_OF_PLMN_ASSIGNED_IDs
      - type: string

    RacFormat:
      anyOf:
      - type: string
        enum:
          - 5GS
          - EPS
      - type: string