A.2 Nsoraf_SOR API
29.5503GPP5G SystemRelease 18Stage 3Steering of roaming application function servicesTS
openapi: 3.0.0
info:
title: ‘Nsoraf_SOR’
version: 1.2.0-alpha.1
description: |
Nsoraf Steering Of Roaming Service.
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.550 V18.0.0; Steering Of Roaming Application Function Services.
url: http://www.3gpp.org/ftp/Specs/archive/29_series/29.550/
servers:
– url: ‘{apiRoot}/nsoraf-sor/v1’
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501
security:
– {}
– oAuth2ClientCredentials:
– nsoraf-sor
paths:
/{supi}/sor-information:
get:
summary: retrieve the steering of roaming information for a UE
operationId: GetSorInformation
tags:
– SoR Information Retrieval
parameters:
– name: supi
in: path
description: Identifier of the UE
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
– name: supported-features
in: query
description: Supported Features
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
– name: plmn-id
in: query
description: serving PLMN ID or SNPN ID
required: true
content:
application/json:
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PlmnIdNid’
– name: access-type
in: query
description: Access type used by the UE
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/AccessType’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/SorInformation’
headers:
Cache-Control:
description: Cache-Control (as described in RFC 7234) with value "no-cache" to indicate that the returned SoR information should not be cached
schema:
type: string
‘307’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/307’
‘308’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/308’
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘401’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/401’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
‘406’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/406’
‘429’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/429’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘502’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/502’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
default:
description: Unexpected error
/{supi}/sor-information/sor-ack:
put:
summary: SoR Acknowledgment Reception Notification
operationId: SorAckInfo
tags:
– Providing the reception status of the acknowledgement of Steering of Roaming information reception by the UE
parameters:
– name: supi
in: path
description: Identifier of the UE
required: true
schema:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
requestBody:
required: true
content:
application/json:
schema:
$ref: ‘#/components/schemas/SorAckInfo’
responses:
‘204’:
description: Successful reception of the indication
‘307’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/307’
‘308’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/308’
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘401’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/401’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
‘429’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/429’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘502’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/502’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
default:
description: Unexpected error
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: ‘{nrfApiRoot}/oauth2/token’
scopes:
nsoraf-sor: Access to the Nsoraf_SOR API
schemas:
#
# COMPLEX DATA TYPES
#
SorInformation:
description: Represents the SoR information to be conveyed to a UE.
type: object
required:
– sorAckIndication
– sorSendingTime
properties:
supportedFeatures:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
steeringContainer:
$ref: ‘#/components/schemas/SteeringContainer’
sorAckIndication:
type: boolean
sorCmci:
$ref: ‘TS29503_Nudm_SDM.yaml#/components/schemas/SorCmci’
storeSorCmciInMe:
type: boolean
sorSendingTime:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’
SorAckInfo:
description: >
Represents an indication to the SOR-AF on the reception status of the
acknowledgment of successful reception of SoR Information by a UE.
type: object
required:
– sorAckStatus
– sorSendingTime
properties:
sorAckStatus:
$ref: ‘#/components/schemas/SorAckStatus’
sorSendingTime:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’
meSupportOfSorCmci:
type: boolean
SteeringContainer:
description: It consists of either a list (array) of SteeringInfo objects or a Secured Packet
oneOf:
– type: array
items:
$ref: ‘#/components/schemas/SteeringInfo’
minItems: 1
– $ref: ‘TS29509_Nausf_SoRProtection.yaml#/components/schemas/SecuredPacket’
SteeringInfo:
description: >
Contains either a PLMN-ID, an SNPN-ID or a GIN and, for the case of PLMNs, zero or more
preferred access technologies for accessing such PLMN
type: object
oneOf:
– required: [ plmnId ]
– required: [ snpnId ]
– required: [ gin ]
properties:
plmnId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PlmnId’
snpnId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PlmnIdNid’
gin:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/PlmnIdNid’
accessTechList:
type: array
items:
$ref: ‘TS29509_Nausf_SoRProtection.yaml#/components/schemas/AccessTech’
minItems: 1
#
# ENUMS
#
SorAckStatus:
description: >
Represents the reception status of the acknowledgment of successful reception of
SoR Information by a UE.
anyOf:
– type: string
enum:
– ACK_SUCCESSFUL
– ACK_NOT_RECEIVED
– ACK_NOT_SUCCESSFUL
– type: string
Annex B (informative):
Change history
|
Change history |
|||||||
|
Date |
Meeting |
TDoc |
CR |
Rev |
Cat |
Subject/Comment |
New version |
|
2019-11 |
CT4#95 |
C4-195242 |
Initial Draft. |
0.1.0 |
|||
|
2020-03 |
CT4#96e |
C4-200833 |
Pseudo-CR on the scope part of SOR-AF API |
0.2.0 |
|||
|
2020-03 |
CT4#96e |
C4-201197 |
Pseudo-CR on the overview part of SOR-AF API |
0.2.0 |
|||
|
2020-03 |
CT4#96e |
C4-201198 |
Pseudo-CR on the definition of Nsoraf service |
0.2.0 |
|||
|
2020-03 |
CT4#96e |
C4-201206 |
Pseudo-CR on the resources part of SOR-AF API |
0.2.0 |
|||
|
2020-03 |
CT4#96e |
C4-201208 |
Pseudo-CR on the data model aspects of SOR-AF API |
0.2.0 |
|||
|
2020-03 |
CT4#96e |
C4-201209 |
Pseudo-CR on the OpenAPI part of SOR-AF API |
0.2.0 |
|||
|
2020-03 |
CT-87e |
CP-200063 |
TS presented for information and approval |
1.0.0 |
|||
|
2020-03 |
CT-87e |
Approved at CT#87e |
16.0.0 |
||||
|
2020-07 |
CT#88e |
CP-201042 |
0001 |
F |
SoR Information wording clarification |
16.1.0 |
|
|
2020-07 |
CT#88e |
CP-201042 |
0002 |
1 |
F |
Storage of YAML files in ETSI Forge |
16.1.0 |
|
2020-07 |
CT#88e |
CP-201042 |
0003 |
F |
Miscellaneous Corrections |
16.1.0 |
|
|
2020-07 |
CT#88e |
CP-201042 |
0006 |
1 |
F |
Add Data type column in the URI variables tables |
16.1.0 |
|
2020-07 |
CT#88e |
CP-201042 |
0007 |
1 |
F |
Add supported headers tables |
16.1.0 |
|
2020-07 |
CT#88e |
CP-201042 |
0008 |
F |
Add API descriptions table |
16.1.0 |
|
|
2020-07 |
CT#88e |
CP-201042 |
0009 |
2 |
B |
Remaining input parameters to Nsoraf_SOR_Get service operation |
16.1.0 |
|
2020-07 |
CT#88e |
CP-201042 |
0010 |
1 |
B |
SoR retrieval response timing control |
16.1.0 |
|
2020-07 |
CT#88e |
CP-201073 |
0011 |
F |
29.550 Rel-16 API version and External doc update |
16.1.0 |
|
|
2020-09 |
CT#89e |
CP-202115 |
0012 |
F |
Miscellaneous Corrections |
16.2.0 |
|
|
2020-11 |
CT#90e |
CP-203035 |
0015 |
F |
Removal of the reference to ETSI forge |
16.3.0 |
|
|
2021-03 |
CT#91e |
CP-210034 |
0018 |
1 |
F |
OpenAPI Reference |
17.0.0 |
|
2021-06 |
CT#92e |
0021 |
1 |
F |
Adding some missing description fields to data type definitions in OpenAPI specification files of the Nsoraf_SOR API |
17.1.0 |
|
|
2021-09 |
CT#93e |
CP-212247 |
0023 |
3 |
F |
Redirect Response |
17.2.0 |
|
2021-12 |
CT#94e |
0027 |
1 |
B |
SOR-CMCI support |
17.3.0 |
|
|
2022-06 |
CT#96 |
CP-221064 |
0030 |
A |
access-type query parameter format |
17.4.0 |
|
|
2022-06 |
CT#96 |
CP-221301 |
0031 |
2 |
F |
SOR functionality with SNPNs |
17.4.0 |
|
2022-06 |
CT#96 |
CP-221302 |
0032 |
1 |
F |
29.550 Rel-17 API version and External doc update |
17.4.0 |
|
2022-12 |
CT#98 |
CP-223028 |
0035 |
1 |
F |
Missing Mandatory Status Codes in OpenAPI |
18.0.0 |
|
2022-12 |
CT#98 |
CP-223033 |
0036 |
F |
29.550 Rel-18 API version and External doc update |
18.0.0 |
|