kubernetes/dcaegen2-services/resources/external/schemas/sa88-rel16/sliceNrm.yaml

   1 openapi: 3.0.1
   2 info:
   3   title: Slice NRM
   4   version: 16.4.0
   5   description: >-
   6     OAS 3.0.1 specification of the Slice NRM
   7     @ 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
   8     All rights reserved.
   9 externalDocs:
  10   description: 3GPP TS 28.541 V16.4.0; 5G NRM, Slice NRM
  11   url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.541/
  12 paths: {}
  13 components:
  14   schemas:
  15
  16 #------------ Type definitions ---------------------------------------------------
  17
  18     Float:
  19       type: number
  20       format: float
  21     MobilityLevel:
  22       type: string
  23       enum:
  24         - STATIONARY
  25         - NOMADIC
  26         - RESTRICTED MOBILITY
  27         - FULLY MOBILITY
  28     SharingLevel:
  29       type: string
  30       enum:
  31         - SHARED
  32         - NON-SHARED
  33     Category:
  34       type: string
  35       enum:
  36         - CHARACTER
  37         - SCALABILITY
  38     Tagging:
  39       type: string
  40       enum:
  41         - PERFORMANCE
  42         - FUNCTION
  43         - OPERATION
  44     Exposure:
  45       type: string
  46       enum:
  47         - API
  48         - KPI
  49     ServAttrCom:
  50       type: object
  51       properties:
  52         category:
  53           $ref: '#/components/schemas/Category'
  54         tagging:
  55           $ref: '#/components/schemas/Tagging'
  56         exposure:
  57           $ref: '#/components/schemas/Exposure'
  58     Support:
  59       type: string
  60       enum:
  61         - NOT SUPPORTED
  62         - SUPPORTED
  63     DelayTolerance:
  64       type: object
  65       properties:
  66         servAttrCom:
  67           $ref: '#/components/schemas/ServAttrCom'
  68         support:
  69           $ref: '#/components/schemas/Support'
  70     DeterministicComm:
  71       type: object
  72       properties:
  73         servAttrCom:
  74           $ref: '#/components/schemas/ServAttrCom'
  75         availability:
  76           $ref: '#/components/schemas/Support'
  77         periodicityList:
  78           type: string
  79     DLThptPerSlice:
  80       type: object
  81       properties:
  82         servAttrCom:
  83           $ref: '#/components/schemas/ServAttrCom'
  84         guaThpt:
  85           $ref: '#/components/schemas/Float'
  86         maxThpt:
  87           $ref: '#/components/schemas/Float'
  88     DLThptPerUE:
  89       type: object
  90       properties:
  91         servAttrCom:
  92           $ref: '#/components/schemas/ServAttrCom'
  93         guaThpt:
  94           $ref: '#/components/schemas/Float'
  95         maxThpt:
  96           $ref: '#/components/schemas/Float'
  97     ULThptPerSlice:
  98       type: object
  99       properties:
 100         servAttrCom:
 101           $ref: '#/components/schemas/ServAttrCom'
 102         guaThpt:
 103           $ref: '#/components/schemas/Float'
 104         maxThpt:
 105           $ref: '#/components/schemas/Float'
 106     ULThptPerUE:
 107       type: object
 108       properties:
 109         servAttrCom:
 110           $ref: '#/components/schemas/ServAttrCom'
 111         guaThpt:
 112           $ref: '#/components/schemas/Float'
 113         maxThpt:
 114           $ref: '#/components/schemas/Float'
 115     MaxPktSize:
 116       type: object
 117       properties:
 118         servAttrCom:
 119           $ref: '#/components/schemas/ServAttrCom'
 120         maxsize:
 121           type: integer
 122     MaxNumberofConns:
 123       type: object
 124       properties:
 125         servAttrCom:
 126           $ref: '#/components/schemas/ServAttrCom'
 127         nOofConn:
 128           type: integer
 129     KPIMonitoring:
 130       type: object
 131       properties:
 132         servAttrCom:
 133           $ref: '#/components/schemas/ServAttrCom'
 134         kPIList:
 135           type: string
 136     SupportedAccessTech:
 137       type: object
 138       properties:
 139         servAttrCom:
 140           $ref: '#/components/schemas/ServAttrCom'
 141         accTechList:
 142           type: integer
 143     UserMgmtOpen:
 144       type: object
 145       properties:
 146         servAttrCom:
 147           $ref: '#/components/schemas/ServAttrCom'
 148         support:
 149           $ref: '#/components/schemas/Support'
 150     V2XCommModels:
 151       type: object
 152       properties:
 153         servAttrCom:
 154           $ref: '#/components/schemas/ServAttrCom'
 155         v2XMode:
 156           $ref: '#/components/schemas/Support'
 157     TermDensity:
 158       type: object
 159       properties:
 160         servAttrCom:
 161           $ref: '#/components/schemas/ServAttrCom'
 162         density:
 163           type: integer
 164     NsInfo:
 165       type: object
 166       properties:
 167         nsInstanceId:
 168           type: string
 169         nsName:
 170           type: string
 171     ServiceProfileList:
 172       type: object
 173       additionalProperties:
 174         type: object
 175         properties:
 176           snssaiList:
 177             $ref: 'nrNrm.yaml#/components/schemas/SnssaiList'
 178           plmnIdList:
 179             $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList'
 180           maxNumberofUEs:
 181             type: number
 182           latency:
 183             type: number
 184           uEMobilityLevel:
 185             $ref: '#/components/schemas/MobilityLevel'
 186           sst:
 187             $ref: 'nrNrm.yaml#/components/schemas/Sst'
 188           resourceSharingLevel:
 189             $ref: '#/components/schemas/SharingLevel'
 190           availability:
 191             type: number
 192           delayTolerance:
 193             $ref: '#/components/schemas/DelayTolerance'
 194           deterministicComm:
 195             $ref: '#/components/schemas/DeterministicComm'
 196           dLThptPerSlice:
 197             $ref: '#/components/schemas/DLThptPerSlice'
 198           dLThptPerUE:
 199             $ref: '#/components/schemas/DLThptPerUE'
 200           uLThptPerSlice:
 201             $ref: '#/components/schemas/ULThptPerSlice'
 202           uLThptPerUE:
 203             $ref: '#/components/schemas/ULThptPerUE'
 204           maxPktSize:
 205             $ref: '#/components/schemas/MaxPktSize'
 206           maxNumberofConns:
 207             $ref: '#/components/schemas/MaxNumberofConns'
 208           kPIMonitoring:
 209             $ref: '#/components/schemas/KPIMonitoring'
 210           supportedAccessTech:
 211             $ref: '#/components/schemas/SupportedAccessTech'
 212           userMgmtOpen:
 213             $ref: '#/components/schemas/UserMgmtOpen'
 214           v2XModels:
 215             $ref: '#/components/schemas/V2XCommModels'
 216           coverageArea:
 217             type: string
 218           termDensity:
 219             $ref: '#/components/schemas/TermDensity'
 220           activityFactor:
 221             $ref: '#/components/schemas/Float'
 222           uESpeed:
 223             type: integer
 224           jitter:
 225             type: integer
 226           survivalTime:
 227             type: string
 228           reliability:
 229             type: string
 230     SliceProfileList:
 231       type: object
 232       additionalProperties:
 233         type: object
 234         properties:
 235           snssaiList:
 236             $ref: 'nrNrm.yaml#/components/schemas/SnssaiList'
 237           plmnIdList:
 238             $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList'
 239           maxNumberofUEs:
 240             type: number
 241           coverageAreaTAList:
 242             $ref: '5gcNrm.yaml#/components/schemas/TACList'
 243           latency:
 244             type: number
 245           uEMobilityLevel:
 246             $ref: '#/components/schemas/MobilityLevel'
 247           resourceSharingLevel:
 248             $ref: '#/components/schemas/SharingLevel'
 249
 250     IpAddress:
 251       oneOf:
 252         - $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr'
 253         - $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr'
 254
 255 #------------ Definition of concrete IOCs ----------------------------------------
 256
 257     NetworkSlice:
 258       allOf:
 259         - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr'
 260         - type: object
 261           properties:
 262             attributes:
 263               allOf:
 264                 - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-Attr'
 265                 - type: object
 266                   properties:
 267                     networkSliceSubnetRef:
 268                       $ref: 'genericNrm.yaml#/components/schemas/Dn'
 269                     operationalState:
 270                       $ref: 'genericNrm.yaml#/components/schemas/OperationalState'
 271                     administrativeState:
 272                       $ref: 'genericNrm.yaml#/components/schemas/AdministrativeState'
 273                     serviceProfileList:
 274                       $ref: '#/components/schemas/ServiceProfileList'
 275
 276     NetworkSliceSubnet:
 277       allOf:
 278         - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr'
 279         - type: object
 280           properties:
 281             attributes:
 282               allOf:
 283                 - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-Attr'
 284                 - type: object
 285                   properties:
 286                     managedFunctionRefList:
 287                       $ref: 'genericNrm.yaml#/components/schemas/DnList'
 288                     networkSliceSubnetRefList:
 289                       $ref: 'genericNrm.yaml#/components/schemas/DnList'
 290                     operationalState:
 291                       $ref: 'genericNrm.yaml#/components/schemas/OperationalState'
 292                     administrativeState:
 293                       $ref: 'genericNrm.yaml#/components/schemas/AdministrativeState'
 294                     nsInfo:
 295                       $ref: '#/components/schemas/NsInfo'
 296                     sliceProfileList:
 297                       $ref: '#/components/schemas/SliceProfileList'
 298             EPTransport:
 299               $ref: '#/components/schemas/EP_Transport-Multiple'
 300
 301     EP_Transport-Single:
 302       allOf:
 303         - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr'
 304         - type: object
 305           properties:
 306             attributes:
 307               type: object
 308               properties:
 309                 ipAddress:
 310                   $ref: '#/components/schemas/IpAddress'
 311                 logicInterfaceId:
 312                   type: string
 313                 nextHopInfo:
 314                   type: string
 315                 qosProfile:
 316                   type: string
 317
 318     EP_Transport-Multiple:
 319       type: array
 320       items:
 321         $ref: '#/components/schemas/EP_Transport-Single'
 322
 323 #------------ Definitions in TS 28.541 for TS 28.532 -----------------------------
 324
 325     resources-sliceNrm:
 326       oneOf:
 327         - $ref: '#/components/schemas/NetworkSlice'
 328         - $ref: '#/components/schemas/NetworkSliceSubnet'