Newer
Older
info:
title: MEC Service Management API
description: The ETSI MEC ISG MEC011 MEC Service Management API described using OpenAPI
contact:
email: cti_support@etsi.org
version: '2.1.1'
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: {}
/applications/{appInstanceId}/subscriptions:
get:
tags:
- appSubscriptions
summary: ApplicationsSubscriptions_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
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
responses:
'200':
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'
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
description: Forbidden. The operation is not allowed given the current status of the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
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
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
summary: ApplicationsSubscriptions_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
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
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
parameters: []
/applications/{appInstanceId}/subscriptions/{subscriptionId}:
get:
tags:
- appSubscriptions
summary: ApplicationsSubscription_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
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:
'200':
description: Upon success, a response body containing the requested subscription is returned.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SerAvailabilityNotificationSubscription'
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
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
summary: ApplicationsSubscription_DELETE
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: {}
description: Forbidden. The operation is not allowed given the current status of the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
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:
get:
tags:
- appServices
summary: AppServices_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
parameters:
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
- 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
responses:
'200':
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
description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
headers: {}
content:
application/json:
schema:
minItems: 0
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
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
description: Forbidden. The operation is not allowed given the current status of the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
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
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
post:
tags:
- appServices
summary: AppServices_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
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
responses:
'201':
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
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
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
description: Forbidden. The operation is not allowed given the current status of the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
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}:
get:
tags:
- appServices
summary: AppServicesServiceId_GET
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
responses:
'200':
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
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
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
description: Forbidden. The operation is not allowed given the current status of the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
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
tags:
- appServices
summary: AppServicesServiceId_PUT
description: This method updates the information about a mecService resource
operationId: AppServicesServiceId_PUT
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
responses:
'200':
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
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
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
description: Forbidden. The operation is not allowed given the current status of the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
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
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
- appServices
summary: AppServicesServiceId_DELETE
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
responses:
'204':
description: No Content
description: Forbidden. The operation is not allowed given the current status of the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
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:
get:
tags:
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
- services
summary: 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
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
responses:
'200':
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
description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
headers: {}
content:
application/json:
schema:
minItems: 0
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
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
description: Forbidden. The operation is not allowed given the current status of the resource.
headers: {}
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
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
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}:
get:
tags:
- services
summary: ServicesServiceId_GET
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
responses:
'200':
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
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
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
parameters: []
/transports:
get:
tags:
- transports
summary: 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
parameters: []
responses:
'200':
description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
headers: {}
content:
application/json:
schema:
minItems: 0
type: array
items:
$ref: '#/components/schemas/TransportInfo'
description: ''
contentMediaType: application/json
'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
parameters: []
components:
schemas:
CategoryRef:
required:
- href
- id
- name
- version
type: object
properties:
href:
type: string
description: Reference of the catalogue
examples:
- /example/catalogue1
type: string
description: Unique identifier of the category
examples:
- id12345
type: string
description: Name of the category, example values include RNI, Location & Bandwidth Management
examples:
- RNI
version:
type: string
description: Category version
examples:
- version1
description: This type represents the category reference
EndPointInfo.Address:
required:
- host
- port
type: object
properties:
host:
type: string
description: Host portion of the address
examples:
- 192.0.2.0
type: integer
description: Port portion of the address
contentEncoding: int32
examples:
- 8080
description: A IP address and port pair
EndPointInfo.Addresses:
required:
properties:
addresses:
minItems: 0
items:
$ref: '#/components/schemas/EndPointInfo.Address'
description: ''
description: Entry point information of the service as one or more pairs of IP address and port
EndPointInfo.Alternative:
required:
- alternative
type: object
properties:
alternative:
type: object
description: Entry point information of the service in a format defined by an implementation, or in an external specification.
EndPointInfo.Uris:
required:
properties:
uris:
minItems: 0
items:
type: string
description: ''
description: Entry point information of the service as string, formatted according to URI syntax
LinkType:
type: object
properties:
href:
type: string
description: URI referring to a resource
examples:
- /mecSerMgmtApi/example
description: This type represents a type of link and may be referenced from data structures
MecServiceMgmtApiSubscriptionLinkList.Links:
title: MecServiceMgmtApiSubscriptionLinkList.Links
required:
properties:
self:
$ref: '#/components/schemas/LinkType'
subscriptions:
type: array
items:
$ref: '#/components/schemas/MecServiceMgmtApiSubscriptionLinkList.Subscription'
description: The MEC application instance's subscriptions
description: Self-referring URI.
MecServiceMgmtApiSubscriptionLinkList.Subscription:
title: MecServiceMgmtApiSubscriptionLinkList.Subscription
required:
- href
- rel
type: object
properties:
href:
type: string
description: URI referring to a resource
examples:
- /mecSerMgmtApi/example
rel:
type: string
description: The value shall be se to SerAvailabilityNotificationSubscription.
description: A link to a subscription.
MecServiceMgmtApiSubscriptionLinkList:
title: MecServiceMgmtApiSubscriptionLinkList
required:
properties:
_links:
$ref: '#/components/schemas/MecServiceMgmtApiSubscriptionLinkList.Links'
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.
ProblemDetails:
type: object
properties:
type:
type: string
description: A URI reference according to IETF RFC 3986 that identifies the problem type
title:
type: string
description: A short, human-readable summary of the problem type
status:
type: integer
description: The HTTP status code for this occurrence of the problem
contentEncoding: int32
detail:
type: string
description: A human-readable explanation specific to this occurrence of the problem
instance:
type: string
description: A URI reference that identifies the specific occurrence of the problem
title: SecurityInfo.OAuth2Info.GrantType
- OAUTH2_AUTHORIZATION_CODE
- OAUTH2_IMPLICIT_GRANT
- OAUTH2_RESOURCE_OWNER
- OAUTH2_CLIENT_CREDENTIALS
type: string
description: OAuth 2.0 grant type
examples:
- OAUTH2_CLIENT_CREDENTIALS
SecurityInfo.OAuth2Info:
required:
- grantTypes
- tokenEndpoint
type: object
properties:
grantTypes:
maxItems: 4
minItems: 1
type: array
items:
$ref: '#/components/schemas/SecurityInfo.OAuth2Info.GrantType'
description: List of supported OAuth 2.0 grant types.
tokenEndpoint:
type: string
description: The token endpoint
examples:
- /mecSerMgmtApi/security/TokenEndPoint
description: Parameters related to use of OAuth 2.0
SecurityInfo:
type: object
properties:
oAuth2Info:
$ref: '#/components/schemas/SecurityInfo.OAuth2Info'
description: This type represents security information related to a transport
required:
properties:
self:
$ref: '#/components/schemas/LinkType'
SerAvailabilityNotificationSubscription:
title: SerAvailabilityNotificationSubscription
required:
- subscriptionType
- callbackReference
- _links
type: object
properties:
subscriptionType:
type: string
description: Shall be set to SerAvailabilityNotificationSubscription.
examples:
- SerAvailabilityNotificationSubscription
callbackReference:
type: string
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.
_links:
$ref: '#/components/schemas/Self'
filteringCriteria:
type: 'null'
not:
type: object
description: Filtering criteria to match services for which events are requested to be reported. If absent, matches all services. All child attributes are combined with the logical "AND" operation.
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.
SerAvailabilityNotificationSubscription.FilteringCriteria:
title: SerAvailabilityNotificationSubscription.FilteringCriteria
type: object
properties:
serInstanceIds:
minItems: 0
type: array
items:
type: string
description: Identifiers of service instances about which to report events.
minItems: 0
type: array
items:
type: string
description: Names of services about which to report events.
minItems: 0
type: array
items:
$ref: '#/components/schemas/CategoryRef'
description: Categories of services about which to report events.
minItems: 0
type: array
items:
$ref: '#/components/schemas/ServiceState'
description: States of the services about which to report events. If the event is a state change, this filter represents the state after the change.
isLocal:
type: boolean
description: Indicate whether the service is located in the same locality (as defined by scopeOfLocality) as the consuming MEC application.
examples:
- true
description: Filtering criteria to match services for which events are requested to be reported. If absent, matches all services. All child attributes are combined with the logical "AND" operation.
ServiceAvailabilityNotification:
title: ServiceAvailabilityNotification
required:
- notificationType
- serviceReferences
- _links
type: object
properties:
notificationType:
type: string
description: Shall be set to SerAvailabilityNotificationSubscription.
examples:
- SerAvailabilityNotificationSubscription
type: array
$ref: '#/components/schemas/ServiceAvailabilityNotification.ServiceReferences'
_links:
$ref: '#/components/schemas/Subscription'
description: This type represents the service availability information.
ServiceAvailabilityNotification.ServiceReferences:
title: ServiceAvailabilityNotification.ServiceReferences
- serName
- serInstanceId
- state
- changeType
type: object
serName:
type: string
description: The name of the service. This is how the service producing MEC application identifies the service instance it produces.
examples:
- ExampleService
type: string
description: Identifier of the service instance assigned by the MEC platform.
examples:
- ServiceInstance123
state:
$ref: '#/components/schemas/ServiceState'
changeType:
$ref: '#/components/schemas/ServiceAvailabilityNotification.ChangeType'
description: List of links to services whose availability has changed.
title: ServiceAvailabilityNotification.ChangeType
- ADDED
- REMOVED
- STATE_CHANGED
- ATTRIBUTES_CHANGED
type: string
description: "Type of the change. Valid values:\n ADDED: The service was newly added.\n REMOVED: The service was removed.\n STATE_CHANGED: Only the state of the service was changed. \n ATTRIBUTES_CHANGED: At least one attribute of the service other than state was changed. The change may or may not include changing the state."
examples:
- ADDED
SerializerType:
title: SerializerType
type: string
description: The enumeration represents types of serializers
examples:
- JSON
LocalityType:
title: LocalityType
- MEC_SYSTEM
- MEC_HOST
- NFVI_POP
- ZONE
- ZONE_GROUP
- NFVI_NODE
description: The scope of locality as expressed by "consumedLocalOnly" and "isLocal". If absent, defaults to MEC_HOST
examples:
- MEC_SYSTEM
ServiceState:
title: ServiceState
type: string
description: This enumeration defines the possible states of a service.
examples:
- ACTIVE
ServiceInfo.Post:
required:
- serName
- version
- state
- serializer
type: object
properties:
serInstanceId:
type: string
description: Identifier of the service instance assigned by the MEC platform.
examples:
- ServiceInstance123
serName:
type: string
description: The name of the service. This is how the service producing MEC application identifies the service instance it produces.
examples:
- ExampleService
serCategory:
$ref: '#/components/schemas/CategoryRef'
version:
type: string
description: Service version
examples:
- ServiceVersion1
state:
transportId:
type: string
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.
examples:
- Rest1
transportInfo:
$ref: '#/components/schemas/TransportInfo'
serializer:
scopeOfLocality:
consumedLocalOnly:
type: boolean
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.
examples:
- false
isLocal:
type: boolean
description: Indicate whether the service is located in the same locality (as defined by scopeOfLocality) as the consuming MEC application.
examples:
- true
description: This type represents the general information of a MEC service.
ServiceInfo:
title: ServiceInfo
required:
- serName
- version
- state
- transportInfo
- serializer
type: object
properties:
serInstanceId:
type: string
description: Identifier of the service instance assigned by the MEC platform.
examples:
- ServiceInstance123
serName:
type: string
description: The name of the service. This is how the service producing MEC application identifies the service instance it produces.
examples:
- ExampleService
serCategory:
$ref: '#/components/schemas/CategoryRef'
version:
type: string
description: Service version
examples:
- ServiceVersion1
state:
transportInfo:
$ref: '#/components/schemas/TransportInfo'
serializer:
scopeOfLocality:
consumedLocalOnly:
type: boolean
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.
examples:
- false
isLocal:
type: boolean
description: Indicate whether the service is located in the same locality (as defined by scopeOfLocality) as the consuming MEC application.
examples:
- true
description: This type represents the general information of a MEC service.
Subscription:
required:
properties:
subscription:
$ref: '#/components/schemas/LinkType'
description: A link to the related subscription
TransportInfo:
required:
- id
- name
- type
- protocol
- version
- endpoint
- security
type: object
properties:
id:
type: string
description: The identifier of this transport
examples:
- TransId12345
type: string
description: The name of this transport
examples:
- REST
description:
type: string
description: Human-readable description of this transport
examples:
- REST API
protocol:
type: string
description: The name of the protocol used. Shall be set to HTTP for a REST API.
examples:
- HTTP
version:
type: string
description: The version of the protocol used
examples:
- '2.0'
endpoint:
oneOf:
- $ref: '#/components/schemas/EndPointInfo.Uris'
- $ref: '#/components/schemas/EndPointInfo.Addresses'
- $ref: '#/components/schemas/EndPointInfo.Alternative'
description: This type represents information about a transport endpoint
security:
$ref: '#/components/schemas/SecurityInfo'
implSpecificInfo:
type: object
description: Additional implementation specific details of the transport
description: This type represents the general information of a MEC service.
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
- REST_HTTP
- MB_TOPIC_BASED
- MB_ROUTING
- MB_PUBSUB
- RPC
- RPC_STREAMING
- WEBSOCKET
type: string
description: The enumeration TransportType represents types of transports
examples:
- REST_HTTP
security:
- {}
tags:
- name: appSubscriptions
- name: appServices
- name: services
- name: transports
- name: callbacks
externalDocs:
description: ETSI GS MEC011 Application Enablement API, V2.1.1
url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/02.01.01_60/gs_MEC011v020101p.pdf