Newer
Older
},
"AppInstSubscriptionRequest": {
"required": [
"subscriptionType",
"callbackUri"
],
"properties": {
"subscriptionType": {
"const": "AppInstanceStateChange",
"type": "string",
"description": "Shall be set to AppInstanceStateChange.",
"examples": [
"AppInstanceStateChange"
]
},
"callbackUri": {
"type": "string",
"description": "The URI of the endpoint for the notification to be sent to."
},
"appInstanceState": {
"$ref": "#/components/schemas/AppInstanceState"
},
"appInstanceSubscriptionFilter": {
"$ref": "#/components/schemas/AppInstanceSubscriptionFilter"
}
}
},
"AppInstanceSubscriptionFilter": {
"required": [
"appInstSelectorType"
],
"properties": {
"appInstSelectorType": {
"$ref": "#/components/schemas/AppInstSelectorType"
},
"appInstances": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
"appsFromProviders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppsFromProviders"
},
"description": "'This data type represents subscription filter criteria to match application instances. '"
},
"AppsFromProviders": {
"required": [
"appProvider"
],
"properties": {
"appProvider": {
"type": "string",
"description": "Provider of the application and of the AppD."
"appProducts": {
"$ref": "#/components/schemas/AppProducts"
}
},
"description": "'Present only if appInstIdSelector = APP_FROM_PROVIDER. Match existing application instances, or those created in the future whilst the subscription is active, that belong to applications from certain providers.'"
},
"AppProducts": {
"required": [
"appName"
],
"properties": {
"appName": {
"type": "string",
"description": "Name to identify the MEC application."
},
"versions": {
"$ref": "#/components/schemas/AppProducts.Versions"
}
},
"description": "'If present, match application instances that belong to application products with certain product names, from one particular provider.'"
},
"AppProducts.Versions": {
"required": [
"appSoftVersion"
],
"properties": {
"appSoftVersion": {
"type": "string",
"description": "Identifies the version of software of the MEC application."
},
"appDVersion": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"description": "'If present, match application instances that belong to application products with certain versions and a certain product name, from one particular provider.'"
},
"AppInstSelectorType": {
"enum": [
"VOID",
"APP_IDENTITY",
"APP_NAME",
"APP_D_ID",
"APP_FROM_PROVIDER"
],
"type": "string",
"description": "0 = void",
"examples": [
"VOID"
]
},
"AppInstanceState": {
"enum": [
"NOT_INSTANTIATED",
"STARTED",
"STOPPED"
],
"type": "string",
"description": "Only send notifications for application instances that are in one of the states listed in this attribute. If this attribute is absent, match all states.",
"examples": [
"NOT_INSTANTIATED"
]
},
"AppInstNotification": {
"title": "AppInstNotification",
"required": [
"_links",
"appDId",
"appInstanceId",
"appPkgId",
"id",
"notificationType",
"subscriptionId",
"timeStamp"
],
"type": "object",
"properties": {
"_links": {
},
"appDId": {
"type": "string",
"description": "The application descriptor identifier identifies the application package and the application descriptor in a globally unique way."
},
"appInstanceId": {
"type": "string",
"description": "Identifier of application instance."
},
"appPkgId": {
"type": "string",
"description": "Identifier of the onboarded application package."
},
"id": {
"type": "string",
"description": "Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the \"notificationId\" attribute of all these notifications shall have the same value."
},
"notificationType": {
"$ref": "#/components/schemas/AppInst.NotificationType"
},
"subscriptionId": {
"type": "string",
"description": "Identifier of the subscription related to this notification."
},
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
},
"AppInstanceInfo": {
"required": [
"id",
"appDId",
"appProvider",
"appName",
"appSoftVersion",
"appDVersion",
"appPkgId",
"instantiationState",
"_links"
],
"properties": {
"id": {
"type": "string",
"description": "Identifier of application instance."
},
"appInstanceName": {
"type": "string",
"description": "Name of the application instance."
},
"appInstanceDescription": {
"type": "string",
"description": "Human-readable description of the application instance to be created."
},
"appDId": {
"type": "string",
"description": "Identifier of this MEC application descriptor. This attribute shall be globally unique."
},
"appProvider": {
"type": "string",
"description": "Provider of the application and of the AppD."
},
"appName": {
"type": "string",
"description": "Name to identify the MEC application."
},
"appSoftVersion": {
"type": "string",
"description": "Identifies the version of software of the MEC application."
},
"appDVersion": {
"type": "string",
"description": "Identifies the version of the application descriptor."
},
"appPkgId": {
"type": "string",
"description": "Identifier of the onboarded application package."
},
"vimConnectionInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VimConnectionInfo"
},
"instantiationState": {
"$ref": "#/components/schemas/InstantiationState"
},
"instantiatedAppState": {
"$ref": "#/components/schemas/InstantiatedAppState"
},
"_links": {
"$ref": "#/components/schemas/AppInstanceInfo.links"
}
},
"description": "'The data type of AppInstanceInfo represents the parameters of instantiated application instance resources.'"
},
"OperationState": {
"enum": [
"STARTING",
"PROCESSING",
"COMPLETED",
"FAILED"
],
"type": "string",
"description": "Operation state",
"examples": [
"STARTING"
]
},
"InstantiationState": {
"enum": [
"NOT_INSTANTIATED",
"INSTANTIATED"
],
"type": "string",
"description": "Instantiation state of the application instance",
"examples": [
"NOT_INSTANTIATED"
]
},
"InstantiatedAppState": {
"required": [
"operationalState"
],
"properties": {
"operationalState": {
"$ref": "#/components/schemas/OperationalState"
}
},
"description": "'Information specific to an instantiated application. This attribute shall be present if the instantiationState attribute value is INSTANTIATED.'"
},
"OperationalState": {
"enum": [
"STARTED",
"STOPPED"
],
"type": "string",
"description": "Operational state is applicable in the instantiation state INSTANTIATED",
"examples": [
"STARTED"
]
},
"AppInstanceInfo.links": {
"required": [
"self"
],
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
},
"instantiate": {
"$ref": "#/components/schemas/LinkType"
},
"terminate": {
"$ref": "#/components/schemas/LinkType"
},
"operate": {
"$ref": "#/components/schemas/LinkType"
}
},
"description": "Links to resources related to this resource."
},
"LcmOperation": {
"enum": [
"INSTATIATE",
"OPERATE",
"TERMINATE"
],
"type": "string",
"description": "Type of the actual LCM operation represented by this application instance LCM operation occurrence",
"examples": [
"INSTATIATE"
]
},
"AppLcmOpOccNotification": {
"required": [
"id",
"notificationType",
"subscriptionId",
"timeStamp",
"appLcmOpOccId",
"appInstanceId",
"_links"
],
"properties": {
"id": {
},
"notificationType": {
"$ref": "#/components/schemas/AppLcmOpOcc.NotificationType"
},
"subscriptionId": {
"type": "string",
"description": "Identifier of the subscription related to this notification."
},
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
},
"appLcmOpOccId": {
"type": "string",
"description": "Identifier of application lifecycle management operation occurrence."
},
"appInstanceId": {
"type": "string",
"description": "Identifier of application instance."
},
"_links": {
"$ref": "#/components/schemas/AppLcmOpOccNotification.links"
}
},
"description": "'This data type represents a notification related to state changes of an application LCM operation occurrence which informs the subscribers'"
},
"AppLcmOpOcc.NotificationType": {
"enum": [
"STARTING",
"PROCESSING",
"COMPLETED",
"FAILED"
],
"type": "string",
"description": "Discriminator for the different notification types",
"examples": [
"STARTING"
]
},
"AppLcmOpOccNotification.links": {
"required": [
"appInstance",
"subscription",
"appLcmOpOcc"
],
"properties": {
"appInstance": {
"$ref": "#/components/schemas/LinkType"
},
"subscription": {
"$ref": "#/components/schemas/LinkType"
},
"appLcmOpOcc": {
"$ref": "#/components/schemas/LinkType"
},
"description": "Links to resources related to this resource."
},
"InstantiateAppRequest": {
"title": "InstantiateAppRequest",
"required": [
"selectedMECHostInfo"
],
"type": "object",
"properties": {
"locationConstraints": {
"$ref": "#/components/schemas/LocationConstraints"
},
"selectedMECHostInfo": {
"items": {
"$ref": "#/components/schemas/MECHostInformation"
},
"description": "Describes the information of selected host for the application instance. See note 2."
},
"vimConnectionInfo": {
"items": {
"$ref": "#/components/schemas/VimConnectionInfo"
},
"description": "Information about VIM connections to be used for managing the resources for the application instance, or refer to external / externally-managed virtual links.\nThis attribute shall only be supported and may be present if application-related resource management in direct mode is applicable. See note 2."
},
"virtualComputeDescriptor": {
"type": "string",
"description": "Ref NFV"
},
"virtualStorageDescriptor": {
"minItems": 0,
"type": "array",
"items": {
"type": "string"
},
"description": "Defines descriptors of virtual storage resources to be used by the application instance to be created. See note 1."
}
},
"LinkType": {
"title": "LinkType",
"required": [
],
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "URI referring to a resource"
},
"LocationConstraints": {
"required": [
"countryCode"
],
"properties": {
"countryCode": {
"type": "string",
"description": "The two-letter ISO 3166 country code in capital letters."
"civicAddressElement": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CivicAddressElement"
},
"description": "'The LocationConstraints data type supports the specification of MEC application requirements related to MEC application deployment location constraints. The location constraints shall be presented as a country code, optionally followed by a civic address based on the format defined by IETF RFC 4776'"
},
"CivicAddressElement": {
"required": [
"caType",
"caValue"
],
"properties": {
"caType": {
"type": "integer",
"description": "'Describe the content type of caValue. The value of caType shall comply with section 3.4 of IETF RFC 4776.'",
"contentEncoding": "int32"
},
"caValue": {
"type": "string",
"description": "'Content of civic address element corresponding to the caType. The format caValue shall comply with section 3.4 of IETF RFC 4776.'"
},
"description": "'The civic address.'"
},
"MECHostInformation": {
"title": "MECHostInformation",
"required": [
"hostId"
],
"type": "object",
"properties": {
"hostId": {
"type": "object",
"description": "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'"
},
"hostName": {
"type": "string",
"description": "Human-readable name of MEC host."
}
},
"OperateAppRequest": {
"title": "OperateAppRequest",
"required": [
],
"type": "object",
"properties": {
"changeStateTo": {
"$ref": "#/components/schemas/ChangeStateTo"
},
"gracefulStopTimeout": {
"type": "integer",
"description": "The time interval (in seconds) to wait for the application instance to be taken out of service during graceful stop, before stopping the application. See note 1 and note 2.",
"contentEncoding": "int32"
},
"stopType": {
"$ref": "#/components/schemas/StopType"
},
"StopType": {
"enum": [
"FORCEFUL",
"GRACEFUL"
],
"type": "string",
"description": "Signals forceful or graceful stop",
"examples": [
"FORCEFUL"
]
},
"ChangeStateTo": {
"enum": [
"STARTED",
"STOPPED"
],
"type": "string",
"description": "The desired operational state",
"examples": [
"STARTED"
]
},
"ProblemDetails": {
"title": "ProblemDetails",
"type": "object",
"properties": {
"detail": {
"type": "string",
"description": "A human-readable explanation specific to this occurrence of the problem"
"instance": {
"type": "string",
"description": "A URI reference that identifies the specific occurrence of the problem"
"status": {
"type": "integer",
"description": "The HTTP status code for this occurrence of the problem",
"contentEncoding": "int32"
},
"title": {
"type": "string",
"description": "A short, human-readable summary of the problem type"
},
"type": {
"type": "string",
"description": "A URI reference according to IETF RFC 3986 that identifies the problem type"
},
"TerminateAppRequest": {
"title": "TerminateAppRequest",
"required": [
"terminationType"
],
"type": "object",
"properties": {
"gracefulTerminationTimeout": {
"type": "integer",
"description": "This attribute is only applicable in case of graceful termination. It defines the time to wait for the application instance to be taken out of service before shutting down the application and releasing the resources. \nThe unit is seconds.\nIf not given and the \"terminationType\" attribute is set to \"GRACEFUL\", it is expected to wait for the successful taking out of service of the application, no matter how long it takes, before shutting down the application and releasing the resources.",
"contentEncoding": "int32"
},
"terminationType": {
"$ref": "#/components/schemas/TerminationType"
}
},
"TimeStamp": {
"title": "TimeStamp",
"required": [
],
"type": "object",
"properties": {
"nanoSeconds": {
"type": "integer",
"description": "The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.",
"contentEncoding": "int32"
"seconds": {
"type": "integer",
"description": "The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.",
"contentEncoding": "int32"
},
"TerminationType": {
"enum": [
"FORCEFUL",
"GRACEFUL"
],
"type": "string",
"description": "'Indicates whether forceful or graceful termination is requested.'",
"examples": [
"FORCEFUL"
]
},
"VimConnectionInfo": {
"title": "VimConnectionInfo",
"required": [
"id",
"vimType"
],
"type": "object",
"properties": {
"accessInfo": {
"type": "object",
"description": "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'"
"type": "object",
"description": "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'"
"id": {
"type": "string",
"description": "The identifier of the VIM Connection. This identifier is managed by the MEO."
"interfaceInfo": {
"type": "object",
"description": "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'"
"vimId": {
"type": "string",
"description": "The identifier of the VIM instance. This identifier is managed by the MEO.Shall be present to address additional information about the VIM if such information has been configured into the MEPM by means outside the scope of the present document, and should be absent otherwise."
"vimType": {
"type": "string",
"description": "Discriminator for the different types of the VIM information.The value of this attribute determines the structure of the \"interfaceInfo\" and \"accessInfo\" attributes, based on the type of the VIM.The set of permitted values is expected to change over time as new types or versions of VIMs become available."
}
},
"Links": {
"title": "Links",
"required": [
],
"type": "object",
"properties": {
"subscription": {
"$ref": "#/components/schemas/LinkType"
},
"description": "Links to resources related to this notification."
"SubscriptionType": {
"title": "SubscriptionType",
"enum": [
"AppInstanceStateChange",
"AppLcmOpOccStateChange"
],
"type": "string",
"examples": [
"AppInstanceStateChange"
]