add description and notes in definitions file (c518dcfa) · Commits · MEC - Multi-access Edge Computing / Application package lifecycle and operation granting API

definitions/MEC010p2_definitions.yaml

+30 −6

Original line number	Diff line number	Diff line
		@@ -40,6 +40,7 @@
		$ref: '#/definitions/UserContextTransferCapability'
		appNetworkPolicy:
		$ref: '#/definitions/AppNetworkPolicy'

		ServiceDependency:
		title: ServiceDependency
		required:
		@@ -68,6 +69,7 @@
		version:
		type: string
		description: The version of the service.

		TransportDependency:
		title: TransportDependency
		required:
		@@ -88,6 +90,7 @@
		description: Information about the serializers in this transport binding, as defined in the SerializerTypes type in ETSI GS MEC 011 [i.4]. Support for at least one of the entries is required in conjunction with the transport.
		transport:
		$ref: '#/definitions/TransportDescriptor'

		TransportDescriptor:
		title: TransportDescriptor
		required:
		@@ -118,6 +121,7 @@
		implSpecificInfo:
		type: object
		description: Additional implementation specific details of the transport.

		ServiceDescriptor:
		title: ServiceDescriptor
		description: "'The ServiceDescriptor data type describes a MEC service produced by a service-providing MEC application.'"
		@@ -140,6 +144,7 @@
		type: array
		items:
		$ref: '#/definitions/TransportsSupported'

		TransportsSupported:
		title: TransportsSupported
		type: object
		@@ -154,6 +159,7 @@
		type: string
		description: "'Information about the serializers in this binding, as defined in the SerializerTypes type in ETSI GS MEC 011 '"
		description: "'Indicates transports and serialization formats supported made available to the service-consuming application. Defaults to REST + JSON if absent.'"

		FeatureDependency:
		title: FeatureDependency
		required:
		@@ -167,6 +173,7 @@
		version:
		type: string
		description: The version of the feature.

		TrafficRuleDescriptor:
		title: TrafficRuleDescriptor
		required:
		@@ -184,12 +191,13 @@
		type: array
		items:
		$ref: '#/definitions/InterfaceDescriptor'
		description: ''
		description: Describes the destination interface information, . Some applications (e.g. inline/tap) _DECAPSULATED, FORWARD_ENCAPSULATED or PASSTHROUGH, one value
		shall be provided. If the action is onDUPLICATE_DECAPSULATED or DUPLICATE_ENCAPSULATED, two values shall be provided. See note 2.
		filterType:
		$ref: '#/definitions/FilterType'
		priority:
		type: integer
		description: Priority of this traffic rule within the range 0 to 255. If traffic rule conflicts, the one with higher priority take precedence. Value indicates the priority in descending order, i.e. with 0 as the highest priority and 255 as the lowest 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.
		contentEncoding: int32
		trafficFilter:
		minItems: 1
		@@ -200,19 +208,24 @@
		trafficRuleId:
		type: string
		description: Identifies the traffic rule.
		description: \|
		NOTE 1: Value indicates the priority in descending order, i.e. with 0 as the highest priority and 255 as the lowest priority.
		NOTE 2: Some applications (like inline/tap) require two interfaces. The first interface in the case of inline/tap is on the
		client (e.g. UE) side and the second on the core network (e.g. EPC) side
		Action:
		title: Action
		enum:
		- DROP
		- FORWARD_DECAPSULATED
		- FORWARD_AS_IS
		- FORWARD, ENCAPSULATED
		- PASSTHROUGH
		- DUPLICATED_DECAPSULATED
		- DUPLICATE_AS_IS
		- DUPLICATE_DECAPSULATED
		- DUPLICATE, .ENCAPSULATED
		type: string
		description: "'Identifies the action of the MEC host data plane, when a packet matches the trafficFilter.'"
		examples:
		- DROP

		TrafficFilter:
		title: TrafficFilter
		type: object
		@@ -287,6 +300,7 @@
		type: array
		items:
		type: string

		DNSRuleDescriptor:
		title: DNSRuleDescriptor
		required:
		@@ -311,6 +325,7 @@
		type: integer
		description: Time-to-live value
		contentEncoding: int32

		IpAddressType:
		title: IpAddressType
		enum:
		@@ -320,6 +335,7 @@
		description: Specifies the IP address type
		examples:
		- IP_V6

		LatencyDescriptor:
		title: LatencyDescriptor
		required:
		@@ -330,6 +346,7 @@
		type: integer
		description: The value of the maximum latency in nano seconds tolerated by the MEC application. See note.
		contentEncoding: int32

		UserContextTransferCapability:
		title: UserContextTransferCapability
		required:
		@@ -340,6 +357,7 @@
		type: boolean
		userContextTransferSupport:
		type: boolean

		AppNetworkPolicy:
		title: AppNetworkPolicy
		required:
		@@ -348,6 +366,7 @@
		properties:
		steeredNetwork:
		$ref: '#/definitions/AppNetworkPolicy.steeredNetwork'

		AppNetworkPolicy.steeredNetwork:
		title: AppNetworkPolicy.steeredNetwork
		type: object
		@@ -358,6 +377,7 @@
		type: boolean
		fixedAccessNetwork:
		type: boolean

		InterfaceDescriptor:
		title: InterfaceDescriptor
		required:
		@@ -377,6 +397,7 @@
		description: If the interface type is MAC, the source address identifies the MAC address of the interface.
		tunnelInfo:
		$ref: '#/definitions/TunnelInfo'

		InterfaceType:
		title: InterfaceType
		enum:
		@@ -387,6 +408,7 @@
		description: Type of interface.
		examples:
		- TUNNEL

		TunnelInfo:
		title: TunnelInfo
		required:
		@@ -405,6 +427,7 @@
		description: Source address of the tunnel.
		tunnelType:
		$ref: '#/definitions/TunnelType'

		TunnelType:
		title: TunnelType
		enum:
		@@ -414,13 +437,14 @@
		description: Type of tunnel.
		examples:
		- GTP-U

		FilterType:
		title: FilterType
		enum:
		- FLOW
		- PACKET
		type: string
		description: 'Definition of filter type: per FLOW or PACKET'
		description: If it is per FLOW, the filter matches upstream (e.g. UE->EPC) packets and the downstream (e.g. EPC->UE) packets are handled by the same context.
		examples:
		- FLOW