forked from jdegre/5GC_APIs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
TS29222_CAPIF_API_Invoker_Management_API.yaml
297 lines (295 loc) · 12.3 KB
/
TS29222_CAPIF_API_Invoker_Management_API.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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
openapi: 3.0.0
info:
title: CAPIF_API_Invoker_Management_API
description: |
API for API invoker management.
© 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
version: "1.2.0-alpha.2"
externalDocs:
description: 3GPP TS 29.222 V17.2.0 Common API Framework for 3GPP Northbound APIs
url: http://www.3gpp.org/ftp/Specs/archive/29_series/29.222/
servers:
- url: '{apiRoot}/api-invoker-management/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in subclause 7.5 of 3GPP TS 29.222
paths:
/onboardedInvokers:
post:
description: Creates a new individual API Invoker profile.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/APIInvokerEnrolmentDetails'
callbacks:
notificationDestination:
'{request.body#/notificationDestination}':
post:
description: Notify the API Invoker about the onboarding completion
requestBody: # contents of the callback message
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/OnboardingNotification'
responses:
'204':
description: No Content (successful onboarding notification)
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
responses:
'201':
description: API invoker on-boarded successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/APIInvokerEnrolmentDetails'
headers:
Location:
description: 'Contains the URI of the newly created resource, according to the structure: {apiRoot}/api-invoker-management/v1/onboardedInvokers/{onboardingId}'
required: true
schema:
type: string
'202':
description: The CAPIF core has accepted the Onboarding request and is processing it.
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
/onboardedInvokers/{onboardingId}:
delete:
description: Deletes an individual API Invoker.
parameters:
- name: onboardingId
in: path
description: String identifying an individual on-boarded API invoker resource
required: true
schema:
type: string
responses:
'204':
description: The individual API Invoker matching onboardingId was offboarded.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
put:
description: Updates an individual API invoker details.
parameters:
- name: onboardingId
in: path
description: String identifying an individual on-boarded API invoker resource
required: true
schema:
type: string
requestBody:
description: representation of the API invoker details to be updated in CAPIF core function
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/APIInvokerEnrolmentDetails'
callbacks:
notificationDestination:
'{request.body#/notificationDestination}':
post:
description: Notify the API Invoker about the API invoker update completion
requestBody: # contents of the callback message
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/OnboardingNotification'
responses:
'204':
description: No Content (successful API invoker update notification)
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
responses:
'200':
description: API invoker details updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/APIInvokerEnrolmentDetails'
'202':
description: The CAPIF core has accepted the API invoker update details request and is processing it.
'204':
description: API invoker’s information updated successfully, with no content to be sent in the response body.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
components:
schemas:
OnboardingInformation:
type: object
description: Represents on-boarding information of the API invoker.
properties:
apiInvokerPublicKey:
type: string
description: The API Invoker’s public key
apiInvokerCertificate:
type: string
description: The API Invoker’s generic client certificate, provided by the CAPIF core function.
onboardingSecret:
type: string
description: The API Invoker’s onboarding secret, provided by the CAPIF core function.
required:
- apiInvokerPublicKey
APIList:
type: array
items:
$ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/ServiceAPIDescription'
minItems: 1
description: The list of service APIs that the API Invoker is allowed to invoke
APIInvokerEnrolmentDetails:
type: object
properties:
apiInvokerId:
type: string
description: API invoker ID assigned by the CAPIF core function to the API invoker while on-boarding the API invoker. Shall not be present in the HTTP POST request from the API invoker to the CAPIF core function, to on-board itself. Shall be present in all other HTTP requests and responses.
readOnly: true
onboardingInformation:
$ref: '#/components/schemas/OnboardingInformation'
notificationDestination:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
requestTestNotification:
type: boolean
description: Set to true by Subscriber to request the CAPIF core function to send a test notification as defined in in subclause 7.6. Set to false or omitted otherwise.
websockNotifConfig:
$ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig'
apiList:
$ref: '#/components/schemas/APIList'
apiInvokerInformation:
type: string
description: Generic information related to the API invoker such as details of the device or the application.
supportedFeatures:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- onboardingInformation
- notificationDestination
description: Information about the API Invoker that requested to onboard
OnboardingNotification:
type: object
description: Represents a notification of on-boarding or update result.
properties:
result:
type: boolean
description: Set to "true" indicate successful on-boarding. Otherwise set to "false"
resourceLocation:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
apiInvokerEnrolmentDetails:
$ref: '#/components/schemas/APIInvokerEnrolmentDetails'
apiList:
$ref: '#/components/schemas/APIList'
required:
- result