{"openapi":"3.0.0","info":{"title":"5gCore-UE","description":"This is a sample UE server.\n","contact":{"email":"albertlost323@gmail.com"},"license":{"name":"The MIT Lisence","url":"https://lostpoet.mit-license.org/"},"version":"1.0.0"},"servers":[{"description":"SwaggerHub API Auto Mocking","url":"https://virtserver.swaggerhub.com/LostPoet/5gCore-UE/1.0.0"},{"url":"{apiRoot}/5gcore-ue/v1","variables":{"apiRoot":{"description":"apiRoot as defined in clause clause 4.4 of 3GPP TS 29.501","default":"https://example.com"}}}],"paths":{"/n1-interface":{"post":{"tags":["Transfer NAS message with AMF"],"operationId":"n1_interface","parameters":[{"name":"messageType","in":"query","description":"indicate the messages type","required":false,"style":"form","explode":true,"schema":{"pattern":"^[A-Z_]+$","type":"string"}}],"responses":{"200":{"description":"Successfully Accept"},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"},"default":{"description":"Unexpected Error"}},"x-openapi-router-controller":"ue1.controllers.transfer_nas_message_with_amf_controller"}},"/rrc-connetion":{"post":{"tags":["Connection with AN"],"operationId":"rrc_connection","parameters":[{"name":"messageType","in":"query","description":"indicate the messages type","required":true,"style":"form","explode":true,"schema":{"pattern":"^[A-Z_]+$","type":"string"}}],"responses":{"200":{"description":"Successfully Accept"},"500":{"description":"Internal Server Error"},"default":{"description":"Unexpected Error"}},"x-openapi-router-controller":"ue1.controllers.connection_with_an_controller"}},"/upf-datalink":{"post":{"tags":["Interact with UPF (via AN)"],"summary":"transfer data with UPF","operationId":"upf_datalink","parameters":[{"name":"pduSessionId","in":"query","description":"indicate the PDU Session ID","required":true,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/PduSessionId"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpfDataFlow"}}},"required":true},"responses":{"200":{"description":"Successfully Accept"},"500":{"description":"Internal Server Error"},"default":{"description":"Unexpected Error"}},"x-openapi-router-controller":"ue1.controllers.interact_with_upf_via_an_controller"}}},"components":{"schemas":{"5gSTmsi":{"required":["prefix","tmsi"],"type":"object","properties":{"prefix":{"$ref":"#/components/schemas/amfSetIdAndAmfPointer"},"tmsi":{"$ref":"#/components/schemas/5gTmsi"}}},"amfSetIdAndAmfPointer":{"pattern":"^[A-Fa-f0-9]{4}$","type":"string"},"5gTmsi":{"pattern":"^[A-Fa-f0-9]{8}$","type":"string"},"5gGuti":{"required":["guami","tmsi"],"properties":{"guami":{"$ref":"#/components/schemas/Guami"},"tmsi":{"$ref":"#/components/schemas/5gTmsi"}},"type":"object"},"RegistrationType":{"type":"string","enum":["INITIAL_REGISTRATION","MOBILITY_REGISTRATION_UPDATE","PERIODIC_REGISTRATION_UPDATE","EMERGENCY_REGISTRATION"]},"suci":{"pattern":"^(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]+)$","type":"string"},"UpfDataFlow":{"required":["data","dataType"],"type":"object","properties":{"data":{"type":"string"},"dataType":{"type":"string","enum":["UPLINK","DOWNLINK"]}}},"Guami":{"required":["amfId","plmnId"],"type":"object","properties":{"plmnId":{"$ref":"#/components/schemas/PlmnId"},"amfId":{"$ref":"#/components/schemas/AmfId"}}},"PlmnId":{"required":["mcc","mnc"],"type":"object","properties":{"mcc":{"$ref":"#/components/schemas/Mcc"},"mnc":{"$ref":"#/components/schemas/Mnc"}}},"Mcc":{"pattern":"^\\d{3}$","type":"string"},"Mnc":{"pattern":"^\\d{2,3}$","type":"string"},"AmfId":{"pattern":"^[A-Fa-f0-9]{6}$","type":"string"},"Pei":{"pattern":"^(imei-[0-9]{15}|imeisv-[0-9]{16}|mac([0-9a-fA-F]{2})((-[0-9a-fA-F]{2}){5})|.+)$","type":"string","example":"2769169126891"},"Area":{"type":"object","properties":{"tacs":{"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/Tac"}},"areaCode":{"$ref":"#/components/schemas/AreaCode"}},"oneOf":[{"required":["tacs"]},{"required":["areaCode"]}]},"AreaCode":{"type":"string"},"Tac":{"pattern":"^([A-Fa-f0-9]{4})|([A-Fa-f0-9]{6})$","type":"string"},"Snssai":{"required":["sst"],"type":"object","properties":{"sst":{"maximum":255,"minimum":0,"type":"integer"},"sd":{"pattern":"^[A-Fa-f0-9]{6}$","type":"string"}}},"Dnn":{"type":"string"},"PduSessionId":{"maximum":255,"minimum":0,"type":"integer"},"RequestType":{"description":"Possible values are - INITIAL_REQUEST - EXISTING_PDU_SESSION - INITIAL_EMERGENCY_REQUEST - EXISTING_EMERGENCY_PDU_SESSION\n","anyOf":[{"type":"string","enum":["INITIAL_REQUEST","EXISTING_PDU_SESSION","INITIAL_EMERGENCY_REQUEST","EXISTING_EMERGENCY_PDU_SESSION"]},{"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.\n"}]},"N1MessageContainer":{"required":["n1MessageClass","n1MessageContent"],"type":"object","properties":{"n1MessageClass":{"$ref":"#/components/schemas/N1MessageClass"},"n1MessageContent":{"$ref":"#/components/schemas/RefToBinaryData"},"nfId":{"$ref":"#/components/schemas/NfInstanceId"},"serviceInstanceId":{"type":"string"}}},"N1MessageClass":{"anyOf":[{"type":"string","enum":["5GMM","SM","LPP","SMS","UPDP","LCS"]},{"type":"string"}]},"RefToBinaryData":{"required":["contentId"],"type":"object","properties":{"contentId":{"type":"string"}}},"NfInstanceId":{"type":"string","format":"uuid"},"PduSessionType":{"anyOf":[{"type":"string","enum":["IPV4","IPV6","IPV4V6","UNSTRUCTURED","ETHERNET"]},{"type":"string"}]},"sscMode":{"pattern":"^[0-7]$","type":"string"},"MaxIntegrityProtectedDataRate":{"description":"Possible values are\n  - 64_KBPS\n  - MAX_UE_RATE\n","anyOf":[{"type":"string","enum":["64_KBPS","MAX_UE_RATE"]},{"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.\n"}]},"Teid":{"pattern":"^[A-F0-9]{8}$","type":"string"},"TunnelInfo":{"required":["gtpTeid"],"type":"object","properties":{"ipv4Addr":{"$ref":"#/components/schemas/Ipv4Addr"},"ipv6Addr":{"$ref":"#/components/schemas/Ipv6Addr"},"gtpTeid":{"$ref":"#/components/schemas/Teid"},"anType":{"$ref":"#/components/schemas/AccessType"}}},"Tai":{"required":["plmnId","tac"],"type":"object","properties":{"plmnId":{"$ref":"#/components/schemas/PlmnId"},"tac":{"$ref":"#/components/schemas/Tac"},"nid":{"$ref":"#/components/schemas/Nid"}}},"Nid":{"pattern":"^[A-Fa-f0-9]{13}$","type":"string"},"GlobalRanNodeId":{"required":["plmnId"],"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"]}]},"N3IwfId":{"pattern":"^[A-Fa-f0-9]+$","type":"string"},"GNbId":{"required":["bitLength","gNBValue"],"type":"object","properties":{"bitLength":{"maximum":32,"minimum":22,"type":"integer"},"gNBValue":{"pattern":"^[A-Fa-f0-9]{6,8}$","type":"string"}},"example":{"bitLength":27,"gNBValue":"gNBValue"}},"NgeNbId":{"pattern":"^(MacroNGeNB-[A-Fa-f0-9]{5}|LMacroNGeNB-[A-Fa-f0-9]{6}|SMacroNGeNB-[A-Fa-f0-9]{5})$","type":"string"},"ENbId":{"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})$","type":"string"},"AccessType":{"type":"string","enum":["3GPP_ACCESS","NON_3GPP_ACCESS"]},"CorrelationID":{"maxLength":255,"minLength":1,"type":"string"},"Ipv4Addr":{"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])$","type":"string","example":"198.51.100.1"},"Ipv6Addr":{"type":"string","example":"2001:db8:85a3::8a2e:370:7334","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}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$"}]}}}}