1 Star 0 Fork 2

Kenny_ZhangWei / 5GC_APIs

forked from yuxi-o / 5GC_APIs 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
该仓库未声明开源许可证文件(LICENSE),使用请关注具体项目描述及其代码上游依赖。
克隆/下载
TS29571_CommonData.yaml 59.65 KB
一键复制 编辑 Web IDE 原始数据 按行查看 历史
Jesus de Gregorio 提交于 2020-04-05 16:19 . Rel-16 Mar'20
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396
openapi: 3.0.0
info:
version: '1.2.0.alpha-4'
title: 'Common Data Types'
description: |
Common Data Types for Service Based Interfaces.
© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.571 Common Data Types for Service Based Interfaces, version 16.3.0
url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.571/'
paths: {}
components:
schemas:
#
# Common Data Types for Generic usage definitiones as defined in clause 5.2
#
#
# COMMON SIMPLE DATA TYPES
#
Binary:
format: binary
type: string
BinaryRm:
format: binary
type: string
nullable: true
Bytes:
format: byte
type: string
BytesRm:
format: byte
type: string
nullable: true
Date:
format: date
type: string
DateRm:
format: date
type: string
nullable: true
DateTime:
format: date-time
type: string
DateTimeRm:
format: date-time
type: string
nullable: true
DiameterIdentity:
type: string
pattern: '^([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}$'
DiameterIdentityRm:
type: string
pattern: '^([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}$'
nullable: true
Double:
format: double
type: number
DoubleRm:
format: double
type: number
nullable: true
DurationSec:
type: integer
DurationSecRm:
type: integer
nullable: true
Float:
format: float
type: number
FloatRm:
format: float
type: number
nullable: true
Int32:
format: int32
type: integer
Int32Rm:
format: int32
type: integer
nullable: true
Int64:
type: integer
format: int64
Int64Rm:
format: int64
type: integer
nullable: true
Ipv4Addr:
type: string
pattern: '^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$'
example: '198.51.100.1'
Ipv4AddrRm:
type: string
pattern: '^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$'
example: '198.51.100.1'
nullable: true
Ipv4AddrMask:
type: string
pattern: '^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(\/([0-9]|[1-2][0-9]|3[0-2]))$'
example: '198.51.0.0/16'
Ipv4AddrMaskRm:
type: string
pattern: '^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(\/([0-9]|[1-2][0-9]|3[0-2]))$'
example: '198.51.0.0/16'
nullable: true
Ipv6Addr:
type: string
allOf:
- pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))$'
- pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$'
example: '2001:db8:85a3::8a2e:370:7334'
Ipv6AddrRm:
type: string
allOf:
- pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))$'
- pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$'
example: '2001:db8:85a3::8a2e:370:7334'
nullable: true
Ipv6Prefix:
type: string
allOf:
- pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))(\/(([0-9])|([0-9]{2})|(1[0-1][0-9])|(12[0-8])))$'
- pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))(\/.+)$'
example: '2001:db8:abcd:12::0/64'
Ipv6PrefixRm:
type: string
allOf:
- pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))(\/(([0-9])|([0-9]{2})|(1[0-1][0-9])|(12[0-8])))$'
- pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))(\/.+)$'
nullable: true
MacAddr48:
type: string
pattern: '^([0-9a-fA-F]{2})((-[0-9a-fA-F]{2}){5})$'
MacAddr48Rm:
type: string
pattern: '^([0-9a-fA-F]{2})((-[0-9a-fA-F]{2}){5})$'
nullable: true
SupportedFeatures:
type: string
pattern: '^[A-Fa-f0-9]*$'
Uinteger:
type: integer
minimum: 0
UintegerRm:
type: integer
minimum: 0
nullable: true
Uint16:
type: integer
minimum: 0
maximum: 65535
Uint16Rm:
type: integer
minimum: 0
maximum: 65535
nullable: true
Uint32:
format: int32
type: integer
minimum: 0
Uint32Rm:
format: int32
type: integer
minimum: 0
nullable: true
Uint64:
format: int64
type: integer
minimum: 0
Uint64Rm:
format: int64
type: integer
minimum: 0
nullable: true
Uri:
type: string
UriRm:
type: string
nullable: true
VarUeId:
type: string
pattern: '^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|gci-.+|gli-.+|.+)$'
VarUeIdRm:
type: string
pattern: '^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|gci-.+|gli-.+|.+)$'
nullable: true
TimeZone:
type: string
TimeZoneRm:
type: string
nullable: true
StnSr:
type: string
StnSrRm:
type: string
nullable: true
CMsisdn:
type: string
pattern: '^[0-9]{5,15}$'
CMsisdnRm:
type: string
pattern: '^[0-9]{5,15}$'
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).
#
# COMMON ENUMERATED DATA TYPES
#
PatchOperation:
anyOf:
- type: string
enum:
- add
- copy
- move
- remove
- replace
- test
- type: string
UriScheme:
anyOf:
- type: string
enum:
- http
- https
- type: string
ChangeType:
anyOf:
- type: string
enum:
- ADD
- MOVE
- REMOVE
- REPLACE
- type: string
HttpMethod:
anyOf:
- type: string
enum:
- GET
- POST
- PUT
- DELETE
- PATCH
- OPTIONS
- HEAD
- CONNECT
- TRACE
- type: string
NullValue:
enum:
- null
#
# COMMON STRUCTURED DATA TYPES
#
ProblemDetails:
type: object
properties:
type:
$ref: '#/components/schemas/Uri'
title:
type: string
status:
type: integer
detail:
type: string
instance:
$ref: '#/components/schemas/Uri'
cause:
type: string
invalidParams:
type: array
items:
$ref: '#/components/schemas/InvalidParam'
minItems: 1
supportedFeatures:
$ref: '#/components/schemas/SupportedFeatures'
Link:
type: object
properties:
href:
$ref: '#/components/schemas/Uri'
LinkRm:
type: object
properties:
href:
$ref: '#/components/schemas/Uri'
nullable: true
PatchItem:
type: object
properties:
op:
$ref: '#/components/schemas/PatchOperation'
path:
type: string
from:
type: string
value: {}
required:
- op
- path
LinksValueSchema:
oneOf:
- type: array
items:
$ref: '#/components/schemas/Link'
minItems: 1
- $ref: '#/components/schemas/Link'
SelfLink:
type: object
properties:
self:
$ref: '#/components/schemas/Link'
required:
- self
InvalidParam:
type: object
properties:
param:
type: string
reason:
type: string
required:
- param
ChangeItem:
type: object
properties:
op:
$ref: '#/components/schemas/ChangeType'
path:
type: string
from:
type: string
origValue: {}
newValue: {}
required:
- op
- path
NotifyItem:
type: object
required:
- resourceId
- changes
properties:
resourceId:
$ref: '#/components/schemas/Uri'
changes:
type: array
items:
$ref: '#/components/schemas/ChangeItem'
minItems: 1
ComplexQuery:
oneOf:
- $ref: '#/components/schemas/Cnf'
- $ref: '#/components/schemas/Dnf'
Cnf:
type: object
required:
- cnfUnits
properties:
cnfUnits:
type: array
items:
$ref: '#/components/schemas/CnfUnit'
minItems: 1
Dnf:
type: object
required:
- dnfUnits
properties:
dnfUnits:
type: array
items:
$ref: '#/components/schemas/DnfUnit'
minItems: 1
CnfUnit:
type: object
required:
- cnfUnit
properties:
cnfUnit:
type: array
items:
$ref: '#/components/schemas/Atom'
minItems: 1
DnfUnit:
type: object
required:
- dnfUnit
properties:
dnfUnit:
type: array
items:
$ref: '#/components/schemas/Atom'
minItems: 1
Atom:
type: object
required:
- attr
- value
properties:
attr:
type: string
value: {}
negative:
type: boolean
PatchResult:
type: object
required:
- report
properties:
report:
type: array
items:
$ref: '#/components/schemas/ReportItem'
minItems: 1
ReportItem:
type: object
required:
- path
properties:
path:
type: string
HalTemplate:
type: object
required:
- method
properties:
title:
type: string
method:
$ref: '#/components/schemas/HttpMethod'
contentType:
type: string
properties:
type: array
items:
$ref: '#/components/schemas/Property'
minItems: 1
Property:
type: object
required:
- name
properties:
name:
type: string
required:
type: boolean
regex:
type: string
value:
type: string
#
# Data Types related to Subscription, Identification and Numbering as defined in clause 5.3
#
#
# SIMPLE DATA TYPES
#
Dnn:
type: string
DnnRm:
type: string
nullable: true
WildcardDnn:
type: string
pattern: '^[*]$'
WildcardDnnRm:
type: string
pattern: '^[*]$'
nullable: true
Gpsi:
type: string
pattern: '^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$'
GpsiRm:
type: string
pattern: '^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$'
nullable: true
GroupId:
type: string
pattern: '^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0-9][A-Fa-f0-9]){1,10}$'
GroupIdRm:
type: string
pattern: '^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0-9][A-Fa-f0-9]){1,10}$'
nullable: true
ExternalGroupId:
type: string
pattern: '^extgroupid-[^@]+@[^@]+$'
ExternalGroupIdRm:
type: string
pattern: '^extgroupid-[^@]+@[^@]+$'
nullable: true
Pei:
type: string
pattern: '^(imei-[0-9]{15}|imeisv-[0-9]{16}|mac((-[0-9a-fA-F]{2}){6})(-untrusted)?|eui((-[0-9a-fA-F]{2}){8})|.+)$'
PeiRm:
type: string
pattern: '^(imei-[0-9]{15}|imeisv-[0-9]{16}|mac((-[0-9a-fA-F]{2}){6})(-untrusted)?|eui((-[0-9a-fA-F]{2}){8})|.+)$'
nullable: true
Supi:
type: string
pattern: '^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$'
SupiRm:
type: string
pattern: '^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$'
nullable: true
NfInstanceId:
type: string
format: uuid
AmfId:
type: string
pattern: '^[A-Fa-f0-9]{6}$'
AmfRegionId:
type: string
pattern: '^[A-Fa-f0-9]{2}$'
AmfSetId:
type: string
pattern: '^[0-3][A-Fa-f0-9]{2}$'
RfspIndex:
type: integer
minimum: 1
maximum: 256
RfspIndexRm:
type: integer
minimum: 1
maximum: 256
nullable: true
NfGroupId:
type: string
MtcProviderInformation:
type: string
CagId:
type: string
pattern: '^[A-Fa-f0-9]{8}$'
SupiOrSuci:
type: string
pattern: '^(imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|suci-(0-[0-9]{3}-[0-9]{2,3}|[1-7]-.+)-[0-9]{1,4}-(0-0-.+|[a-fA-F1-9]-([1-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])-[a-fA-F0-9]+)|.+)$'
#
# STRUCTURED DATA TYPES
#
Guami:
type: object
properties:
plmnId:
$ref: '#/components/schemas/PlmnId'
amfId:
$ref: '#/components/schemas/AmfId'
required:
- plmnId
- amfId
GuamiRm:
type: object
properties:
plmnId:
$ref: '#/components/schemas/PlmnId'
amfId:
$ref: '#/components/schemas/AmfId'
required:
- plmnId
- amfId
nullable: true
NetworkId:
type: object
properties:
mnc:
$ref: '#/components/schemas/Mnc'
mcc:
$ref: '#/components/schemas/Mcc'
#
# Data Types related to 5G Network as defined in clause 5.4
#
#
# SIMPLE DATA TYPES
#
ApplicationId:
type: string
ApplicationIdRm:
type: string
nullable: true
PduSessionId:
type: integer
minimum: 0
maximum: 255
Mcc:
type: string
pattern: '^\d{3}$'
MccRm:
type: string
pattern: '^\d{3}$'
nullable: true
Mnc:
type: string
pattern: '^\d{2,3}$'
MncRm:
type: string
pattern: '^\d{2,3}$'
nullable: true
Tac:
type: string
pattern: '(^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)'
TacRm:
type: string
pattern: '(^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)'
nullable: true
EutraCellId:
type: string
pattern: '^[A-Fa-f0-9]{7}$'
EutraCellIdRm:
type: string
pattern: '^[A-Fa-f0-9]{7}$'
nullable: true
NrCellId:
type: string
pattern: '^[A-Fa-f0-9]{9}$'
NrCellIdRm:
type: string
pattern: '^[A-Fa-f0-9]{9}$'
nullable: true
Dnai:
type: string
DnaiRm:
type: string
nullable: true
5GMmCause:
$ref: '#/components/schemas/Uinteger'
AmfName:
type: string
AreaCode:
type: string
AreaCodeRm:
type: string
nullable: true
N3IwfId:
type: string
pattern: '^[A-Fa-f0-9]+$'
NgeNbId:
type: string
pattern: '^(MacroNGeNB-[A-Fa-f0-9]{5}|LMacroNGeNB-[A-Fa-f0-9]{6}|SMacroNGeNB-[A-Fa-f0-9]{5})$'
Nid:
type: string
pattern: '^[A-Fa-f0-9]{11}$'
NidRm:
type: string
pattern: '^[A-Fa-f0-9]{11}$'
nullable: true
NfSetId:
type: string
NfServiceSetId:
type: string
PlmnAssiUeRadioCapId:
$ref: '#/components/schemas/Bytes'
ManAssiUeRadioCapId:
$ref: '#/components/schemas/Bytes'
TypeAllocationCode:
type: string
pattern: '^[0-9]{8}$'
HfcNId:
type: string
maxLength: 6
HfcNIdRm:
type: string
maxLength: 6
nullable: true
ENbId:
type: string
pattern: '^(MacroeNB-[A-Fa-f0-9]{5}|LMacroeNB-[A-Fa-f0-9]{6}|SMacroeNB-[A-Fa-f0-9]{5}|HomeeNB-[A-Fa-f0-9]{7})$'
Gli:
$ref: '#/components/schemas/Bytes'
#
# ENUMERATED DATA TYPES
#
AccessType:
type: string
enum:
- 3GPP_ACCESS
- NON_3GPP_ACCESS
AccessTypeRm:
anyOf:
- $ref: '#/components/schemas/AccessType'
- $ref: '#/components/schemas/NullValue'
RatType:
anyOf:
- type: string
enum:
- NR
- EUTRA
- WLAN
- VIRTUAL
- NBIOT
- WIRELINE
- WIRELINE_CABLE
- WIRELINE_DSL
- WIRELINE_PON
- LTE-M
- NR_U
- EUTRA_U
- TRUSTED_N3GA
- TRUSTED_WLAN
- UTRA
- GERA
- type: string
RatTypeRm:
allOf:
- $ref: '#/components/schemas/RatType'
nullable: true
PduSessionType:
anyOf:
- type: string
enum:
- IPV4
- IPV6
- IPV4V6
- UNSTRUCTURED
- ETHERNET
- type: string
PduSessionTypeRm:
anyOf:
- $ref: '#/components/schemas/PduSessionType'
- $ref: '#/components/schemas/NullValue'
UpIntegrity:
anyOf:
- type: string
enum:
- REQUIRED
- PREFERRED
- NOT_NEEDED
- type: string
UpIntegrityRm:
anyOf:
- $ref: '#/components/schemas/UpIntegrity'
- $ref: '#/components/schemas/NullValue'
UpConfidentiality:
anyOf:
- type: string
enum:
- REQUIRED
- PREFERRED
- NOT_NEEDED
- type: string
UpConfidentialityRm:
anyOf:
- $ref: '#/components/schemas/UpConfidentiality'
- $ref: '#/components/schemas/NullValue'
SscMode:
anyOf:
- type: string
enum:
- SSC_MODE_1
- SSC_MODE_2
- SSC_MODE_3
- type: string
SscModeRm:
anyOf:
- $ref: '#/components/schemas/SscMode'
- $ref: '#/components/schemas/NullValue'
DnaiChangeType:
anyOf:
- type: string
enum:
- EARLY
- EARLY_LATE
- LATE
- 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
- EARLY: Early notification of UP path reconfiguration.
- EARLY_LATE: Early and late notification of UP path reconfiguration. This value shall only be present in the subscription to the DNAI change event.
- LATE: Late notification of UP path reconfiguration.
DnaiChangeTypeRm:
anyOf:
- $ref: '#/components/schemas/DnaiChangeType'
- $ref: '#/components/schemas/NullValue'
RestrictionType:
anyOf:
- type: string
enum:
- ALLOWED_AREAS
- NOT_ALLOWED_AREAS
- type: string
RestrictionTypeRm:
anyOf:
- $ref: '#/components/schemas/RestrictionType'
- $ref: '#/components/schemas/NullValue'
CoreNetworkType:
anyOf:
- type: string
enum:
- 5GC
- EPC
- type: string
CoreNetworkTypeRm:
anyOf:
- $ref: '#/components/schemas/CoreNetworkType'
- $ref: '#/components/schemas/NullValue'
PresenceState:
anyOf:
- type: string
enum:
- IN_AREA
- OUT_OF_AREA
- UNKNOWN
- INACTIVE
- type: string
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
StationaryIndicationRm:
anyOf:
- $ref: '#/components/schemas/StationaryIndication'
- $ref: '#/components/schemas/NullValue'
ScheduledCommunicationType:
anyOf:
- type: string
enum:
- DOWNLINK_ONLY
- UPLINK_ONLY
- BIDIRECTIONAL
- type: string
ScheduledCommunicationTypeRm:
anyOf:
- $ref: '#/components/schemas/ScheduledCommunicationType'
- $ref: '#/components/schemas/NullValue'
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.
TrafficProfileRm:
anyOf:
- $ref: '#/components/schemas/TrafficProfile'
- $ref: '#/components/schemas/NullValue'
LcsServiceAuth:
anyOf:
- type: string
enum:
- "LOCATION_NOT_ALLOWED"
- "LOCATION_ALLOWED_WITH_NOTIFICATION"
- "LOCATION_ALLOWED_WITHOUT_NOTIFICATION"
- "LOCATION_ALLOWED_WITHOUT_RESPONSE"
- "LOCATION_RESTRICTED_WITHOUT_RESPONSE"
- "NOTIFICATION_ONLY"
- "NOTIFICATION_AND_VERIFICATION_ONLY"
- 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
- "LOCATION_NOT_ALLOWED": Indicates the start of MO Exception Data delivery.
- "STOP": Indicates the stop of MO Exception Data delivery.
- "LOCATION_NOT_ALLOWED": Location not allowed
- "LOCATION_ALLOWED_WITH_NOTIFICATION": Location allowed with notification
- "LOCATION_ALLOWED_WITHOUT_NOTIFICATION": Location allowed without notification
- "LOCATION_ALLOWED_WITHOUT_RESPONSE": Location with notification and privacy verification; location allowed if no response
- "LOCATION_RESTRICTED_WITHOUT_RESPONSE": Location with notification and privacy verification; location restricted if no response
- "NOTIFICATION_ONLY": Notification only
- "NOTIFICATION_AND_VERIFICATION_ONLY": Notification and privacy verification only
UeAuth:
anyOf:
- type: string
enum:
- AUTHORIZED
- NOT_AUTHORIZED
- type: string
DlDataDeliveryStatus:
anyOf:
- type: string
enum:
- BUFFERED
- TRANSMITTED
- DISCARDED
- 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
- BUFFERED: The first downlink data is buffered with extended buffering matching the source of the downlink traffic.
- TRANSMITTED: The first downlink data matching the source of the downlink traffic is transmitted after previous buffering or discarding of corresponding packet(s) because the UE of the PDU Session becomes ACTIVE, and buffered data can be delivered to UE.
- DISCARDED: The first downlink data matching the source of the downlink traffic is discarded because the Extended Buffering time, as determined by the SMF, expires or the amount of downlink data to be buffered is exceeded.
DlDataDeliveryStatusRm:
anyOf:
- $ref: '#/components/schemas/DlDataDeliveryStatus'
- $ref: '#/components/schemas/NullValue'
MoExceptionDataFlag:
anyOf:
- type: string
enum:
- START
- STOP
- 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
- "START": Indicates the start of MO Exception Data delivery.
- "STOP": Indicates the stop of MO Exception Data delivery.
#
# STRUCTURED DATA TYPES
#
Snssai:
type: object
properties:
sst:
type: integer
minimum: 0
maximum: 255
sd:
type: string
pattern: '^[A-Fa-f0-9]{6}$'
required:
- sst
PlmnId:
type: object
properties:
mcc:
$ref: '#/components/schemas/Mcc'
mnc:
$ref: '#/components/schemas/Mnc'
required:
- mcc
- mnc
PlmnIdRm:
type: object
properties:
mcc:
$ref: '#/components/schemas/Mcc'
mnc:
$ref: '#/components/schemas/Mnc'
required:
- mcc
- mnc
nullable: true
Tai:
type: object
properties:
plmnId:
$ref: '#/components/schemas/PlmnId'
tac:
$ref: '#/components/schemas/Tac'
nid:
$ref: '#/components/schemas/Nid'
required:
- plmnId
- tac
TaiRm:
type: object
properties:
plmnId:
$ref: '#/components/schemas/PlmnId'
tac:
$ref: '#/components/schemas/Tac'
nid:
$ref: '#/components/schemas/Nid'
required:
- plmnId
- tac
nullable: true
Ecgi:
type: object
properties:
plmnId:
$ref: '#/components/schemas/PlmnId'
# PLMN Identity
eutraCellId:
$ref: '#/components/schemas/EutraCellId'
nid:
$ref: '#/components/schemas/Nid'
required:
- plmnId
- eutraCellId
EcgiRm:
type: object
properties:
plmnId:
$ref: '#/components/schemas/PlmnId'
# PLMN Identity
eutraCellId:
$ref: '#/components/schemas/EutraCellId'
nid:
$ref: '#/components/schemas/Nid'
required:
- plmnId
- eutraCellId
nullable: true
Ncgi:
type: object
properties:
plmnId:
$ref: '#/components/schemas/PlmnId'
nrCellId:
$ref: '#/components/schemas/NrCellId'
nid:
$ref: '#/components/schemas/Nid'
required:
- plmnId
- nrCellId
NcgiRm:
type: object
properties:
plmnId:
$ref: '#/components/schemas/PlmnId'
nrCellId:
$ref: '#/components/schemas/NrCellId'
nid:
$ref: '#/components/schemas/Nid'
required:
- plmnId
- nrCellId
nullable: true
UserLocation:
type: object
properties:
eutraLocation:
$ref: '#/components/schemas/EutraLocation'
nrLocation:
$ref: '#/components/schemas/NrLocation'
n3gaLocation:
$ref: '#/components/schemas/N3gaLocation'
EutraLocation:
type: object
properties:
tai:
$ref: '#/components/schemas/Tai'
ecgi:
$ref: '#/components/schemas/Ecgi'
ignoreEcgi:
type: boolean
default: false
ageOfLocationInformation:
type: integer
minimum: 0
maximum: 32767
ueLocationTimestamp:
$ref: '#/components/schemas/DateTime'
geographicalInformation:
type: string
pattern: '^[0-9A-F]{16}$'
geodeticInformation:
type: string
pattern: '^[0-9A-F]{20}$'
globalNgenbId:
$ref: '#/components/schemas/GlobalRanNodeId'
globalENbId:
$ref: '#/components/schemas/GlobalRanNodeId'
required:
- tai
- ecgi
EutraLocationRm:
type: object
properties:
tai:
$ref: '#/components/schemas/Tai'
ecgi:
$ref: '#/components/schemas/Ecgi'
ageOfLocationInformation:
type: integer
minimum: 0
maximum: 32767
ueLocationTimestamp:
$ref: '#/components/schemas/DateTime'
geographicalInformation:
type: string
pattern: '^[0-9A-F]{16}$'
geodeticInformation:
type: string
pattern: '^[0-9A-F]{20}$'
globalNgenbId:
$ref: '#/components/schemas/GlobalRanNodeId'
globalENbId:
$ref: '#/components/schemas/GlobalRanNodeId'
required:
- tai
- ecgi
nullable: true
NrLocation:
type: object
properties:
tai:
$ref: '#/components/schemas/Tai'
ncgi:
$ref: '#/components/schemas/Ncgi'
ageOfLocationInformation:
type: integer
minimum: 0
maximum: 32767
ueLocationTimestamp:
$ref: '#/components/schemas/DateTime'
geographicalInformation:
type: string
pattern: '^[0-9A-F]{16}$'
geodeticInformation:
type: string
pattern: '^[0-9A-F]{20}$'
globalGnbId:
$ref: '#/components/schemas/GlobalRanNodeId'
required:
- tai
- ncgi
NrLocationRm:
type: object
properties:
tai:
$ref: '#/components/schemas/Tai'
ncgi:
$ref: '#/components/schemas/Ncgi'
ignoreNcgi:
type: boolean
default: false
ageOfLocationInformation:
type: integer
minimum: 0
maximum: 32767
ueLocationTimestamp:
$ref: '#/components/schemas/DateTime'
geographicalInformation:
type: string
pattern: '^[0-9A-F]{16}$'
geodeticInformation:
type: string
pattern: '^[0-9A-F]{20}$'
globalGnbId:
$ref: '#/components/schemas/GlobalRanNodeId'
required:
- tai
- ncgi
nullable: true
N3gaLocation:
type: object
properties:
n3gppTai:
$ref: '#/components/schemas/Tai'
n3IwfId:
type: string
pattern: '^[A-Fa-f0-9]+$'
ueIpv4Addr:
$ref: '#/components/schemas/Ipv4Addr'
ueIpv6Addr:
$ref: '#/components/schemas/Ipv6Addr'
portNumber:
$ref: '#/components/schemas/Uinteger'
ssId:
type: string
bssId:
type: string
civicAddress:
$ref: '#/components/schemas/Bytes'
hfcNodeId:
$ref: '#/components/schemas/HfcNodeId'
gli:
$ref: '#/components/schemas/Gli'
UpSecurity:
type: object
properties:
upIntegr:
$ref: '#/components/schemas/UpIntegrity'
upConfid:
$ref: '#/components/schemas/UpConfidentiality'
required:
- upIntegr
- upConfid
UpSecurityRm:
type: object
properties:
upIntegr:
$ref: '#/components/schemas/UpIntegrity'
upConfid:
$ref: '#/components/schemas/UpConfidentiality'
required:
- upIntegr
- upConfid
nullable: true
NgApCause:
type: object
properties:
group:
$ref: '#/components/schemas/Uinteger'
value:
$ref: '#/components/schemas/Uinteger'
required:
- group
- value
BackupAmfInfo:
type: object
properties:
backupAmf:
$ref: '#/components/schemas/AmfName'
guamiList:
type: array
items:
$ref: '#/components/schemas/Guami'
minItems: 1
required:
- backupAmf
RefToBinaryData:
type: object
properties:
contentId:
type: string
required:
- contentId
RefToBinaryDataRm:
type: object
properties:
contentId:
type: string
required:
- contentId
nullable: true
RouteToLocation:
type: object
properties:
dnai:
$ref: '#/components/schemas/Dnai'
routeInfo:
$ref: '#/components/schemas/RouteInformation'
routeProfId:
type: string
nullable: true
required:
- dnai
anyOf:
- required: [ routeInfo ]
- required: [ routeProfId ]
nullable: true
RouteInformation:
type: object
properties:
ipv4Addr:
$ref: '#/components/schemas/Ipv4Addr'
ipv6Addr:
$ref: '#/components/schemas/Ipv6Addr'
portNumber:
$ref: '#/components/schemas/Uinteger'
required:
- portNumber
nullable: true
SubscribedDefaultQos:
type: object
required:
- 5qi
- arp
properties:
5qi:
$ref: '#/components/schemas/5Qi'
arp:
$ref: '#/components/schemas/Arp'
priorityLevel:
$ref: '#/components/schemas/5QiPriorityLevel'
Area:
type: object
oneOf:
- required:
- tacs
- required:
- areaCode
properties:
tacs:
type: array
items:
$ref: '#/components/schemas/Tac'
minItems: 1
areaCode:
$ref: '#/components/schemas/AreaCode'
ServiceAreaRestriction:
type: object
properties:
restrictionType:
$ref: '#/components/schemas/RestrictionType'
areas:
type: array
items:
$ref: '#/components/schemas/Area'
maxNumOfTAs:
$ref: '#/components/schemas/Uinteger'
maxNumOfTAsForNotAllowedAreas:
$ref: '#/components/schemas/Uinteger'
allOf:
#
# 1st condition: restrictionType and areas attributes shall be either both absent
# or both present
#
- oneOf:
- not:
required: [ restrictionType ]
- required: [ areas ]
#
# 2nd condition: if restrictionType takes value NOT_ALLOWED_AREAS,
# then maxNumOfTAs shall be absent
#
- anyOf:
- not:
required: [ restrictionType ]
properties:
restrictionType:
type: string
enum: [ NOT_ALLOWED_AREAS ]
- not:
required: [ maxNumOfTAs ]
#
# 3rd condition: if restrictionType takes value ALLOWED_AREAS,
# then maxNumOfTAsForNotAllowedAreas shall be absent
#
- anyOf:
- not:
required: [ restrictionType ]
properties:
restrictionType:
type: string
enum: [ ALLOWED_AREAS ]
- not:
required: [ maxNumOfTAsForNotAllowedAreas ]
WirelineArea:
type: object
properties:
globalLineIds:
type: array
items:
$ref: '#/components/schemas/Gli'
minItems: 1
hfcNIds:
type: array
items:
$ref: '#/components/schemas/HfcNId'
minItems: 1
areaCodeB:
$ref: '#/components/schemas/AreaCode'
areaCodeC:
$ref: '#/components/schemas/AreaCode'
WirelineServiceAreaRestriction:
type: object
properties:
restrictionType:
$ref: '#/components/schemas/RestrictionType'
areas:
type: array
items:
$ref: '#/components/schemas/WirelineArea'
PresenceInfo:
type: object
properties:
praId:
type: string
presenceState:
$ref: '#/components/schemas/PresenceState'
trackingAreaList:
type: array
items:
$ref: '#/components/schemas/Tai'
minItems: 1
ecgiList:
type: array
items:
$ref: '#/components/schemas/Ecgi'
minItems: 1
ncgiList:
type: array
items:
$ref: '#/components/schemas/Ncgi'
minItems: 1
globalRanNodeIdList:
type: array
items:
$ref: '#/components/schemas/GlobalRanNodeId'
minItems: 1
globaleNbIdList:
type: array
items:
$ref: '#/components/schemas/GlobalRanNodeId'
minItems: 1
PresenceInfoRm:
type: object
properties:
praId:
type: string
presenceState:
$ref: '#/components/schemas/PresenceState'
trackingAreaList:
type: array
items:
$ref: '#/components/schemas/Tai'
minItems: 0
ecgiList:
type: array
items:
$ref: '#/components/schemas/Ecgi'
minItems: 0
ncgiList:
type: array
items:
$ref: '#/components/schemas/Ncgi'
minItems: 0
globalRanNodeIdList:
type: array
items:
$ref: '#/components/schemas/GlobalRanNodeId'
globaleNbIdList:
type: array
items:
$ref: '#/components/schemas/GlobalRanNodeId'
minItems: 1
nullable: true
GlobalRanNodeId:
type: object
properties:
plmnId:
$ref: '#/components/schemas/PlmnId'
n3IwfId:
$ref: '#/components/schemas/N3IwfId'
gNbId:
$ref: '#/components/schemas/GNbId'
ngeNbId:
$ref: '#/components/schemas/NgeNbId'
nid:
$ref: '#/components/schemas/Nid'
eNbId:
$ref: '#/components/schemas/ENbId'
oneOf:
- required: [ n3IwfId ]
- required: [ gNbId ]
- required: [ ngeNbId ]
- required: [ eNbId ]
required:
- plmnId
GNbId:
type: object
properties:
bitLength:
type: integer
minimum: 22
maximum: 32
gNBValue:
type: string
pattern: '^[A-Fa-f0-9]{6,8}$'
required:
- bitLength
- gNBValue
AtsssCapability:
type: object
properties:
atsssLL:
type: boolean
default: false
mptcp:
type: boolean
default: false
PlmnIdNid:
type: object
required:
- mcc
- mnc
properties:
mcc:
$ref: '#/components/schemas/Mcc'
mnc:
$ref: '#/components/schemas/Mnc'
nid:
$ref: '#/components/schemas/Nid'
SmallDataRateStatus:
type: object
properties:
remainPacketsUl:
type: integer
minimum: 0
remainPacketsDl:
type: integer
minimum: 0
validityTime:
$ref: '#/components/schemas/DateTime'
remainExReportsUl:
type: integer
minimum: 0
remainExReportsDl:
type: integer
minimum: 0
ApnRateStatus:
type: object
properties:
remainPacketsUl:
type: integer
minimum: 0
remainPacketsDl:
type: integer
minimum: 0
validityTime:
$ref: '#/components/schemas/DateTime'
remainExReportsUl:
type: integer
minimum: 0
remainExReportsDl:
type: integer
minimum: 0
HfcNodeId:
type: object
required:
- hfcNId
properties:
hfcNId:
$ref: '#/components/schemas/HfcNId'
HfcNodeIdRm:
type: object
required:
- hfcNId
properties:
hfcNId:
$ref: '#/components/schemas/HfcNId'
nullable: true
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'
ScheduledCommunicationTimeRm:
anyOf:
- $ref: '#/components/schemas/ScheduledCommunicationTime'
- $ref: '#/components/schemas/NullValue'
BatteryIndication:
type: object
properties:
batteryInd:
type: boolean
replaceableInd:
type: boolean
rechargeableInd:
type: boolean
BatteryIndicationRm:
anyOf:
- $ref: '#/components/schemas/BatteryIndication'
- $ref: '#/components/schemas/NullValue'
AcsInfo:
type: object
properties:
acsUrl:
$ref: '#/components/schemas/Uri'
acsIpv4Addr:
$ref: '#/components/schemas/Ipv4Addr'
acsIpv6Addr:
$ref: '#/components/schemas/Ipv6Addr'
AcsInfoRm:
anyOf:
- $ref: '#/components/schemas/AcsInfo'
- $ref: '#/components/schemas/NullValue'
NrV2xAuth:
type: object
properties:
vehicleUeAuth:
$ref: '#/components/schemas/UeAuth'
pedestrianUeAuth:
$ref: '#/components/schemas/UeAuth'
LteV2xAuth:
type: object
properties:
vehicleUeAuth:
$ref: '#/components/schemas/UeAuth'
pedestrianUeAuth:
$ref: '#/components/schemas/UeAuth'
Pc5QoSPara:
type: object
required:
- pc5QosFlowList
properties:
pc5QosFlowList:
type: array
items:
$ref: '#/components/schemas/Pc5QosFlowItem'
pc5LinkAmbr:
$ref: '#/components/schemas/BitRate'
Pc5QosFlowItem:
type: object
required:
- pqi
properties:
pqi:
$ref: '#/components/schemas/5Qi'
pc5FlowBitRates:
$ref: '#/components/schemas/Pc5FlowBitRates'
range:
$ref: '#/components/schemas/Uinteger'
Pc5FlowBitRates:
type: object
properties:
guaFbr:
$ref: '#/components/schemas/BitRate'
maxFbr:
$ref: '#/components/schemas/BitRate'
UtraLocation:
type: object
oneOf:
- required:
- cgi
- required:
- sai
- required:
- rai
properties:
cgi:
$ref: '#/components/schemas/CellGlobalId'
sai:
$ref: '#/components/schemas/ServiceAreaId'
lai:
$ref: '#/components/schemas/LocationAreaId'
rai:
$ref: '#/components/schemas/RoutingAreaId'
ageOfLocationInformation:
type: integer
minimum: 0
maximum: 32767
ueLocationTimestamp:
$ref: '#/components/schemas/DateTime'
geographicalInformation:
type: string
pattern: '^[0-9A-F]{16}$'
geodeticInformation:
type: string
pattern: '^[0-9A-F]{20}$'
GeraLocation:
type: object
oneOf:
- required:
- cgi
- required:
- sai
- required:
- rai
properties:
locationNumber:
type: string
cgi:
$ref: '#/components/schemas/CellGlobalId'
sai:
$ref: '#/components/schemas/ServiceAreaId'
lai:
$ref: '#/components/schemas/LocationAreaId'
vlrNumber:
type: string
mscNumber:
type: string
ageOfLocationInformation:
type: integer
minimum: 0
maximum: 32767
ueLocationTimestamp:
$ref: '#/components/schemas/DateTime'
geographicalInformation:
type: string
pattern: '^[0-9A-F]{16}$'
geodeticInformation:
type: string
pattern: '^[0-9A-F]{20}$'
CellGlobalId:
type: object
required:
- plmnId
- lac
- cellId
properties:
plmnId:
$ref: '#/components/schemas/PlmnId'
lac:
type: string
cellId:
type: string
pattern: '^[A-Fa-f0-9]$'
ServiceAreaId:
type: object
required:
- plmnId
- lac
- sac
properties:
plmnId:
$ref: '#/components/schemas/PlmnId'
lac:
type: string
pattern: '^[A-Fa-f0-9]$'
sac:
type: string
pattern: '^[A-Fa-f0-9]$'
LocationAreaId:
type: object
required:
- plmnId
- lac
properties:
plmnId:
$ref: '#/components/schemas/PlmnId'
lac:
type: string
pattern: '^[A-Fa-f0-9]$'
RoutingAreaId:
type: object
required:
- plmnId
- lac
- rac
properties:
plmnId:
$ref: '#/components/schemas/PlmnId'
lac:
type: string
pattern: '^[A-Fa-f0-9]$'
rac:
type: string
pattern: '^[A-Fa-f0-9]$'
DddTrafficDescriptor:
type: object
properties:
ipv4Addr:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
ipv6Addr:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'
portNumber:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
macAddr:
$ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48'
MoExpDataCounter:
type: object
required:
- counter
properties:
counter:
type: integer
timeStamp:
$ref: '#/components/schemas/DateTime'
#
# Data Types related to 5G QoS as defined in clause 5.5
#
#
# SIMPLE DATA TYPES
#
#
Qfi:
type: integer
minimum: 0
maximum: 63
QfiRm:
type: integer
minimum: 0
maximum: 63
nullable: true
5Qi:
type: integer
minimum: 0
maximum: 255
5QiRm:
type: integer
minimum: 0
maximum: 255
nullable: true
BitRate:
type: string
pattern: '^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$'
BitRateRm:
type: string
pattern: '^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$'
nullable: true
ArpPriorityLevelRm:
type: integer
minimum: 1
maximum: 15
nullable: true
ArpPriorityLevel:
type: integer
minimum: 1
maximum: 15
nullable: true
description: nullable true shall not be used for this attribute
5QiPriorityLevel:
type: integer
minimum: 1
maximum: 127
5QiPriorityLevelRm:
type: integer
minimum: 1
maximum: 127
nullable: true
PacketDelBudget:
type: integer
minimum: 1
PacketDelBudgetRm:
type: integer
minimum: 1
nullable: true
PacketErrRate:
type: string
pattern: '^([0-9]E-[0-9])$'
PacketErrRateRm:
type: string
pattern: '^([0-9]E-[0-9])$'
nullable: true
PacketLossRate:
type: integer
minimum: 0
maximum: 1000
PacketLossRateRm:
type: integer
minimum: 0
maximum: 1000
nullable: true
AverWindow:
type: integer
minimum: 1
maximum: 4095
default: 2000
AverWindowRm:
type: integer
maximum: 4095
default: 2000
minimum: 1
nullable: true
MaxDataBurstVol:
type: integer
minimum: 1
maximum: 4095
MaxDataBurstVolRm:
type: integer
minimum: 1
maximum: 4095
nullable: true
SamplingRatio:
type: integer
minimum: 1
maximum: 100
SamplingRatioRm:
type: integer
minimum: 1
maximum: 100
nullable: true
RgWirelineCharacteristics:
$ref: '#/components/schemas/Bytes'
RgWirelineCharacteristicsRm:
allOf:
- $ref: '#/components/schemas/RgWirelineCharacteristics'
- nullable: true
ExtMaxDataBurstVol:
type: integer
minimum: 4096
maximum: 2000000
ExtMaxDataBurstVolRm:
type: integer
minimum: 4096
maximum: 2000000
nullable: true
#
# ENUMERATED DATA TYPES
#
PreemptionCapability:
anyOf:
- type: string
enum:
- NOT_PREEMPT
- MAY_PREEMPT
- type: string
PreemptionCapabilityRm:
anyOf:
- $ref: '#/components/schemas/PreemptionCapability'
- $ref: '#/components/schemas/NullValue'
PreemptionVulnerability:
anyOf:
- type: string
enum:
- NOT_PREEMPTABLE
- PREEMPTABLE
- type: string
PreemptionVulnerabilityRm:
anyOf:
- $ref: '#/components/schemas/PreemptionVulnerability'
- $ref: '#/components/schemas/NullValue'
ReflectiveQoSAttribute:
anyOf:
- type: string
enum:
- RQOS
- NO_RQOS
- type: string
ReflectiveQoSAttributeRm:
anyOf:
- $ref: '#/components/schemas/ReflectiveQoSAttribute'
- $ref: '#/components/schemas/NullValue'
NotificationControl:
anyOf:
- type: string
enum:
- REQUESTED
- NOT_REQUESTED
- type: string
NotificationControlRm:
anyOf:
- $ref: '#/components/schemas/NotificationControl'
- $ref: '#/components/schemas/NullValue'
QosResourceType:
anyOf:
- type: string
enum:
- NON_GBR
- NON_CRITICAL_GBR
- CRITICAL_GBR
- type: string
QosResourceTypeRm:
anyOf:
- $ref: '#/components/schemas/QosResourceType'
- $ref: '#/components/schemas/NullValue'
AdditionalQosFlowInfo:
anyOf:
- anyOf:
- type: string
enum:
- MORE_LIKELY
- type: string
- $ref: '#/components/schemas/NullValue'
#
#
# STRUCTURED DATA TYPES
#
Arp:
type: object
properties:
priorityLevel:
$ref: '#/components/schemas/ArpPriorityLevel'
preemptCap:
$ref: '#/components/schemas/PreemptionCapability'
preemptVuln:
$ref: '#/components/schemas/PreemptionVulnerability'
required:
- priorityLevel
- preemptCap
- preemptVuln
ArpRm:
type: object
properties:
priorityLevel:
$ref: '#/components/schemas/ArpPriorityLevel'
preemptCap:
$ref: '#/components/schemas/PreemptionCapability'
preemptVuln:
$ref: '#/components/schemas/PreemptionVulnerability'
required:
- priorityLevel
- preemptCap
- preemptVuln
nullable: true
Ambr:
type: object
properties:
uplink:
$ref: '#/components/schemas/BitRate'
downlink:
$ref: '#/components/schemas/BitRate'
required:
- uplink
- downlink
AmbrRm:
type: object
properties:
uplink:
$ref: '#/components/schemas/BitRate'
downlink:
$ref: '#/components/schemas/BitRate'
required:
- uplink
- downlink
nullable: true
Dynamic5Qi:
type: object
properties:
resourceType:
$ref: '#/components/schemas/QosResourceType'
priorityLevel:
$ref: '#/components/schemas/5QiPriorityLevel'
packetDelayBudget:
$ref: '#/components/schemas/PacketDelBudget'
packetErrRate:
$ref: '#/components/schemas/PacketErrRate'
averWindow:
$ref: '#/components/schemas/AverWindow'
maxDataBurstVol:
$ref: '#/components/schemas/MaxDataBurstVol'
extMaxDataBurstVol:
$ref: '#/components/schemas/ExtMaxDataBurstVol'
required:
- resourceType
- priorityLevel
- packetDelayBudget
- packetErrRate
NonDynamic5Qi:
type: object
properties:
priorityLevel:
$ref: '#/components/schemas/5QiPriorityLevel'
averWindow:
$ref: '#/components/schemas/AverWindow'
maxDataBurstVol:
$ref: '#/components/schemas/MaxDataBurstVol'
extMaxDataBurstVol:
$ref: '#/components/schemas/ExtMaxDataBurstVol'
minProperties: 0
Tmbr:
type: object
properties:
uplink:
$ref: '#/components/schemas/BitRate'
downlink:
$ref: '#/components/schemas/BitRate'
required:
- uplink
- downlink
TmbrRm:
anyOf:
- $ref: '#/components/schemas/Tmbr'
- $ref: '#/components/schemas/NullValue'
#
# Data Types related to 5G Trace as defined in clause 5.6
#
#
# SIMPLE DATA TYPES
#
#
#
# Enumerations
#
TraceDepth:
anyOf:
- type: string
enum:
- MINIMUM
- MEDIUM
- MAXIMUM
- MINIMUM_WO_VENDOR_EXTENSION
- MEDIUM_WO_VENDOR_EXTENSION
- MAXIMUM_WO_VENDOR_EXTENSION
- type: string
TraceDepthRm:
anyOf:
- $ref: '#/components/schemas/TraceDepth'
- $ref: '#/components/schemas/NullValue'
#
# STRUCTURED DATA TYPES
#
TraceData:
type: object
nullable: true
properties:
traceRef:
type: string
pattern: '^[0-9]{3}[0-9]{2,3}-[A-Fa-f0-9]{6}$'
traceDepth:
$ref: '#/components/schemas/TraceDepth'
neTypeList:
type: string
pattern: '^[A-Fa-f0-9]+$'
eventList:
type: string
pattern: '^[A-Fa-f0-9]+$'
collectionEntityIpv4Addr:
$ref: '#/components/schemas/Ipv4Addr'
collectionEntityIpv6Addr:
$ref: '#/components/schemas/Ipv6Addr'
interfaceList:
type: string
pattern: '^[A-Fa-f0-9]+$'
required:
- traceRef
- traceDepth
- neTypeList
- eventList
# Data Types related to 5G ODB as defined in clause 5.7
#
# SIMPLE DATA TYPES
#
#
#
# Enumerations
#
RoamingOdb:
anyOf:
- type: string
enum:
- OUTSIDE_HOME_PLMN
- OUTSIDE_HOME_PLMN_COUNTRY
- type: string
OdbPacketServices:
anyOf:
- anyOf:
- type: string
enum:
- ALL_PACKET_SERVICES
- ROAMER_ACCESS_HPLMN_AP
- ROAMER_ACCESS_VPLMN_AP
- type: string
- $ref: '#/components/schemas/NullValue'
#
# STRUCTURED DATA TYPES
#
OdbData:
type: object
properties:
roamingOdb:
$ref: '#/components/schemas/RoamingOdb'
#
# Data Types related to Charging as defined in clause 5.8
#
#
# SIMPLE DATA TYPES
#
#
ChargingId:
$ref: '#/components/schemas/Uint32'
ApplicationChargingId:
type: string
RatingGroup:
$ref: '#/components/schemas/Uint32'
ServiceId:
$ref: '#/components/schemas/Uint32'
#
# Enumerations
#
#
# STRUCTURED DATA TYPES
#
SecondaryRatUsageReport:
type: object
properties:
secondaryRatType:
$ref: '#/components/schemas/RatType'
qosFlowsUsageData:
type: array
items:
$ref: '#/components/schemas/QosFlowUsageReport'
minItems: 1
required:
- secondaryRatType
- qosFlowsUsageData
QosFlowUsageReport:
type: object
properties:
qfi:
$ref: '#/components/schemas/Qfi'
startTimeStamp:
$ref: '#/components/schemas/DateTime'
endTimeStamp:
$ref: '#/components/schemas/DateTime'
downlinkVolume:
$ref: '#/components/schemas/Int64'
uplinkVolume:
$ref: '#/components/schemas/Int64'
required:
- qfi
- startTimeStamp
- endTimeStamp
- downlinkVolume
- uplinkVolume
SecondaryRatUsageInfo:
type: object
properties:
secondaryRatType:
$ref: '#/components/schemas/RatType'
qosFlowsUsageData:
type: array
items:
$ref: '#/components/schemas/QosFlowUsageReport'
minItems: 1
pduSessionUsageData:
type: array
items:
$ref: '#/components/schemas/VolumeTimedReport'
minItems: 1
required:
- secondaryRatType
VolumeTimedReport:
type: object
properties:
startTimeStamp:
$ref: '#/components/schemas/DateTime'
endTimeStamp:
$ref: '#/components/schemas/DateTime'
downlinkVolume:
$ref: '#/components/schemas/Int64'
uplinkVolume:
$ref: '#/components/schemas/Int64'
required:
- startTimeStamp
- endTimeStamp
- downlinkVolume
- uplinkVolume
#
# HTTP responses
#
responses:
'400':
description: Bad request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: Unauthorized
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'405':
description: Method Not Allowed
'408':
description: Request Timeout
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'406':
description: 406 Not Acceptable
'409':
description: Conflict
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'410':
description: Gone
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'411':
description: Length Required
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'412':
description: Precondition Failed
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'413':
description: Payload Too Large
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'414':
description: URI Too Long
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'415':
description: Unsupported Media Type
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'429':
description: Too Many Requests
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'500':
description: Internal Server Error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'501':
description: Not Implemented
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'503':
description: Service Unavailable
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'504':
description: Gateway Timeout
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
default:
description: Generic Error
1
https://gitee.com/kenny.w.zhang/v5GC_APIs.git
git@gitee.com:kenny.w.zhang/v5GC_APIs.git
kenny.w.zhang
v5GC_APIs
5GC_APIs
master

搜索帮助

14c37bed 8189591 565d56ea 8189591