Commit e371708d authored by Jesus de Gregorio's avatar Jesus de Gregorio
Browse files

CT#85

parent 236b720a
Loading
Loading
Loading
Loading
+611 −254

File changed.

Preview size limit exceeded, changes collapsed.

+18 −2
Original line number Diff line number Diff line
openapi: 3.0.0

info:
  version: '1.1.0.alpha-1'
  version: '1.1.0.alpha-2'
  title: 'Nudm_EE'
  description: |
    Nudm Event Exposure Service.
@@ -9,7 +9,7 @@ info:
    All rights reserved.

externalDocs:
  description: 3GPP TS 29.503 Unified Data Management Services, version 16.0.0
  description: 3GPP TS 29.503 Unified Data Management Services, version 16.1.0
  url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.503/'

servers:
@@ -161,6 +161,12 @@ paths:
              minItems: 1
        required: true
      responses:
        '200':
          description: Expected response to a valid request
          content:
            application/json:
              schema:
                $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult'
        '204': 
          description: Successful response
        '403': 
@@ -267,6 +273,8 @@ components:
          $ref: '#/components/schemas/EventType'
        report:
          $ref: '#/components/schemas/Report'
        reachabilityForSmsReport:
          $ref: '#/components/schemas/ReachabilityForSmsReport'
        gpsi:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
        timeStamp:
@@ -278,6 +286,14 @@ components:
        - $ref: '#/components/schemas/RoamingStatusReport'
        - $ref: '#/components/schemas/CnTypeChangeReport'

    ReachabilityForSmsReport:
      type: object
      required:
        - smsfAccessType
      properties:
        smsfAccessType:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType'

    ChangeOfSupiPeiAssociationReport:
      type: object
      required:
+16 −7
Original line number Diff line number Diff line
openapi: 3.0.0

info:
  version: '1.0.0.alpha-1'
  version: '1.0.0.alpha-2'
  title: 'Nudm_NIDDAU'
  description: 'Nudm NIDD Authorization Service'

externalDocs:
  description: 3GPP TS 29.503 Unified Data Management Services, version 16.0.0
  description: 3GPP TS 29.503 Unified Data Management Services, version 16.1.0
  url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.503/'

servers:
@@ -92,11 +92,18 @@ components:
# COMPLEX TYPES:
#
    AuthorizationData:
      type: object
      required:
       - authorizationData
      properties:
        authorizationData:
          type: array
          items:
            $ref: '#/components/schemas/UserIdentifier'
          minItems: 1
          uniqueItems: true
        validityTime:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'

    UserIdentifier:
      type: object
@@ -107,6 +114,8 @@ components:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
        gpsi:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
        validityTime:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'



+278 −3
Original line number Diff line number Diff line
openapi: 3.0.0

info:
  version: '1.0.1'
  version: '1.1.0.alpha-1'
  title: 'Nudm_PP'
  description: |
    Nudm Parameter Provision Service.
@@ -9,7 +9,7 @@ info:
    All rights reserved.

externalDocs:
  description: 3GPP TS 29.503 Unified Data Management Services, version 15.4.0
  description: 3GPP TS 29.503 Unified Data Management Services, version 16.1.0
  url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.503/'

servers:
@@ -44,6 +44,106 @@ paths:
            schema:
              $ref: '#/components/schemas/PpData'
        required: true
      responses:
        '200':
          description: Expected response to a valid request
          content:
            application/json:
              schema:
                $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult'
        '204':
          description: Expected response to a valid request
        '400':
          $ref: 'TS29571_CommonData.yaml#/components/responses/400'
        '403':
          $ref: 'TS29571_CommonData.yaml#/components/responses/403'
        '404':
          $ref: 'TS29571_CommonData.yaml#/components/responses/404'
        '500':
          $ref: 'TS29571_CommonData.yaml#/components/responses/500'
        '503':
          $ref: 'TS29571_CommonData.yaml#/components/responses/503'
        default:
          description: Unexpected error
  /5g-vn-groups/{external-group-id}:
    put:
      summary: create a 5G VN Group
      operationId: Create 5G VN Group
      tags:
        - 5G VN Group Creation
      parameters:
        - name: external-group-id
          in: path
          description: External Identifier of the Group
          required: true
          schema:
            $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/5GVnGroupConfiguration'
        required: true
      responses:
        '201':
          description: Expected response to a valid request
        '400':
          $ref: 'TS29571_CommonData.yaml#/components/responses/400'
        '403':
          $ref: 'TS29571_CommonData.yaml#/components/responses/403'
        '404':
          $ref: 'TS29571_CommonData.yaml#/components/responses/404'
        '500':
          $ref: 'TS29571_CommonData.yaml#/components/responses/500'
        '503':
          $ref: 'TS29571_CommonData.yaml#/components/responses/503'
        default:
          description: Unexpected error
    delete:
      summary: delete a 5G VN Group
      operationId: Delete 5G VN Group
      tags:
        - 5G VN Group Deletion
      parameters:
        - name: external-group-id
          in: path
          description: External Identifier of the Group
          required: true
          schema:
            $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId'
      responses:
        '204':
          description: Expected response to a valid request
        '400':
          $ref: 'TS29571_CommonData.yaml#/components/responses/400'
        '403':
          $ref: 'TS29571_CommonData.yaml#/components/responses/403'
        '404':
          $ref: 'TS29571_CommonData.yaml#/components/responses/404'
        '500':
          $ref: 'TS29571_CommonData.yaml#/components/responses/500'
        '503':
          $ref: 'TS29571_CommonData.yaml#/components/responses/503'
        default:
          description: Unexpected error
    patch:
      summary: modify a 5G VN Group
      operationId: Modify 5G VN Group
      tags:
        - 5G VN Group Modification
      parameters:
        - name: external-group-id
          in: path
          description: External Identifier of the group
          required: true
          schema:
            $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId'
      requestBody:
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/5GVnGroupConfiguration'
        required: true
      responses:
        '204':
          description: Expected response to a valid request
@@ -83,6 +183,8 @@ components:
          $ref: '#/components/schemas/CommunicationCharacteristics'
        supportedFeatures:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
        expectedUeBehaviourParameters:
          $ref: '#/components/schemas/ExpectedUeBehaviour'

    CommunicationCharacteristics:
      type: object
@@ -107,6 +209,8 @@ components:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
        referenceId:
          $ref: '#/components/schemas/ReferenceId'
        validityTime:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
      nullable: true

    PpActiveTime:
@@ -122,8 +226,131 @@ components:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
        referenceId:
          $ref: '#/components/schemas/ReferenceId'
        validityTime:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
      nullable: true

    5GVnGroupConfiguration:
      type: object
      properties:
        5gVnGroupData:
          $ref: '#/components/schemas/5GVnGroupData'
        members:
          type: array
          items:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
          minItems: 1
        referenceId:
          $ref: '#/components/schemas/ReferenceId'
        afInstanceId:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
        internalGroupIdentifier:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId'

    5GVnGroupData:
      type: object
      required:
        - dnn
        - sNssai
      properties:
        dnn:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
        sNssai:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
        dnnConfiguration:
          $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/DnnConfiguration'

    ExpectedUeBehaviour:
      type: object
      required:
        - afInstanceId
        - referenceId
      properties:
        afInstanceId:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
        referenceId:
          $ref: '#/components/schemas/ReferenceId'
        stationaryIndication:
          $ref: '#/components/schemas/StationaryIndication'
        communicationDurationTime:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
        periodicTime:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
        scheduledCommunicationTime:
          $ref: '#/components/schemas/ScheduledCommunicationTime'
        expectedUmts:
          type: array
          items:
            $ref: '#/components/schemas/LocationArea'
          minItems: 1
          description: Identifies the UE's expected geographical movement. The attribute is only applicable in 5G.
        trafficProfile:
          $ref: '#/components/schemas/TrafficProfile'
        validityTime:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'

    ScheduledCommunicationTime:
      type: object
      properties:
        daysOfWeek:
          type: array
          items:
            $ref: '#/components/schemas/DayOfWeek'
          minItems: 1
          maxItems: 6
          description: Identifies the day(s) of the week. If absent, it indicates every day of the week.
        timeOfDayStart:
          $ref: '#/components/schemas/TimeOfDay'
        timeOfDayEnd:
          $ref: '#/components/schemas/TimeOfDay'

    LocationArea:
      type: object
      properties:
        geographicAreas:
          type: array
          items:
            $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea'
          minItems: 0
          description: Identifies a list of geographic area of the user where the UE is located.
        civicAddresses:
          type: array
          items:
            $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress'
          minItems: 0
          description: Identifies a list of civic addresses of the user where the UE is located.
        nwAreaInfo:
          $ref: '#/components/schemas/NetworkAreaInfo'

    NetworkAreaInfo:
      description: Describes a network area information in which the NF service consumer requests the number of UEs.
      type: object
      properties:
        ecgis:
          description: Contains a list of E-UTRA cell identities.
          type: array
          items:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi'
          minItems: 1
        ncgis:
          description: Contains a list of NR cell identities.
          type: array
          items:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi'
          minItems: 1
        gRanNodeIds:
          description: Contains a list of NG RAN nodes.
          type: array
          items:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId'
          minItems: 1
        tais:
          description: Contains a list of tracking area identities.
          type: array
          items:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai'
          minItems: 1


# SIMPLE TYPES:

@@ -134,5 +361,53 @@ components:
      type: integer
      nullable: true

    DayOfWeek:
      type: integer
      minimum: 1
      maximum: 7
      description: integer between and including 1 and 7 denoting a weekday. 1 shall indicate Monday, and the subsequent weekdays shall be indicated with the next higher numbers. 7 shall indicate Sunday.

    TimeOfDay:
      type: string
      description: String with format partial-time or full-time as defined in clause 5.6 of IETF RFC 3339. Examples, 20:15:00, 20:15:00-08:00 (for 8 hours behind UTC).



# ENUMS:

    StationaryIndication:
      anyOf:
      - type: string
        enum:
          - STATIONARY
          - MOBILE
      - 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
        - STATIONARY: Identifies the UE is stationary
        - MOBILE: Identifies the UE is mobile

    TrafficProfile:
      anyOf:
      - type: string
        enum:
          - SINGLE_TRANS_UL
          - SINGLE_TRANS_DL
          - DUAL_TRANS_UL_FIRST
          - DUAL_TRANS_DL_FIRST
          - MULTI_TRANS
      - 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
        - SINGLE_TRANS_UL: Uplink single packet transmission.
        - SINGLE_TRANS_DL: Downlink single packet transmission.
        - DUAL_TRANS_UL_FIRST: Dual packet transmission, firstly uplink packet transmission with subsequent downlink packet transmission.
        - DUAL_TRANS_DL_FIRST: Dual packet transmission, firstly downlink packet transmission with subsequent uplink packet transmission.
 No newline at end of file
+186 −7
Original line number Diff line number Diff line
openapi: 3.0.0

info:
  version: '2.1.0.alpha-1'
  version: '2.1.0.alpha-2'
  title: 'Nudm_SDM'
  description: |
    Nudm Subscriber Data Management Service.
@@ -9,7 +9,7 @@ info:
    All rights reserved.

externalDocs:
  description: 3GPP TS 29.503 Unified Data Management Services, version 16.0.0
  description: 3GPP TS 29.503 Unified Data Management Services, version 16.1.0
  url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.503/'

servers:
@@ -748,6 +748,8 @@ paths:
          description: Successful response
        '400':
          $ref: 'TS29571_CommonData.yaml#/components/responses/400'
        '404':
          $ref: 'TS29571_CommonData.yaml#/components/responses/404'
        '500':
          $ref: 'TS29571_CommonData.yaml#/components/responses/500'
        '503':
@@ -787,6 +789,8 @@ paths:
                $ref: '#/components/schemas/SdmSubscription'
        '400':
          $ref: 'TS29571_CommonData.yaml#/components/responses/400'
        '403':
          $ref: 'TS29571_CommonData.yaml#/components/responses/403'
        '404':
          $ref: 'TS29571_CommonData.yaml#/components/responses/404'
        '500':
@@ -795,24 +799,31 @@ paths:
          $ref: 'TS29571_CommonData.yaml#/components/responses/503'
        default:
          description: Unexpected error
  /{gpsi}/id-translation-result:
  /{ueId}/id-translation-result:
    get:
      summary: retrieve a UE's SUPI
      operationId: GetSupi
      summary: retrieve a UE's SUPI or GPSI
      operationId: GetSupiOrGpsi
      tags:
        - GPSI to SUPI Translation
      parameters:
        - name: gpsi
        - name: ueId
          in: path
          description: Identifier of the UE
          required: true
          schema:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
            $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId'
        - name: supported-features
          in: query
          description: Supported Features
          schema:
             $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
        - name: app-port-id
          in: query
          description: Application port identifier
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppPortId'
        - name: If-None-Match
          in: header
          description: Validator for conditional requests, as described in RFC 7232, 3.2 
@@ -911,6 +922,64 @@ paths:
          $ref: 'TS29571_CommonData.yaml#/components/responses/503'
        default:
          description: Unexpected error
  /{supi}/am-data/subscribed-snssais-ack:
    put:
      summary: Nudm_Sdm Info operation for S-NSSAIs acknowledgement
      operationId: S-NSSAIs Ack
      tags:
        - Providing acknowledgement of S-NSSAIs Update
      parameters:
        - name: supi
          in: path
          description: Identifier of the UE
          required: true
          schema:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AcknowledgeInfo'
      responses:
        '204':
          description: Successful acknowledgement
        '400':
          $ref: 'TS29571_CommonData.yaml#/components/responses/400'
        '500':
          $ref: 'TS29571_CommonData.yaml#/components/responses/500'
        '503':
          $ref: 'TS29571_CommonData.yaml#/components/responses/503'
        default:
          description: Unexpected error
  /{supi}/am-data/cag-ack:
    put:
      summary: Nudm_Sdm Info operation for CAG acknowledgement
      operationId: CAG Ack
      tags:
        - Providing acknowledgement of CAG Update
      parameters:
        - name: supi
          in: path
          description: Identifier of the UE
          required: true
          schema:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AcknowledgeInfo'
      responses:
        '204':
          description: Successful acknowledgement
        '400':
          $ref: 'TS29571_CommonData.yaml#/components/responses/400'
        '500':
          $ref: 'TS29571_CommonData.yaml#/components/responses/500'
        '503':
          $ref: 'TS29571_CommonData.yaml#/components/responses/503'
        default:
          description: Unexpected error
  /shared-data:
    get:
      summary: retrieve shared data
@@ -1046,6 +1115,8 @@ paths:
          description: Successful response
        '400':
          $ref: 'TS29571_CommonData.yaml#/components/responses/400'
        '404':
          $ref: 'TS29571_CommonData.yaml#/components/responses/404'
        '500':
          $ref: 'TS29571_CommonData.yaml#/components/responses/500'
        '503':
@@ -1079,6 +1150,8 @@ paths:
                $ref: '#/components/schemas/SdmSubscription'
        '400':
          $ref: 'TS29571_CommonData.yaml#/components/responses/400'
        '403':
          $ref: 'TS29571_CommonData.yaml#/components/responses/403'
        '404':
          $ref: 'TS29571_CommonData.yaml#/components/responses/404'
        '500':
@@ -1230,6 +1303,16 @@ components:
          items:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId'
          minItems: 1
        vnGroupInfo:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/VnGroupData'
          minProperties: 1
        sharedVnGroupDataIds:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SharedDataId'
          minProperties: 1
        subscribedUeAmbr:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/AmbrRm'
        nssai:
@@ -1283,6 +1366,38 @@ components:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
        traceData:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData'
        cagData:
          $ref: '#/components/schemas/CagData'
        stnSr:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/StnSr'
        cMsisdn:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/CMsisdn'
        nbIoTUePriority:
          $ref: '#/components/schemas/NbIoTUePriority'
    CagData:
      type: object
      required:
        - cagInfos
      properties:
        cagInfos:
          description: A map (list of key-value pairs where PlmnId serves as key) of CagInfo
          type: object
          additionalProperties:
            $ref: '#/components/schemas/CagInfo'
        provisioningTime:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'

    CagInfo:
      type: object
      required:
        - allowedCagList
      properties:
        allowedCagList:
          type: array
          items:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/CagId'
        cagOnlyIndicator:
          type: boolean

    SmfSelectionSubscriptionData:
      type: object
@@ -1320,6 +1435,8 @@ components:
          $ref: '#/components/schemas/LboRoamingAllowed'
        iwkEpsInd:
          $ref: '#/components/schemas/IwkEpsInd'
        dnnBarred:
          type: boolean

    Nssai:
      type: object
@@ -1338,6 +1455,13 @@ components:
          items:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
          minItems: 1
        provisioningTime:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
        additionalSnssaiData:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AdditionalSnssaiData'
          minProperties: 1
      nullable: true

    UeContextInSmfData:
@@ -1416,6 +1540,16 @@ components:
          items:
            $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId'
          minItems: 1
        vnGroupInfo:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/VnGroupData'
          minProperties: 1
        sharedVnGroupDataIds:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SharedDataId'
          minProperties: 1
        sharedDnnConfigurationsId:
          $ref: '#/components/schemas/SharedDataId'
        odbPacketServices:
@@ -1459,6 +1593,8 @@ components:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
        niddInfo:
          $ref: '#/components/schemas/NiddInformation'
        redundantSessionAllowed:
          type: boolean

    NiddInformation:
      type: object
@@ -1723,6 +1859,46 @@ components:
        intGroupId:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId'

    VnGroupData:
      type: object
      properties:
        pduSessionTypes:
          $ref: '#/components/schemas/PduSessionTypes'
        dnn:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
        singleNssai:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
        appDescriptors:
          type: array
          items:
            $ref: '#/components/schemas/AppDescriptor'
          minItems: 1

    AppDescriptor:
      type: object
      properties:
        osId:
          $ref: 'TS29519_Policy_Data.yaml#/components/schemas/OsId' 
        appId:
          type: string

    AdditionalSnssaiData:
      type: object
      properties:
        requiredAuthnAuthz:
          type: boolean
        support3Gpp:
          type: boolean
        supportNon3Gpp:
          type: boolean

    AppPortId:
      type: object
      properties:
        destinationPort:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint16'
        originatorPort:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint16'

# SIMPLE TYPES:

@@ -1772,6 +1948,9 @@ components:
      type: string
      pattern: '^extgroupid-[^@]+@[^@]+$'

    NbIoTUePriority:
      type: integer


# ENUMS:

Loading