update MTS API changes as per InterDigital template (0d03c60d) · Commits · MEC - Multi-access Edge Computing / ETSI MEC Sandbox

docs/api-mts/Apis/MtsApi.md

+87 −76

Original line number	Original line	Diff line number	Diff line
	# MtsApi		# {{classname}}

	All URIs are relative to https://localhost/sandboxname/mts/v1		All URIs are relative to https://localhost/sandboxname/mts/v1

	Method \| HTTP request \| Description		Method \| HTTP request \| Description
	------------- \| ------------- \| -------------		------------- \| ------------- \| -------------
	[mec011AppTerminationPOST](MtsApi.md#mec011AppTerminationPOST) \| POST /notifications/mec011/appTermination \| MEC011 Application Termination notification for self termination		[Mec011AppTerminationPOST](MtsApi.md#Mec011AppTerminationPOST) \| Post /notifications/mec011/appTermination \| MEC011 Application Termination notification for self termination
	[mtsCapabilityInfoGET](MtsApi.md#mtsCapabilityInfoGET) \| GET /mts_capability_info \| Retrieve the MTS capability informations		[MtsCapabilityInfoGET](MtsApi.md#MtsCapabilityInfoGET) \| Get /mts_capability_info \| Retrieve the MTS capability informations
	[mtsSessionDELETE](MtsApi.md#mtsSessionDELETE) \| DELETE /mts_sessions/{sessionId} \| Remove specific MTS session		[MtsSessionDELETE](MtsApi.md#MtsSessionDELETE) \| Delete /mts_sessions/{sessionId} \| Remove specific MTS session
	[mtsSessionGET](MtsApi.md#mtsSessionGET) \| GET /mts_sessions/{sessionId} \| Retrieve information about specific MTS session		[MtsSessionGET](MtsApi.md#MtsSessionGET) \| Get /mts_sessions/{sessionId} \| Retrieve information about specific MTS session
	[mtsSessionPOST](MtsApi.md#mtsSessionPOST) \| POST /mts_sessions \| Create a MTS session		[MtsSessionPOST](MtsApi.md#MtsSessionPOST) \| Post /mts_sessions \| Create a MTS session
	[mtsSessionPUT](MtsApi.md#mtsSessionPUT) \| PUT /mts_sessions/{sessionId} \| Update the information about specific MTS session		[MtsSessionPUT](MtsApi.md#MtsSessionPUT) \| Put /mts_sessions/{sessionId} \| Update the information about specific MTS session
	[mtsSessionsListGET](MtsApi.md#mtsSessionsListGET) \| GET /mts_sessions \| Retrieve information about a list of MTS sessions		[MtsSessionsListGET](MtsApi.md#MtsSessionsListGET) \| Get /mts_sessions \| Retrieve information about a list of MTS sessions

			# Mec011AppTerminationPOST
	<a name="mec011AppTerminationPOST"></a>		> Mec011AppTerminationPOST(ctx, body)
	# mec011AppTerminationPOST
	> mec011AppTerminationPOST(AppTerminationNotification)

	MEC011 Application Termination notification for self termination		MEC011 Application Termination notification for self termination

	Terminates itself.		Terminates itself.

	### Parameters		### Required Parameters

	Name \| Type \| Description \| Notes		Name \| Type \| Description \| Notes
	------------- \| ------------- \| ------------- \| -------------		------------- \| ------------- \| ------------- \| -------------
	AppTerminationNotification \| [AppTerminationNotification](../Models/AppTerminationNotification.md)\| Termination notification details \|		ctx \| context.Context \| context for authentication, logging, cancellation, deadlines, tracing, etc.
			body \| [AppTerminationNotification](AppTerminationNotification.md)\| Termination notification details \|

	### Return type		### Return type

	null (empty response body)		(empty response body)

	### Authorization		### Authorization

	@@ -40,20 +38,20 @@ No authorization required
	- Content-Type: application/json		- Content-Type: application/json
	- Accept: Not defined		- Accept: Not defined

	<a name="mtsCapabilityInfoGET"></a>		[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
	# mtsCapabilityInfoGET
	> MtsCapabilityInfo mtsCapabilityInfoGET()

			# MtsCapabilityInfoGET
			> MtsCapabilityInfo MtsCapabilityInfoGET(ctx, )
	Retrieve the MTS capability informations		Retrieve the MTS capability informations

	Used to query information about the MTS information. Typically used in the 'Get MTS service Info from the MTS Service' procedure as described in clause 6.2.6.		Used to query information about the MTS information. Typically used in the 'Get MTS service Info from the MTS Service' procedure as described in clause 6.2.6.

	### Parameters		### Required Parameters
	This endpoint does not need any parameter.		This endpoint does not need any parameter.

	### Return type		### Return type

	[MtsCapabilityInfo](../Models/MtsCapabilityInfo.md)		[MtsCapabilityInfo](MtsCapabilityInfo.md)

	### Authorization		### Authorization

	@@ -64,23 +62,24 @@ No authorization required
	- Content-Type: Not defined		- Content-Type: Not defined
	- Accept: application/json, application/problem+json		- Accept: application/json, application/problem+json

	<a name="mtsSessionDELETE"></a>		[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
	# mtsSessionDELETE
	> mtsSessionDELETE(sessionId)

			# MtsSessionDELETE
			> MtsSessionDELETE(ctx, sessionId)
	Remove specific MTS session		Remove specific MTS session

	DELETE method is typically used in 'Unregister from the MTS Service' procedure as described in clause 6.2.8.		DELETE method is typically used in 'Unregister from the MTS Service' procedure as described in clause 6.2.8.

	### Parameters		### Required Parameters

	Name \| Type \| Description \| Notes		Name \| Type \| Description \| Notes
	------------- \| ------------- \| ------------- \| -------------		------------- \| ------------- \| ------------- \| -------------
	sessionId \| String\| Represents a MTS session instance \| [default to null]		ctx \| context.Context \| context for authentication, logging, cancellation, deadlines, tracing, etc.
			sessionId \| string\| Represents a MTS session instance \|

	### Return type		### Return type

	null (empty response body)		(empty response body)

	### Authorization		### Authorization

	@@ -91,23 +90,24 @@ No authorization required
	- Content-Type: Not defined		- Content-Type: Not defined
	- Accept: application/problem+json		- Accept: application/problem+json

	<a name="mtsSessionGET"></a>		[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
	# mtsSessionGET
	> MtsSessionInfo mtsSessionGET(sessionId)

			# MtsSessionGET
			> MtsSessionInfo MtsSessionGET(ctx, sessionId)
	Retrieve information about specific MTS session		Retrieve information about specific MTS session

	Retrieves information about an individual MTS session. Typically used in the 'Get configured MTS Session Info from the MTS Service' procedure as described in clause 6.2.10.		Retrieves information about an individual MTS session. Typically used in the 'Get configured MTS Session Info from the MTS Service' procedure as described in clause 6.2.10.

	### Parameters		### Required Parameters

	Name \| Type \| Description \| Notes		Name \| Type \| Description \| Notes
	------------- \| ------------- \| ------------- \| -------------		------------- \| ------------- \| ------------- \| -------------
	sessionId \| String\| Represents a MTS session instance \| [default to null]		ctx \| context.Context \| context for authentication, logging, cancellation, deadlines, tracing, etc.
			sessionId \| string\| Represents a MTS session instance \|

	### Return type		### Return type

	[MtsSessionInfo](../Models/MtsSessionInfo.md)		[MtsSessionInfo](MtsSessionInfo.md)

	### Authorization		### Authorization

	@@ -118,23 +118,24 @@ No authorization required
	- Content-Type: Not defined		- Content-Type: Not defined
	- Accept: application/json, application/problem+json		- Accept: application/json, application/problem+json

	<a name="mtsSessionPOST"></a>		[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
	# mtsSessionPOST
	> MtsSessionInfo mtsSessionPOST(MtsSessionInfo)

			# MtsSessionPOST
			> MtsSessionInfo MtsSessionPOST(ctx, body)
	Create a MTS session		Create a MTS session

	Used to create a MTS session. This method is typically used in 'Register application to the MTS Service' procedure as described in clause 6.2.7.		Used to create a MTS session. This method is typically used in 'Register application to the MTS Service' procedure as described in clause 6.2.7.

	### Parameters		### Required Parameters

	Name \| Type \| Description \| Notes		Name \| Type \| Description \| Notes
	------------- \| ------------- \| ------------- \| -------------		------------- \| ------------- \| ------------- \| -------------
	MtsSessionInfo \| [MtsSessionInfo](../Models/MtsSessionInfo.md)\| Entity body in the request contains MtsSessionInfo to be created. \|		ctx \| context.Context \| context for authentication, logging, cancellation, deadlines, tracing, etc.
			body \| [MtsSessionInfo](MtsSessionInfo.md)\| Entity body in the request contains MtsSessionInfo to be created. \|

	### Return type		### Return type

	[MtsSessionInfo](../Models/MtsSessionInfo.md)		[MtsSessionInfo](MtsSessionInfo.md)

	### Authorization		### Authorization

	@@ -145,24 +146,25 @@ No authorization required
	- Content-Type: application/json		- Content-Type: application/json
	- Accept: application/json, application/problem+json		- Accept: application/json, application/problem+json

	<a name="mtsSessionPUT"></a>		[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
	# mtsSessionPUT
	> MtsSessionInfo mtsSessionPUT(sessionId, MtsSessionInfo)

			# MtsSessionPUT
			> MtsSessionInfo MtsSessionPUT(ctx, body, sessionId)
	Update the information about specific MTS session		Update the information about specific MTS session

	Updates the information about an individual MTS session. As specified in ETSI GS MEC 009 [6], the PUT HTTP method has 'replace' semantics.		Updates the information about an individual MTS session. As specified in ETSI GS MEC 009 [6], the PUT HTTP method has 'replace' semantics.

	### Parameters		### Required Parameters

	Name \| Type \| Description \| Notes		Name \| Type \| Description \| Notes
	------------- \| ------------- \| ------------- \| -------------		------------- \| ------------- \| ------------- \| -------------
	sessionId \| String\| Represents a MTS session instance \| [default to null]		ctx \| context.Context \| context for authentication, logging, cancellation, deadlines, tracing, etc.
	MtsSessionInfo \| [MtsSessionInfo](../Models/MtsSessionInfo.md)\| MtsSessionInfo with updated information is included as entity body of the request. \|		body \| [MtsSessionInfo](MtsSessionInfo.md)\| MtsSessionInfo with updated information is included as entity body of the request. \|
			sessionId \| string\| Represents a MTS session instance \|

	### Return type		### Return type

	[MtsSessionInfo](../Models/MtsSessionInfo.md)		[MtsSessionInfo](MtsSessionInfo.md)

	### Authorization		### Authorization

	@@ -173,25 +175,32 @@ No authorization required
	- Content-Type: application/json		- Content-Type: application/json
	- Accept: application/json, application/problem+json		- Accept: application/json, application/problem+json

	<a name="mtsSessionsListGET"></a>		[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
	# mtsSessionsListGET
	> List mtsSessionsListGET(app\_instance\_id, app\_name, session\_id)

			# MtsSessionsListGET
			> []MtsSessionInfo MtsSessionsListGET(ctx, optional)
	Retrieve information about a list of MTS sessions		Retrieve information about a list of MTS sessions

	Retrieves information about a list of MTS sessions. Typically used in the 'Get configured MTS Session Info from the MTS Service' procedure as described in clause 6.2.10.		Retrieves information about a list of MTS sessions. Typically used in the 'Get configured MTS Session Info from the MTS Service' procedure as described in clause 6.2.10.

	### Parameters		### Required Parameters

	Name \| Type \| Description \| Notes		Name \| Type \| Description \| Notes
	------------- \| ------------- \| ------------- \| -------------		------------- \| ------------- \| ------------- \| -------------
	app\_instance\_id \| [List](../Models/String.md)\| A MEC application instance may use multiple app_instance_ids as an input parameter to query the MTS session of a list of MEC application instances. See note. \| [optional] [default to null]		ctx \| context.Context \| context for authentication, logging, cancellation, deadlines, tracing, etc.
	app\_name \| [List](../Models/String.md)\| A MEC application instance may use multiple app_names as an input parameter to query the MTS session of a list of MEC application instances. See note. \| [optional] [default to null]		optional \| *MtsApiMtsSessionsListGETOpts \| optional parameters \| nil if no parameters
	session\_id \| [List](../Models/String.md)\| A MEC application instance may use session_id as an input parameter to query the information of a list of MTS sessions. See note. \| [optional] [default to null]
			### Optional Parameters
			Optional parameters are passed through a pointer to a MtsApiMtsSessionsListGETOpts struct
			Name \| Type \| Description \| Notes
			------------- \| ------------- \| ------------- \| -------------
			appInstanceId \| [optional.Interface of []string](string.md)\| A MEC application instance may use multiple app_instance_ids as an input parameter to query the MTS session of a list of MEC application instances. See note. \|
			appName \| [optional.Interface of []string](string.md)\| A MEC application instance may use multiple app_names as an input parameter to query the MTS session of a list of MEC application instances. See note. \|
			sessionId \| [optional.Interface of []string](string.md)\| A MEC application instance may use session_id as an input parameter to query the information of a list of MTS sessions. See note. \|

	### Return type		### Return type

	[List](../Models/MtsSessionInfo.md)		[[]MtsSessionInfo](MtsSessionInfo.md)

	### Authorization		### Authorization

	@@ -202,3 +211,5 @@ No authorization required
	- Content-Type: Not defined		- Content-Type: Not defined
	- Accept: application/json, application/problem+json		- Accept: application/json, application/problem+json

			[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

docs/api-mts/Models/AppTerminationNotification.md

+5 −5

Original line number	Original line	Diff line number	Diff line
	# AppTerminationNotification		# AppTerminationNotification
	## Properties

			## Properties
	Name \| Type \| Description \| Notes		Name \| Type \| Description \| Notes
	------------ \| ------------- \| ------------- \| -------------		------------ \| ------------- \| ------------- \| -------------
	notificationType \| [String](string.md) \| Shall be set to AppTerminationNotification. \| [default to null]		NotificationType \| string \| Shall be set to AppTerminationNotification. \| [default to null]
	operationAction \| [OperationActionType](OperationActionType.md) \| \| [default to null]		OperationAction \| [*OperationActionType](OperationActionType.md) \| \| [default to null]
	maxGracefulTimeout \| [Integer](integer.md) \| Maximum timeout value in seconds for graceful termination or graceful stop of an application instance. \| [default to null]		MaxGracefulTimeout \| int32 \| Maximum timeout value in seconds for graceful termination or graceful stop of an application instance. \| [default to null]
	\_links \| [AppTerminationNotification__links](AppTerminationNotification__links.md) \| \| [default to null]		Links \| [*AppTerminationNotificationLinks](AppTerminationNotification__links.md) \| \| [default to null]

	[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)		[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/api-mts/Models/AppTerminationNotificationLinks.md

+3 −3

Original line number	Original line	Diff line number	Diff line
	# AppTerminationNotificationLinks		# AppTerminationNotificationLinks
	## Properties

			## Properties
	Name \| Type \| Description \| Notes		Name \| Type \| Description \| Notes
	------------ \| ------------- \| ------------- \| -------------		------------ \| ------------- \| ------------- \| -------------
	subscription \| [LinkType](LinkType.md) \| \| [default to null]		Subscription \| [*LinkType](LinkType.md) \| \| [default to null]
	confirmTermination \| [LinkType](LinkType.md) \| \| [optional] [default to null]		ConfirmTermination \| [*LinkType](LinkType.md) \| \| [optional] [default to null]

	[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)		[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/api-mts/Models/LinkType.md

+2 −2

Original line number	Original line	Diff line number	Diff line
	# LinkType		# LinkType
	## Properties

			## Properties
	Name \| Type \| Description \| Notes		Name \| Type \| Description \| Notes
	------------ \| ------------- \| ------------- \| -------------		------------ \| ------------- \| ------------- \| -------------
	href \| [URI](URI.md) \| URI referring to a resource \| [default to null]		Href \| string \| URI referring to a resource \| [default to null]

	[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)		[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/api-mts/Models/MtsCapabilityInfo.md

+4 −4

Original line number	Original line	Diff line number	Diff line
	# MtsCapabilityInfo		# MtsCapabilityInfo
	## Properties

			## Properties
	Name \| Type \| Description \| Notes		Name \| Type \| Description \| Notes
	------------ \| ------------- \| ------------- \| -------------		------------ \| ------------- \| ------------- \| -------------
	mtsAccessInfo \| [List](MtsCapabilityInfo_mtsAccessInfo.md) \| The information on access network connection as defined below \| [default to null]		MtsAccessInfo \| [[]MtsCapabilityInfoMtsAccessInfo](MtsCapabilityInfo_mtsAccessInfo.md) \| The information on access network connection as defined below \| [default to null]
	mtsMode \| [List](integer.md) \| Numeric value corresponding to a specific MTS operation supported by the TMS 0 = low cost, i.e. using the unmetered access network connection whenever it is available 1 = low latency, i.e. using the access network connection with lower latency 2 = high throughput, i.e. using the access network connection with higher throughput, or/and multiple access network connection simultaneously if supported 3 = redundancy, i.e. sending duplicated (redundancy) packets over multiple access network connections for highreliability and low-latency applications 4 = QoS, i.e. performing MTS based on the specific QoS requirements from the app \| [default to null]		MtsMode \| []int32 \| Numeric value corresponding to a specific MTS operation supported by the TMS 0 = low cost, i.e. using the unmetered access network connection whenever it is available 1 = low latency, i.e. using the access network connection with lower latency 2 = high throughput, i.e. using the access network connection with higher throughput, or/and multiple access network connection simultaneously if supported 3 = redundancy, i.e. sending duplicated (redundancy) packets over multiple access network connections for highreliability and low-latency applications 4 = QoS, i.e. performing MTS based on the specific QoS requirements from the app \| [default to null]
	timeStamp \| [MtsCapabilityInfo_timeStamp](MtsCapabilityInfo_timeStamp.md) \| \| [optional] [default to null]		TimeStamp \| [*MtsCapabilityInfoTimeStamp](MtsCapabilityInfo_timeStamp.md) \| \| [optional] [default to null]

	[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)		[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Original line number	Original line	Diff line number	Diff line
	# AppTerminationNotification		# AppTerminationNotification
	## Properties

			## Properties
	Name \| Type \| Description \| Notes		Name \| Type \| Description \| Notes
	------------ \| ------------- \| ------------- \| -------------		------------ \| ------------- \| ------------- \| -------------
	notificationType \| [String](string.md) \| Shall be set to AppTerminationNotification. \| [default to null]		NotificationType \| string \| Shall be set to AppTerminationNotification. \| [default to null]
	operationAction \| [OperationActionType](OperationActionType.md) \| \| [default to null]		OperationAction \| [*OperationActionType](OperationActionType.md) \| \| [default to null]
	maxGracefulTimeout \| [Integer](integer.md) \| Maximum timeout value in seconds for graceful termination or graceful stop of an application instance. \| [default to null]		MaxGracefulTimeout \| int32 \| Maximum timeout value in seconds for graceful termination or graceful stop of an application instance. \| [default to null]
	\_links \| [AppTerminationNotification__links](AppTerminationNotification__links.md) \| \| [default to null]		Links \| [*AppTerminationNotificationLinks](AppTerminationNotification__links.md) \| \| [default to null]

	[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)		[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)