Newer
Older
"info": {
"title": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management",
"description": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI.",
"license": {
"name": "BSD-3-Clause",
"url": "https://forge.etsi.org/legal-matters"
"contact": {
"name": "ETSI Forge",
"url": "https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api",
"email": "cti_support@etsi.org"
},
},
"externalDocs": {
"description": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.2.1",
"url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.02.01_60/gs_MEC01002v020201p.pdf"
"jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
"tags": [
{
"name": "app-lcm",
"description": "App lifecycle management"
{
"name": "app-lcm-notifications",
"description": "App lifecycle management notifications"
}
],
"servers": [
{
"url": "https://localhost/app_lcm/v1",
"paths": {
"/app_instances": {
"post": {
"tags": [
],
"summary": "Create an application instance resource",
"description": "Create an application instance resource",
"operationId": "appInstancePOST",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateAppInstanceRequest"
"responses": {
"201": {
"description": "An application instance identifier and the related resource has been created successfully.",
"schema": {
"$ref": "#/components/schemas/AppInstanceInfo"
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Unauthorized : used when the client did not submit credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"406": {
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"get": {
"tags": [
],
"summary": "Queries information relating to on-boarded application packages in the MEO",
"description": "queries information relating to on-boarded application packages in the MEO",
"operationId": "appInstanceGET",
"name": "filter",
"in": "query",
"description": "Attribute-based filtering parameters according to ETSI GS MEC 009",
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
{
"name": "all_fields",
"in": "query",
"description": "Include all complex attributes in the response.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
{
"name": "fields",
"in": "query",
"description": "Complex attributes of AppPkgInfo to be included into the response",
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
{
"name": "exclude_fields",
"in": "query",
"description": "Complex attributes of AppPkgInfo to be excluded from the response.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
{
"name": "exclude_default",
"in": "query",
"description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
],
"responses": {
"200": {
"description": "Array the representations of zero or more application instances",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppInstanceInfo"
},
"description": "",
"contentMediaType": "application/json"
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"406": {
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"/app_instances/{appInstanceId}": {
"get": {
"tags": [
],
"summary": "Retrieves the information of an individual application instance via reading an individual application instance.",
"description": "Retrieves the information of an individual application instance via reading an individual application instance.",
"operationId": "appInstanceIdGET",
"parameters": [
{
"name": "appInstanceId",
"in": "path",
"description": "Identifier of an individual application instance",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Contains a representation of the read resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppInstanceInfo"
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"406": {
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"delete": {
"tags": [
],
"summary": "Deletes an individual application instance resource.",
"description": "Deletes an individual application instance resource.",
"operationId": "appInstanceIdDELETE",
"parameters": [
{
"name": "appInstanceId",
"in": "path",
"description": "Identifier of an individual application instance",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"406": {
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"/subscriptions": {
"post": {
"tags": [
"summary": "subscribe to the notification of application instance related change",
"description": "subscribe to the notification of application instance related change",
"operationId": "appLcmSubscriptionsPOST",
"requestBody": {
"content": {
"application/json": {
"oneOf": [
{
"$ref": "#/components/schemas/AppInstSubscriptionRequest"
},
{
"$ref": "#/components/schemas/AppLcmOpOccSubscriptionRequest"
},
{
"$ref": "#/components/schemas/AppInstIdCreationSubscriptionRequest"
},
{
"$ref": "#/components/schemas/AppInstIdDeletionSubscriptionRequest"
],
"contentMediaType": "application/json"
"responses": {
"201": {
"description": "a representation of the created SubscriptionInfo.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/AppInstSubscriptionInfo"
"$ref": "#/components/schemas/AppLcmOpOccSubscriptionInfo"
},
{
"$ref": "#/components/schemas/AppInstIdCreationSubscriptionInfo"
},
{
"$ref": "#/components/schemas/AppInstIdDeletionSubscriptionInfo"
],
"contentMediaType": "application/json"
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"406": {
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"callbacks": {
"notification": {
"{$request.body#/callbackUri}": {
"post": {
"summary": "Callback POST used to send a notification",
"description": "Notification for informing the subscribers about operational state of application instance resources or state changes of an application LCM operation occurrence. It depends on subscription type.",
"operationId": "notificationPOST",
"requestBody": {
"description": "Subscription notification",
"required": true,
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/AppInstNotification"
},
{
"$ref": "#/components/schemas/AppLcmOpOccNotification"
}
]
}
}
}
},
"responses": {
"204": {
"description": "No content"
},
"404": {
"description": "Not found"
}
}
}
}
}
},
"deprecated": false
},
"get": {
"tags": [
],
"summary": "Retrieves the information of multiple subscriptions to notifications related to an application instance.",
"description": "Retrieves the information of multiple subscriptions to notifications related to an application instance.",
"operationId": "appLcmSubscriptionsGET",
"name": "subscriptionType",
"description": "Query parameter to filter on a specific subscription type.",
"$ref": "#/components/schemas/AppInstanceSubscriptionType"
"responses": {
"200": {
"description": "List of all subscriptions is returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppInstanceSubscriptionLinkList"
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"406": {
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"/subscriptions/{subscriptionId}": {
"get": {
"tags": [
],
"summary": "Used to represent an individual subscription to notifications about application package changes.",
"description": "Used to represent an individual subscription to notifications about application package changes.",
"operationId": "individualSubscriptionGET",
"name": "subscriptionId",
"in": "path",
"description": "Represents an individual subscription to notification related to an application instance",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
"responses": {
"200": {
"description": "Representation of the resource.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/AppInstSubscriptionInfo"
},
{
"$ref": "#/components/schemas/AppLcmOpOccSubscriptionInfo"
},
{
"$ref": "#/components/schemas/AppInstIdCreationSubscriptionInfo"
},
{
"$ref": "#/components/schemas/AppInstIdDeletionSubscriptionInfo"
],
"contentMediaType": "application/json"
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"406": {
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"delete": {
"tags": [
"summary": "Deletes the individual subscription to notifications about application package changes in MEO.",
"description": "Deletes the individual subscription to notifications about application package changes in MEO.",
"operationId": "individualSubscriptionDELETE",
"parameters": [
{
"name": "subscriptionId",
"in": "path",
"description": "Represents an individual subscription to notification related to an application instance",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"headers": {},
"content": {}
"description": "Unauthorized : used when the client did not submit credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"/user_defined_notification": {
"post": {
"tags": [
],
"summary": "Delivers a notification from the application lifecycle management resource to the subscriber.",
"description": "Delivers a notification from the application lifecycle management resource to the subscriber.",
"operationId": "appInstNotificationPOST",
"requestBody": {
"content": {
"application/json": {
"oneOf": [
{
"$ref": "#/components/schemas/AppInstNotification"
},
{
"$ref": "#/components/schemas/AppLcmOpOccNotification"
},
{
"$ref": "#/components/schemas/AppInstanceIdentifierCreationNotification"
},
{
"$ref": "#/components/schemas/AppInstanceIdentifierDeletionNotification"
],
"contentMediaType": "application/json"
},
"responses": {
"204": {
"headers": {},
"content": {}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"406": {
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"/app_instances/{appInstanceId}/instantiate": {
"post": {
"tags": [
"summary": "Deletes the individual subscription to notifications about application package changes in MEO.",
"description": "task of instantiating an application instance.",
"operationId": "appLcmInstanciatePOST",
"parameters": [
{
"name": "appInstanceId",
"in": "path",
"description": "Identifier of an individual application instance",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"$ref": "#/components/schemas/InstantiateAppRequest"
}
}
},
"responses": {
"202": {
"description": "accepted for processing, but the processing has not yet been completed.",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"406": {
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"/app_instances/{appInstanceId}/terminate": {
"post": {
"tags": [
],
"summary": "terminate an application instance.",
"description": "terminate an application instance.",
"operationId": "appLcmTerminatePOST",
"parameters": [
{
"name": "appInstanceId",
"in": "path",
"description": "Identifier of an individual application instance",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"$ref": "#/components/schemas/TerminateAppRequest"
}
},
"responses": {
"202": {
"description": "accepted for processing, but the processing has not yet been completed.",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"406": {
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"/app_instances/{appInstanceId}/operate": {
"post": {
"tags": [
],
"summary": "change the operational state, i.e. start or stop, of the application instance",
"description": "change the operational state, i.e. start or stop, of the application instance",
"operationId": "appLcmOperatePOST",
"parameters": [
{
"name": "appInstanceId",
"in": "path",
"description": "Identifier of an individual application instance",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperateAppRequest"
},
"responses": {
"202": {
"description": "accepted for processing, but the processing has not yet been completed.",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"406": {
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"/app_lcm_op_occs": {
"get": {
"tags": [
],
"summary": "retrieves information of operation status about multiple application instance lifecycle management operation occurrences",
"description": "retrieves information of operation status about multiple application instance lifecycle management operation occurrences",
"operationId": "appLcmOpOccsGET",
"name": "filter",
"in": "query",
"description": "Attribute-based filtering parameters according to ETSI GS MEC 009",
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
{
"name": "all_fields",
"in": "query",
"description": "Include all complex attributes in the response.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
},
{
"name": "fields",
"description": "Complex attributes of AppLcmOpOcc to be excluded from the response.",
"schema": {
"type": "string"
},
{
"name": "exclude_fields",
"description": "Complex attributes of AppLcmOpOcc to be excluded from the response.",
"schema": {
"type": "string"
},
{
"name": "exclude_default",
"description": "Indicates to exclude the following complex attributes of AppLcmOpOcc from the response.",
"schema": {
"type": "string"
"responses": {
"200": {
"description": "Status information for zero or more application instance lifecycle management operation occurrences was queried successfully",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppLcmOpOcc"
},
"description": "",
"contentMediaType": "application/json"
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"406": {
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"/app_lcm_op_occs/{appLcmOpOccId}": {
"get": {
"tags": [
],
"summary": "reads the status information of an individual application LCM operation occurrence",
"description": "reads the status information of an individual application LCM operation occurrence",
"operationId": "appLcmOpOccsbyIdGET",
"parameters": [
{
"name": "appLcmOpOccId",
"in": "path",
"description": "Identifies an individual application LCM operation occurrence",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Information about an application LCM operation occurrence was read successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppLcmOpOcc"
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"406": {
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"/app_lcm_op_occs/{appLcmOpOccId}/cancel": {
"post": {
"tags": [
"app-lcm"
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
"summary": "cancel an ongoing application lifecycle operation whose related \"Individual application LCM operation occurrence\" resource is in \"PROCESSING\" state.",
"description": "cancel an ongoing application lifecycle operation whose related \"Individual application LCM operation occurrence\" resource is in \"PROCESSING\" state.",
"operationId": "appLcmCancelPOST",
"parameters": [
{
"name": "appLcmOpOccId",
"in": "path",
"description": "Identifies an individual application LCM operation occurrence",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CancelMode"
}
}
"required": true
},
"responses": {
"202": {
"description": "The request was accepted for processing, but it is possible that the processing is not yet completed.",
"headers": {},
"content": {}
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"406": {
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"409": {
"description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"/app_lcm_op_occs/{appLcmOpOccId}/fail": {
"post": {
"tags": [
"app-lcm"
"summary": "marks an application lifecycle management operation occurrence as \"finally failed\"",
"description": "marks an application lifecycle management operation occurrence as \"finally failed\"",
"operationId": "appLcmFailPOST",
"parameters": [
{
"name": "appLcmOpOccId",
"in": "path",
"description": "Identifies an individual application LCM operation occurrence",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
"responses": {
"202": {
"description": "Shall be returned when the state of the application lifecycle management operation occurrence has been changed successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppLcmOpOcc"
}
}
}
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"406": {
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated": false
},
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
},
"/app_lcm_op_occs/{appLcmOpOccId}/retry": {
"post": {
"tags": [
"app-lcm"
],
"summary": "initiate retrying an application lifecycle operation that has experience a temporary failure",
"description": "initiate retrying an application lifecycle operation that has experience a temporary failure",
"operationId": "appLcmRetryPOST",
"parameters": [
{
"name": "appLcmOpOccId",
"in": "path",
"description": "Identifies an individual application LCM operation occurrence",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "The request was accepted for processing, but it is possible that the processing is not yet completed",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"406": {
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated": false
},
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
},
"/app_instances/{appInstanceId}/configure_platform_for_app": {
"post": {
"tags": [
"app-lcm"
],
"summary": "provide configuration information in AppD to the MEPM-V, intended to configure the MEP to run the application instance.",
"description": "provide configuration information in AppD to the MEPM-V, intended to configure the MEP to run the application instance.",
"operationId": "appInstancesConfigPlatformPOST",
"parameters": [
{
"name": "appInstanceId",
"in": "path",
"description": "The identifier of the application instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The payload body in the request contains the information necessary to provide configuration information in AppD",
"content": {
"application/json": {
"schema": {
"$ref": "./MEC010p2_definitions.yaml#/definitions/ConfigPlatformForAppRequest"
}
}
}
},
"responses": {
"202": {
"description": "The request was accepted for processing, but it is possible that the processing is not yet completed",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"406": {
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"409": {
"description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated": false
},
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
}
},
"components": {
"schemas": {
"AppLcmOpOcc": {
"title": "AppLcmOpOcc",
"required": [
"id",
"operationState",
"stateEnteredTime",
"startTime",
"lcmOperation",
"_links"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "'Identifier of the subscription to application LCM operation occurrence notification'"
},
"operationState": {
"$ref": "#/components/schemas/OperationState"
},
"stateEnteredTime": {
"$ref": "#/components/schemas/TimeStamp"
},
"startTime": {
"$ref": "#/components/schemas/TimeStamp"
},
"lcmOperation": {
"$ref": "#/components/schemas/LcmOperation"
},
"operationParams": {
"$ref": "#/components/schemas/OperationParams"
},
"isCancelPending": {
"type": "boolean",
"description": "If the application LCM operation occurrence operationState is in \"PROCESSING\" state and the operation is being cancelled, this attribute shall be set to true. Otherwise, it shall be set to false."
},
"cancelMode": {
"$ref": "#/components/schemas/CancelMode"
},
"_links": {
"$ref": "#/components/schemas/AppInstanceLcmOpOcc.links"
}
},
"description": "'This data type represents an application lifecycle management operation occurrence'"
},
"AppInstanceSubscriptionLinkList": {
"required": [
"_links"
],
"properties": {
"_links": {
"$ref": "#/components/schemas/AppInstanceSubscriptionLinkList._links"
}
}
},
"AppInstanceSubscriptionLinkList._links": {
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "URI referring to a resource"
},
"subscriptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppInstanceSubscriptionLinkList._links.subscriptions"
}
}
}
},
"AppInstanceSubscriptionLinkList._links.subscriptions": {
"type": "object",
"required": [
"href",
"subscriptionType"
],
"properties": {
"href": {
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
},
"subscriptionType": {
"$ref": "#/components/schemas/AppInstanceSubscriptionType"
}
}
},
"AppInstanceSubscriptionType": {
"type": "string",
"description": "String representing the type of a subscription.",
"enum": [
"AppInstanceStateChangeSubscription",
"AppLcmOpOccStateChangeSubscription",
"AppIdentifierCreationSubscription",
"AppIdentifierDeletionSubscription"
]
},
"OperationParams": {
"oneOf": [
{
"$ref": "#/components/schemas/InstantiateAppRequest"
},
{
"$ref": "#/components/schemas/OperateAppRequest"
},
{
"$ref": "#/components/schemas/TerminateAppRequest"
}
]
},
"CancelMode": {
"description": "Indicates the intervention action to be taken. GRACEFUL Indicates ongoing resource management operations in the underlying system are allowed to complete execution or time out. FORCED Indicates ongoing resource management operations in the underlying system are to be cancelled without allowing them to complete execution or time out.",
"type": "string",
"enum": [
"GRACEFUL",
"FORCED"
]
},
"AppInstIdCreationSubscriptionRequest": {
"type": "object",
"required": [
"subscriptionType",
"callbackUri"
],
"properties": {
"subscriptionType": {
"type": "string"
},
"callbackUri": {
},
"appInstanceSubscriptionFilter": {
"$ref": "#/components/schemas/AppInstanceSubscriptionFilter"
}
}
},
"AppInstIdDeletionSubscriptionRequest": {
"type": "object",
"required": [
"subscriptionType",
"callbackUri"
],
"properties": {
"subscriptionType": {
"type": "string",
"description": "Shall be set to \"AppIdentifierDeletionSubscription\"."
},
"callbackUri": {
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
},
"appInstanceSubscriptionFilter": {
"$ref": "#/components/schemas/AppInstanceSubscriptionFilter"
}
}
},
"AppInstIdCreationSubscriptionInfo": {
"type": "object",
"required": [
"id",
"subscriptionType",
"callbackUri",
"_links"
],
"properties": {
"id": {
"type": "string"
},
"subscriptionType": {
"type": "string"
},
"callbackUri": {
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
},
"appInstanceSubscriptionFilter": {
"$ref": "#/components/schemas/AppInstanceSubscriptionFilter"
},
"_links": {
"type": "object",
"required": [
"self"
],
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
}
}
}
}
},
"AppInstIdDeletionSubscriptionInfo": {
"type": "object",
"required": [
"id",
"subscriptionType",
"callbackUri",
"_links"
],
"properties": {
"id": {
"type": "string"
},
"subscriptionType": {
"type": "string",
"description": "Shall be set to \"AppIdentifierDeletionSubscription\"."
},
"callbackUri": {
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
},
"appInstanceSubscriptionFilter": {
"$ref": "#/components/schemas/AppInstanceSubscriptionFilter"
},
"_links": {
"type": "object",
"required": [
"self"
],
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
}
}
}
}
},
"AppInstanceLcmOpOcc.links": {
"title": "AppInstanceLcmOpOcc.links",
"required": [
"self",
"appInstance"
],
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
},
"appInstance": {
"$ref": "#/components/schemas/LinkType"
"description": "Links to resources related to this resource."
},
"AppLcmOpOccSubscriptionInfo": {
"required": [
"id",
"subscriptionType",
"callbackUri",
"_links"
],
"properties": {
"id": {
"description": "Identifier of this subscription resource."
},
"subscriptionType": {
"const": "AppLcmOpOccStateChange",
"type": "string",
"description": "Shall be set to \"AppLcmOpOccStateChangeSubscription\".",
"examples": [
"AppLcmOpOccStateChange"
]
},
"callbackUri": {
"type": "string",
"description": "The URI of the endpoint for the notification to be sent to."
"appLcmOpOccSubscriptionFilter": {
"$ref": "#/components/schemas/AppLcmOpOccSubscriptionFilter",
"description": "Criteria used to select application LCM operation occurrences on which to send notifications related to this subscription."
},
"_links": {
"$ref": "#/components/schemas/AppLcmOpOccSubscriptionInfo.links"
},
"description": "'This data type represents a subscription to notifications of application life cycle management operation occurrence'"
},
"AppLcmOpOccSubscriptionInfo.links": {
"title": "AppLcmOpOccSubscriptionInfo.links",
"required": [
"self"
],
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
}
},
"description": "Links to resources related to this resource."
},
"AppInstSubscriptionInfo": {
"required": [
"id",
"subscriptionType",
"callbackUri",
"_links"
],
"properties": {
"id": {
"type": "string",
"description": "'Identifier of the subscription to application instance operational state change notification.'"
},
"subscriptionType": {
"const": "AppInstanceStateChange",
"type": "string",
"description": "Shall be set to \"AppInstanceStateChangeSubscription\".",
"AppInstanceStateChangeSubscription"
"appInstanceState": {
"type": "string",
"enum": [
"NOT_INSTANTIATED",
"STARTED",
"STOPPED"
]
},
"appInstanceSubscriptionFilter": {
"$ref": "#/components/schemas/AppInstanceSubscriptionFilter"
},
"callbackUri": {
"description": "The URI of the endpoint for the subscription related notification to be sent to."
},
"_links": {
"$ref": "#/components/schemas/AppInstSubscriptionInfo.links"
}
},
"description": "'The data type represents a subscription to notification of application instance operational state change.'"
},
"AppInstSubscriptionInfo.links": {
"title": "AppInstSubscriptionInfo.links",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
"description": "Links to resources related to this resource."
},
"AppLcmOpOccSubscriptionRequest": {
"title": "AppLcmOpOccSubscriptionRequest",
"required": [
"callbackUri",
"subscriptionType"
],
"type": "object",
"properties": {
"appLcmOpOccSubscriptionFilter": {
"$ref": "#/components/schemas/AppLcmOpOccSubscriptionFilter"
},
"callbackUri": {
},
"subscriptionType": {
"type": "string",
"description": "Shall be set to \"AppLcmOpOccStateChangeSubscription\"."
},
"AppLcmOpOccSubscriptionFilter": {
"title": "AppLcmOpOccSubscriptionFilter",
"type": "object",
"properties": {
"appInstanceSubscriptionFilter": {
"$ref": "#/components/schemas/AppInstanceSubscriptionFilter"
},
"notificationTypes": {
"description": "Match particular notification types. Permitted values AppLcmOpOccNotification.",
"$ref": "#/components/schemas/NotificationTypes"
},
"operationStates": {
"$ref": "#/components/schemas/OperationStates"
"operationTypes": {
"$ref": "#/components/schemas/OperationTypes"
}
}
},
"NotificationTypes": {
"title": "NotificationTypes",
"const": "AppLcmOperationOccurrenceNotification",
"type": "string",
"description": "Match particular notification types.",
"examples": [
"AppLcmOperationOccurrenceNotification"
]
},
"OperationStates": {
"enum": [
"STARTING",
"PROCESSING",
"COMPLETED",
],
"type": "string",
"description": "'Type of the LCM operation state represented by this application instance LCM operation occurrence.'",
"examples": [
"STARTING"
]
},
"OperationTypes": {
"enum": [
"INSTANTIATE",
"OPERATE",
"TERMINATE"
],
"type": "string",
"description": "'Type of the LCM operation represented by this application instance LCM operation occurrence.'",
"examples": [
"INSTANTIATE"
"MepInformation": {
"type": "object",
"required": [
"mepId"
],
"properties": {
"mepId": {
"type": "string",
"description": "Deployment-specific identifier of MEC platform."
},
"mepName": {
"type": "string",
"description": "Human-readable name of MEC platform"
}
}
},
"CreateAppInstanceRequest": {
"title": "CreateAppInstanceRequest",
"required": [
"appDId"
],
"type": "object",
"properties": {
"appDId": {
"type": "string",
"description": "The application descriptor identifier. It is managed by the application provider to identify the application descriptor in a globally unique way."
},
"appInstanceDescription": {
"type": "string",
"description": "Human-readable description of the application instance to be created."
},
"appInstanceName": {
"type": "string",
"description": "Human-readable name of the application instance to be created."
},
"appPlacementInfo": {
"description": "Describes the information of selected MEC platform for the application instance to associate",
"$ref": "#/components/schemas/MepInformation"
},
"AppInstSubscriptionRequest": {
"required": [
"subscriptionType",
"callbackUri"
],
"properties": {
"subscriptionType": {
"const": "AppInstanceStateChange",
"type": "string",
"description": "Shall be set to \"AppInstanceStateChangeSubscription\".",
"examples": [
"AppInstanceStateChange"
]
},
"callbackUri": {
"type": "string",
"description": "The URI of the endpoint for the notification to be sent to."
},
"appInstanceState": {
"$ref": "#/components/schemas/AppInstanceState"
},
"appInstanceSubscriptionFilter": {
"$ref": "#/components/schemas/AppInstanceSubscriptionFilter"
}
}
},
"AppInstanceSubscriptionFilter": {
"required": [
"appInstSelectorType"
],
"properties": {
"appInstSelectorType": {
"$ref": "#/components/schemas/AppInstSelectorType"
},
"appInstances": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
"appsFromProviders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppsFromProviders"
},
"description": "'This data type represents subscription filter criteria to match application instances. '"
},
"AppsFromProviders": {
"required": [
"appProvider"
],
"properties": {
"appProvider": {
"type": "string",
"description": "Provider of the application and of the AppD."
"appProducts": {
"$ref": "#/components/schemas/AppProducts"
}
},
"description": "'Present only if appInstIdSelector = APP_FROM_PROVIDER. Match existing application instances, or those created in the future whilst the subscription is active, that belong to applications from certain providers.'"
},
"AppProducts": {
"required": [
"appName"
],
"properties": {
"appName": {
"type": "string",
"description": "Name to identify the MEC application."
},
"versions": {
"$ref": "#/components/schemas/AppProducts.Versions"
}
},
"description": "'If present, match application instances that belong to application products with certain product names, from one particular provider.'"
},
"AppProducts.Versions": {
"required": [
"appSoftVersion"
],
"properties": {
"appSoftVersion": {
"type": "string",
"description": "Identifies the version of software of the MEC application."
},
"appDVersion": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"description": "'If present, match application instances that belong to application products with certain versions and a certain product name, from one particular provider.'"
},
"AppInstSelectorType": {
"enum": [
"VOID",
"APP_IDENTITY",
"APP_NAME",
"APP_D_ID",
"APP_FROM_PROVIDER"
],
"type": "string",
"description": "0 = void",
"examples": [
"VOID"
]
},
"AppInstanceState": {
"enum": [
"NOT_INSTANTIATED",
"STARTED",
"STOPPED"
],
"type": "string",
"description": "Only send notifications for application instances that are in one of the states listed in this attribute. If this attribute is absent, match all states.",
"examples": [
"NOT_INSTANTIATED"
]
},
"AppInstNotification": {
"title": "AppInstNotification",
"required": [
"_links",
"appDId",
"appInstanceId",
"appPkgId",
"id",
"notificationType",
"subscriptionId",
"timeStamp"
],
"type": "object",
"properties": {
"_links": {
},
"appDId": {
"type": "string",
"description": "The application descriptor identifier identifies the application package and the application descriptor in a globally unique way."
},
"appInstanceId": {
"type": "string",
"description": "Identifier of application instance."
},
"appPkgId": {
"type": "string",
"description": "Identifier of the onboarded application package."
},
"id": {
"type": "string",
"description": "Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the \"notificationId\" attribute of all these notifications shall have the same value."
},
"notificationType": {
"type": "string",
"description": "Discriminator for the different notification types. Shall be set to \"AppInstanceStateChangeSubscription\" for this notification type."
},
"subscriptionId": {
"type": "string",
"description": "Identifier of the subscription related to this notification."
},
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
},
"appInstLocation": {
"$ref": "#/components/schemas/LocationInformation"
},
"appInstanceState": {
"type": "string",
"enum": [
"NOT_INSTANTIATED",
"STARTED",
"STOPPED"
]
}
}
},
"LocationInformation": {
"type": "object",
"required": [
"countryCode"
],
"properties": {
"countryCode": {
"type": "string"
},
"civicAddress": {
"$ref": "#/components/schemas/LocationInformation.civicAddress"
},
"geographicalPosition": {
"type": "string"
}
}
},
"LocationInformation.civicAddress": {
"type": "object",
"required": [
"civicAddressElement"
],
"properties": {
"civicAddressElement": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CivicAddressElement"
}
},
"AppInstanceInfo": {
"required": [
"id",
"appDId",
"appProvider",
"appName",
"appSoftVersion",
"appDVersion",
"appPkgId",
"instantiationState",
"_links"
],
"properties": {
"id": {
"type": "string",
"description": "Identifier of application instance."
},
"appInstanceName": {
"type": "string",
"description": "Name of the application instance."
},
"appInstanceDescription": {
"type": "string",
"description": "Human-readable description of the application instance to be created."
},
"appDId": {
"type": "string",
"description": "Identifier of this MEC application descriptor. This attribute shall be globally unique."
},
"appProvider": {
"type": "string",
"description": "Provider of the application and of the AppD."
},
"appName": {
"type": "string",
"description": "Name to identify the MEC application."
},
"appSoftVersion": {
"type": "string",
"description": "Identifies the version of software of the MEC application."
},
"appDVersion": {
"type": "string",
"description": "Identifies the version of the application descriptor."
},
"appPkgId": {
"type": "string",
"description": "Identifier of the onboarded application package."
},
"vimConnectionInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VimConnectionInfo"
},
"instantiationState": {
"$ref": "#/components/schemas/InstantiationState"
},
"instantiatedAppState": {
"$ref": "#/components/schemas/InstantiatedAppState"
},
"_links": {
"$ref": "#/components/schemas/AppInstanceInfo.links"
}
},
"description": "'The data type of AppInstanceInfo represents the parameters of instantiated application instance resources.'"
},
"OperationState": {
"enum": [
"STARTING",
"PROCESSING",
"COMPLETED",
],
"type": "string",
"description": "Operation state",
"examples": [
"STARTING"
]
},
"InstantiationState": {
"enum": [
"NOT_INSTANTIATED",
"INSTANTIATED"
],
"type": "string",
"description": "Instantiation state of the application instance",
"examples": [
"NOT_INSTANTIATED"
]
},
"InstantiatedAppState": {
"required": [
"operationalState"
],
"properties": {
"operationalState": {
"$ref": "#/components/schemas/OperationalState"
}
},
"description": "'Information specific to an instantiated application. This attribute shall be present if the instantiationState attribute value is INSTANTIATED.'"
},
"OperationalState": {
"enum": [
"STARTED",
"STOPPED"
],
"type": "string",
"description": "Operational state is applicable in the instantiation state INSTANTIATED",
"examples": [
"STARTED"
]
},
"AppInstanceInfo.links": {
"required": [
"self"
],
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
},
"instantiate": {
"$ref": "#/components/schemas/LinkType"
},
"terminate": {
"$ref": "#/components/schemas/LinkType"
},
"operate": {
"$ref": "#/components/schemas/LinkType"
}
},
"description": "Links to resources related to this resource."
},
"LcmOperation": {
"enum": [
"INSTATIATE",
"OPERATE",
"TERMINATE"
],
"type": "string",
"description": "Type of the actual LCM operation represented by this application instance LCM operation occurrence",
"examples": [
"INSTATIATE"
]
},
"AppLcmOpOccNotification": {
"required": [
"id",
"notificationType",
"operationType",
"operationState",
"subscriptionId",
"timeStamp",
"appLcmOpOccId",
"appInstanceId",
"_links"
],
"properties": {
"id": {
},
"notificationType": {
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
"type": "string",
"description": "Discriminator for the different notification types. Shall be set to \"AppLcmOpOccStateChangeSubscription\" for this notification type."
},
"operationType": {
"type": "string",
"description": "Type of the LCM operation represented by this application instance LCM operation occurrence.",
"enum": [
"INSTANTIATE",
"OPERATE",
"TERMINATE"
]
},
"operationState": {
"type": "string",
"enum": [
"STARTING",
"PROCESSING",
"COMPLETED",
"FAILED",
"FAILED_TEMP"
]
},
"subscriptionId": {
"type": "string",
"description": "Identifier of the subscription related to this notification."
},
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
},
"appLcmOpOccId": {
"type": "string",
"description": "Identifier of application lifecycle management operation occurrence."
},
"appInstanceId": {
"type": "string",
"description": "Identifier of application instance."
},
"_links": {
"$ref": "#/components/schemas/AppLcmOpOccNotification.links"
}
},
"description": "'This data type represents a notification related to state changes of an application LCM operation occurrence which informs the subscribers'"
"AppInstanceIdentifierCreationNotification": {
"title": "AppInstanceIdentifierCreationNotification",
"required": [
"id",
"notificationType",
"subscriptionId",
"timeStamp",
"appInstanceId",
"_links"
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
"type": "object",
"properties": {
"id": {
"type": "string"
},
"notificationType": {
"type": "string",
"description": "Discriminator for the different notification types. Shall be set to \"AppIdentifierCreationSubscription\" for this notification type."
},
"subscriptionId": {
"type": "string"
},
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
},
"appInstanceId": {
"type": "string"
},
"_links": {
"$ref": "#/components/schemas/Notification._links"
}
}
},
"Notification._links": {
"type": "object",
"required": [
"subscription",
"appInstance"
],
"properties": {
"subscription": {
"$ref": "#/components/schemas/LinkType"
},
"appInstance": {
"$ref": "#/components/schemas/LinkType"
}
}
},
"AppInstanceIdentifierDeletionNotification": {
"title": "AppInstanceIdentifierDeletionNotification",
"required": [
"id",
"notificationType",
"subscriptionId",
"timeStamp",
"appInstanceId",
"_links"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"notificationType": {
"type": "string",
"description": "Discriminator for the different notification types. Shall be set to \"AppIdentifierDeletionSubscription\" for this notification type."
},
"subscriptionId": {
"type": "string"
},
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
},
"appInstanceId": {
"type": "string"
},
"_links": {
"$ref": "#/components/schemas/Notification._links"
}
}
},
"AppLcmOpOccNotification.links": {
"required": [
"appInstance",
"subscription",
"appLcmOpOcc"
],
"properties": {
"appInstance": {
"$ref": "#/components/schemas/LinkType"
},
"subscription": {
"$ref": "#/components/schemas/LinkType"
},
"appLcmOpOcc": {
"$ref": "#/components/schemas/LinkType"
},
"description": "Links to resources related to this resource."
},
"InstantiateAppRequest": {
"title": "InstantiateAppRequest",
"required": [
"selectedMECHostInfo"
],
"type": "object",
"properties": {
"locationConstraints": {
"$ref": "#/components/schemas/LocationConstraints"
},
"selectedMECHostInfo": {
"items": {
"$ref": "#/components/schemas/MECHostInformation"
},
"description": "Describes the information of selected host for the application instance. See note 2."
},
"vimConnectionInfo": {
"items": {
"$ref": "#/components/schemas/VimConnectionInfo"
},
"description": "Information about VIM connections to be used for managing the resources for the application instance, or refer to external / externally-managed virtual links.\nThis attribute shall only be supported and may be present if application-related resource management in direct mode is applicable. See note 2."
},
"virtualComputeDescriptor": {
"description": "Describes CPU and memory requirements, as well as optional additional requirements, such as disk and acceleration related capabilities, of the virtualisation container used to realize the application instance to be created. This attribute may be provided in the InstantiateAppRequest structure to override the same attribute in the AppD."
},
"virtualStorageDescriptor": {
"type": "array",
"items": {
"type": "string"
},
"description": "Defines descriptors of virtual storage resources to be used by the application instance to be created. See note 1."
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
},
"appTermCandsForCoord": {
"$ref": "#/components/schemas/AppTermCandsForCoord"
}
}
},
"AppTermCandsForCoord": {
"type": "object",
"required": [
"terminationOptions"
],
"properties": {
"terminationOptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppTermCandsForCoord.terminationOptions"
}
}
}
},
"AppTermCandsForCoord.terminationOptions": {
"type": "object",
"required": [
"appInstIdTerminationCands"
],
"properties": {
"appInstIdTerminationCands": {
"type": "array",
"items": {
"type": "string"
}
}
},
"LinkType": {
"title": "LinkType",
"required": [
],
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "URI referring to a resource"
},
"LocationConstraints": {
"title": "LocationConstraints",
"type": "object",
"properties": {
"countryCode": {
"type": "string",
"description": "The two-letter ISO 3166 country code in capital letters."
"civicAddressElement": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CivicAddressElement"
}
},
"area": {
"type": "object",
"description": "Geographic area. Shall be absent if the \"civicAddressElement\" attribute is present. The content of this attribute shall follow the provisions for the \"Polygon\" geometry object as defined in IETF RFC 7946 [8], for which"
},
"description": "'The LocationConstraints data type supports the specification of MEC application requirements related to MEC application deployment location constraints. The location constraints shall be presented as a country code, optionally followed by a civic address based on the format defined by IETF RFC 4776'"
},
"CivicAddressElement": {
"required": [
"caType",
"caValue"
],
"properties": {
"caType": {
"type": "integer",
"description": "'Describe the content type of caValue. The value of caType shall comply with section 3.4 of IETF RFC 4776.'",
"contentEncoding": "int32"
},
"caValue": {
"type": "string",
"description": "'Content of civic address element corresponding to the caType. The format caValue shall comply with section 3.4 of IETF RFC 4776.'"
},
"description": "'The civic address.'"
},
"MECHostInformation": {
"title": "MECHostInformation",
"required": [
"hostId"
],
"type": "object",
"properties": {
"hostId": {
"description": "Deployment-specific information to identify a MEC host. This information can be structured to cater for host identification schemes that are more complex than a simple identifier, e.g. when referring to the structure of an NFVI."
},
"hostName": {
"type": "string",
"description": "Human-readable name of MEC host."
}
},
"OperateAppRequest": {
"title": "OperateAppRequest",
"required": [
],
"type": "object",
"properties": {
"changeStateTo": {
"$ref": "#/components/schemas/ChangeStateTo"
},
"gracefulStopTimeout": {
"type": "integer",
"description": "The time interval (in seconds) to wait for the application instance to be taken out of service during graceful stop, before stopping the application. See note 1 and note 2.",
"contentEncoding": "int32"
},
"stopType": {
"$ref": "#/components/schemas/StopType"
},
"StopType": {
"enum": [
"FORCEFUL",
"GRACEFUL"
],
"type": "string",
"description": "Signals forceful or graceful stop",
"examples": [
"FORCEFUL"
]
},
"ChangeStateTo": {
"enum": [
"STARTED",
"STOPPED"
],
"type": "string",
"description": "The desired operational state",
"examples": [
"STARTED"
]
},
"ProblemDetails": {
"title": "ProblemDetails",
"type": "object",
"properties": {
"detail": {
"type": "string",
"description": "A human-readable explanation specific to this occurrence of the problem"
"instance": {
"type": "string",
"description": "A URI reference that identifies the specific occurrence of the problem"
"status": {
"type": "integer",
"description": "The HTTP status code for this occurrence of the problem",
"contentEncoding": "int32"
},
"title": {
"type": "string",
"description": "A short, human-readable summary of the problem type"
},
"type": {
"type": "string",
"description": "A URI reference according to IETF RFC 3986 that identifies the problem type"
},
"TerminateAppRequest": {
"title": "TerminateAppRequest",
"required": [
"terminationType"
],
"type": "object",
"properties": {
"gracefulTerminationTimeout": {
"type": "integer",
"description": "This attribute is only applicable in case of graceful termination. It defines the time to wait for the application instance to be taken out of service before shutting down the application and releasing the resources. \nThe unit is seconds.\nIf not given and the \"terminationType\" attribute is set to \"GRACEFUL\", it is expected to wait for the successful taking out of service of the application, no matter how long it takes, before shutting down the application and releasing the resources.",
"contentEncoding": "int32"
},
"terminationType": {
"$ref": "#/components/schemas/TerminationType"
}
},
"TimeStamp": {
"title": "TimeStamp",
"required": [
],
"type": "object",
"properties": {
"nanoSeconds": {
"type": "integer",
"description": "The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.",
"contentEncoding": "int32"
"seconds": {
"type": "integer",
"description": "The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.",
},
"TerminationType": {
"enum": [
"FORCEFUL",
"GRACEFUL"
],
"type": "string",
"description": "'Indicates whether forceful or graceful termination is requested.'",
"examples": [
"FORCEFUL"
]
},
"VimConnectionInfo": {
"title": "VimConnectionInfo",
"required": [
"id",
"vimType"
],
"type": "object",
"properties": {
"accessInfo": {
"type": "object",
"description": "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'"
"type": "object",
"description": "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'"
"id": {
"type": "string",
"description": "The identifier of the VIM Connection. This identifier is managed by the MEO."
"interfaceInfo": {
"type": "object",
"description": "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'"
"vimId": {
"type": "string",
"description": "The identifier of the VIM instance. This identifier is managed by the MEO.Shall be present to address additional information about the VIM if such information has been configured into the MEPM by means outside the scope of the present document, and should be absent otherwise."
"vimType": {
"type": "string",
"description": "Discriminator for the different types of the VIM information.The value of this attribute determines the structure of the \"interfaceInfo\" and \"accessInfo\" attributes, based on the type of the VIM.The set of permitted values is expected to change over time as new types or versions of VIMs become available."
}
},
"Links": {
"title": "Links",
"required": [
],
"type": "object",
"properties": {
"subscription": {
"$ref": "#/components/schemas/LinkType"
},
"description": "Links to resources related to this notification."