Newer
Older
"title": "MEC Application Support API",
"version": "2.1.1",
"description": "The ETSI MEC ISG MEC011 MEC Application Support API described using OpenAPI",
"name": "BSD-3-Clause",
"url": "https://forge.etsi.org/legal-matters"
},
"contact": {
"email": "cti_support@etsi.org"
"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"
"jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
"servers": [
{
"url": "http://127.0.0.1:8081/mec_app_support/v1",
"variables": {}
},
{
"url": "https://127.0.0.1:8081/mec_app_support/v1",
"variables": {}
}
],
"description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
"operationId": "ApplicationsTrafficRules_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"
}
}
],
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
"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/TrafficRule"
},
"description": "",
"examples": [
[
{
"trafficRuleId": "TrafficRule123",
"serName": "ExampleService",
"filterType": "FLOW",
"priority": 1,
"trafficFilter": [
{
"srcAddress": [
"192.168.2.0/24",
"192.168.3.0/24"
],
"dstAddress": [
"192.127.4.100/32"
],
"dstPort": [
"80"
]
}
],
"action": "FORWARD_DECAPSULATED",
"dstInterface": {
"interfaceType": "IP",
"dstIpAddress": "20.1.1.1"
},
"state": "ACTIVE"
}
]
],
"contentMediaType": "application/json"
},
"examples": {
"TrafficRules": {
"value": [
{
"trafficRuleId": "TrafficRule123",
"serName": "ExampleService",
"filterType": "FLOW",
"priority": 1,
"trafficFilter": [
{
"srcAddress": [
"192.168.2.0/24",
"192.168.3.0/24"
],
"dstAddress": [
"192.127.4.100/32"
],
"dstPort": [
"80"
]
}
],
"action": "FORWARD_DECAPSULATED",
"dstInterface": {
"interfaceType": "IP",
"dstIpAddress": "20.1.1.1"
},
"state": "ACTIVE"
}
]
}
}
}
}
"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}/traffic_rules/{trafficRuleId}": {
"description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
"operationId": "ApplicationsTrafficRule_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": "trafficRuleId",
"in": "path",
"description": "Represents a traffic rule.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
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
"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/TrafficRule"
},
"examples": {
"TrafficRule": {
"value": {
"trafficRuleId": "TrafficRule123",
"serName": "ExampleService",
"filterType": "FLOW",
"priority": 1,
"trafficFilter": [
{
"srcAddress": [
"192.168.2.0/24",
"192.168.3.0/24"
],
"dstAddress": [
"192.127.4.100/32"
],
"dstPort": [
"80"
]
}
],
"action": "FORWARD_DECAPSULATED",
"dstInterface": {
"interfaceType": "IP",
"dstIpAddress": "20.1.1.1"
},
"state": "ACTIVE"
}
}
}
}
}
"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"
}
}
}
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
"description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
"operationId": "ApplicationsTrafficRule_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": "trafficRuleId",
"in": "path",
"description": "Represents a traffic rule.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "One or more updated attributes that are allowed to be changed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrafficRule"
}
}
},
"required": true
},
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
"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/TrafficRule"
},
"examples": {
"TrafficRule": {
"value": {
"trafficRuleId": "TrafficRule123",
"serName": "ExampleService",
"filterType": "FLOW",
"priority": 1,
"trafficFilter": [
{
"srcAddress": [
"192.168.2.0/24",
"192.168.3.0/24"
],
"dstAddress": [
"192.127.4.100/32"
],
"dstPort": [
"80"
]
}
],
"action": "FORWARD_DECAPSULATED",
"dstInterface": {
"interfaceType": "IP",
"dstIpAddress": "20.1.1.1"
},
"state": "ACTIVE"
}
}
}
}
}
"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"
}
}
}
Walter Featherstone
committed
},
"deprecated": false
},
"parameters": []
"description": "This method retrieves information about all the DNS rules associated with a MEC application instance.",
"operationId": "ApplicationsDnsRules_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"
}
}
],
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
"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/DnsRule"
},
"description": "",
"examples": [
[
{
"dnsRuleId": "DnsRule1",
"domainName": "www.example.com",
"ipAddressType": "IP_V4",
"ipAddress": "146.241.7.3",
"ttl": 300,
"state": "ACTIVE"
},
{
"dnsRuleId": "DnsRule2",
"domainName": "www.example.com",
"ipAddressType": "IP_V4",
"ipAddress": "146.241.7.4",
"ttl": 300,
"state": "INACTIVE"
}
]
],
"contentMediaType": "application/json"
},
"examples": {
"DnsRules": {
"value": [
{
"dnsRuleId": "DnsRule1",
"domainName": "www.example.com",
"ipAddressType": "IP_V4",
"ipAddress": "146.241.7.3",
"ttl": 300,
"state": "ACTIVE"
},
{
"dnsRuleId": "DnsRule2",
"domainName": "www.example.com",
"ipAddressType": "IP_V4",
"ipAddress": "146.241.7.4",
"ttl": 300,
"state": "INACTIVE"
}
]
}
}
}
}
"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}/dns_rules/{dnsRuleId}": {
"description": "This method retrieves information about a DNS rule associated with a MEC application instance.",
"operationId": "ApplicationsDnsRule_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": "dnsRuleId",
"in": "path",
"description": "Represents a DNS rule.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"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/DnsRule"
},
"examples": {
"DnsRule": {
"value": {
"dnsRuleId": "DnsRule1",
"domainName": "www.example.com",
"ipAddressType": "IP_V4",
"ipAddress": "146.241.7.3",
"ttl": 300,
"state": "ACTIVE"
}
}
}
}
}
"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"
}
}
}
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
"description": "This method activates, de-activates or updates a traffic rule.",
"operationId": "ApplicationsDnsRule_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": "dnsRuleId",
"in": "path",
"description": "Represents a DNS rule.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The updated state is included in the entity body of the request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DnsRule"
}
}
},
"required": true
},
"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/DnsRule"
},
"examples": {
"DnsRule": {
"value": {
"dnsRuleId": "DnsRule1",
"domainName": "www.example.com",
"ipAddressType": "IP_V4",
"ipAddress": "146.241.7.3",
"ttl": 300,
"state": "ACTIVE"
}
}
}
}
}
"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
},
"parameters": []
"/applications/{appInstanceId}/subscriptions": {
"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"
}
}
],
"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/MecAppSuptApiSubscriptionLinkList"
}
}
}
"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": "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/AppTerminationNotificationSubscription"
}
}
},
"required": true
},
"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/AppTerminationNotificationSubscription"
}
}
}
"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": {