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"
},
"jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
"externalDocs": {
"description": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v3.0.1",
"url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/03.00.01_60/gs_MEC01002v030001p.pdf"
},
"tags": [
{
"name": "app-pkgm",
"description": "App Package management"
{
"name": "app-pkgm-notifications",
"description": "App Package management notifications"
}
],
"servers": [
{
"url": "https://localhost/app_pkgm/v1",
"paths": {
"/app_packages": {
"post": {
"summary": "Create a resource for on-boarding an application package to a MEO/MEAO",
"description": "Create a resource for on-boarding an application package to a MEO/MEAO",
"operationId": "app_packagesPOST",
"requestBody": {
"description": "Resource to be created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateAppPkg"
"responses": {
"201": {
"description": "Successful response for resource creation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPkgInfo",
"description": "The response body shall contain a representation of the application package resource"
"summary": "Queries information relating to on-boarded application packages in the MEO/MEAO'",
"description": "queries information relating to on-boarded application packages in the MEO/MEAO",
"operationId": "app_packagesGET",
"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": "Contains a representation of the application package resource",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppPkgInfo"
"description": "Indicate the success of request. The response message content shall contain a list of representations of the \"individual application package\" resources that match the attribute filter"
},
"401": {
},
"403": {
},
"404": {
},
"406": {
},
"429": {
"/onboarded_app_packages": {
"post": {
"summary": "Create a resource for on-boarding an application package to a MEO/MEAO",
"description": "Create a resource for on-boarding an application package to a MEO/MEAO",
"operationId": "onboarded_app_packagesPOST",
"requestBody": {
"description": "Resource to be created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateAppPkg"
}
"responses": {
"201": {
"description": "Successful response for resource creation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPkgInfo",
"description": "The response body shall contain a representation of the application package resource"
},
"400": {
},
"401": {
},
"403": {
},
"404": {
},
"406": {
},
"429": {
"summary": "Queries information relating to on-boarded application packages in the MEO/MEAO'",
"description": "queries information relating to on-boarded application packages in the MEO/MEAO",
"operationId": "onboarded_app_packagesGET",
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
"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": "Contains a representation of the application package resource",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppPkgInfo"
},
"description": "Indicate the success of request. The response body message content shall contain a list of representations of the \"individual application package\" resources that match the attribute filter."
},
"400": {
},
"401": {
},
"403": {
},
"404": {
},
"406": {
},
"429": {
},
"/app_packages/{appPkgId}": {
"get": {
"summary": "Queries the information related to individual application package resources",
"description": "Queries the information related to individual application package resources",
"operationId": "app_packageGET",
"parameters": [
{
"name": "appPkgId",
"in": "path",
"description": "Identifier of an individual application package resource",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Contains a representation of the application package resource",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/AppPkgInfo"
},
"description": "Indicates the success of request. The response message content shall contain a representation of the resource"
},
"401": {
},
"403": {
},
"404": {
},
"406": {
},
"429": {
"summary": "Deletes an individual application package resources in MEO/MEAO",
"description": "Deletes an individual application package resources in MEO/MEAO",
"operationId": "app_packageDELETE",
"parameters": [
{
"name": "appPkgId",
"in": "path",
"description": "Identifier of an individual application package resource",
"required": true,
"style": "simple",
"schema": {
"type": "string"
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"400": {
},
"401": {
},
"403": {
},
"404": {
},
"406": {
},
"429": {
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
"summary": "Updates the operational state of an individual application package resource",
"description": "Updates the operational state of an individual application package resources",
"operationId": "app_packagePATCH",
"parameters": [
{
"name": "appPkgId",
"in": "path",
"description": "Identifier of an individual application package resource",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Parameters for application package information modification.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPkgInfoModifications"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Shows that the operation has been completed successfully",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/AppPkgInfoModifications"
},
"description": "Shall be returned when the operation has been completed successfully."
},
"400": {
},
"401": {
},
"403": {
},
"404": {
},
"406": {
"/onboarded_app_packages/{appPkgId}": {
"summary": "Queries the information related to individual application package resources",
"description": "Queries the information related to individual application package resources",
"operationId": "onboarded_app_packageGET",
"description": "Identifier of an individual application package resource",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Contains a representation of the application package resource",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/AppPkgInfo"
},
"description": "Indicates the success of request. The response message content shall contain arepresentation of the resource."
},
"401": {
},
"403": {
},
"404": {
},
"406": {
},
"429": {
"summary": "Deletes an individual application package resources in MEO/MEAO",
"description": "Deletes an individual application package resources in MEO/MEAO",
"operationId": "onboarded_app_packageDELETE",
"description": "Identifier of an individual application package resource",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"headers": {},
"content": {}
},
"403": {
},
"404": {
"summary": "Updates the operational state of an individual application package resource",
"description": "Updates the operational state of an individual application package resources",
"operationId": "onboarded_app_packagePATCH",
"description": "Identifier of an individual application package resource",
"schema": {
"type": "string"
"requestBody": {
"description": "Parameters for application package information modification.",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/AppPkgInfoModifications"
},
"description": "Shall be returned when the operation has been completed successfully."
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Shows that the operation has been completed successfully",
"$ref": "#/components/schemas/AppPkgInfoModifications"
},
"403": {
},
"404": {
"summary": "Subscribe to notifications about on-boarding an application package",
"description": "Subscribe to notifications about on-boarding an application package",
"operationId": "subscriptionsPOST",
"requestBody": {
"description": "The input parameters of subscribe operation to notifications",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPkgSubscription"
}
"responses": {
"201": {
"description": "Successful response for created subscription",
"$ref": "#/components/schemas/AppPkgSubscriptionInfo",
"descriprion": "Upon success, a response message contentrepresenting the created subscription shall bereturned."
},
"403": {
},
"404": {
},
"406": {
},
"429": {
"callbacks": {
"notification": {
"{$request.body#/subscription.href}": {
"post": {
"summary": "Callback POST used to send a notification",
"description": " The notification is triggered when a new application package is onboarded",
"operationId": "notificationPOST",
"requestBody": {
"description": "Subscription notification",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPkgNotification"
}
}
}
},
"responses": {
"204": {
"description": "No content"
},
"404": {
"description": "Not found"
"summary": "used to retrieve the information of subscriptions to individual application package resource in MEO or MEAO",
"description": "used to retrieve the information of subscriptions to individual application package resource in MEO or MEAO package",
"operationId": "subscriptionsGET",
"responses": {
"200": {
"description": "List of zero or more subscriptions",
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPkgSubscriptionLinkList",
"description": "Upon success, a response message content containing a list of zero or more subscriptions shallbe returned."
},
"400": {
},
"401": {
},
"403": {
},
"404": {
},
"406": {
},
"/subscriptions/{subscriptionId}": {
"get": {
"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",
"description": "Identifier of an individual subscription to notifications about application package changes",
"required": true,
"style": "simple",
"schema": {
"type": "string"
"responses": {
"200": {
"description": "a response body containing a representation of the resource shall be returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPkgSubscriptionInfo",
"descriprion": "Upon success, a response message content containing a representation of the resource shall be returned."
},
"400": {
},
"401": {
},
"403": {
},
"404": {
},
"406": {
},
"429": {
"summary": "Deletes the individual subscription to notifications about application package changes in MEO or MEAO.",
"description": "Deletes the individual subscription to notifications about application package changes in MEO or MEAO.",
"operationId": "individualSubscriptionDELETE",
"description": "Identifier of an individual subscription to notifications about application package changes",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
"400": {
"$ref": "#/components/responses/400"
},
},
"403": {
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
},
"/app_packages/{appPkgId}/appd": {
"get": {
"summary": "Reads the content of the AppD of on-boarded individual application package resources.",
"description": "Reads the content of the AppD of on-boarded individual application package resources.",
"operationId": "appPkgIdGET",
"description": "Identifier of an on-boarded individual application package",
"required": true,
"style": "simple",
"schema": {
"type": "string"
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
},
{
"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": "Content of the AppD is returned.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AppD",
"descriprion": "Indicates the success of request, and the content of the AppD is returned.The response message content shall contain a copy of the file representing the AppD or a ZIP file that contains the file or multiple files representing the AppD.The \"Content-Type\" HTTP header shall be set according to the format of the returned file, which is selected according to \"Accept\" HTTP header options passed in the request."
},
"400": {
},
"401": {
},
"403": {
},
"404": {
},
"406": {
},
"429": {
"/onboarded_app_packages/{appDId}/appd": {
"get": {
"summary": "Reads the content of the AppD of on-boarded individual application package resources.",
"description": "Reads the content of the AppD of on-boarded individual application package resources.",
"operationId": "appDGET",
"parameters": [
{
"name": "appDId",
"in": "path",
"description": "Identifier of an application descriptor",
"required": true,