Autogenerated openapi version v030201 (c8c8876e) · Commits · MEC - Multi-access Edge Computing / Application package lifecycle and operation granting API

MEC01002_AppGrant.yaml

+1 −1

Original line number	Diff line number	Diff line
		@@ -10,7 +10,7 @@ info:
		name: ETSI Forge
		url: https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api
		email: cti_support@etsi.org
		version: 3.1.1
		version: 3.2.1
		servers:
		- url: https://localhost/granting/v1
		paths:

MEC01002_AppLcm.yaml

+173 −41

Original line number	Diff line number	Diff line
		@@ -10,7 +10,7 @@ info:
		name: ETSI Forge
		url: https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api
		email: cti_support@etsi.org
		version: 3.1.1
		version: 3.2.1
		servers:
		- url: https://localhost/app_lcm/v1
		paths:
		@@ -67,11 +67,11 @@ paths:
		tags:
		- app-lcm
		parameters:
		- $ref: '#/components/parameters/Query.Filter'
		- $ref: '#/components/parameters/Query.All_fields'
		- $ref: '#/components/parameters/Query.Fields'
		- $ref: '#/components/parameters/Query.Exclude_fields'
		- $ref: '#/components/parameters/Query.Exclude_default'
		- $ref: '#/components/parameters/Query.filter'
		- $ref: '#/components/parameters/Query.all_fields'
		- $ref: '#/components/parameters/Query.fields'
		- $ref: '#/components/parameters/Query.exclude_fields'
		- $ref: '#/components/parameters/Query.exclude_default'
		responses:
		'200':
		description: 'Information about zero or more application instances was queried successfully.
		@@ -229,7 +229,7 @@ paths:
		post:
		summary: Callback POST used to send a notification
		description: Subscription notification
		operationId: notificationPOST159916
		operationId: notificationPOST906012
		requestBody:
		description: Subscription notification
		required: true
		@@ -257,7 +257,7 @@ paths:
		tags:
		- subscriptions
		parameters:
		- $ref: '#/components/parameters/Query.Subscriptiontype'
		- $ref: '#/components/parameters/Query.subscriptionType'
		responses:
		'200':
		description: Upon success, a response message content containing a list of all subscriptions is returned.
		@@ -552,11 +552,11 @@ paths:
		tags:
		- app-lcm
		parameters:
		- $ref: '#/components/parameters/Query.Filter1'
		- $ref: '#/components/parameters/Query.All_fields'
		- $ref: '#/components/parameters/Query.Fields1'
		- $ref: '#/components/parameters/Query.Exclude_fields1'
		- $ref: '#/components/parameters/Query.Exclude_default1'
		- $ref: '#/components/parameters/Query.filter1'
		- $ref: '#/components/parameters/Query.all_fields'
		- $ref: '#/components/parameters/Query.fields1'
		- $ref: '#/components/parameters/Query.exclude_fields1'
		- $ref: '#/components/parameters/Query.exclude_default1'
		responses:
		'200':
		description: 'Status information for zero or more application instance lifecycle management operation occurrences was queried successfully.
		@@ -1615,10 +1615,10 @@ components:
		filterType:
		type: string
		enum:
		- SEE_DESCRIPTION
		- PACKET
		description: 'Definition of filter type: per FLOW or PACKET

		If it is per FLOW, the filter matches upstream (e.g. UE->EPC) packets and downstream (e.g. EPC->UE) packets are handled by the same context.'
		'
		priority:
		description: "Priority of this traffic rule within the range 0 to 255. If traffic rule conflicts, the one with higher priority take precedence. See note\_1."
		type: integer
		@@ -1659,6 +1659,18 @@ components:
		x-etsi-ref: 6.2.1.10
		type: object
		properties:
		direction:
		type: integer
		enum:
		- 0
		- 1
		description: 'Identifies the direction of the data flow when the value of "filterType" is "per FLOW". See note.

		Permitted values:

		00 = Downlink (towards the UE)

		01 = Uplink (away from the UE)'
		srcAddress:
		description: 'An IP address or a range of IP addresses.

		@@ -1748,6 +1760,7 @@ components:
		tC:
		description: Used to match all IPv6 packets that have the same TC.
		type: integer
		description: "\|-\n NOTE:\tWhen direction, srcAddress, dstAddress, srcPort, dstPort and protocol are combined to describe a IP flow traffic filter which is transferred to 5G core network by MEC system, this group of attributes follows the rules specified in the clause 5.3.8 of ETSI TS 129 214 [22]."
		InterfaceDescriptor:
		x-etsi-ref: 6.2.1.11
		type: object
		@@ -1786,9 +1799,6 @@ components:
		tunnelSrcAddress:
		description: Source address of the tunnel.
		type: string
		tunnelSpecificData:
		description: Parameters specific to the tunnel.
		type: object
		required:
		- tunnelType
		- tunnelDstAddress
		@@ -2819,7 +2829,7 @@ components:
		type: string
		required:
		- countryCode
		description: "\|-\n NOTE:\tAt least one of civicAddress or geographicalPosition shall be present. If both are present they shall specify the same location, bound by the precision of the provided coordinates."
		description: "\|-\n NOTE:\tAt least one of civicAddress or geographicalPosition shall be present. If both are present, they shall specify the same location, bound by the precision of the provided coordinates."
		CancelMode:
		x-etsi-ref: 6.2.2.32
		type: object
		@@ -2873,6 +2883,102 @@ components:
		required:
		- algorithm
		- hash
		AppInstRegistrationSubscriptionRequest:
		x-etsi-ref: 6.2.6.1
		type: object
		properties:
		subscriptionType:
		description: Shall be set to "AppInstRegistrationSubscription".
		type: string
		callbackUri:
		description: The URI of the endpoint for the subscription related notification to be sent to.
		type: string
		format: uri
		appInstRegistrationSubscriptionFilter:
		description: Criteria used to filter application instances registrations for which to send notifications related to this subscription.
		$ref: '#/components/schemas/AppInstRegistrationSubscriptionFilter'
		required:
		- subscriptionType
		- callbackUri
		AppInstDeregistrationSubscriptionRequest:
		x-etsi-ref: 6.2.6.2
		type: object
		properties:
		subscriptionType:
		description: Shall be set to "AppInstDeregistrationSubscription".
		type: string
		callbackUri:
		description: The URI of the endpoint for the subscription related notification to be sent to.
		type: string
		format: uri
		appInstRegistrationSubscriptionFilter:
		description: Criteria used to filter application instances registrations for which to send notifications related to this subscription.
		$ref: '#/components/schemas/AppInstRegistrationSubscriptionFilter'
		required:
		- subscriptionType
		- callbackUri
		AppInstRegistrationNotification:
		x-etsi-ref: 6.2.6.3
		type: object
		properties:
		id:
		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.
		type: string
		notificationType:
		description: Discriminator for the different notification types. Shall be set to "AppInstRegistrationSubscription" for this notification type.
		type: string
		subscriptionId:
		description: Identifier of the subscription related to this notification.
		type: string
		timeStamp:
		description: Date and time of the notification generation.
		$ref: '#/components/schemas/TimeStamp'
		appInfo:
		description: Information provided by a MEC application instance as part of an application registration request/update to a MEC platform.
		$ref: MecAppSupportApi.yaml#/components/schemas/AppInfo
		_links:
		$ref: '#/components/schemas/_links8'
		required:
		- id
		- notificationType
		- subscriptionId
		- timeStamp
		- _links
		AppInstDeregistrationNotification:
		x-etsi-ref: 6.2.6.4
		type: object
		properties:
		id:
		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.
		type: string
		notificationType:
		description: Discriminator for the different notification types. Shall be set to "AppInstDeregistrationSubscription" for this notification type.
		type: string
		subscriptionId:
		description: Identifier of the subscription related to this notification.
		type: string
		timeStamp:
		description: Date and time of the notification generation.
		$ref: '#/components/schemas/TimeStamp'
		appInstanceId:
		description: The application instance identifier associated with application information resource that has been deleted at a MEC platform.
		type: string
		_links:
		$ref: '#/components/schemas/_links9'
		required:
		- id
		- notificationType
		- subscriptionId
		- timeStamp
		- appInstanceId
		- _links
		AppInstRegistrationSubscriptionFilter:
		x-etsi-ref: 6.2.6.5
		type: object
		properties:
		isInsByMec:
		description: "If TRUE, only match application instances that are instantiated by the MEC management. \nDefault to FALSE if absent."
		type: boolean
		TransportsSupported:
		description: Indicates transports and serialization formats supported made available to the service-consuming application. Defaults to REST + JSON if absent.
		type: object
		@@ -3139,6 +3245,32 @@ components:
		$ref: '#/components/schemas/CivicAddressElement1'
		required:
		- civicAddressElement
		_links8:
		description: Links to resources related to this notification.
		type: object
		properties:
		subscription:
		description: A link to the related subscription.
		$ref: '#/components/schemas/LinkType'
		appRegistration:
		description: Link to the resource representing the information of the registered application instance.
		$ref: '#/components/schemas/LinkType'
		required:
		- subscription
		- appRegistration
		_links9:
		description: Links to resources related to this notification.
		type: object
		properties:
		subscription:
		description: A link to the related subscription.
		$ref: '#/components/schemas/LinkType'
		appRegistration:
		description: Link to the resource representing the deleted information of the registered application instance.
		$ref: '#/components/schemas/LinkType'
		required:
		- subscription
		- appRegistration
		VimConnectionInfoMap:
		type: object
		additionalProperties:
		@@ -3191,7 +3323,7 @@ components:
		schema:
		$ref: '#/components/schemas/ProblemDetails'
		parameters:
		Query.Filter:
		Query.filter:
		description: 'Attribute-based filtering parameters according to ETSI GS MEC 009 [4].

		The API producer shall support receiving filtering parameters as part of the URI query string.
		@@ -3202,50 +3334,50 @@ components:
		name: filter
		in: query
		required: false
		x-exportParamName: Query.Filter
		x-exportParamName: Query.filter
		schema:
		type: string
		Query.All_fields:
		Query.all_fields:
		description: "Include all complex attributes in the response. See clause 6.18 in ETSI GS\_MEC\_009\_[4] for details. The API producer shall support this parameter."
		name: all_fields
		in: query
		required: false
		x-exportParamName: Query.All_fields
		x-exportParamName: Query.all_fields
		schema:
		type: string
		Query.Fields:
		Query.fields:
		description: "Complex attributes to be included into the response. See clause 6.18 in ETSI GS\_MEC\_009 [4] for details. The API producer should support this parameter."
		name: fields
		in: query
		required: false
		x-exportParamName: Query.Fields
		x-exportParamName: Query.fields
		schema:
		type: string
		Query.Exclude_fields:
		Query.exclude_fields:
		description: Complex attributes to be excluded from the response. See clause 6.18 in [4] for details. The API producer should support this parameter.
		name: exclude_fields
		in: query
		required: false
		x-exportParamName: Query.Exclude_fields
		x-exportParamName: Query.exclude_fields
		schema:
		type: string
		Query.Exclude_default:
		Query.exclude_default:
		description: "Indicates to exclude the following complex attributes from the response. See clause\_6.18 in ETSI GS MEC 009 [4] for details. The API producer shall support this parameter.\nThe following attributes shall be excluded from the AppInstanceInfo structure in the response message content if this parameter is provided, or none of the parameters \"all_fields\", \"fields\", \"exclude_fields\", \"exclude_default\" are provided:\nvimConnectionInfo;\ninstantiate;\nterminate;\noperate."
		name: exclude_default
		in: query
		required: false
		x-exportParamName: Query.Exclude_default
		x-exportParamName: Query.exclude_default
		schema:
		type: string
		Query.Subscriptiontype:
		Query.subscriptionType:
		description: Query parameter to filter on a specific subscription type.
		name: subscriptiontype
		name: subscriptionType
		in: query
		required: false
		x-exportParamName: Query.Subscriptiontype
		x-exportParamName: Query.subscriptionType
		schema:
		$ref: '#/components/schemas/AppInstanceSubscriptionType'
		Query.Filter1:
		Query.filter1:
		description: 'Attribute-based filtering parameters according to ETSI GS MEC 009 [4].

		The API producer shall support receiving filtering parameters as part of the URI query string.
		@@ -3254,10 +3386,10 @@ components:
		name: filter1
		in: query
		required: false
		x-exportParamName: Query.Filter1
		x-exportParamName: Query.filter1
		schema:
		type: string
		Query.Fields1:
		Query.fields1:
		description: 'Complex attributes of AppLcmOpOcc to be included into the response.


		@@ -3265,10 +3397,10 @@ components:
		name: fields1
		in: query
		required: false
		x-exportParamName: Query.Fields1
		x-exportParamName: Query.fields1
		schema:
		type: string
		Query.Exclude_fields1:
		Query.exclude_fields1:
		description: 'Complex attributes of AppLcmOpOcc to be excluded from the response.


		@@ -3276,10 +3408,10 @@ components:
		name: exclude_fields1
		in: query
		required: false
		x-exportParamName: Query.Exclude_fields1
		x-exportParamName: Query.exclude_fields1
		schema:
		type: string
		Query.Exclude_default1:
		Query.exclude_default1:
		description: 'Indicates to exclude the following complex attributes of AppLcmOpOcc from the response.


		@@ -3291,7 +3423,7 @@ components:
		name: exclude_default1
		in: query
		required: false
		x-exportParamName: Query.Exclude_default1
		x-exportParamName: Query.exclude_default1
		schema:
		type: string

MEC01002_AppPkgMgmt.yaml

+222 −87

File changed.

Preview size limit exceeded, changes collapsed.