Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
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
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
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
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
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
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
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
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
863
864
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
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
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
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.2
servers:
- url: 'http://127.0.0.1:8081/mec_service_mgmt/v1'
- url: 'https://127.0.0.1:8081/mec_service_mgmt/v1'
info:
title: MEC Service Management API
version: 2.0.9
description: The ETSI MEC ISG MEC011 MEC Service Management API described using OpenAPI
license:
name: ETSI Forge copyright notice
url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt'
contact:
email: cti_support@etsi.org
externalDocs:
description: 'ETSI GS MEC011 Application Enablement API, V2.0.9'
url: >-
https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv209.zip
tags:
- name: appSubscriptions
- name: appServices
- name: services
- name: transports
- name: callbacks
paths:
'/services':
get:
description: >-
This method retrieves information about a list of mecService resources.
This method is typically used in "service availability query" procedure
operationId: Services_GET
tags:
- services
parameters:
- $ref: '#/components/parameters/Query.Ser_instance_id'
- $ref: '#/components/parameters/Query.Ser_name'
- $ref: '#/components/parameters/Query.Ser_category_id'
- $ref: '#/components/parameters/Query.Consumed_local_only'
- $ref: '#/components/parameters/Query.Is_local'
- $ref: '#/components/parameters/Query.LocalityTypes'
responses:
'200':
$ref: '#/components/responses/Services.200'
'400':
$ref: '#/components/responses/Error.400'
'403':
$ref: '#/components/responses/Error.403'
'404':
$ref: '#/components/responses/Error.404'
'/services/{serviceId}':
parameters:
- $ref: '#/components/parameters/Path.ServiceId'
get:
description: >-
This method retrieves information about a mecService resource. This
method is typically used in "service availability query" procedure
operationId: ServicesServiceId_GET
tags:
- services
responses:
'200':
$ref: '#/components/responses/ServicesServiceId.200'
'400':
$ref: '#/components/responses/Error.400'
'403':
$ref: '#/components/responses/Error.403'
'404':
$ref: '#/components/responses/Error.404'
'/applications/{appInstanceId}/services':
parameters:
- $ref: '#/components/parameters/Path.AppInstanceId'
get:
description: >-
This method retrieves information about a list of mecService resources.
This method is typically used in "service availability query" procedure
operationId: AppServices_GET
tags:
- appServices
parameters:
- $ref: '#/components/parameters/Query.Ser_instance_id'
- $ref: '#/components/parameters/Query.Ser_name'
- $ref: '#/components/parameters/Query.Ser_category_id'
- $ref: '#/components/parameters/Query.Consumed_local_only'
- $ref: '#/components/parameters/Query.Is_local'
- $ref: '#/components/parameters/Query.LocalityTypes'
responses:
'200':
$ref: '#/components/responses/Services.200'
'400':
$ref: '#/components/responses/Error.400'
'403':
$ref: '#/components/responses/Error.403'
'404':
$ref: '#/components/responses/Error.404'
post:
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
tags:
- appServices
responses:
'201':
$ref: '#/components/responses/Services.201'
'400':
$ref: '#/components/responses/Error.400'
'403':
$ref: '#/components/responses/Error.403'
'404':
$ref: '#/components/responses/Error.404'
requestBody:
$ref: '#/components/requestBodies/Services.Post'
'/applications/{appInstanceId}/services/{serviceId}':
parameters:
- $ref: '#/components/parameters/Path.AppInstanceId'
- $ref: '#/components/parameters/Path.ServiceId'
get:
description: >-
This method retrieves information about a mecService resource. This
method is typically used in "service availability query" procedure
operationId: AppServicesServiceId_GET
tags:
- appServices
responses:
'200':
$ref: '#/components/responses/ServicesServiceId.200'
'400':
$ref: '#/components/responses/Error.400'
'403':
$ref: '#/components/responses/Error.403'
'404':
$ref: '#/components/responses/Error.404'
put:
description: This method updates the information about a mecService resource
operationId: AppServicesServiceId_PUT
tags:
- appServices
responses:
'200':
$ref: '#/components/responses/ServicesServiceId.200'
'400':
$ref: '#/components/responses/Error.400'
'403':
$ref: '#/components/responses/Error.403'
'404':
$ref: '#/components/responses/Error.404'
'412':
$ref: '#/components/responses/Error.412'
requestBody:
$ref: '#/components/requestBodies/ServicesServiceId'
'/applications/{appInstanceId}/subscriptions':
parameters:
- $ref: '#/components/parameters/Path.AppInstanceId'
get:
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
tags:
- appSubscriptions
responses:
'200':
$ref: '#/components/responses/ApplicationsSubscriptions.200'
'400':
$ref: '#/components/responses/Error.400'
'403':
$ref: '#/components/responses/Error.403'
'404':
$ref: '#/components/responses/Error.404'
post:
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
tags:
- appSubscriptions
responses:
'201':
$ref: '#/components/responses/ApplicationsSubscriptions.201'
'400':
$ref: '#/components/responses/Error.400'
'403':
$ref: '#/components/responses/Error.403'
'404':
$ref: '#/components/responses/Error.404'
requestBody:
$ref: '#/components/requestBodies/ApplicationsSubscriptions'
callbacks:
serviceAvailabilityNotification:
$ref: '#/components/callbacks/ServiceAvailabilityNotification'
'/applications/{appInstanceId}/subscriptions/{subscriptionId}':
parameters:
- $ref: '#/components/parameters/Path.AppInstanceId'
- $ref: '#/components/parameters/Path.SubscriptionId'
get:
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
tags:
- appSubscriptions
responses:
'200':
$ref: '#/components/responses/ApplicationsSubscription.200'
'400':
$ref: '#/components/responses/Error.400'
'403':
$ref: '#/components/responses/Error.403'
'404':
$ref: '#/components/responses/Error.404'
delete:
description: >-
This method deletes a mecSrvMgmtSubscription. This method is typically used
in "Unsubscribing from service availability event notifications"
procedure.
operationId: ApplicationsSubscription_DELETE
tags:
- appSubscriptions
responses:
'204':
description: No Content
'403':
$ref: '#/components/responses/Error.403'
'404':
$ref: '#/components/responses/Error.404'
'/transports':
get:
description: >-
This method retrieves information about a list of available transports.
This method is typically used by a service-producing application to
discover transports provided by the MEC platform in the
"transport information query" procedure
operationId: Transports_GET
tags:
- transports
responses:
'200':
$ref: '#/components/responses/Transports.200'
'400':
$ref: '#/components/responses/Error.400'
'403':
$ref: '#/components/responses/Error.403'
'404':
$ref: '#/components/responses/Error.404'
components:
schemas:
Empty:
description: Empty schema
CategoryRef.Href:
description: Reference of the catalogue
type: string
example: 'catItem1'
CategoryRef.Id:
description: Unique identifier of the category
type: string
example: 'id12345'
CategoryRef.Name:
description: Name of the category, example values include RNI, Location & Bandwidth Management
type: string
example: 'RNI'
CategoryRef.Version:
description: Category version
type: string
example: 'version1'
CategoryRef:
description: This type represents the category reference
type: object
required:
- href
- id
- name
- version
properties:
href:
$ref: '#/components/schemas/CategoryRef.Href'
id:
$ref: '#/components/schemas/CategoryRef.Id'
name:
$ref: '#/components/schemas/CategoryRef.Name'
version:
$ref: '#/components/schemas/CategoryRef.Version'
EndPointInfo.Address.Host:
description: Host portion of the address
type: string
example: '192.0.2.0'
EndPointInfo.Address_Port:
description: Port portion of the address
type: integer
format: uint32
example: 8080
EndPointInfo.Address:
description: A IP address and port pair
type: object
required:
- host
- port
properties:
host:
$ref: '#/components/schemas/EndPointInfo.Address.Host'
port:
$ref: '#/components/schemas/EndPointInfo.Address_Port'
EndPointInfo.Addresses:
description: >-
Entry point information of the service as one or more pairs of IP
address and port
type: object
required:
- addresses
properties:
addresses:
type: array
minItems: 0
items:
$ref: '#/components/schemas/EndPointInfo.Address'
EndPointInfo.Alternative:
description: >-
Entry point information of the service in a format defined by an
implementation, or in an external specification.
type: object
required:
- alternative
properties:
alternative:
type: object
EndPointInfo.Uri:
description: Entry point information of the service
type: string
format: uri
example: '/mecSerMgmtApi/service/EntryPoint'
EndPointInfo.Uris:
description: >-
Entry point information of the service as string, formatted according to
URI syntax
type: object
required:
- uris
properties:
uris:
type: array
minItems: 0
items:
$ref: '#/components/schemas/EndPointInfo.Uri'
LinkType:
description: This type represents a type of link and may be referenced from data structures
type: object
properties:
href:
$ref: '#/components/schemas/Href'
Href:
description: URI referring to a resource
type: string
format: uri
example: '/mecSerMgmtApi/example'
MecServiceMgmtApiSubscriptionLinkList.Links:
description: Self-referring URI.
type: object
required:
- self
properties:
self:
$ref: '#/components/schemas/LinkType'
subscriptions:
description: The MEC application instance's subscriptions
type: array
items:
$ref: '#/components/schemas/MecServiceMgmtApiSubscriptionLinkList.Subscription'
MecServiceMgmtApiSubscriptionLinkList.Subscription:
description: A link to a subscription.
type: object
required:
- href
- rel
properties:
href:
$ref: '#/components/schemas/Href'
rel:
description: >-
The value shall be se to SerAvailabilityNotificationSubscription.
type: string
MecServiceMgmtApiSubscriptionLinkList:
description: >-
This type represents a list of links related to currently existing
subscriptions for a MEC application instance. This information
is returned when sending a request to receive current subscriptions.
type: object
required:
- _links
properties:
_links:
$ref: '#/components/schemas/MecServiceMgmtApiSubscriptionLinkList.Links'
ProblemDetails:
type: object
properties:
type:
$ref: '#/components/schemas/Problem.type'
title:
$ref: '#/components/schemas/Problem.title'
status:
$ref: '#/components/schemas/Problem.status'
detail:
$ref: '#/components/schemas/Problem.detail'
instance:
$ref: '#/components/schemas/Problem.instance'
Problem.detail:
type: string
description: A human-readable explanation specific to this occurrence of the problem
Problem.instance:
type: string
format: uri
description: A URI reference that identifies the specific occurrence of the problem
Problem.status:
type: integer
format: uint32
description: The HTTP status code for this occurrence of the problem
Problem.title:
type: string
description: 'A short, human-readable summary of the problem type'
Problem.type:
type: string
format: uri
description: >-
A URI reference according to IETF RFC 3986 that identifies the problem
type
SecurityInfo.OAuth2Info.GrantTypes:
description: List of supported OAuth 2.0 grant types
type: string
enum:
- OAUTH2_AUTHORIZATION_CODE
- OAUTH2_IMPLICIT_GRANT
- OAUTH2_RESOURCE_OWNER
- OAUTH2_CLIENT_CREDENTIALS
example: 'OAUTH2_CLIENT_CREDENTIALS'
SecurityInfo.OAuth2Info.TokenEndpoint:
description: The token endpoint
type: string
format: uri
example: '/mecSerMgmtApi/security/TokenEndPoint'
SecurityInfo.OAuth2Info:
description: Parameters related to use of OAuth 2.0
required:
- grantTypes
- tokenEndpoint
properties:
grantTypes:
description: >-
List of supported OAuth 2.0 grant types.
type: array
minItems: 1
maxItems: 4
items:
$ref: '#/components/schemas/SecurityInfo.OAuth2Info.GrantTypes'
tokenEndpoint:
$ref: '#/components/schemas/SecurityInfo.OAuth2Info.TokenEndpoint'
type: object
SecurityInfo:
description: This type represents security information related to a transport
type: object
properties:
oAuth2Info:
$ref: '#/components/schemas/SecurityInfo.OAuth2Info'
Self:
description: Self-referring URI.
type: object
required:
- self
properties:
self:
$ref: '#/components/schemas/LinkType'
readOnly: true
SerAvailabilityNotificationSubscription.CallbackReference:
description: >-
URI selected by the MEC application instance to receive
notifications on the subscribed MEC service availability
information. This shall be included in both the request and the
response.
type: string
format: uri
SerAvailabilityNotificationSubscription:
description: >-
This type represents a subscription to the notifications from the
MEC platform regarding the availability of a MEC service or a
list of MEC services.
type: object
required:
- subscriptionType
- callbackReference
- _links
- filteringCriteria
properties:
subscriptionType:
$ref: >-
#/components/schemas/SerAvailabilityNotificationSubscription.SubscriptionType
callbackReference:
$ref: >-
#/components/schemas/SerAvailabilityNotificationSubscription.CallbackReference
_links:
$ref: '#/components/schemas/Self'
filteringCriteria:
$ref: '#/components/schemas/ServiceInfo'
SerAvailabilityNotificationSubscription.SubscriptionType:
description: Shall be set to SerAvailabilityNotificationSubscription.
type: string
example: 'SerAvailabilityNotificationSubscription'
ServiceAvailabilityNotification:
description: >-
This type represents the service availability information.
type: object
required:
- notificationType
- services
- _links
properties:
notificationType:
$ref: >-
#/components/schemas/SerAvailabilityNotificationSubscription.SubscriptionType
services:
type: array
items:
$ref: '#/components/schemas/ServiceInfo'
_links:
$ref: '#/components/schemas/Subscription'
SerializerTypes:
description: The enumeration SerializerTypes represents types of serializers
type: string
enum:
- JSON
- XML
- PROTOBUF3
example: 'JSON'
LocalityTypes:
description: The scope of locality as expressed by "consumedLocalOnly" and "isLocal". If absent, defaults to MEC_HOST
type: string
enum:
- MEC_SYSTEM
- MEC_HOST
- NFVI_POP
- ZONE
- ZONE_GROUP
- NFVI_NODE
example: 'MEC_SYSTEM'
ServiceInfo.SerInstanceId:
description: >-
Identifier of the service instance assigned by the MEC platform.
type: string
readOnly: true
example: 'ServiceInstance123'
ServiceInfo.SerName:
description: >-
The name of the service. This is how the service producing MEC
application identifies the service instance it produces.
type: string
example: 'ExampleService'
ServiceInfo.State:
description: Contains the state
type: string
enum:
- ACTIVE
- INACTIVE
example: 'ACTIVE'
ServiceInfo.TransportId:
description: >-
Identifier of the platform-provided transport to be used by the service.
Valid identifiers may be obtained using the "Transport information
query" procedure. May be present in POST requests to signal the use of a
platform-provided transport for the service, and shall be absent
otherwise.
type: string
writeOnly: true
example: 'Rest1'
ServiceInfo.Version:
description: Service version
type: string
example: 'ServiceVersion1'
ServiceInfo.ConsumedLocalOnly:
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.
type: boolean
example: false
ServiceInfo.IsLocal:
description: >-
Indicate whether the service is located in the same locality (as defined
by scopeOfLocality) as the consuming MEC application.
type: boolean
example: true
ServiceInfo.Post:
description: This type represents the general information of a MEC service.
type: object
required:
- serName
- version
- state
- serializer
oneOf:
- required: [transportId]
- required: [transportInfo]
properties:
serInstanceId:
$ref: '#/components/schemas/ServiceInfo.SerInstanceId'
serName:
$ref: '#/components/schemas/ServiceInfo.SerName'
serCategory:
$ref: '#/components/schemas/CategoryRef'
version:
$ref: '#/components/schemas/ServiceInfo.Version'
state:
$ref: '#/components/schemas/ServiceInfo.State'
transportId:
$ref: '#/components/schemas/ServiceInfo.TransportId'
transportInfo:
$ref: '#/components/schemas/TransportInfo'
serializer:
$ref: '#/components/schemas/SerializerTypes'
scopeOfLocality:
$ref: '#/components/schemas/LocalityTypes'
consumedLocalOnly:
$ref: '#/components/schemas/ServiceInfo.ConsumedLocalOnly'
isLocal:
$ref: '#/components/schemas/ServiceInfo.IsLocal'
ServiceInfo:
description: This type represents the general information of a MEC service.
type: object
required:
- serName
- version
- state
- transportInfo
- serializer
properties:
serInstanceId:
$ref: '#/components/schemas/ServiceInfo.SerInstanceId'
serName:
$ref: '#/components/schemas/ServiceInfo.SerName'
serCategory:
$ref: '#/components/schemas/CategoryRef'
version:
$ref: '#/components/schemas/ServiceInfo.Version'
state:
$ref: '#/components/schemas/ServiceInfo.State'
transportInfo:
$ref: '#/components/schemas/TransportInfo'
serializer:
$ref: '#/components/schemas/SerializerTypes'
scopeOfLocality:
$ref: '#/components/schemas/LocalityTypes'
consumedLocalOnly:
$ref: '#/components/schemas/ServiceInfo.ConsumedLocalOnly'
isLocal:
$ref: '#/components/schemas/ServiceInfo.IsLocal'
Subscription:
description: A link to the related subscription
type: object
required:
- subscription
properties:
subscription:
$ref: '#/components/schemas/LinkType'
TransportInfo.Description:
description: Human-readable description of this transport
type: string
example: 'REST API'
TransportInfo.Id:
description: The identifier of this transport
type: string
example: 'TransId12345'
TransportInfo.ImplSpecificInfo:
description: Additional implementation specific details of the transport
type: object
TransportInfo.Name:
description: The name of this transport
type: string
example: 'REST'
TransportInfo.Protocol:
description: The name of the protocol used. Shall be set to HTTP for a REST API.
type: string
example: 'HTTP'
TransportInfo.Version:
description: The version of the protocol used
type: string
example: '2.0'
TransportInfo:
description: This type represents the general information of a MEC service.
type: object
required:
- id
- name
- type
- protocol
- version
- endpoint
- security
properties:
id:
$ref: '#/components/schemas/TransportInfo.Id'
name:
$ref: '#/components/schemas/TransportInfo.Name'
description:
$ref: '#/components/schemas/TransportInfo.Description'
type:
$ref: '#/components/schemas/TransportTypes'
protocol:
$ref: '#/components/schemas/TransportInfo.Protocol'
version:
$ref: '#/components/schemas/TransportInfo.Version'
endpoint:
description: This type represents information about a transport endpoint
type: object
oneOf:
- $ref: '#/components/schemas/EndPointInfo.Uris'
- $ref: '#/components/schemas/EndPointInfo.Addresses'
- $ref: '#/components/schemas/EndPointInfo.Alternative'
security:
$ref: '#/components/schemas/SecurityInfo'
implSpecificInfo:
$ref: '#/components/schemas/TransportInfo.ImplSpecificInfo'
TransportTypes:
description: The enumeration TransportTypes represents types of transports
type: string
enum:
- REST_HTTP
- MB_TOPIC_BASED
- MB_ROUTING
- MB_PUBSUB
- RPC
- RPC_STREAMING
- WEBSOCKET
example: 'REST_HTTP'
parameters:
Path.AppInstanceId:
name: appInstanceId
description: >-
Represents a MEC application instance. Note that the
appInstanceId is allocated by the MEC platform manager.
in: path
required: true
schema:
type: string
Path.SubscriptionId:
name: subscriptionId
description: >-
Represents a subscription to the notifications from the MEC
platform.
in: path
required: true
schema:
type: string
Path.ServiceId:
name: serviceId
description: Represents a MEC service instance.
in: path
required: true
schema:
type: string
Query.Ser_category_id:
name: ser_category_id
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.
in: query
required: false
schema:
type: string
Query.Ser_instance_id:
name: ser_instance_id
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.
in: query
required: false
schema:
type: array
items:
type: string
Query.Ser_name:
name: ser_name
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.
in: query
required: false
schema:
type: array
items:
type: string
Query.LocalityTypes:
name: scope_of_locality
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.
in: query
required: false
schema:
type: string
Query.Is_local:
name: is_local
description: >-
Indicate whether the service is located in the same locality (as
defined by scopeOfLocality) as the consuming MEC application.
in: query
required: false
schema:
type: boolean
Query.Consumed_local_only:
name: consumed_local_only
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.
in: query
required: false
schema:
type: boolean
responses:
ApplicationsSubscriptions.200:
description: >-
Upon success, a response body containing the list of links to the
requested subscriptions is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/MecServiceMgmtApiSubscriptionLinkList'
links:
getIndividualmecSerMgmtApiSubscriptionLinkList:
$ref: '#/components/links/GetIndividualmecSerMgmtApiSubscriptionLinkList'
delIndividualmecSerMgmtApiSubscriptionLinkList:
$ref: '#/components/links/DelIndividualmecSerMgmtApiSubscriptionLinkList'
ApplicationsSubscriptions.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
schema:
type: string
format: uri
content:
application/json:
schema:
$ref: '#/components/schemas/SerAvailabilityNotificationSubscription'
links:
getIndividualmecSerMgmtApiSubscription:
$ref: '#/components/links/GetIndividualmecSerMgmtApiSubscription'
delIndividualmecSerMgmtApiSubscription:
$ref: '#/components/links/DelIndividualmecSerMgmtApiSubscription'
ApplicationsSubscription.200:
description: >-
Upon success, a response body containing the requested subscription
is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/SerAvailabilityNotificationSubscription'
Services.200:
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
content:
application/json:
schema:
type: array
minItems: 0
items:
$ref: '#/components/schemas/ServiceInfo'
examples:
ServiceInfoList:
$ref: '#/components/examples/ServiceInfoList'
links:
getIndividualmecService:
$ref: '#/components/links/GetIndividualmecService'
putIndividualmecService:
$ref: '#/components/links/PutIndividualmecService'
Services.201:
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
schema:
type: string
format: uri
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceInfo'
examples:
ServiceInfo:
$ref: '#/components/examples/ServiceInfo'
links:
getIndividualmecService:
$ref: '#/components/links/GetIndividualmecService'
putIndividualmecService:
$ref: '#/components/links/PutIndividualmecService'
ServicesServiceId.200:
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceInfo'
examples:
ServiceInfo:
$ref: '#/components/examples/ServiceInfo'
Transports.200:
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
content:
application/json:
schema:
type: array
minItems: 0
items:
$ref: '#/components/schemas/TransportInfo'
links:
getTransportInfo:
$ref: '#/components/links/GetTransportInfo'
Error.400:
description: >-
Bad Request.
It is used to indicate that incorrect parameters were passed to the request.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
$ref: '#/components/schemas/Empty'
Error.401:
description: >-
Unauthorized.
It is used when the client did not submit the appropriate credentials.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
$ref: '#/components/schemas/Empty'
Error.403:
description: >-
Forbidden.
The operation is not allowed given the current status of the resource.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
Error.404:
description: >-
Not Found.
It is used when a client provided a URI that cannot be mapped
to a valid resource URI.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
$ref: '#/components/schemas/Empty'
Error.409:
description: >-
Conflict.
The operation cannot be executed currently, due to a conflict with
the state of the resource. Typically, this is because the application
instance resource is in NOT_INSTANTIATED state.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
$ref: '#/components/schemas/Empty'
Error.412:
description: >-
Precondition Failed.
It is used when a condition has failed during conditional requests,
e.g. when using ETags to avoid write conflicts.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
$ref: '#/components/schemas/Empty'
Error.429:
description: >-