forked from jdegre/5GC_APIs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathTS29518_Namf_MT.yaml
259 lines (259 loc) · 9.08 KB
/
TS29518_Namf_MT.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
openapi: 3.0.0
info:
version: 1.1.1
title: Namf_MT
description: |
AMF Mobile Terminated Service
© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
security:
- {}
- oAuth2ClientCredentials:
- namf-mt
externalDocs:
description: 3GPP TS 29.518 V16.6.0; 5G System; Access and Mobility Management Services
url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.518/'
servers:
- url: '{apiRoot}/namf-mt/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause clause 4.4 of 3GPP TS 29.501
paths:
'/ue-contexts/{ueContextId}':
get:
summary: Namf_MT Provide Domain Selection Info service Operation
tags:
- ueContext (Document)
operationId: Provide Domain Selection Info
parameters:
- name: ueContextId
in: path
description: UE Context Identifier
required: true
schema:
type: string
pattern: '^(imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|.+)$'
- name: info-class
in: query
description: UE Context Information Class
schema:
$ref: '#/components/schemas/UeContextInfoClass'
- name: supported-features
in: query
description: Supported Features
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
- name: old-guami
in: query
description: Old GUAMI
content:
application/json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Guami'
responses:
'200':
description: Requested UE Context Information returned
content:
application/json:
schema:
$ref: '#/components/schemas/UeContextInfo'
'307':
description: Temporary Redirect
content:
application/problem+json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
headers:
Location:
description: 'The URI of the resource located on the target NF Service Consumer (e.g. AMF) to which the request is redirected'
required: true
schema:
type: string
3gpp-Sbi-Target-Nf-Id:
description: ' Identifier of the target NF (service) instance ID towards which the request is redirected'
schema:
type: string
'308':
description: permanent redirect
content:
application/problem+json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
headers:
Location:
description: 'An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set'
required: true
schema:
type: string
3gpp-Sbi-Target-Nf-Id:
description: ' Identifier of the target NF (service) instance ID towards which the request is redirected'
schema:
type: string
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'414':
$ref: 'TS29571_CommonData.yaml#/components/responses/414'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
description: Unexpected error
/ue-contexts/{ueContextId}/ue-reachind:
put:
summary: Namf_MT EnableUEReachability service Operation
tags:
- ueReachInd (Document)
operationId: EnableUeReachability
parameters:
- name: ueContextId
in: path
description: UE Context Identifier
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EnableUeReachabilityReqData'
required: true
responses:
'200':
description: UE has become reachable as desired
content:
application/json:
schema:
$ref: '#/components/schemas/EnableUeReachabilityRspData'
'307':
description: Temporary Redirect
content:
application/problem+json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
headers:
Location:
description: 'The URI of the resource located on the target NF Service Consumer (e.g. AMF) to which the request is redirected'
required: true
schema:
type: string
3gpp-Sbi-Target-Nf-Id:
description: ' Identifier of the target NF (service) instance ID towards which the request is redirected'
schema:
type: string
'308':
description: permanent redirect
content:
application/problem+json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
headers:
Location:
description: 'An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set'
required: true
schema:
type: string
3gpp-Sbi-Target-Nf-Id:
description: ' Identifier of the target NF (service) instance ID towards which the request is redirected'
schema:
type: string
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'403':
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetailsEnableUeReachability'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29571_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
'504':
description: Gateway Timeout
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetailsEnableUeReachability'
default:
description: Unexpected error
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{nrfApiRoot}/oauth2/token'
scopes:
namf-mt: Access to the Namf_MT API
schemas:
EnableUeReachabilityReqData:
type: object
properties:
reachability:
$ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/UeReachability'
supportedFeatures:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
oldGuami:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Guami'
extBufSupport:
type: boolean
default: false
required:
- reachability
EnableUeReachabilityRspData:
type: object
properties:
reachability:
$ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/UeReachability'
supportedFeatures:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- reachability
UeContextInfo:
type: object
properties:
supportVoPS:
type: boolean
supportVoPSn3gpp:
type: boolean
lastActTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
accessType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType'
ratType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RatType'
supportedFeatures:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
ProblemDetailsEnableUeReachability:
allOf:
- $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
- $ref: '#/components/schemas/AdditionInfoEnableUeReachability'
AdditionInfoEnableUeReachability:
type: object
properties:
maxWaitingTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
UeContextInfoClass:
anyOf:
- type: string
enum:
- TADS
- type: string