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"
},
"version": "2.1.1"
},
"externalDocs": {
"description": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1",
"url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.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",
"variables": {}
}
],
"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.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"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.",
"headers": {},
"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.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"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.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"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.",
"headers": {},
"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.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/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.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"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.",
"headers": {},
"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.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"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": {
"description": "No Content",
"headers": {},
"content": {}
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"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.",
"headers": {},
"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.",
"headers": {},
"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",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/subscriptions": {
"post": {
"tags": [
],
"summary": "subscribe to the notification of application instance operational state change",
"description": "subscribe to the notification of application instance operational state change",
"operationId": "appLcmSubscriptionsPOST",
"name": "subscriptionType",
"description": "\"Query parameter to filter on a specific subscription type. Permitted values:\n • \"AppInstanceStateChange\"\n • \"AppLcmOpOccStateChange\"\n\"",
"required": true,
"style": "form",
"explode": true,
"oneOf": [
{
"$ref": "#/components/schemas/AppInst.SubscriptionType"
},
{
"$ref": "#/components/schemas/AppLcmOpOcc.SubscriptionType"
}
]
"requestBody": {
"content": {
"application/json": {
"oneOf": [
{
"$ref": "#/components/schemas/AppInstSubscriptionRequest"
},
{
"$ref": "#/components/schemas/AppLcmOpOccSubscriptionRequest"
],
"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"
],
"contentMediaType": "application/json"
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"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.",
"headers": {},
"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.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
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
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"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"
}
}
}
}
}
},
"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": "Permitted values: AppInstanceStateChange or AppLcmOpOccStateChange",
"schema": {
"type": "string"
"responses": {
"200": {
"description": "List of all subscriptions is returned.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionLinkList"
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"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.",
"headers": {},
"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.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/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"
}
},
{
"name": "subscriptionType",
"description": "Permitted values: AppInstanceStateChange or AppLcmOpOccStateChange",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string"
"responses": {
"200": {
"description": "Representation of the resource.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/AppInstSubscriptionInfo"
},
{
"$ref": "#/components/schemas/AppLcmOpOccSubscriptionInfo"
}
],
"contentMediaType": "application/json"
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"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.",
"headers": {},
"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.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"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": {
"description": "No Content",
"headers": {},
"content": {}
"description": "Unauthorized : used when the client did not submit credentials.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"headers": {},
"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.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/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"
}
],
"contentMediaType": "application/json"
},
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"401": {