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, v2.2.1",
"url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.02.01_60/gs_MEC01002v020201p.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",
"variables": {}
}
],
"paths": {
"/app_packages": {
"post": {
"tags": [
"app-pkgm"
],
"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",
"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": [
"app-pkgm"
],
"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": "",
"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"
}
}
}
},
"deprecated": false
},
"parameters": []
"/onboarded_app_packages": {
"post": {
"tags": [
"app-pkgm"
],
"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",
"parameters": [],
"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",
"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"
}
}
}
"tags": [
"app-pkgm"
],
"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",
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
"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": "",
"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"
}
}
}
"parameters": []
},
"/app_packages/{appPkgId}": {
"get": {
"tags": [
"app-pkgm"
],
"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": {
"$ref": "#/components/schemas/AppPkgInfo"
"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
},
"tags": [
"app-pkgm"
],
"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",
},
"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"
}
}
}
}
},
"tags": [
"app-pkgm"
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
"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": {
"$ref": "#/components/schemas/AppPkgInfoModifications"
},
"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
"/onboarded_app_packages/{appPkgId}": {
"get": {
"tags": [
"app-pkgm"
],
"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": {
"$ref": "#/components/schemas/AppPkgInfo"
"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": [
"app-pkgm"
],
"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": {
"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"
}
}
}
},
"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"
}
}
}
},
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"tags": [
"app-pkgm"
],
"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": {
"$ref": "#/components/schemas/AppPkgInfoModifications"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Shows that the operation has been completed successfully",
"$ref": "#/components/schemas/AppPkgInfoModifications"
}
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/json": {
"$ref": "#/components/schemas/ProblemDetails"
"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"
}
}
}
},
"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"
}
}
}
},
"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": [
"app-pkgm"
],
"summary": "Subscribe to notifications about on-boarding an application package",
"description": "Subscribe to notifications about on-boarding an application package",
"operationId": "subscriptionsPOST",
"parameters": [],
"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"
}
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/json": {
"$ref": "#/components/schemas/ProblemDetails"
"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"
}
}
}
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
"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"
}
}
}
}
},
"get": {
"tags": [
"app-pkgm"
"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",
"parameters": [],
"responses": {
"200": {
"description": "List of zero or more subscriptions",
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPkgSubscriptionLinkList"
}
}
},
"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"
}
}
}
},
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"parameters": []
},
"/subscriptions/{subscriptionId}": {
"get": {
"tags": [
"app-pkgm"
],
"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"
}
}
}
},
"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"
}
}
}
"tags": [
"app-pkgm"
],
"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",
},
"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"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"parameters": []
},
"/app_packages/{appPkgId}/appd": {
"get": {
"tags": [
"app-pkgm"
],
"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"
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
},
{
"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"
}
},
"application/zip": {}
}
},
"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": []
},
"/onboarded_app_packages/{appDId}/appd": {
"get": {
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
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
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
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
2201
2202
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
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
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
2331
2332
2333
2334
"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,
"style": "simple",
"schema": {
"type": "string"
}
},
{
"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.",
"headers": {},
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AppD"
}
},
"application/zip": {}
}
},
"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_packages/{appPkgId}/package_content": {
"get": {
"tags": [
"app-pkgm"
],
"summary": "Fetch the onboarded application package content identified by appPkgId or appDId.",
"description": "Fetch the onboarded application package content identified by appPkgId or appDId.",
"operationId": "appPkgGET",
"parameters": [
{
"name": "appPkgId",
"in": "path",
"description": "Identifier of an on-boarded individual application package",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The payload body shall contain a copy of the file representing the AppD or a ZIP file that contains the file or multiple files representing the AppD.",
"headers": {},
"content": {
"application/zip": {}
}
},
"206": {
"description": "On success, if the MEO or MEAO supports range requests, a single consecutive byte range from the content of the application package file shall be returned.",
"headers": {},
"content": {
"application/zip": {}
}
},
"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"
}
}
}
},
"416": {
"description": "Range Not Satisfiable .",
"headers": {},
"content": {}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated": false
},
"put": {
"tags": [
"app-pkgm"
],
"summary": "Uploads the content of application package.",
"description": "Uploads the content of application package.",
"operationId": "appPkgPUT",
"parameters": [
{
"name": "appPkgId",
"in": "path",
"description": "Identifier of an on-boarded individual application package",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/zip": {}
},
"required": false
},
"responses": {
"202": {
"description": "The application package has been accepted for uploading, but the processing has not been completed.",
"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": []
},
"/onboarded_app_packages/{appDId}/package_content": {
"get": {
"tags": [
"app-pkgm"
],
"summary": "Fetch the onboarded application package content identified by appPkgId or appDId.",
"description": "Fetch the onboarded application package content identified by appPkgId or appDId.",
"operationId": "appDIdGET",
"parameters": [
{
"name": "appDId",
"in": "path",
"description": "Identifier of an application descriptor",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The payload body shall contain a copy of the file representing the AppD or a ZIP file that contains the file or multiple files representing the AppD.",
"headers": {},
"content": {}
},
"206": {
"description": "On success, if the MEO or MEAO supports range requests, a single consecutive byte range from the content of the application package file shall be returned.",
"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"
}
}
}
},
"416": {
"description": "Range Not Satisfiable .",
"headers": {},
"content": {}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated": false
},
"put": {
"tags": [
"app-pkgm"
],
"summary": "Fetch the onboarded application package content identified by appPkgId or appDId.",
"description": "Uploads the content of application package.",
"operationId": "appDIdPUT",
"parameters": [
{
"name": "appDId",
"in": "path",
"description": "Identifier of an application descriptor",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/zip": {}
},
"required": false
},
"responses": {
"202": {
"description": "The application package has been accepted for uploading, but the processing has not been completed.",
"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": []
},
"/user_defined_notification": {
"post": {
"tags": [
"app-pkgm-notifications"
],
"summary": "Registers a notification endpoint to notify application package operations",
"description": "Registers a notification endpoint to notify application package operations",
"operationId": "app_pkg_notificationPOST",
"parameters": [],
"requestBody": {
"description": "Notification endpoint to be created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppPkgNotification"
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
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"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"
}
}
}
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"deprecated": false
},
"parameters": []
}
},
"components": {
"schemas": {
"AppD": {
"title": "AppD",
"required": [
"appDId",
"appDVersion",
"appDescription",
"appName",
"appProvider",
"appSoftVersion",
"mecVersion",
"swImageDescriptor",
"virtualComputeDescriptor"
],
"type": "object",
"properties": {
"appDId": {
"type": "string",
"description": "Identifier of this MEC application descriptor. This attribute shall be globally unique. See note 1."
},
"appDNSRule": {
"$ref": "./MEC010p2_v221_definitions.yaml#/definitions/DNSRuleDescriptor"
"description": "Describes DNS rules the MEC application requires."
},
"appDVersion": {
"type": "string",
"description": "Identifies the version of the application descriptor."
},
"appDescription": {
"type": "string",
"description": "Human readable description of the MEC application."
},
"appExtCpd": {
"items": {
"$ref": "#/components/schemas/AppExternalCpd"
},
"description": "Describes external interface(s) exposed by this MEC application."
},
"appFeatureOptional": {
"$ref": "./MEC010p2_v221_definitions.yaml#/definitions/FeatureDependency"
"description": "Describes features a MEC application may use if available."
},
"appFeatureRequired": {
"$ref": "./MEC010p2_v221_definitions.yaml#/definitions/FeatureDependency"
"description": "Describes features a MEC application requires to run."
},
"appInfoName": {
"type": "string",
"description": "Human readable name for the MEC application."
},
"appLatency": {
"$ref": "./MEC010p2_v221_definitions.yaml#/definitions/LatencyDescriptor"
},
"appName": {
"type": "string",
"description": "Name to identify the MEC application."
},
"appProvider": {
"type": "string",
"description": "Provider of the application and of the AppD."
},
"appServiceOptional": {
"$ref": "./MEC010p2_v221_definitions.yaml#/definitions/ServiceDependency"
"description": "Describes services a MEC application may use if available."
},
"appServiceProduced": {
"$ref": "./MEC010p2_v221_definitions.yaml#/definitions/ServiceDescriptor"
"description": "Describes services a MEC application is able to produce to the platform or other MEC applications. Only relevant for service-producing apps."
},
"appServiceRequired": {
"$ref": "./MEC010p2_v221_definitions.yaml#/definitions/ServiceDependency"
"description": "Describes services a MEC application requires to run."
},
"appSoftVersion": {
"type": "string",
"description": "Identifies the version of software of the MEC application."
},
"appTrafficRule": {
"$ref": "./MEC010p2_v221_definitions.yaml#/definitions/TrafficRuleDescriptor"
"description": "Describes traffic rules the MEC application requires."
},
"changeAppInstanceStateOpConfig": {
"type": "string",
"description": "NFV"
},
"mecVersion": {
"items": {
"type": "string"
"description": "Identifies version(s) of MEC system compatible with the MEC application described in this version of the AppD. The value shall be formatted as comma-separated list of strings. Each entry shall have the format <x>.<y>.<z> where <x>, <y> and <z> are decimal numbers representing the version of the present document. Whitespace between list entries shall be trimmed before validation."
},
"swImageDescriptor": {
"description": "Describes the descriptors of the software image to be used by the virtualisation container used to realize this MEC application."
},
"terminateAppInstanceOpConfig": {
"type": "string",
"description": "NFV"
},
"transportDependencies": {
"$ref": "./MEC010p2_v221_definitions.yaml#/definitions/TransportDependency"
"description": "Transports, if any, that this application requires to be provided by the platform. These transports will be used by the application to deliver services provided by this application. Only relevant for service-producing apps. 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 this MEC application.",
"type": "object"
},
"virtualStorageDescriptor": {
"type": "array",
"items": {
"type": "string"
},
"description": "Defines descriptors of virtual storage resources to be used by the MEC application."
},
"userContextTransferCapability": {
"$ref": "./MEC010p2_v221_definitions.yaml#/definitions/UserContextTransferCapability"
},
"appNetworkPolicy": {
"$ref": "./MEC010p2_v221_definitions.yaml#/definitions/AppNetworkPolicy"
}
},
"AppExternalCpd": {
"title": "AppExternalCpd",
"required": [
],
"type": "object",
"properties": {
"inherited_attributes": {
"type": "object",
"description": "All attributes inherited from Cpd."
},
"virtualNetworkInterfaceRequirements": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies requirements on a virtual network interface realizing the CPs instantiated from this CPD."
},
"AppPkgInfo": {
"required": [
"id",
"appDId",
"appName",
"appSoftwareVersion",
"appDVersion",
"checksum",
"softwareImages",
"onboardingState",
"operationalState",
"usageState",
"_links"
],
"properties": {
"id": {
"type": "string",
"description": "Identifier of the onboarded application package."
},
"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."
},
"appSoftwareVersion": {
"type": "string",
"description": "Software version of the application. This is updated when there is any change to the software in the onboarded application package."
},
"appDVersion": {
"type": "string",
"description": "Identifies the version of the application descriptor."
},
"checksum": {
"$ref": "#/components/schemas/Checksum"
},
"signingCertificate": {
"type": "string",
"description": "The singleton signing certificate if it is included as a file in the AppD archive."
},
"softwareImages": {
"type": "object",
"description": "Information of application software image in application package. Type is TBD"
},
"additionalArtifacts": {
"type": "object",
"description": "Additional information of application package artifacts that are not application software images. Type is TBD"
},
"onboardingState": {
"$ref": "#/components/schemas/OnboardingState"
},
"operationalState": {
"$ref": "#/components/schemas/AppPkg.OperationalState"
},
"usageState": {
"$ref": "#/components/schemas/UsageState"
},
"mecInfo": {
"type": "array",
"description": "The MEC version that compatible with this application. This information is copied from the AppD.",
"items": {
"type": "string"
}
},
"onBoardingFailureDetails": {
"description": "Failure details of current onboarding procedure",
"$ref": "#/components/schemas/ProblemDetails"
},
"userDefinedData": {
"$ref": "#/components/schemas/KeyValuePairs",
"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'"
},
"_links": {
"$ref": "#/components/schemas/AppPkgInfo.links"
}
},
"description": "'The data type AppPkgInfo represents the parameters for an application package resource'"
},
"AppPkgInfoModifications": {
"required": [
"operationState"
],
"properties": {
"operationState": {
"$ref": "#/components/schemas/OperationState"
},
"description": "'The data type represents the operational state for an application package resource'"
},
"AppPkg.OperationalState": {
"enum": [
"ENABLED",
"DISABLED"
],
"type": "string",
"description": "Operational state of the onboarded application package: •ENABLED: the application package can be used for instantiation of new application instances. •DISABLED: the application package cannot be used for further application instantiation requests.",
"examples": [
"ENABLED"
]
},
"OnboardingState": {
"enum": [
"CREATED",
"UPLOADING",
"PROCESSING",
"ONBOARDED"
],
"type": "string",
"description": "Onboarding state of application package",
"examples": [
"CREATED"
]
},
"UsageState": {
"enum": [
"IN_USE",
"NOT_IN_USE"
],
"type": "string",
"description": "Usage state of the onboarded instance of the application package",
"examples": [
"IN_USE"
]
},
"AppPkgInfo.links": {
"required": [
"self",
"appD",
"appPkgContent"
],
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
},
"appD": {
"$ref": "#/components/schemas/LinkType"
},
"appPkgContent": {
"$ref": "#/components/schemas/LinkType"
},
"vnfPkgInfo": {
"$ref": "#/components/schemas/LinkType"
},
"description": "Links to resources related to this resource."
},
"AppPkgNotification": {
"required": [
"id",
"notificationType",
"subscriptionId",
"timeStamp",
"appPkgId",
"appDId",
"operationalState",
"_links"
],
"properties": {
"id": {
},
"notificationType": {
"$ref": "#/components/schemas/AppPkg.NotificationType"
},
"subscriptionId": {
"type": "string",
"description": "Identifier of the subscription related to this notification."
},
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
},
"appPkgId": {
"type": "string",
"description": "Identifier of the onboarded application package."
},
"appDId": {
"type": "string",
"description": "Identifier of this MEC application descriptor. This attribute shall be globally unique."
},
"operationalState": {
"$ref": "#/components/schemas/OperationalState"
},
"_links": {
"$ref": "#/components/schemas/AppPkgNotification.links"
}
},
"description": "'This data type represents an application package management notification for informing the subscribers about onboarding application package resources. The notification is triggered when a new application package is onboarded'"
},
"AppPkg.NotificationType": {
"enum": [
"AppPackageOnBoarded",
"AppPacakgeEnabled",
"AppPacakgeDisabled",
"AppPackageDeleted"
],
"type": "string",
"description": "Discriminator for the different notification types",
"examples": [
"AppPackageOnBoarded"
]
},
"AppPkgNotification.links": {
"required": [
"subscription"
],
"properties": {
"subscription": {
"$ref": "#/components/schemas/LinkType"
}
},
"description": "Links to resources related to this resource."
},
"AppPkgSubscriptionInfo": {
"required": [
"id",
"subscriptionType",
"callbackUri",
"_links"
],
"properties": {
"id": {
"description": "Identifier of the subscription to application package notification."
},
"subscriptionType": {
"description": "Type of subscription.",
"$ref": "#/components/schemas/AppPkgSubscriptionType"
},
"callbackUri": {
"type": "string",
"description": "The URI of the endpoint for the notification to be sent to."
},
"_links": {
"$ref": "#/components/schemas/AppPkgSubscriptionInfo.links"
}
},
"description": "'The data type represents a subscription to notification of application package management for the onboarding, or operational state change of application package'"
"AppPkgSubscriptionType": {
"title": "AppPkgSubscriptionType",
"AppPackageOnBoardingSubscription",
"AppPackageChangeSubscription",
"AppPackageDeletionSubscription"
"description": "type of a subscription.",
"AppPackageOnBoardingSubscription"
]
},
"AppPkgSubscriptionInfo.links": {
"required": [
"self"
],
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
}
},
"description": "Links to resources related to this resource."
},
"AppPkgSubscriptionLinkList": {
"required": [
"_links"
],
"properties": {
"_links": {
"$ref": "#/components/schemas/AppPkgSubscriptionLinkList.links"
}
},
"description": "'The data type represents a subscription link list of notification on application package management'"
},
"AppPkgSubscriptionLinkList.links": {
"title": "AppPkgSubscriptionLinkList.links",
"required": [
"self"
],
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
},
"subscriptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Subscriptions.AppPkgSubscription"
},
"description": "Links to resources related to this resource."
},
"Subscriptions.AppPkgSubscription": {
"title": "Subscriptions.AppPkgSubscription",
"required": [
"href",
"properties": {
"href": {
"type": "string",
"description": "The URI referring to the subscription."
"subscriptionType": {
"$ref": "#/components/schemas/AppPkgSubscriptionType"
},
"description": "'The data type represents the input parameters of \"subscription operation\" to notification of application package management for the onboarding, or operational state change of application package.'"
},
"AppPkgSubscription": {
"required": [
"callbackUri",
"properties": {
"callbackUri": {
"type": "string",
"description": "The URI of the endpoint for the notification to be sent to."
"subscriptionType": {
"$ref": "#/components/schemas/AppPkgSubscriptionType"
},
"appPkgFilter": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppPkgFilter"
"description": "The attribute-based filter is to filter application packages on which the query applies"
},
"description": "'The data type represents the input parameters of \"subscription operation\" to notification of application package management for the onboarding, or operational state change of application package.'"
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
"AppPkgFilter": {
"title": "AppPkgFilter",
"type": "object",
"properties": {
"appPkgInfoId": {
"type": "string",
"description": "Match the application package identifier which is allocated by the MEO. The attributes \"appPkgInfoId \", and \"appDId\" are alternatives to reference particular application package in a filter."
},
"appDId": {
"type": "string",
"description": "Match the application descriptor identifier which is allocated by the application provider. The attributes \"appPkgInfoId \", and \"appDId\" are alternatives to reference particular application package in a filter."
},
"appProvider": {
"type": "string",
"description": "Match the provider's name of the onboarded application."
},
"appName": {
"type": "string",
"description": "Match the name of the onboarded application."
},
"appSoftwareVersion": {
"type": "string",
"description": "Match the software version of the application package."
},
"appDVersion": {
"type": "string",
"description": "Match the version of the application descriptor."
},
"operationalState": {
"type": "string",
"description": "Match particular operational state of the application package. May be present if the \"subscriptionType\" attribute contains the value \"AppPackageChangeSubscription\", and shall be absent otherwise.",
"enum": [
"ENABLED",
"DISABLED"
]
},
"usageState": {
"type": "string",
"description": "Match particular usage state of the application package. May be present if the \"subscriptionType\" attribute contains the value \"AppPackageChangeSubscription\", and shall be absent otherwise.",
"enum": [
"N_USE",
"NOT_IN_USE"
]
}
}
},
"Checksum": {
"title": "Checksum",
"required": [
"algorithm",
"hash"
],
"type": "object",
"properties": {
"algorithm": {
"type": "string",
"description": "Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512."
},
"hash": {
"type": "string",
"description": "'String 1 The hexadecimal value of the checksum'"
},
"CreateAppPkg": {
"title": "CreateAppPkg",
"required": [
"appPkgName",
"appPkgPath",
"appPkgVersion",
"checksum"
],
"type": "object",
"properties": {
"appPkgName": {
"type": "string",
"description": "Name of the application package to be onboarded."
},
"appPkgPath": {
},
"appPkgVersion": {
"type": "string",
"description": "Version of the application package to be onboarded.The appPkgName with appPkgVersion can be used to uniquely identify the application package."
},
"appProvider": {
"type": "string",
"description": "The provider's name of the application package to be onboarded."
},
"checksum": {
"$ref": "#/components/schemas/Checksum"
},
"userDefinedData": {
"$ref": "#/components/schemas/KeyValuePairs",
"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'"
"additionalProperties": {
"type": "object"
}
},
"LinkType": {
"title": "LinkType",
"required": [
],
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "URI referring to a resource"
},
"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"
},
"TimeStamp": {
"title": "TimeStamp",
"required": [
"nanoSeconds",
"seconds"
],
"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.",
"contentEncoding": "int32"
"OperationalState": {
"title": "OperationalState",
"enum": [
"DISABLED",
"ENABLED"
],
"type": "string",
"examples": [
"DISABLED"
]
"OperationState": {
"title": "OperationState",
"enum": [
"DISABLED",
"ENABLED"
],
"type": "string",
"examples": [
"DISABLED"
]