MEC021_AppMobilityService.json 72.3 KB
Newer Older
Elian Kraja's avatar
Elian Kraja committed
1
{
piscione's avatar
piscione committed
2
  "openapi": "3.1.0",
Elian Kraja's avatar
Elian Kraja committed
3
4
  "info": {
    "title": "ETSI GS MEC 021 Application Mobility Service API",
5
    "version": "2.2.1",
Elian Kraja's avatar
Elian Kraja committed
6
7
8
9
10
11
    "description": "ETSI GS MEC 021 Application Mobility Service API described using OpenAPI.",
    "license": {
      "name": "BSD-3-Clause",
      "url": "https://forge.etsi.org/legal-matters"
    },
    "contact": {
Elian Kraja's avatar
Elian Kraja committed
12
      "name": "ETSI Forge",
piscione's avatar
piscione committed
13
14
      "url": "https://forge.etsi.org/rep/mec/gs021-amsi-api",
      "email": "cti_support@etsi.org"
Elian Kraja's avatar
Elian Kraja committed
15
16
17
    }
  },
  "externalDocs": {
18
19
    "description": "ETSI GS MEC 021 Application Mobility Service API, v2.2.1",
    "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/021/02.02.01_60/gs_mec021v020201p.pdf"
Elian Kraja's avatar
Elian Kraja committed
20
  },
piscione's avatar
piscione committed
21
  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
Elian Kraja's avatar
Elian Kraja committed
22
23
  "servers": [
    {
piscione's avatar
piscione committed
24
25
      "url": "https://localhost/amsi/v1",
      "variables": {}
Elian Kraja's avatar
Elian Kraja committed
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
    }
  ],
  "tags": [
    {
      "name": "adj-app-inst",
      "description": "Adjacent App instances"
    },
    {
      "name": "app-mob-ser",
      "description": "Application Mobility Services"
    },
    {
      "name": "app-mob-ser-der",
      "description": "Application Mobility Services Deregister task"
    },
    {
      "name": "subscriptions",
      "description": "Subscription for Application Mobility Service"
44
45
46
47
    },
    {
      "name": "notifications",
      "description": "Notification for Application Mobility Service"
Elian Kraja's avatar
Elian Kraja committed
48
49
50
    }
  ],
  "paths": {
piscione's avatar
piscione committed
51
52
53
54
55
56
57
58
59
60
61
62
    "/queries/adjacent_app_instances": {
      "get": {
        "tags": [
          "adj-app-inst"
        ],
        "summary": "Retrieve information about this subscription.",
        "description": "Retrieve information about this subscription.",
        "operationId": "adj_app_instGET",
        "parameters": [
          {
            "name": "filter",
            "in": "query",
63
            "description": "Attribute-based filtering parameters according to ETSI GS MEC 009",
piscione's avatar
piscione committed
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "all_fields",
            "in": "query",
            "description": "Include all complex attributes in the response.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fields",
            "in": "query",
83
            "description": "Complex attributes to be included into the response. See clause 6.18 in ETSI GS MEC 009",
piscione's avatar
piscione committed
84
85
86
87
88
89
90
91
92
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "exclude_fields",
            "in": "query",
93
            "description": "Complex attributes to be excluded from the response.See clause 6.18 in ETSI GS MEC 009",
piscione's avatar
piscione committed
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
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "exclude_default",
            "in": "query",
            "description": "Indicates to exclude the following complex attributes from the response  See clause 6.18 in ETSI GS MEC 011 for details.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A response body containing  zero or more adjacent application instances",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/AdjacentAppInstanceInfo"
                  },
                  "description": "",
                  "contentMediaType": "application/json"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "406": {
            "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "parameters": []
    },
Elian Kraja's avatar
Elian Kraja committed
199
200
201
202
203
    "/app_mobility_services": {
      "get": {
        "tags": [
          "app-mob-ser"
        ],
piscione's avatar
piscione committed
204
        "summary": "Retrieve information about the registered application mobility service.",
Elian Kraja's avatar
Elian Kraja committed
205
206
207
208
209
        "description": " Retrieve information about the registered application mobility service.",
        "operationId": "app_mobility_serviceGET",
        "parameters": [
          {
            "name": "filter",
piscione's avatar
piscione committed
210
211
212
213
            "in": "query",
            "description": "Attribute-based filtering parameters according to ETSI GS MEC 011",
            "style": "form",
            "explode": true,
Elian Kraja's avatar
Elian Kraja committed
214
215
            "schema": {
              "type": "string"
piscione's avatar
piscione committed
216
            }
Elian Kraja's avatar
Elian Kraja committed
217
218
219
          },
          {
            "name": "all_fields",
piscione's avatar
piscione committed
220
221
222
223
            "in": "query",
            "description": "Include all complex attributes in the response.",
            "style": "form",
            "explode": true,
Elian Kraja's avatar
Elian Kraja committed
224
225
            "schema": {
              "type": "string"
piscione's avatar
piscione committed
226
            }
Elian Kraja's avatar
Elian Kraja committed
227
228
229
          },
          {
            "name": "fields",
piscione's avatar
piscione committed
230
231
232
233
            "in": "query",
            "description": "Complex attributes to be included into the response. See clause 6.18 in ETSI GS MEC 011",
            "style": "form",
            "explode": true,
Elian Kraja's avatar
Elian Kraja committed
234
235
            "schema": {
              "type": "string"
piscione's avatar
piscione committed
236
            }
Elian Kraja's avatar
Elian Kraja committed
237
238
239
          },
          {
            "name": "exclude_fields",
piscione's avatar
piscione committed
240
241
242
243
            "in": "query",
            "description": "Complex attributes to be excluded from the response.See clause 6.18 in ETSI GS MEC 011",
            "style": "form",
            "explode": true,
Elian Kraja's avatar
Elian Kraja committed
244
245
            "schema": {
              "type": "string"
piscione's avatar
piscione committed
246
            }
Elian Kraja's avatar
Elian Kraja committed
247
248
249
          },
          {
            "name": "exclude_default",
piscione's avatar
piscione committed
250
251
252
253
            "in": "query",
            "description": "Indicates to exclude the following complex attributes from the response  See clause 6.18 in ETSI GS MEC 011 for details.",
            "style": "form",
            "explode": true,
Elian Kraja's avatar
Elian Kraja committed
254
255
            "schema": {
              "type": "string"
piscione's avatar
piscione committed
256
            }
Elian Kraja's avatar
Elian Kraja committed
257
258
259
260
261
          }
        ],
        "responses": {
          "200": {
            "description": "Contains in an array the representations of zero or more application mobility services.",
piscione's avatar
piscione committed
262
            "headers": {},
Elian Kraja's avatar
Elian Kraja committed
263
264
265
266
267
268
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/RegistrationInfo"
piscione's avatar
piscione committed
269
270
271
                  },
                  "description": "",
                  "contentMediaType": "application/json"
Elian Kraja's avatar
Elian Kraja committed
272
273
274
275
276
                }
              }
            }
          },
          "400": {
piscione's avatar
piscione committed
277
278
279
280
281
282
283
284
285
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
286
287
          },
          "401": {
piscione's avatar
piscione committed
288
289
290
291
292
293
294
295
296
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
297
298
          },
          "403": {
piscione's avatar
piscione committed
299
300
301
302
303
304
305
306
307
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
308
309
          },
          "404": {
piscione's avatar
piscione committed
310
311
312
313
314
315
316
317
318
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
319
320
          },
          "406": {
piscione's avatar
piscione committed
321
322
323
324
325
326
327
328
329
            "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
330
331
          },
          "429": {
piscione's avatar
piscione committed
332
333
334
335
336
337
338
339
340
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
341
          }
piscione's avatar
piscione committed
342
343
        },
        "deprecated": false
Elian Kraja's avatar
Elian Kraja committed
344
345
346
347
348
349
350
351
      },
      "post": {
        "tags": [
          "app-mob-ser"
        ],
        "summary": "Create a new application mobility service for the service requester.",
        "description": "Create a new application mobility service for the service requester.",
        "operationId": "app_mobility_servicePOST",
piscione's avatar
piscione committed
352
        "parameters": [],
Elian Kraja's avatar
Elian Kraja committed
353
354
355
356
357
358
359
360
        "requestBody": {
          "description": "Application mobility service to be created",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RegistrationInfo"
              }
            }
piscione's avatar
piscione committed
361
362
          },
          "required": true
Elian Kraja's avatar
Elian Kraja committed
363
364
365
366
        },
        "responses": {
          "201": {
            "description": "Successful response for application mobility service creation",
piscione's avatar
piscione committed
367
            "headers": {},
Elian Kraja's avatar
Elian Kraja committed
368
369
370
371
372
373
374
375
376
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RegistrationInfo"
                }
              }
            }
          },
          "400": {
piscione's avatar
piscione committed
377
378
379
380
381
382
383
384
385
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
386
387
          },
          "401": {
piscione's avatar
piscione committed
388
389
390
391
392
393
394
395
396
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
397
398
          },
          "403": {
piscione's avatar
piscione committed
399
400
401
402
403
404
405
406
407
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
408
409
          },
          "404": {
piscione's avatar
piscione committed
410
411
412
413
414
415
416
417
418
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
419
420
          },
          "406": {
piscione's avatar
piscione committed
421
422
423
424
425
426
427
428
429
            "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
430
431
          },
          "429": {
piscione's avatar
piscione committed
432
433
434
435
436
437
438
439
440
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
441
          }
piscione's avatar
piscione committed
442
443
444
445
        },
        "deprecated": false
      },
      "parameters": []
Elian Kraja's avatar
Elian Kraja committed
446
447
448
449
450
451
452
453
454
    },
    "/app_mobility_services/{appMobilityServiceId}": {
      "get": {
        "tags": [
          "app-mob-ser"
        ],
        "summary": "Retrieve information about this individual application mobility service",
        "description": "Retrieve information about this individual application mobility service",
        "operationId": "app_mobility_service_by_idGET",
piscione's avatar
piscione committed
455
456
457
458
459
460
461
462
463
464
465
466
        "parameters": [
          {
            "name": "appMobilityServiceId",
            "in": "path",
            "description": "It uniquely identifies the created individual application mobility service",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
Elian Kraja's avatar
Elian Kraja committed
467
468
469
        "responses": {
          "200": {
            "description": "Contains a representation of the application mobility service.",
piscione's avatar
piscione committed
470
            "headers": {},
Elian Kraja's avatar
Elian Kraja committed
471
472
473
474
475
476
477
478
479
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RegistrationInfo"
                }
              }
            }
          },
          "400": {
piscione's avatar
piscione committed
480
481
482
483
484
485
486
487
488
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
489
490
          },
          "401": {
piscione's avatar
piscione committed
491
492
493
494
495
496
497
498
499
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
500
501
          },
          "403": {
piscione's avatar
piscione committed
502
503
504
505
506
507
508
509
510
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
511
512
          },
          "404": {
piscione's avatar
piscione committed
513
514
515
516
517
518
519
520
521
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
522
523
          },
          "406": {
piscione's avatar
piscione committed
524
525
526
527
528
529
530
531
532
            "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
533
534
          },
          "429": {
piscione's avatar
piscione committed
535
536
537
538
539
540
541
542
543
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
544
          }
piscione's avatar
piscione committed
545
546
        },
        "deprecated": false
Elian Kraja's avatar
Elian Kraja committed
547
548
549
550
551
552
553
554
      },
      "put": {
        "tags": [
          "app-mob-ser"
        ],
        "summary": " update the existing individual application mobility service",
        "description": " update the existing individual application mobility service",
        "operationId": "app_mobility_service_by_idPUT",
piscione's avatar
piscione committed
555
556
557
558
559
560
561
562
563
564
565
566
        "parameters": [
          {
            "name": "appMobilityServiceId",
            "in": "path",
            "description": "It uniquely identifies the created individual application mobility service",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
Elian Kraja's avatar
Elian Kraja committed
567
        "requestBody": {
piscione's avatar
piscione committed
568
          "description": "",
Elian Kraja's avatar
Elian Kraja committed
569
570
571
572
573
574
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RegistrationInfo"
              }
            }
piscione's avatar
piscione committed
575
576
          },
          "required": true
Elian Kraja's avatar
Elian Kraja committed
577
578
579
580
        },
        "responses": {
          "200": {
            "description": "Contains a data type describing the updated application mobility service.",
piscione's avatar
piscione committed
581
            "headers": {},
Elian Kraja's avatar
Elian Kraja committed
582
583
584
585
586
587
588
589
590
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RegistrationInfo"
                }
              }
            }
          },
          "400": {
piscione's avatar
piscione committed
591
592
593
594
595
596
597
598
599
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
600
601
          },
          "401": {
piscione's avatar
piscione committed
602
603
604
605
606
607
608
609
610
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
611
612
          },
          "403": {
piscione's avatar
piscione committed
613
614
615
616
617
618
619
620
621
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
622
623
          },
          "404": {
piscione's avatar
piscione committed
624
625
626
627
628
629
630
631
632
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
633
634
          },
          "406": {
piscione's avatar
piscione committed
635
636
637
638
639
640
641
642
643
            "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
644
645
          },
          "412": {
piscione's avatar
piscione committed
646
647
648
649
650
651
652
653
654
            "description": "Precondition failed :  used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
655
656
          },
          "422": {
piscione's avatar
piscione committed
657
658
659
660
661
662
663
664
665
            "description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
666
667
          },
          "429": {
piscione's avatar
piscione committed
668
669
670
671
672
673
674
675
676
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
677
          }
piscione's avatar
piscione committed
678
679
        },
        "deprecated": false
Elian Kraja's avatar
Elian Kraja committed
680
681
682
683
684
685
686
687
      },
      "delete": {
        "tags": [
          "app-mob-ser"
        ],
        "summary": " deregister the individual application mobility service",
        "description": " deregister the individual application mobility service",
        "operationId": "app_mobility_service_by_idDELETE",
piscione's avatar
piscione committed
688
689
690
691
692
693
694
695
696
697
698
699
        "parameters": [
          {
            "name": "appMobilityServiceId",
            "in": "path",
            "description": "It uniquely identifies the created individual application mobility service",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
Elian Kraja's avatar
Elian Kraja committed
700
701
        "responses": {
          "204": {
piscione's avatar
piscione committed
702
703
704
            "description": "No Content",
            "headers": {},
            "content": {}
Elian Kraja's avatar
Elian Kraja committed
705
706
          },
          "401": {
piscione's avatar
piscione committed
707
708
709
710
711
712
713
714
715
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
716
717
          },
          "403": {
piscione's avatar
piscione committed
718
719
720
721
722
723
724
725
726
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
727
728
          },
          "404": {
piscione's avatar
piscione committed
729
730
731
732
733
734
735
736
737
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
738
739
          },
          "429": {
piscione's avatar
piscione committed
740
741
742
743
744
745
746
747
748
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
749
          }
piscione's avatar
piscione committed
750
751
752
753
        },
        "deprecated": false
      },
      "parameters": []
Elian Kraja's avatar
Elian Kraja committed
754
755
756
757
758
759
760
761
762
    },
    "/app_mobility_services/{appMobilityServiceId}/deregister_task": {
      "post": {
        "tags": [
          "app-mob-ser-der"
        ],
        "summary": " deregister the individual application mobility service",
        "description": " deregister the individual application mobility service",
        "operationId": "app_mobility_service_derPOST",
piscione's avatar
piscione committed
763
764
765
766
767
768
769
770
771
772
773
774
        "parameters": [
          {
            "name": "appMobilityServiceId",
            "in": "path",
            "description": "It uniquely identifies the created individual application mobility service",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
Elian Kraja's avatar
Elian Kraja committed
775
776
        "responses": {
          "204": {
piscione's avatar
piscione committed
777
778
779
            "description": "No Content",
            "headers": {},
            "content": {}
Elian Kraja's avatar
Elian Kraja committed
780
781
          },
          "401": {
piscione's avatar
piscione committed
782
783
784
785
786
787
788
789
790
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
791
792
          },
          "403": {
piscione's avatar
piscione committed
793
794
795
796
797
798
799
800
801
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
802
803
          },
          "404": {
piscione's avatar
piscione committed
804
805
806
807
808
809
810
811
812
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
813
814
          },
          "406": {
piscione's avatar
piscione committed
815
816
817
818
819
820
821
822
823
            "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
824
825
          },
          "429": {
piscione's avatar
piscione committed
826
827
828
829
830
831
832
833
834
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
835
          }
piscione's avatar
piscione committed
836
837
838
839
        },
        "deprecated": false
      },
      "parameters": []
Elian Kraja's avatar
Elian Kraja committed
840
    },
piscione's avatar
piscione committed
841
    "/subscriptions": {
Elian Kraja's avatar
Elian Kraja committed
842
843
844
845
846
847
848
849
850
851
      "get": {
        "tags": [
          "subscriptions"
        ],
        "summary": "Retrieve information about the subscriptions for this requestor.",
        "description": "Retrieve information about the subscriptions for this requestor.",
        "operationId": "subGET",
        "parameters": [
          {
            "name": "subscriptionType",
piscione's avatar
piscione committed
852
            "in": "query",
Elian Kraja's avatar
Elian Kraja committed
853
            "description": "Query parameter to filter on a specific subscription type. Permitted values: mobility_proc or adj_app_info",
piscione's avatar
piscione committed
854
855
856
            "required": true,
            "style": "form",
            "explode": true,
Elian Kraja's avatar
Elian Kraja committed
857
858
            "schema": {
              "type": "string"
piscione's avatar
piscione committed
859
            }
Elian Kraja's avatar
Elian Kraja committed
860
861
862
863
864
          }
        ],
        "responses": {
          "200": {
            "description": "Contains  the list of links to requestor subscriptions.",
piscione's avatar
piscione committed
865
            "headers": {},
Elian Kraja's avatar
Elian Kraja committed
866
867
868
869
870
871
872
873
874
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriptionLinkList"
                }
              }
            }
          },
          "400": {
piscione's avatar
piscione committed
875
876
877
878
879
880
881
882
883
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
884
885
          },
          "401": {
piscione's avatar
piscione committed
886
887
888
889
890
891
892
893
894
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
895
896
          },
          "403": {
piscione's avatar
piscione committed
897
898
899
900
901
902
903
904
905
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
906
907
          },
          "404": {
piscione's avatar
piscione committed
908
909
910
911
912
913
914
915
916
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
917
918
          },
          "406": {
piscione's avatar
piscione committed
919
920
921
922
923
924
925
926
927
            "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
928
929
          },
          "429": {
piscione's avatar
piscione committed
930
931
932
933
934
935
936
937
938
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
939
          }
piscione's avatar
piscione committed
940
941
        },
        "deprecated": false
Elian Kraja's avatar
Elian Kraja committed
942
943
944
945
946
947
948
949
      },
      "post": {
        "tags": [
          "subscriptions"
        ],
        "summary": "Create a new subscription to Application Mobility Service notifications.",
        "description": "Create a new subscription to Application Mobility Service notifications.",
        "operationId": "subPOST",
piscione's avatar
piscione committed
950
        "parameters": [],
Elian Kraja's avatar
Elian Kraja committed
951
        "requestBody": {
piscione's avatar
piscione committed
952
          "description": "",
Elian Kraja's avatar
Elian Kraja committed
953
954
955
956
957
958
959
960
961
962
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/MobilityProcedureSubscription"
                  },
                  {
                    "$ref": "#/components/schemas/AdjacentAppInfoSubscription"
                  }
piscione's avatar
piscione committed
963
964
                ],
                "contentMediaType": "application/json"
Elian Kraja's avatar
Elian Kraja committed
965
966
              }
            }
piscione's avatar
piscione committed
967
968
          },
          "required": true
Elian Kraja's avatar
Elian Kraja committed
969
970
971
972
        },
        "responses": {
          "201": {
            "description": "Created subscription is described using the appropriate data type",
piscione's avatar
piscione committed
973
            "headers": {},
Elian Kraja's avatar
Elian Kraja committed
974
975
976
977
978
979
980
981
982
983
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/MobilityProcedureSubscription"
                    },
                    {
                      "$ref": "#/components/schemas/AdjacentAppInfoSubscription"
                    }
piscione's avatar
piscione committed
984
985
                  ],
                  "contentMediaType": "application/json"
Elian Kraja's avatar
Elian Kraja committed
986
987
988
989
990
                }
              }
            }
          },
          "400": {
piscione's avatar
piscione committed
991
992
993
994
995
996
997
998
999
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
1000
1001
          },
          "401": {
piscione's avatar
piscione committed
1002
1003
1004
1005
1006
1007
1008
1009
1010
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
1011
1012
          },
          "403": {
piscione's avatar
piscione committed
1013
1014
1015
1016
1017
1018
1019
1020
1021
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
1022
1023
          },
          "404": {
piscione's avatar
piscione committed
1024
1025
1026
1027
1028
1029
1030
1031
1032
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
1033
1034
          },
          "406": {
piscione's avatar
piscione committed
1035
1036
1037
1038
1039
1040
1041
1042
1043
            "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
1044
1045
          },
          "415": {
piscione's avatar
piscione committed
1046
1047
1048
1049
1050
1051
1052
1053
1054
            "description": "Unsupported Media Type :  used to indicate that the server or the client does not support the content type of the entity body.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
1055
1056
          },
          "422": {
piscione's avatar
piscione committed
1057
1058
1059
1060
1061
1062
1063
1064
1065
            "description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
1066
1067
          },
          "429": {
piscione's avatar
piscione committed
1068
1069
1070
1071
1072
1073
1074
1075
1076
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
1077
          }
piscione's avatar
piscione committed
1078
1079
1080
1081
        },
        "deprecated": false
      },
      "parameters": []
Elian Kraja's avatar
Elian Kraja committed
1082
1083
1084
1085
1086
1087
1088
1089
1090
    },
    "/subscriptions/{subscriptionId}": {
      "get": {
        "tags": [
          "subscriptions"
        ],
        "summary": "Retrieve information about this subscription.",
        "description": "Retrieve information about this subscription.",
        "operationId": "sub_byIdGET",
piscione's avatar
piscione committed
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "Refers to created subscription, where the AMS API allocates a unique resource name for this subscription",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
Elian Kraja's avatar
Elian Kraja committed
1103
1104
1105
        "responses": {
          "200": {
            "description": "A response body containing data type describing the specific RNI event subscription",
piscione's avatar
piscione committed
1106
            "headers": {},
Elian Kraja's avatar
Elian Kraja committed
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/MobilityProcedureSubscription"
                    },
                    {
                      "$ref": "#/components/schemas/AdjacentAppInfoSubscription"
                    }
piscione's avatar
piscione committed
1117
1118
                  ],
                  "contentMediaType": "application/json"
Elian Kraja's avatar
Elian Kraja committed
1119
1120
1121
1122
1123
                }
              }
            }
          },
          "400": {
piscione's avatar
piscione committed
1124
1125
1126
1127
1128
1129
1130
1131
1132
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
1133
1134
          },
          "401": {
piscione's avatar
piscione committed
1135
1136
1137
1138
1139
1140
1141
1142
1143
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
1144
1145
          },
          "403": {
piscione's avatar
piscione committed
1146
1147
1148
1149
1150
1151
1152
1153
1154
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
1155
1156
          },
          "404": {
piscione's avatar
piscione committed
1157
1158
1159
1160
1161
1162
1163
1164
1165
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
1166
1167
          },
          "406": {
piscione's avatar
piscione committed
1168
1169
1170
1171
1172
1173
1174
1175
1176
            "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
1177
1178
          },
          "429": {
piscione's avatar
piscione committed
1179
1180
1181
1182
1183
1184
1185
1186
1187
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
1188
          }
piscione's avatar
piscione committed
1189
1190
        },
        "deprecated": false
Elian Kraja's avatar
Elian Kraja committed
1191
1192
1193
1194
1195
1196
1197
1198
      },
      "put": {
        "tags": [
          "subscriptions"
        ],
        "summary": "update the existing individual subscription.",
        "description": "update the existing individual subscription.",
        "operationId": "sub_byIdPUT",
piscione's avatar
piscione committed
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
        "parameters": [
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "Refers to created subscription, where the AMS API allocates a unique resource name for this subscription",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
Elian Kraja's avatar
Elian Kraja committed
1211
        "requestBody": {
piscione's avatar
piscione committed
1212
          "description": "",
Elian Kraja's avatar
Elian Kraja committed
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/MobilityProcedureSubscription"
                  },
                  {
                    "$ref": "#/components/schemas/AdjacentAppInfoSubscription"
                  }
piscione's avatar
piscione committed
1223
1224
                ],
                "contentMediaType": "application/json"
Elian Kraja's avatar
Elian Kraja committed
1225
1226
              }
            }
piscione's avatar
piscione committed
1227
1228
          },
          "required": true
Elian Kraja's avatar
Elian Kraja committed
1229
1230
1231
        },
        "responses": {
          "200": {
piscione's avatar
piscione committed
1232
1233
            "description": "a response body containing data type describing the updated subscription",
            "headers": {},
Elian Kraja's avatar
Elian Kraja committed
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/MobilityProcedureSubscription"
                    },
                    {
                      "$ref": "#/components/schemas/AdjacentAppInfoSubscription"
                    }
piscione's avatar
piscione committed
1244
1245
                  ],
                  "contentMediaType": "application/json"
Elian Kraja's avatar
Elian Kraja committed
1246
1247
1248
1249
1250
                }
              }
            }
          },
          "400": {
piscione's avatar
piscione committed
1251
1252
1253
1254
1255
1256
1257
1258
1259
            "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
1260
1261
          },
          "401": {
piscione's avatar
piscione committed
1262
1263
1264
1265
1266
1267
1268
1269
1270
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
1271
1272
          },
          "403": {
piscione's avatar
piscione committed
1273
1274
1275
1276
1277
1278
1279
1280
1281
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
1282
1283
          },
          "404": {
piscione's avatar
piscione committed
1284
1285
1286
1287
1288
1289
1290
1291
1292
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
1293
1294
          },
          "406": {
piscione's avatar
piscione committed
1295
1296
1297
1298
1299
1300
1301
1302
1303
            "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
1304
1305
          },
          "412": {
piscione's avatar
piscione committed
1306
1307
1308
1309
1310
1311
1312
1313
1314
            "description": "Precondition failed :  used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
1315
1316
          },
          "422": {
piscione's avatar
piscione committed
1317
1318
1319
1320
1321
1322
1323
1324
1325
            "description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
1326
1327
          },
          "429": {
piscione's avatar
piscione committed
1328
1329
1330
1331
1332
1333
1334
1335
1336
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
1337
          }
piscione's avatar
piscione committed
1338
1339
        },
        "deprecated": false
Elian Kraja's avatar
Elian Kraja committed
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
      },
      "delete": {
        "tags": [
          "subscriptions"
        ],
        "summary": "cancel the existing individual subscription",
        "description": "cancel the existing individual subscription",
        "operationId": "sub_byIdDELETE",
        "parameters": [
          {
piscione's avatar
piscione committed
1350
1351
1352
1353
1354
            "name": "subscriptionId",
            "in": "path",
            "description": "Refers to created subscription, where the AMS API allocates a unique resource name for this subscription",
            "required": true,
            "style": "simple",
Elian Kraja's avatar
Elian Kraja committed
1355
1356
            "schema": {
              "type": "string"
piscione's avatar
piscione committed
1357
            }
Elian Kraja's avatar
Elian Kraja committed
1358
1359
1360
          }
        ],
        "responses": {
piscione's avatar
piscione committed
1361
1362
1363
1364
1365
1366
1367
1368
          "204": {
            "description": "No Content",
            "headers": {},
            "content": {}
          },
          "401": {
            "description": "Unauthorized :  used when the client did not submit credentials.",
            "headers": {},
Elian Kraja's avatar
Elian Kraja committed
1369
1370
1371
            "content": {
              "application/json": {
                "schema": {
piscione's avatar
piscione committed
1372
                  "$ref": "#/components/schemas/ProblemDetails"
Elian Kraja's avatar
Elian Kraja committed
1373
1374
1375
1376
1377
                }
              }
            }
          },
          "403": {
piscione's avatar
piscione committed
1378
1379
1380
1381
1382
1383
1384
1385
1386
            "description": "Forbidden :  operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
1387
1388
          },
          "404": {
piscione's avatar
piscione committed
1389
1390
1391
1392
1393
1394
1395
1396
1397
            "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
1398
1399
          },
          "429": {
piscione's avatar
piscione committed
1400
1401
1402
1403
1404
1405
1406
1407
1408
            "description": "Too Many Requests : used when a rate limiter has triggered.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
Elian Kraja's avatar
Elian Kraja committed
1409
          }
piscione's avatar
piscione committed
1410
1411
1412
1413
        },
        "deprecated": false
      },
      "parameters": []
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
    },
    "/uri_provided_by_subscriber": {
      "post": {
        "tags": [
          "notifications"
        ],
        "summary": "delivers a notification from the AMS resource to the subscriber",
        "description": "delivers a notification from the AMS resource to the subscriber",
        "operationId": "notificationPOST",
        "parameters": [],
        "requestBody": {
          "description": "",
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/MobilityProcedureNotification"
                  },
                  {
                    "$ref": "#/components/schemas/AdjacentAppInfoNotification"
                  },
                  {
                    "$ref": "#/components/schemas/ExpiryNotification"
                  }
                ],
                "contentMediaType": "application/json"
              }
            }
          },
          "required": true
        },
        "responses": {
          "204": {
            "description": "The notification was delivered successfully. The response body shall be empty.",
            "headers": {},
            "content": {}
          },
          "401": {
            "description": "It is used when the client did not submit credentials.'",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "operation is not allowed given the current status of the resource.'",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Used when a client provided a URI that cannot be mapped to a valid resource URI.'",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "406": {
            "description": "Used to indicate that the server cannot provide the any of the content formats supported by the client.'",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "429": {
            "description": "Used when a rate limiter has triggered.'",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
        }
      }
Elian Kraja's avatar
Elian Kraja committed
1509
1510
1511
1512
1513
    }
  },
  "components": {
    "schemas": {
      "AdjacentAppInfoSubscription.links": {
piscione's avatar
piscione committed
1514
        "title": "AdjacentAppInfoSubscription.links",
Elian Kraja's avatar
Elian Kraja committed
1515
1516
1517
        "required": [
          "self"
        ],
piscione's avatar
piscione committed
1518
        "type": "object",
Elian Kraja's avatar
Elian Kraja committed
1519
1520
1521
1522
        "properties": {
          "self": {
            "$ref": "#/components/schemas/LinkType"
          }
piscione's avatar
piscione committed
1523
1524
        },
        "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests."
Elian Kraja's avatar
Elian Kraja committed
1525
1526
      },
      "AdjacentAppInfoSubscription.filterCriteria": {
piscione's avatar
piscione committed
1527
1528
        "title": "AdjacentAppInfoSubscription.filterCriteria",
        "type": "object",
Elian Kraja's avatar
Elian Kraja committed
1529
1530
1531
1532
        "properties": {
          "appInstanceId": {
            "type": "string"
          }
piscione's avatar
piscione committed
1533
1534
        },
        "description": "List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response."
Elian Kraja's avatar
Elian Kraja committed
1535
1536
      },
      "AdjacentAppInfoSubscription": {
piscione's avatar
piscione committed
1537
1538
1539
1540
1541
1542
1543
        "title": "AdjacentAppInfoSubscription",
        "required": [
          "callbackReference",
          "filterCriteria",
          "subscriptionType"
        ],
        "type": "object",
Elian Kraja's avatar
Elian Kraja committed
1544
1545
1546
1547
1548
        "properties": {
          "_links": {
            "$ref": "#/components/schemas/AdjacentAppInfoSubscription.links"
          },
          "callbackReference": {
piscione's avatar
piscione committed
1549
1550
            "type": "string",
            "format": "uri",
piscione's avatar
piscione committed
1551
            "description": "URI selected by the service consumer to receive notifications on the subscribed Application Mobility Service. This shall be included both in the request and in response."
Elian Kraja's avatar
Elian Kraja committed
1552
          },
1553
1554
1555