Newer
Older
"info": {
"title": "MEC Service Management API",
"description": "The ETSI MEC ISG MEC011 MEC Service Management API described using OpenAPI",
"license": {
"name": "BSD-3-Clause",
"url": "https://forge.etsi.org/legal-matters"
},
"contact": {
"email": "cti_support@etsi.org"
"description": "ETSI GS MEC011 Application Enablement API, V3.1.1",
"url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/03.01.01_60/gs_MEC011v030101p.pdf"
"jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
"servers": [
{
"url": "http://127.0.0.1:8081/mec_service_mgmt/v1",
},
{
"url": "https://127.0.0.1:8081/mec_service_mgmt/v1",
"tags": [
{
"name": "appSubscriptions"
},
{
"name": "appServices"
},
{
"name": "services"
},
{
"name": "transports"
},
{
"name": "callbacks"
},
{
"name": "individualMECservice"
"/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",
"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 message content 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.",
"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"
}
}
}
},
"deprecated": false
},
"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"
}
}
"description": "Message content 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
},
"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"
}
}
}
"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"
}
}
}
}
},
"deprecated": false,
"callbacks": {
"ServiceAvailailityNotification": {
"{$request.body#/callbackReference}": {
"post": {
"description": "'Represents the service availability information that is used in the following cases\n when the MEC platform announces the newly available\nservices to the authorized relevant MEC applications (e.g. the applications that indicate the services as \"optional\" or \"required\") that are subscribed to the corresponding service availability notifications when the MEC platform notifies the authorized relevant applications that are subscribed to the corresponding service availability notifications about the service availability changes.'",
"operationId": "ServiceAvailabilityNotification_POST",
"tags": [
"callbacks"
],
"requestBody": {
"$ref": "#/components/requestBodies/ServiceAvailabilityNotification"
},
"responses": {
"200": {
"description": "Expected responses from callback consumer, if it accepts the callback"
}
}
}
}
"/applications/{appInstanceId}/subscriptions/{subscriptionId}": {
"description": "The GET method requests information about a subscription for this requestor. Upon success, the response contains message content with the subscription for the requestor.",
"operationId": "ApplicationsSubscription_GET",
"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 message content containing the requested subscription is returned.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SerAvailabilityNotificationSubscription"
}
}
}
"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"
}
}
}
"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.",
"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"
}
}
}
"get": {
"tags": [
"appServices"
],
"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": [
{
"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"
}
}
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
{
"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": {},
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
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceInfo"
},
"description": "",
"examples": [
[
{
"serInstanceId": "ServiceInstance123",
"serName": "ExampleService",
"serCategory": {
"href": "catItem1",
"id": "id12345",
"name": "RNI",
"version": "version1"
},
"version": "ServiceVersion1",
"state": "ACTIVE",
"transportInfo": {
"id": "TransId12345",
"name": "REST",
"description": "REST API",
"type": "REST_HTTP",
"protocol": "HTTP",
"version": "2.0",
"endpoint": {
"addresses": [
{
"host": "192.0.2.0",
"port": 8080
}
]
},
"security": {
"oAuth2Info": {
"grantTypes": [
"OAUTH2_CLIENT_CREDENTIALS"
],
"tokenEndpoint": "/mecSerMgmtApi/security/TokenEndPoint"
}
}
},
"serializer": "JSON"
}
]
],
"contentMediaType": "application/json"
},
"examples": {
"ServiceInfoList": {
"value": [
{
"serInstanceId": "ServiceInstance123",
"serName": "ExampleService",
"serCategory": {
"href": "catItem1",
"id": "id12345",
"name": "RNI",
"version": "version1"
},
"version": "ServiceVersion1",
"state": "ACTIVE",
"transportInfo": {
"id": "TransId12345",
"name": "REST",
"description": "REST API",
"type": "REST_HTTP",
"protocol": "HTTP",
"version": "2.0",
"endpoint": {
"addresses": [
{
"host": "192.0.2.0",
"port": 8080
}
]
},
"security": {
"oAuth2Info": {
"grantTypes": [
"OAUTH2_CLIENT_CREDENTIALS"
],
"tokenEndpoint": "/mecSerMgmtApi/security/TokenEndPoint"
}
}
},
"serializer": "JSON"
}
]
}
}
}
}
"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"
}
}
}
}
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
"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
},
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
"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",
"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"
}
}
}
}
}
},
"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"
}
}
}
"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"
}
}
}
"/applications/{appInstanceId}/services/{serviceId}": {
"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 (see note).",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "It is used to indicate nonspecific success. The response message content contains a representation of the resource.",
"headers": {},
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
"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.",
"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"
}
}
}
"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. (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": {},
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
"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.",
"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"
}
}
}
},
"delete": {
"tags": [
"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"
}
}
}
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
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
"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": {},
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
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
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceInfo"
},
"description": "",
"examples": [
[
{
"serInstanceId": "ServiceInstance123",
"serName": "ExampleService",
"serCategory": {
"href": "catItem1",
"id": "id12345",
"name": "RNI",
"version": "version1"
},
"version": "ServiceVersion1",
"state": "ACTIVE",
"transportInfo": {
"id": "TransId12345",
"name": "REST",
"description": "REST API",
"type": "REST_HTTP",
"protocol": "HTTP",
"version": "2.0",
"endpoint": {
"addresses": [
{
"host": "192.0.2.0",
"port": 8080
}
]
},
"security": {
"oAuth2Info": {
"grantTypes": [
"OAUTH2_CLIENT_CREDENTIALS"
],
"tokenEndpoint": "/mecSerMgmtApi/security/TokenEndPoint"
}
}
},
"serializer": "JSON"
}
]
],
"contentMediaType": "application/json"
},
"examples": {
"ServiceInfoList": {
"value": [
{
"serInstanceId": "ServiceInstance123",
"serName": "ExampleService",
"serCategory": {
"href": "catItem1",
"id": "id12345",
"name": "RNI",
"version": "version1"
},
"version": "ServiceVersion1",
"state": "ACTIVE",
"transportInfo": {
"id": "TransId12345",
"name": "REST",
"description": "REST API",
"type": "REST_HTTP",
"protocol": "HTTP",
"version": "2.0",
"endpoint": {
"addresses": [
{
"host": "192.0.2.0",
"port": 8080
}
]
},
"security": {
"oAuth2Info": {
"grantTypes": [
"OAUTH2_CLIENT_CREDENTIALS"
],
"tokenEndpoint": "/mecSerMgmtApi/security/TokenEndPoint"
}
}
},
"serializer": "JSON"
}
]
}
}
}
}
"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": {
"tags": [
"services"
],
"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": {},
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
"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"
}
}
}
}
}
},
"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
},
"/transports": {
"get": {
"tags": [
"transports"
],
"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": {
"tags": [
"individualMECservice"
],
"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": {
"tags": [
"individualMECservice"
],
"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.",
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
"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",
"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"
]
"type": "string",
"description": "Category version",
"examples": [
"version1"
]
},
"description": "This type represents the category reference"
},
"EndPointInfo.Address": {
"required": [
"host",
"port"
],
"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": [
"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": {
"required": [
"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": {
"required": [
"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",
"required": [
"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",
"examples": [
"/mecSerMgmtApi/example"
]
},
"description": "This type represents a type of link and may be referenced from data structures"
},
"MecServiceMgmtApiSubscriptionLinkList.Links": {
"title": "MecServiceMgmtApiSubscriptionLinkList.Links",
"required": [
"self"
],
"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"
],
"properties": {
"href": {
"type": "string",
"description": "URI referring to a resource",
"examples": [
"/mecSerMgmtApi/example"
]
"type": "string",
"description": "The value shall be se to SerAvailabilityNotificationSubscription."
},
"description": "A link to a subscription."
},
"MecServiceMgmtApiSubscriptionLinkList": {
"title": "MecServiceMgmtApiSubscriptionLinkList",
"required": [
"_links"
],
"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"
"type": "string",
"description": "A short, human-readable summary of the problem type"
"type": "integer",
"description": "The HTTP status code for this occurrence of the problem",
"contentEncoding": "int32"
"type": "string",
"description": "A human-readable explanation specific to this occurrence of the problem"
"type": "string",
"description": "A URI reference that identifies the specific occurrence of the problem"
"title": "SecurityInfo.OAuth2Info.GrantType",
"enum": [
"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"
],
"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": [
"self"
],
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
}
},
},
"SerAvailabilityNotificationSubscription": {
"title": "SerAvailabilityNotificationSubscription",
"required": [
"subscriptionType",
"callbackReference",
"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": {
"$ref": "#/components/schemas/SerAvailabilityNotificationSubscription.FilteringCriteria"
}
},
"x-etsi-notes": "NOTE:\tThe attributes \"serInstanceIds\", \"serNames\" and \"serCategories\" provide mutually-exclusive alternatives to define a set of services. Only one of them may be present."
},
"SerAvailabilityNotificationSubscription.FilteringCriteria": {
"title": "SerAvailabilityNotificationSubscription.FilteringCriteria",
"type": "object",
"properties": {
"serInstanceIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Identifiers of service instances about which to report events."
"type": "array",
"items": {
"type": "string"
},
"description": "Names of services about which to report events."
"type": "array",
"items": {
"$ref": "#/components/schemas/CategoryRef"
},
"description": "Categories of services about which to report events."
"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."
"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",
"properties": {
"notificationType": {
"type": "string",
"description": "Shall be set to SerAvailabilityNotificationSubscription.",
"examples": [
"SerAvailabilityNotificationSubscription"
]
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceAvailabilityNotification.ServiceReferences"
},
"_links": {
"$ref": "#/components/schemas/Subscription"
}
},
"description": "This type represents the service availability information."
"ServiceAvailabilityNotification.ServiceReferences": {
"title": "ServiceAvailabilityNotification.ServiceReferences",
"required": [
"serName",
"serInstanceId",
"state",
"changeType"
],
"properties": {
"link": {
"$ref": "#/components/schemas/LinkType"
},
"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."
},
"ServiceAvailabilityNotification.ChangeType": {
"title": "ServiceAvailabilityNotification.ChangeType",
"enum": [
"ADDED",
"REMOVED",
"STATE_CHANGED",
"ATTRIBUTES_CHANGED"
"description": "Type of the change. Valid values:\n 1. ADDED: The service was newly added.\n 2. REMOVED: The service was removed.\n 3. STATE_CHANGED: Only the state of the service was changed. \n 4. ATTRIBUTES_CHANGED: At least one attribute of the service other than state was changed. The change may or may not include changing the state.",
"enum": [
"JSON",
"XML",
"PROTOBUF3"
],
"type": "string",
"description": "The enumeration represents types of serializers",
"examples": [
"JSON"
]
"enum": [
"MEC_SYSTEM",
"MEC_HOST",
"NFVI_POP",
"ZONE",
"ZONE_GROUP",
"NFVI_NODE"
],
"type": "string",
"description": "The scope of locality as expressed by \"consumedLocalOnly\" and \"isLocal\". If absent, defaults to MEC_HOST",
"examples": [
"MEC_SYSTEM"
]
"INACTIVE",
"SUSPENDED"
"description": "This enumeration defines the possible states of a service.",
"examples": [
"ACTIVE"
]
"required": [
"serName",
"version",
"state",
"transportInfo",
"serializer"
],
"properties": {
"serInstanceId": {
"type": "string",
"description": "Identifier of the service instance assigned by the MEC platform.",
"examples": [
"ServiceInstance123"
]
"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"
]
"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. See note 2.",
"examples": [
"transportId1"
]
},
"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
]
"type": "boolean",
"description": "Indicate whether the service is located in the same locality (as defined by scopeOfLocality) as the consuming MEC application.",
"examples": [
true
]
},
"livenessInterval": {
"type": "integer",
"description": "Interval (in seconds) between two consecutive \"heartbeat\" messages (see clause 8.2.10.3.3). If the service-producing application supports sending \"heartbeat\" messages, it shall include this attribute in the registration request. In this case, the application shall either set the value of this attribute to zero or shall use this attribute to propose a non-zero positive value for the liveness interval. If the application has provided this attribute in the request and the MEC platform requires \"heartbeat\" messages, the MEC platform shall return this attribute value in the HTTP responses. The MEC platform may use the value proposed in the request or may choose a different value. If the MEC platform does not require \"heartbeat\" messages for this service instance it shall omit the attribute in responses."
},
"_links": {
"type": "object",
"required": [
"self"
],
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
},
"liveness": {
"$ref": "#/components/schemas/LinkType"
}
}
"description": "This type represents the general information of a MEC service.",
"x-etsi-notes": "NOTE 1:\tThe service category may be included in the application descriptor. It may be allocated by the operator or by the application developer.\nNOTE 2:\tEither transportId or transportInfo but not both shall be present in POST requests.\nNOTE 3:\tValues NFVI_POP, ZONE and NFVI_NODE are used when the service instance is deployed as a VNF.\nNOTE 4:\tThe isLocal is used only in service availability query response and service availability subscription/notification messages.\nNOTE 5:\tValue ZONE_GROUP can be used when the service instance is deployed as a VNF.\nNOTE 6:\tRegarding the value MEC_SYSTEM, if the service is running on the same MEC system as the MEC app, then it will be local to it."
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
"ServiceLivenessInfo": {
"type": "object",
"required": [
"state",
"timeStamp",
"interval"
],
"properties": {
"state": {
"$ref": "#/components/schemas/ServiceState"
},
"timeStamp": {
"type": "object",
"description": "The time when the last \"heartbeat\" message was received by MEC platform",
"required": [
"seconds",
"nanoSeconds"
],
"properties": {
"seconds": {
"type": "integer"
},
"nanoSeconds": {
"type": "integer"
}
}
},
"interval": {
"type": "integer",
"description": "The interval (in seconds) between two consecutive \"heartbeat\" messages (see clause 8.2.10.3.3) that MEC platform has determined."
}
}
},
"ServiceLivenessUpdate": {
"type": "object",
"required": [
"state"
],
"properties": {
"state": {
"$ref": "#/components/schemas/ServiceState"
}
}
},
"required": [
"subscription"
],
"properties": {
"subscription": {
"$ref": "#/components/schemas/LinkType"
}
},
"description": "A link to the related subscription"
},
"TransportInfo": {
"required": [
"id",
"name",
"type",
"protocol",
"version",
"endpoint",
"security"
],
"properties": {
"id": {
"type": "string",
"description": "The identifier of this transport",
"examples": [
"TransId12345"
]
"type": "string",
"description": "The name of this transport",
"examples": [
"REST"
]
"type": "string",
"description": "Human-readable description of this transport",
"examples": [
"REST API"
]
"type": "string",
"description": "The name of the protocol used. Shall be set to HTTP for a REST API.",
"examples": [
"HTTP"
]
"type": "string",
"description": "The version of the protocol used",
"examples": [
"2.0"
]
},
"endpoint": {
"oneOf": [
{
"$ref": "#/components/schemas/EndPointInfo.Uris"
},
{
"$ref": "#/components/schemas/EndPointInfo.Fqdn"
},
{
"$ref": "#/components/schemas/EndPointInfo.Addresses"
},
{
"$ref": "#/components/schemas/EndPointInfo.Alternative"
}
"description": "This type represents information about a transport endpoint",
"x-etsi-notes": "NOTE:\tExactly one of \"uris\", \"fqdn\", \"addresses\" or \"alternative\" shall be present."
},
"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."
"enum": [
"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"
]
}
},
"requestBodies": {
"ServiceAvailabilityNotification": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceAvailabilityNotification"
}
}
},
"required": true
}
}