MecServiceMgmtApi.yaml 64.3 KB
Newer Older
1
openapi: 3.1.0
2
3
4
info:
  title: MEC Service Management API
  description: The ETSI MEC ISG MEC011 MEC Service Management API described using OpenAPI
5
6
7
  license:
    name: BSD-3-Clause
    url: 'https://forge.etsi.org/legal-matters'
8
9
  contact:
    email: cti_support@etsi.org
10
  version: '2.2.1'
11
externalDocs:
12
13
  description: ETSI GS MEC011 Application Enablement API, V2.2.1
  url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/02.02.01_60/gs_MEC011v020201p.pdf
14
15
16
17
18
19
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
servers:
- url: http://127.0.0.1:8081/mec_service_mgmt/v1
  variables: {}
- url: https://127.0.0.1:8081/mec_service_mgmt/v1
  variables: {}
20
21
22
23
24
25
tags:
- name: appSubscriptions
- name: appServices
- name: services
- name: transports
- name: callbacks
26
- name: individualMECservice
27

28
paths:
29
  /applications/{appInstanceId}/subscriptions:
30
31
    get:
      tags:
32
      - appSubscriptions
Elian Kraja's avatar
Elian Kraja committed
33
      summary: "Get subscriptions"
34
35
      description: The GET method may be used to request information about all subscriptions for this requestor. Upon success, the response contains entity body with all the subscriptions for the requestor.
      operationId: ApplicationsSubscriptions_GET
36
      parameters:
37
38
39
40
41
42
43
      - name: appInstanceId
        in: path
        description: Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.
        required: true
        style: simple
        schema:
          type: string
44
45
      responses:
        '200':
46
47
48
49
50
51
          description: Upon success, a response body containing the list of links to the requested subscriptions is returned.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MecServiceMgmtApiSubscriptionLinkList'
52
        '400':
53
54
55
56
57
58
59
60
61
62
63
          description: Bad Request. It is used to indicate that incorrect parameters were passed to the request.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                type: object
                description: Empty schema
                contentMediaType: text/plain
64
        '403':
65
66
67
68
69
70
          description: Forbidden. The operation is not allowed given the current status of the resource.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
71
        '404':
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
          description: Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                type: object
                description: Empty schema
                contentMediaType: text/plain
      deprecated: false
    post:
      tags:
      - appSubscriptions
Elian Kraja's avatar
Elian Kraja committed
87
      summary: "Create subscription"
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
      description: The POST method may be used to create a new subscription. One example use case is to create a new subscription to the MEC service availability notifications. Upon success, the response contains entity body describing the created subscription.
      operationId: ApplicationsSubscriptions_POST
      parameters:
      - name: appInstanceId
        in: path
        description: Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Entity body in the request contains a subscription to the MEC application termination notifications that is to be created.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SerAvailabilityNotificationSubscription'
        required: true
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
      responses:
        '201':
          description: Entity body in the request contains a subscription to the MEC service availability notifications that is to be created.
          headers:
            location:
              description: The resource URI of the created resource
              content:
                text/plain:
                  schema:
                    type: string
                    description: The resource URI of the created resource
                    contentMediaType: text/plain
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SerAvailabilityNotificationSubscription'
        '400':
          description: Bad Request. It is used to indicate that incorrect parameters were passed to the request.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                type: object
                description: Empty schema
                contentMediaType: text/plain
        '403':
          description: Forbidden. The operation is not allowed given the current status of the resource.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                type: object
                description: Empty schema
                contentMediaType: text/plain
      deprecated: false
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170

      callbacks:
        ServiceAvailailityNotification:
          '{$request.body#/callbackReference}':
             post:
              description: >-
               'Represents the service availability information that 
               is used in the following cases
                when the MEC platform announces the newly available
               services to the authorized relevant MEC applications (e.g. 
               the applications that indicate the services as "optional" 
               or "required") that are subscribed to the corresponding 
               service availability notifications
               when the MEC platform notifies the authorized relevant 
               applications that are subscribed to the corresponding 
               service availability notifications about the service availability changes.'
              operationId: ServiceAvailabilityNotification_POST
Elian Kraja's avatar
Elian Kraja committed
171
              summary: "Create callback"
172
173
174
175
176
177
178
              tags:
              - callbacks
              requestBody:
               $ref: '#/components/requestBodies/ServiceAvailabilityNotification'
              responses:
               '200':
                 description: Expected responses from callback consumer, if it accepts the callback
179
180
    parameters: []
  /applications/{appInstanceId}/subscriptions/{subscriptionId}:
181
182
    get:
      tags:
183
      - appSubscriptions
Elian Kraja's avatar
Elian Kraja committed
184
      summary: "Get subscription"
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
      description: The GET method requests information about a subscription for this requestor. Upon success, the response contains entity body with the subscription for the requestor.
      operationId: ApplicationsSubscription_GET
      parameters:
      - name: appInstanceId
        in: path
        description: Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.
        required: true
        style: simple
        schema:
          type: string
      - name: subscriptionId
        in: path
        description: Represents a subscription to the notifications from the MEC platform.
        required: true
        style: simple
        schema:
          type: string
202
203
      responses:
        '200':
204
205
206
207
208
209
          description: Upon success, a response body containing the requested subscription is returned.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SerAvailabilityNotificationSubscription'
210
        '400':
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
          description: Bad Request. It is used to indicate that incorrect parameters were passed to the request.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                type: object
                description: Empty schema
                contentMediaType: text/plain
        '403':
          description: Forbidden. The operation is not allowed given the current status of the resource.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                type: object
                description: Empty schema
                contentMediaType: text/plain
      deprecated: false
    delete:
      tags:
      - appSubscriptions
Elian Kraja's avatar
Elian Kraja committed
245
      summary: delete subscription
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
      description: This method deletes a mecSrvMgmtSubscription. This method is typically used in "Unsubscribing from service availability event notifications" procedure.
      operationId: ApplicationsSubscription_DELETE
      parameters:
      - name: appInstanceId
        in: path
        description: Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.
        required: true
        style: simple
        schema:
          type: string
      - name: subscriptionId
        in: path
        description: Represents a subscription to the notifications from the MEC platform.
        required: true
        style: simple
        schema:
          type: string
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
268
        '403':
269
270
271
272
273
274
          description: Forbidden. The operation is not allowed given the current status of the resource.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
275
        '404':
276
277
278
279
280
281
282
283
284
285
286
287
288
289
          description: Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                type: object
                description: Empty schema
                contentMediaType: text/plain
      deprecated: false
    parameters: []
  /applications/{appInstanceId}/services:
290
291
    get:
      tags:
292
      - appServices
Elian Kraja's avatar
Elian Kraja committed
293
      summary: get services
294
295
      description: This method retrieves information about a list of mecService resources. This method is typically used in "service availability query" procedure
      operationId: AppServices_GET
296
      parameters:
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
      - name: appInstanceId
        in: path
        description: Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.
        required: true
        style: simple
        schema:
          type: string
      - name: ser_instance_id
        in: query
        description: A MEC application instance may use multiple ser_instance_ids as an input parameter to query the availability of a list of MEC service instances. Either "ser_instance_id" or "ser_name" or "ser_category_id" or none of them shall be present.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: ser_name
        in: query
        description: A MEC application instance may use multiple ser_names as an input parameter to query the availability of a list of MEC service instances. Either "ser_instance_id" or "ser_name" or "ser_category_id" or none of them shall be present.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: ser_category_id
        in: query
        description: A MEC application instance may use ser_category_id as an input parameter to query the availability of a list of MEC service instances in a serCategory. Either "ser_instance_id" or "ser_name" or "ser_category_id" or none of them shall be present.
        style: form
        explode: true
        schema:
          type: string
      - name: consumed_local_only
        in: query
        description: Indicate whether the service can only be consumed by the MEC  applications located in the same locality (as defined by  scopeOfLocality) as this service instance.
        style: form
        explode: true
        schema:
          type: boolean
      - name: is_local
        in: query
        description: Indicate whether the service is located in the same locality (as  defined by scopeOfLocality) as the consuming MEC application.
        style: form
        explode: true
        schema:
          type: boolean
      - name: scope_of_locality
        in: query
        description: A MEC application instance may use scope_of_locality as an input  parameter to query the availability of a list of MEC service instances  with a certain scope of locality.
        style: form
        explode: true
        schema:
          type: string
350
351
      responses:
        '200':
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
          description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ServiceInfo'
                description: ''
                examples:
                - - serInstanceId: ServiceInstance123
                    serName: ExampleService
                    serCategory:
                      href: catItem1
                      id: id12345
                      name: RNI
                      version: version1
                    version: ServiceVersion1
                    state: ACTIVE
                    transportInfo:
                      id: TransId12345
                      name: REST
                      description: REST API
                      type: REST_HTTP
                      protocol: HTTP
                      version: '2.0'
                      endpoint:
                        addresses:
                        - host: 192.0.2.0
                          port: 8080
                      security:
                        oAuth2Info:
                          grantTypes:
                          - OAUTH2_CLIENT_CREDENTIALS
                          tokenEndpoint: /mecSerMgmtApi/security/TokenEndPoint
                    serializer: JSON
                contentMediaType: application/json
              examples:
                ServiceInfoList:
                  value:
                  - serInstanceId: ServiceInstance123
                    serName: ExampleService
                    serCategory:
                      href: catItem1
                      id: id12345
                      name: RNI
                      version: version1
                    version: ServiceVersion1
                    state: ACTIVE
                    transportInfo:
                      id: TransId12345
                      name: REST
                      description: REST API
                      type: REST_HTTP
                      protocol: HTTP
                      version: '2.0'
                      endpoint:
                        addresses:
                        - host: 192.0.2.0
                          port: 8080
                      security:
                        oAuth2Info:
                          grantTypes:
                          - OAUTH2_CLIENT_CREDENTIALS
                          tokenEndpoint: /mecSerMgmtApi/security/TokenEndPoint
                    serializer: JSON
418
        '400':
419
420
421
422
423
424
425
426
427
428
429
          description: Bad Request. It is used to indicate that incorrect parameters were passed to the request.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                type: object
                description: Empty schema
                contentMediaType: text/plain
430
        '403':
431
432
433
434
435
436
          description: Forbidden. The operation is not allowed given the current status of the resource.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
437
        '404':
438
439
440
441
442
443
444
445
446
447
448
          description: Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                type: object
                description: Empty schema
                contentMediaType: text/plain
449
        '414':
450
451
452
453
454
455
456
457
458
459
460
461
          description: It is used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                type: object
                description: Empty schema
                contentMediaType: text/plain
      deprecated: false
462
463
    post:
      tags:
464
      - appServices
Elian Kraja's avatar
Elian Kraja committed
465
      summary: create service
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
      description: This method is used to create a mecService resource. This method is typically used in "service availability update and new service registration" procedure
      operationId: AppServices_POST
      parameters:
      - name: appInstanceId
        in: path
        description: Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: New ServiceInfo with updated "state" is included as entity body of the request
        content:
          application/json:
            schema:
              oneOf:
              - type: object
              - type: object
              description: New ServiceInfo with updated "state" is included as entity body of the request
              contentMediaType: application/json
        required: true
487
488
      responses:
        '201':
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
          description: Upon success, the HTTP response shall include a Location HTTP header that contains the resource URI of the created resource.
          headers:
            location:
              description: The resource URI of the created resource
              content:
                text/plain:
                  schema:
                    type: string
                    description: The resource URI of the created resource
                    contentMediaType: text/plain
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceInfo'
              examples:
                ServiceInfo:
                  value:
                    serInstanceId: ServiceInstance123
                    serName: ExampleService
                    serCategory:
                      href: catItem1
                      id: id12345
                      name: RNI
                      version: version1
                    version: ServiceVersion1
                    state: ACTIVE
                    transportInfo:
                      id: TransId12345
                      name: REST
                      description: REST API
                      type: REST_HTTP
                      protocol: HTTP
                      version: '2.0'
                      endpoint:
                        uris:
                        - /mecSerMgmtApi/service/EntryPoint
                      security:
                        oAuth2Info:
                          grantTypes:
                          - OAUTH2_CLIENT_CREDENTIALS
                          tokenEndpoint: /mecSerMgmtApi/security/TokenEndPoint
                    serializer: JSON
531
        '400':
532
533
534
535
536
537
538
539
540
541
542
          description: Bad Request. It is used to indicate that incorrect parameters were passed to the request.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                type: object
                description: Empty schema
                contentMediaType: text/plain
543
        '403':
544
545
546
547
548
549
          description: Forbidden. The operation is not allowed given the current status of the resource.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
550
        '404':
551
552
553
554
555
556
557
558
559
560
561
562
563
564
          description: Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                type: object
                description: Empty schema
                contentMediaType: text/plain
      deprecated: false
    parameters: []
  /applications/{appInstanceId}/services/{serviceId}:
565
566
    get:
      tags:
567
      - appServices
Elian Kraja's avatar
Elian Kraja committed
568
      summary: get service
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
      description: This method retrieves information about a mecService resource. This method is typically used in "service availability query" procedure
      operationId: AppServicesServiceId_GET
      parameters:
      - name: appInstanceId
        in: path
        description: Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.
        required: true
        style: simple
        schema:
          type: string
      - name: serviceId
        in: path
        description: Represents a MEC service instance.
        required: true
        style: simple
        schema:
          type: string
586
587
      responses:
        '200':
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
          description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceInfo'
              examples:
                ServiceInfo:
                  value:
                    serInstanceId: ServiceInstance123
                    serName: ExampleService
                    serCategory:
                      href: catItem1
                      id: id12345
                      name: RNI
                      version: version1
                    version: ServiceVersion1
                    state: ACTIVE
                    transportInfo:
                      id: TransId12345
                      name: REST
                      description: REST API
                      type: REST_HTTP
                      protocol: HTTP
                      version: '2.0'
                      endpoint:
                        uris:
                        - /mecSerMgmtApi/service/EntryPoint
                      security:
                        oAuth2Info:
                          grantTypes:
                          - OAUTH2_CLIENT_CREDENTIALS
                          tokenEndpoint: /mecSerMgmtApi/security/TokenEndPoint
                    serializer: JSON
622
        '400':
623
624
625
626
627
628
629
630
631
632
633
          description: Bad Request. It is used to indicate that incorrect parameters were passed to the request.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                type: object
                description: Empty schema
                contentMediaType: text/plain
634
        '403':
635
636
637
638
639
640
          description: Forbidden. The operation is not allowed given the current status of the resource.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
641
        '404':
642
643
644
645
646
647
648
649
650
651
652
653
          description: Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                type: object
                description: Empty schema
                contentMediaType: text/plain
      deprecated: false
654
    put:
655
656
      tags:
      - appServices
Elian Kraja's avatar
Elian Kraja committed
657
      summary: update service
658
659
      description: This method updates the information about a mecService resource
      operationId: AppServicesServiceId_PUT
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
      parameters:
      - name: appInstanceId
        in: path
        description: Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.
        required: true
        style: simple
        schema:
          type: string
      - name: serviceId
        in: path
        description: Represents a MEC service instance.
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: New ServiceInfo with updated "state" is included as entity body of the request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceInfo'
        required: true
682
683
      responses:
        '200':
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
          description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceInfo'
              examples:
                ServiceInfo:
                  value:
                    serInstanceId: ServiceInstance123
                    serName: ExampleService
                    serCategory:
                      href: catItem1
                      id: id12345
                      name: RNI
                      version: version1
                    version: ServiceVersion1
                    state: ACTIVE
                    transportInfo:
                      id: TransId12345
                      name: REST
                      description: REST API
                      type: REST_HTTP
                      protocol: HTTP
                      version: '2.0'
                      endpoint:
                        uris:
                        - /mecSerMgmtApi/service/EntryPoint
                      security:
                        oAuth2Info:
                          grantTypes:
                          - OAUTH2_CLIENT_CREDENTIALS
                          tokenEndpoint: /mecSerMgmtApi/security/TokenEndPoint
                    serializer: JSON
718
        '400':
719
720
721
722
723
724
725
726
727
728
729
          description: Bad Request. It is used to indicate that incorrect parameters were passed to the request.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                type: object
                description: Empty schema
                contentMediaType: text/plain
730
        '403':
731
732
733
734
735
736
          description: Forbidden. The operation is not allowed given the current status of the resource.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
737
        '404':
738
739
740
741
742
743
744
745
746
747
748
          description: Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                type: object
                description: Empty schema
                contentMediaType: text/plain
749
        '412':
750
751
752
753
754
755
756
757
758
759
760
761
          description: Precondition Failed. It is used when a condition has failed during conditional requests,  e.g. when using ETags to avoid write conflicts.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                type: object
                description: Empty schema
                contentMediaType: text/plain
      deprecated: false
762
763
    delete:
      tags:
764
      - appServices
Elian Kraja's avatar
Elian Kraja committed
765
      summary: delete service
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
      description: 'This method deletes a mecService resource. This method is typically used in the service deregistration procedure. '
      operationId: AppServicesServiceId_DELETE
      parameters:
      - name: appInstanceId
        in: path
        description: Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.
        required: true
        style: simple
        schema:
          type: string
      - name: serviceId
        in: path
        description: Represents a MEC service instance.
        required: true
        style: simple
        schema:
          type: string
783
784
785
      responses:
        '204':
          description: No Content
786
787
          headers: {}
          content: {}
788
        '403':
789
790
791
792
793
794
          description: Forbidden. The operation is not allowed given the current status of the resource.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
795
        '404':
796
797
798
799
800
801
802
803
804
805
806
807
808
809
          description: Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                type: object
                description: Empty schema
                contentMediaType: text/plain
      deprecated: false
    parameters: []
  /services:
810
811
    get:
      tags:
812
      - services
Elian Kraja's avatar
Elian Kraja committed
813
      summary: get services
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
      description: This method retrieves information about a list of mecService resources. This method is typically used in "service availability query" procedure
      operationId: Services_GET
      parameters:
      - name: ser_instance_id
        in: query
        description: A MEC application instance may use multiple ser_instance_ids as an input parameter to query the availability of a list of MEC service instances. Either "ser_instance_id" or "ser_name" or "ser_category_id" or none of them shall be present.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: ser_name
        in: query
        description: A MEC application instance may use multiple ser_names as an input parameter to query the availability of a list of MEC service instances. Either "ser_instance_id" or "ser_name" or "ser_category_id" or none of them shall be present.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: ser_category_id
        in: query
        description: A MEC application instance may use ser_category_id as an input parameter to query the availability of a list of MEC service instances in a serCategory. Either "ser_instance_id" or "ser_name" or "ser_category_id" or none of them shall be present.
        style: form
        explode: true
        schema:
          type: string
      - name: consumed_local_only
        in: query
        description: Indicate whether the service can only be consumed by the MEC  applications located in the same locality (as defined by  scopeOfLocality) as this service instance.
        style: form
        explode: true
        schema:
          type: boolean
      - name: is_local
        in: query
        description: Indicate whether the service is located in the same locality (as  defined by scopeOfLocality) as the consuming MEC application.
        style: form
        explode: true
        schema:
          type: boolean
      - name: scope_of_locality
        in: query
        description: A MEC application instance may use scope_of_locality as an input  parameter to query the availability of a list of MEC service instances  with a certain scope of locality.
        style: form
        explode: true
        schema:
          type: string
863
864
      responses:
        '200':
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
          description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ServiceInfo'
                description: ''
                examples:
                - - serInstanceId: ServiceInstance123
                    serName: ExampleService
                    serCategory:
                      href: catItem1
                      id: id12345
                      name: RNI
                      version: version1
                    version: ServiceVersion1
                    state: ACTIVE
                    transportInfo:
                      id: TransId12345
                      name: REST
                      description: REST API
                      type: REST_HTTP
                      protocol: HTTP
                      version: '2.0'
                      endpoint:
                        addresses:
                        - host: 192.0.2.0
                          port: 8080
                      security:
                        oAuth2Info:
                          grantTypes:
                          - OAUTH2_CLIENT_CREDENTIALS
                          tokenEndpoint: /mecSerMgmtApi/security/TokenEndPoint
                    serializer: JSON
                contentMediaType: application/json
              examples:
                ServiceInfoList:
                  value:
                  - serInstanceId: ServiceInstance123
                    serName: ExampleService
                    serCategory:
                      href: catItem1
                      id: id12345
                      name: RNI
                      version: version1
                    version: ServiceVersion1
                    state: ACTIVE
                    transportInfo:
                      id: TransId12345
                      name: REST
                      description: REST API
                      type: REST_HTTP
                      protocol: HTTP
                      version: '2.0'
                      endpoint:
                        addresses:
                        - host: 192.0.2.0
                          port: 8080
                      security:
                        oAuth2Info:
                          grantTypes:
                          - OAUTH2_CLIENT_CREDENTIALS
                          tokenEndpoint: /mecSerMgmtApi/security/TokenEndPoint
                    serializer: JSON
931
        '400':
932
933
934
935
936
937
938
939
940
941
942
          description: Bad Request. It is used to indicate that incorrect parameters were passed to the request.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                type: object
                description: Empty schema
                contentMediaType: text/plain
943
        '403':
944
945
946
947
948
949
          description: Forbidden. The operation is not allowed given the current status of the resource.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
950
        '404':
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
          description: Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                type: object
                description: Empty schema
                contentMediaType: text/plain
        '414':
          description: It is used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                type: object
                description: Empty schema
                contentMediaType: text/plain
      deprecated: false
    parameters: []
  /services/{serviceId}:
977
978
    get:
      tags:
979
      - services
Elian Kraja's avatar
Elian Kraja committed
980
      summary: get service
981
982
983
984
985
986
987
988
989
990
      description: This method retrieves information about a mecService resource. This method is typically used in "service availability query" procedure
      operationId: ServicesServiceId_GET
      parameters:
      - name: serviceId
        in: path
        description: Represents a MEC service instance.
        required: true
        style: simple
        schema:
          type: string
991
992
      responses:
        '200':
993
994
995
996
997
998
999
1000
          description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceInfo'
              examples:
                ServiceInfo:
For faster browsing, not all history is shown. View entire blame