MEC010-2_AppPkgMgmt.yaml 78.1 KB
Newer Older
1
openapi: 3.1.0
Elian Kraja's avatar
Elian Kraja committed
2
info:
3
4
  title: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management'
  description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI.'
5
6
7
  license:
    name: BSD-3-Clause
    url: 'https://forge.etsi.org/legal-matters'
Elian Kraja's avatar
Elian Kraja committed
8
  contact:
9
    name: ETSI Forge
Elian Kraja's avatar
Elian Kraja committed
10
    url: https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api
11
    email: cti_support@etsi.org
12
  version: '2.2.1'
13
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
14
15

externalDocs:
16
17
  description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.2.1'
  url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.02.01_60/gs_MEC01002v020201p.pdf'
18
19
20
21
22
tags:
- name: app-pkgm
  description: App Package management
- name: app-pkgm-notifications
  description: App Package management notifications
Elian Kraja's avatar
Elian Kraja committed
23
servers:
24
25
- url: https://localhost/app_pkgm/v1
  variables: {}
Elian Kraja's avatar
Elian Kraja committed
26
27
28
29
paths:
  /app_packages:
    post:
      tags:
30
      - app-pkgm
31
32
      summary:  'Create a resource for on-boarding an application package to a MEO/MEAO'
      description: Create a resource for on-boarding an application package to a MEO/MEAO
Elian Kraja's avatar
Elian Kraja committed
33
      operationId: app_packagesPOST
34
      parameters: []
Elian Kraja's avatar
Elian Kraja committed
35
36
37
38
39
40
      requestBody:
        description: Resource to be created
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAppPkg'
41
        required: true
Elian Kraja's avatar
Elian Kraja committed
42
43
44
      responses:
        '201':
          description: Successful response for resource creation
45
          headers: {}
Elian Kraja's avatar
Elian Kraja committed
46
47
48
          content:
            application/json:
              schema:
49
50
                $ref: '#/components/schemas/AppPkgInfo'
                description: The response body shall contain a representation of the application package resource
51
                contentMediaType: application/json
Elian Kraja's avatar
Elian Kraja committed
52
        '400':
53
54
55
56
57
58
          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
59
        '401':
60
61
62
63
64
65
          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
66
        '403':
67
68
69
70
71
72
          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
73
        '404':
74
75
76
77
78
79
          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
80
        '406':
81
82
83
84
85
86
          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
87
        '429':
88
89
90
91
92
93
94
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
Elian Kraja's avatar
Elian Kraja committed
95
96
    get:
      tags:
97
      - app-pkgm
98
99
      summary: Queries information relating to on-boarded application packages in the MEO/MEAO'
      description: queries information relating to on-boarded application packages in the MEO/MEAO
Elian Kraja's avatar
Elian Kraja committed
100
101
      operationId: app_packagesGET
      parameters:
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
      - name: filter
        in: query
        description: Attribute-based filtering parameters according to ETSI GS MEC 009
        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
        description: Complex attributes of AppPkgInfo to be included into the response
        style: form
        explode: true
        schema:
          type: string
      - name: exclude_fields
        in: query
        description: Complex attributes of AppPkgInfo to be excluded from the response.
        style: form
        explode: true
        schema:
          type: string
      - name: exclude_default
        in: query
        description: Indicates to exclude the following complex attributes of AppPkgInfo from the response.
        style: form
        explode: true
        schema:
          type: string
Elian Kraja's avatar
Elian Kraja committed
137
138
      responses:
        '200':
139
140
          description: Contains a representation of the application package resource
          headers: {}
Elian Kraja's avatar
Elian Kraja committed
141
142
143
144
145
146
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AppPkgInfo'
147
148
                description: ''
                contentMediaType: application/json
Elian Kraja's avatar
Elian Kraja committed
149
        '400':
150
151
152
153
154
155
          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
156
        '401':
157
158
159
160
161
162
          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
163
        '403':
164
165
166
167
168
169
          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
170
        '404':
171
172
173
174
175
176
          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
177
        '406':
178
179
180
181
182
183
          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
184
        '429':
185
186
187
188
189
190
191
192
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
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
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
  
  /onboarded_app_packages:
      post:
        tags:
        - app-pkgm
        summary:  'Create a resource for on-boarding an application package to a MEO/MEAO'
        description: Create a resource for on-boarding an application package to a MEO/MEAO
        operationId: onboarded_app_packagesPOST
        parameters: []
        requestBody:
          description: Resource to be created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAppPkg'
          required: true
        responses:
          '201':
            description: Successful response for resource creation
            headers: {}
            content:
              application/json:
                schema:
                  $ref: '#/components/schemas/AppPkgInfo'
                  description: The response body shall contain a representation of the application package resource
                  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
      get:
        tags:
        - app-pkgm
        summary: Queries information relating to on-boarded application packages in the MEO/MEAO'
        description: queries information relating to on-boarded application packages in the MEO/MEAO
        operationId: onboarded_app_packagesGET
        parameters:
        - name: filter
          in: query
          description: Attribute-based filtering parameters according to ETSI GS MEC 009
          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
          description: Complex attributes of AppPkgInfo to be included into the response
          style: form
          explode: true
          schema:
            type: string
        - name: exclude_fields
          in: query
          description: Complex attributes of AppPkgInfo to be excluded from the response.
          style: form
          explode: true
          schema:
            type: string
        - name: exclude_default
          in: query
          description: Indicates to exclude the following complex attributes of AppPkgInfo from the response.
          style: form
          explode: true
          schema:
            type: string
        responses:
          '200':
            description: Contains a representation of the application package resource
            headers: {}
            content:
              application/json:
                schema:
                  type: array
                  items:
                    $ref: '#/components/schemas/AppPkgInfo'
                  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
361
362
363
  /app_packages/{appPkgId}:
    get:
      tags:
364
      - app-pkgm
365
      summary: 'Queries the information related to individual application package resources'
366
      description: Queries the information related to individual application package resources
Elian Kraja's avatar
Elian Kraja committed
367
      operationId: app_packageGET
368
369
370
371
372
373
374
375
      parameters:
      - name: appPkgId
        in: path
        description: Identifier of an individual application package resource
        required: true
        style: simple
        schema:
          type: string
Elian Kraja's avatar
Elian Kraja committed
376
377
      responses:
        '200':
378
379
          description: Contains a representation of the application package resource
          headers: {}
Elian Kraja's avatar
Elian Kraja committed
380
381
382
383
384
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppPkgInfo'
        '400':
385
386
387
388
389
390
          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
391
        '401':
392
393
394
395
396
397
          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
398
        '403':
399
400
401
402
403
404
          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
405
        '404':
406
407
408
409
410
411
          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
412
        '406':
413
414
415
416
417
418
          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
419
        '429':
420
421
422
423
424
425
426
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
Elian Kraja's avatar
Elian Kraja committed
427
428
    delete:
      tags:
429
      - app-pkgm
430
431
      summary: 'Deletes an individual application package resources in MEO/MEAO'
      description: Deletes an individual application package resources in MEO/MEAO
Elian Kraja's avatar
Elian Kraja committed
432
      operationId: app_packageDELETE
433
434
435
436
437
438
439
440
      parameters:
      - name: appPkgId
        in: path
        description: Identifier of an individual application package resource
        required: true
        style: simple
        schema:
          type: string
Elian Kraja's avatar
Elian Kraja committed
441
442
      responses:
        '204':
443
444
445
          description: No Content
          headers: {}
          content: {}
Elian Kraja's avatar
Elian Kraja committed
446
        '400':
447
448
449
450
451
452
          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
453
        '401':
454
455
456
457
458
459
          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
460
        '403':
461
462
463
464
465
466
          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
467
        '404':
468
469
470
471
472
473
          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
474
        '406':
475
476
477
478
479
480
          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
481
        '429':
482
483
484
485
486
487
488
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
Elian Kraja's avatar
Elian Kraja committed
489
490
    patch:
      tags:
491
      - app-pkgm
492
      summary: 'Updates the operational state of an individual application package resource'
493
      description: Updates the operational state of an individual application package resources
Elian Kraja's avatar
Elian Kraja committed
494
      operationId: app_packagePATCH
495
496
497
498
499
500
501
502
      parameters:
      - name: appPkgId
        in: path
        description: Identifier of an individual application package resource
        required: true
        style: simple
        schema:
          type: string
Elian Kraja's avatar
Elian Kraja committed
503
      requestBody:
504
        description: Parameters for application package information modification.
Elian Kraja's avatar
Elian Kraja committed
505
506
507
508
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppPkgInfoModifications'
509
        required: true
Elian Kraja's avatar
Elian Kraja committed
510
511
      responses:
        '200':
512
513
          description: Shows that the operation has been completed successfully
          headers: {}
Elian Kraja's avatar
Elian Kraja committed
514
515
516
517
518
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppPkgInfoModifications'
        '400':
519
520
521
522
523
524
          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
525
        '401':
526
527
528
529
530
531
          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
532
        '403':
533
534
535
536
537
538
          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
539
        '404':
540
541
542
543
544
545
          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
546
        '406':
547
548
549
550
551
552
          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
553
        '409':
554
555
556
557
558
559
          description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
Elian Kraja's avatar
Elian Kraja committed
560
        '429':
561
562
563
564
565
566
567
568
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
  
  /onboarded_app_packages/{appPkgId}:
    get:
      tags:
      - app-pkgm
      summary: 'Queries the information related to individual application package resources'
      description: Queries the information related to individual application package resources
      operationId: onboarded_app_packageGET
      parameters:
      - name: appPkgId
        in: path
        description: Identifier of an individual application package resource
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: Contains a representation of the application package resource
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppPkgInfo'
        '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
    delete:
      tags:
      - app-pkgm
      summary: 'Deletes an individual application package resources in MEO/MEAO'
      description: Deletes an individual application package resources in MEO/MEAO
      operationId: onboarded_app_packageDELETE
      parameters:
      - name: appPkgId
        in: path
        description: Identifier of an individual application package resource
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '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
    patch:
      tags:
      - app-pkgm
      summary: 'Updates the operational state of an individual application package resource'
      description: Updates the operational state of an individual application package resources
      operationId: onboarded_app_packagePATCH
      parameters:
      - name: appPkgId
        in: path
        description: Identifier of an individual application package resource
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Parameters for application package information modification.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppPkgInfoModifications'
        required: true
      responses:
        '200':
          description: Shows that the operation has been completed successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppPkgInfoModifications'
        '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'
        '409':
          description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource'
          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
779
780
781
  /subscriptions:
    post:
      tags:
782
      - app-pkgm
783
      summary: 'Subscribe to notifications about on-boarding an application package'
784
      description: Subscribe to notifications about on-boarding an application package
Elian Kraja's avatar
Elian Kraja committed
785
      operationId: subscriptionsPOST
786
      parameters: []
Elian Kraja's avatar
Elian Kraja committed
787
      requestBody:
788
        description: The input parameters of subscribe operation to notifications
Elian Kraja's avatar
Elian Kraja committed
789
790
791
792
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppPkgSubscription'
793
        required: true
Elian Kraja's avatar
Elian Kraja committed
794
795
796
      responses:
        '201':
          description: Successful response for created subscription
797
          headers: {}
Elian Kraja's avatar
Elian Kraja committed
798
799
800
          content:
            application/json:
              schema:
801
                $ref: '#/components/schemas/AppPkgSubscriptionInfo'
Elian Kraja's avatar
Elian Kraja committed
802
        '400':
803
804
805
806
807
808
          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
809
        '401':
810
811
812
813
814
815
          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
816
        '403':
817
818
819
820
821
822
          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
823
        '404':
824
825
826
827
828
829
          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
830
        '406':
831
832
833
834
835
836
          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
837
        '429':
838
839
840
841
842
843
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
      callbacks: 
        notification:
          '{$request.body#/subscription.href}':
            post:
              summary: 'Callback POST used to send a notification'
              description: ' The notification is triggered when a new application package is onboarded'
              operationId: notificationPOST
              requestBody:
                description: Subscription notification
                required: true
                content:
                  application/json:
                    schema:
                     $ref: '#/components/schemas/AppPkgNotification'
              responses:
                '204':
                 description: "No content"
Elian Kraja's avatar
Elian Kraja committed
861
862
    get:
      tags:
863
      - app-pkgm
864
865
      summary:  'used to retrieve the information of subscriptions to individual application package resource in MEO or MEAO'
      description: used to retrieve the information of subscriptions to individual application package resource in MEO or MEAO package
Elian Kraja's avatar
Elian Kraja committed
866
      operationId: subscriptionsGET
867
      parameters: []
Elian Kraja's avatar
Elian Kraja committed
868
869
      responses:
        '200':
870
871
          description: List of zero or more subscriptions
          headers: {}
Elian Kraja's avatar
Elian Kraja committed
872
873
874
          content:
            application/json:
              schema:
875
                $ref: '#/components/schemas/AppPkgSubscriptionLinkList'
Elian Kraja's avatar
Elian Kraja committed
876
        '400':
877
878
879
880
881
882
          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
883
        '401':
884
885
886
887
888
889
          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
890
        '403':
891
892
893
894
895
896
          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
897
        '404':
898
899
900
901
902
903
          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
904
        '406':
905
906
907
908
909
910
          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
911
        '429':
912
913
914
915
916
917
918
919
920
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
    parameters: []
  /subscriptions/{subscriptionId}:
Elian Kraja's avatar
Elian Kraja committed
921
922
    get:
      tags:
923
      - app-pkgm
924
      summary:  'Used to represent an individual subscription to notifications about application package changes.'
925
      description: Used to represent an individual subscription to notifications about application package changes.
Elian Kraja's avatar
Elian Kraja committed
926
      operationId: individualSubscriptionGET
927
928
929
930
931
932
933
934
      parameters:
      - name: subscriptionId
        in: path
        description: Identifier of an individual subscription to notifications about application package changes
        required: true
        style: simple
        schema:
          type: string
Elian Kraja's avatar
Elian Kraja committed
935
936
      responses:
        '200':
937
          description: a response body containing a representation of the resource shall be returned.
938
          headers: {}
Elian Kraja's avatar
Elian Kraja committed
939
940
941
          content:
            application/json:
              schema:
942
                $ref: '#/components/schemas/AppPkgSubscriptionInfo'
Elian Kraja's avatar
Elian Kraja committed
943
        '400':
944
945
946
947
948
949
          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
950
        '401':
951
952
953
954
955
956
          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
957
        '403':
958
959
960
961
962
963
          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
964
        '404':
965
966
967
968
969
970
          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
971
        '406':
972
973
974
975
976
977
          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
978
        '429':
979
980
981
982
983
984
985
          description: 'Too Many Requests : used when a rate limiter has triggered.'
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: false
Elian Kraja's avatar
Elian Kraja committed
986
987
    delete:
      tags:
988
      - app-pkgm
989
990
      summary:  'Deletes the individual subscription to notifications about application package changes in MEO or MEAO.'
      description: Deletes the individual subscription to notifications about application package changes in MEO or MEAO.
Elian Kraja's avatar
Elian Kraja committed
991
      operationId: individualSubscriptionDELETE
992
993
994
995
      parameters:
      - name: subscriptionId
        in: path
        description: Identifier of an individual subscription to notifications about application package changes
Elian Kraja's avatar
Elian Kraja committed
996
        required: true
997
998
999
        style: simple
        schema:
          type: string
Elian Kraja's avatar
Elian Kraja committed
1000
      responses:
For faster browsing, not all history is shown. View entire blame