Newer
Older
"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. (see note)",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
"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": {
"description": "It is used to indicate nonspecific success. The response message content contains a representation of the resource.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceInfo"
},
"examples": [
{
"ServiceInfo": {
"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",
"_links": {
"self": {
"href": "http://example.com/"
}
"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": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"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.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
},
"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": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"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. (see note)",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"headers": {},
"content": {}
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"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.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
"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": {
"description": "It is used to indicate nonspecific success. The response message content contains a representation of the resource.",
"headers": {},
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceInfo"
},
"description": "",
"examples": [
[
{
"serInstanceId": "ServiceInstance123",
"serName": "ExampleService",
"serCategory": {
"href": "catItem1",
"id": "id12345",
"name": "RNI",
"version": "version1"
},
"version": "ServiceVersion1",
"state": "ACTIVE",
"transportInfo": {
"id": "TransId12345",
"name": "REST",
"description": "REST API",
"type": "REST_HTTP",
"protocol": "HTTP",
"version": "2.0",
"endpoint": {
"addresses": [
{
"host": "192.0.2.0",
"port": 8080
}
]
},
"security": {
"oAuth2Info": {
"grantTypes": ["OAUTH2_CLIENT_CREDENTIALS"],
"tokenEndpoint": "/mecSerMgmtApi/security/TokenEndPoint"
}
}
},
"serializer": "JSON",
"_links": {
"self": {
"href": "http://example.com/"
}
}
}
]
],
"contentMediaType": "application/json"
},
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
"examples": {
"ServiceInfoList": [
{
"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
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
"security": {
"oAuth2Info": {
"grantTypes": ["OAUTH2_CLIENT_CREDENTIALS"],
"tokenEndpoint": "/mecSerMgmtApi/security/TokenEndPoint"
}
}
},
"serializer": "JSON",
"_links": {
"self": {
"href": "http://example.com/"
}
}
},
{
"serInstanceId": "ServiceInstance345",
"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.1",
"port": 8080
]
},
"security": {
"oAuth2Info": {
"grantTypes": ["OAUTH2_CLIENT_CREDENTIALS"],
"tokenEndpoint": "/mecSerMgmtApi/security/TokenEndPoint"
},
"serializer": "JSON",
"_links": {
"self": {
"href": "http://example.com/"
}
}
"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": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"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.",
"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.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
}
},
"deprecated": false
},
"/services/{serviceId}": {
"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. (see note)",
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"x-etsi-notes": "NOTE:\t serviceId corresponds to serInstanceId"
}
],
"responses": {
"200": {
"description": "It is used to indicate nonspecific success. The response message content contains a representation of the resource.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceInfo"
},
"examples": [
{
"ServiceInfo": {
"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",
"_links": {
"self": {
"href": "http://example.com/"
}
}
}
},
"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": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
},
"403": {
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"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.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
}
},
"deprecated": false
"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",
"description": "It is used to indicate nonspecific success. The response messages content contains a representation of the resource.",
"headers": {},
"content": {
"application/json": {
"schema": {
"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.",
"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.",
"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.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
}
},
"deprecated": false
},
"/resource_uri_allocated_by_MEC_platform": {
"get": {
"description": "This method retrieves information about an \"Individual mecServiceLiveness\" resource",
"operationId": "get_individual_MEC_service",
"responses": {
"200": {
"description": "It is used to indicate nonspecific success. The response message content contains a representation of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceLivenessInfo"
}
}
}
},
"400": {
"description": "It is used to indicate that incorrect parameters were passed to the request. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "The operation is not allowed given the current status of the resource. More information shall be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "It is used when a client provided a URI that cannot be mapped to a valid resource URI. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
},
"patch": {
"description": "This method updates a resource on top of the existing resource state with partial changes described by the client.",
"operationId": "patch_individual_MEC_service",
"requestBody": {
"description": "It contains an update of the liveness state.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceLivenessUpdate"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Upon success, a response message content is returned containing the updated liveness interval value of the service Instance.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceLivenessInfo"
}
}
}
},
"204": {
"description": "Successful response sent when there is no need to provide a new liveness interval value to the service Instance.",
"headers": {},
"content": {}
},
"400": {
"description": "It is used to indicate that incorrect parameters were passed to the request. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "The operation is not allowed given the current status of the resource. More information shall be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "It is used when a client provided a URI that cannot be mapped to a valid resource URI. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.",
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"409": {
"description": "The operation is not allowed due to a conflict with the state of the resource. The MEC platform shall respond with this code if the service instance is in \"INACTIVE\" state. More information shall be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"412": {
"description": "It is used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"required": ["href", "id", "name", "version"],
"properties": {
"href": {
"type": "string",
"description": "Reference of the catalogue",
"type": "string",
"description": "Unique identifier of the category",
"type": "string",
"description": "Name of the category, example values include RNI, Location & Bandwidth Management",
"type": "string",
"description": "Category version",
},
"description": "This type represents the category reference"
},
"EndPointInfo.Address": {
"properties": {
"host": {
"type": "string",
"description": "Host portion of the address",
"type": "integer",
"description": "Port portion of the address",
"contentEncoding": "int32",
},
"description": "A IP address and port pair"
},
"EndPointInfo.Addresses": {
"properties": {
"addresses": {
"items": {
"$ref": "#/components/schemas/EndPointInfo.Address"
"description": "Entry point information of the service as one or more pairs of IP address and port. See note."
"description": "This type represents information about a transport endpoint."
},
"EndPointInfo.Alternative": {
"properties": {
"alternative": {
"type": "object",
"description": "Entry point information of the service in a format defined by an implementation, or in an external specification. See note."
"description": "This type represents information about a transport endpoint."
},
"EndPointInfo.Uris": {
"properties": {
"uris": {
"description": "Entry point information of the service as string, formatted according to URI syntax"
"description": "This type represents information about a transport endpoint."
},
"EndPointInfo.Fqdn": {
"title": "EndPointInfo.Fqdn",
"type": "object",
"properties": {
"fqdn": {
"type": "array",
"items": {
"type": "string"
},
"description": "Fully Qualified Domain Name of the service. See note."
}
},
"description": "This type represents information about a transport endpoint. "
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "URI referring to a resource",
},
"description": "This type represents a type of link and may be referenced from data structures"
},
"MecServiceMgmtApiSubscriptionLinkList.Links": {
"title": "MecServiceMgmtApiSubscriptionLinkList.Links",
"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",
"properties": {
"href": {
"type": "string",
"description": "URI referring to a resource",
"type": "string",
"description": "The value shall be se to SerAvailabilityNotificationSubscription."
},
"description": "A link to a subscription."
},
"MecServiceMgmtApiSubscriptionLinkList": {
"title": "MecServiceMgmtApiSubscriptionLinkList",
"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."