Commit 0d03c60d authored by Ayesha Ayub's avatar Ayesha Ayub
Browse files

update MTS API changes as per InterDigital template

parent 9f54adb0
Loading
Loading
Loading
Loading
+87 −76
Original line number Diff line number Diff line
# MtsApi
# {{classname}}

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**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
[**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
[**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
[**mtsSessionsListGET**](MtsApi.md#mtsSessionsListGET) | **GET** /mts_sessions | Retrieve information about a list of MTS sessions


<a name="mec011AppTerminationPOST"></a>
# **mec011AppTerminationPOST**
> mec011AppTerminationPOST(AppTerminationNotification)

[**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
[**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
[**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
[**MtsSessionsListGET**](MtsApi.md#MtsSessionsListGET) | **Get** /mts_sessions | Retrieve information about a list of MTS sessions

# **Mec011AppTerminationPOST**
> Mec011AppTerminationPOST(ctx, body)
MEC011 Application Termination notification for self termination

Terminates itself.

### Parameters
### Required Parameters

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

null (empty response body)
 (empty response body)

### Authorization

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

<a name="mtsCapabilityInfoGET"></a>
# **mtsCapabilityInfoGET**
> MtsCapabilityInfo mtsCapabilityInfoGET()
[[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(ctx, )
Retrieve the MTS capability informations

    Used to query information about the MTS information. Typically used in the &#39;Get MTS service Info from the MTS Service&#39; 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.

### Return type

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

### Authorization

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

<a name="mtsSessionDELETE"></a>
# **mtsSessionDELETE**
> mtsSessionDELETE(sessionId)
[[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(ctx, sessionId)
Remove specific MTS session

    DELETE method is typically used in &#39;Unregister from the MTS Service&#39; 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
------------- | ------------- | ------------- | -------------
 **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

null (empty response body)
 (empty response body)

### Authorization

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

<a name="mtsSessionGET"></a>
# **mtsSessionGET**
> MtsSessionInfo mtsSessionGET(sessionId)
[[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(ctx, sessionId)
Retrieve information about specific MTS session

    Retrieves information about an individual MTS session. Typically used in the &#39;Get configured MTS Session Info from the MTS Service&#39; 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
------------- | ------------- | ------------- | -------------
 **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

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

### Authorization

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

<a name="mtsSessionPOST"></a>
# **mtsSessionPOST**
> MtsSessionInfo mtsSessionPOST(MtsSessionInfo)
[[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(ctx, body)
Create a MTS session

    Used to create a MTS session. This method is typically used in &#39;Register application to the MTS Service&#39; 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
------------- | ------------- | ------------- | -------------
 **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

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

### Authorization

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

<a name="mtsSessionPUT"></a>
# **mtsSessionPUT**
> MtsSessionInfo mtsSessionPUT(sessionId, MtsSessionInfo)
[[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(ctx, body, sessionId)
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 &#39;replace&#39; 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
------------- | ------------- | ------------- | -------------
 **sessionId** | **String**| Represents a MTS session instance | [default to null]
 **MtsSessionInfo** | [**MtsSessionInfo**](../Models/MtsSessionInfo.md)| MtsSessionInfo with updated information is included as entity body of the request. |
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
  **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

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

### Authorization

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

<a name="mtsSessionsListGET"></a>
# **mtsSessionsListGET**
> List mtsSessionsListGET(app\_instance\_id, app\_name, session\_id)
[[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**
> []MtsSessionInfo MtsSessionsListGET(ctx, optional)
Retrieve information about a list of MTS sessions

    Retrieves information about a list of MTS sessions. Typically used in the &#39;Get configured MTS Session Info from the MTS Service&#39; 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
------------- | ------------- | ------------- | -------------
 **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]
 **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]
 **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]
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
 **optional** | ***MtsApiMtsSessionsListGETOpts** | optional parameters | nil if no parameters

### 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

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

### Authorization

@@ -202,3 +211,5 @@ No authorization required
 - **Content-Type**: Not defined
 - **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)
+5 −5
Original line number Diff line number Diff line
# AppTerminationNotification
## Properties

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**notificationType** | [**String**](string.md) | Shall be set to AppTerminationNotification. | [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]
**\_links** | [**AppTerminationNotification__links**](AppTerminationNotification__links.md) |  | [default to null]
**NotificationType** | **string** | Shall be set to AppTerminationNotification. | [default to null]
**OperationAction** | [***OperationActionType**](OperationActionType.md) |  | [default to null]
**MaxGracefulTimeout** | **int32** | Maximum timeout value in seconds for graceful termination or graceful stop of an application instance. | [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)
+3 −3
Original line number Diff line number Diff line
# AppTerminationNotificationLinks
## Properties

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**subscription** | [**LinkType**](LinkType.md) |  | [default to null]
**confirmTermination** | [**LinkType**](LinkType.md) |  | [optional] [default to null]
**Subscription** | [***LinkType**](LinkType.md) |  | [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)
+2 −2
Original line number Diff line number Diff line
# LinkType
## Properties

## Properties
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)
+4 −4
Original line number Diff line number Diff line
# MtsCapabilityInfo
## Properties

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