Commit 9f54adb0 authored by Ayesha Ayub's avatar Ayesha Ayub
Browse files

update BWM API changes as per InterDigital template

parent 070f327a

docs/api-bwm/Apis/BwmApi.md

+79 −68
Original line number Original line Diff line number Diff line 
# BwmApi

# {{classname}}





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

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





Method | HTTP request | Description

Method | HTTP request | Description

------------- | ------------- | -------------

------------- | ------------- | -------------

[**bandwidthAllocationDELETE**](BwmApi.md#bandwidthAllocationDELETE) | **DELETE** /bw_allocations/{allocationId} | Remove a specific bandwidthAllocation

[**BandwidthAllocationDELETE**](BwmApi.md#BandwidthAllocationDELETE) | **Delete** /bw_allocations/{allocationId} | Remove a specific bandwidthAllocation

[**bandwidthAllocationGET**](BwmApi.md#bandwidthAllocationGET) | **GET** /bw_allocations/{allocationId} | Retrieve information about a specific bandwidthAllocation

[**BandwidthAllocationGET**](BwmApi.md#BandwidthAllocationGET) | **Get** /bw_allocations/{allocationId} | Retrieve information about a specific bandwidthAllocation

[**bandwidthAllocationListGET**](BwmApi.md#bandwidthAllocationListGET) | **GET** /bw_allocations | Retrieve information about a list of bandwidthAllocation resources

[**BandwidthAllocationListGET**](BwmApi.md#BandwidthAllocationListGET) | **Get** /bw_allocations | Retrieve information about a list of bandwidthAllocation resources

[**bandwidthAllocationPATCH**](BwmApi.md#bandwidthAllocationPATCH) | **PATCH** /bw_allocations/{allocationId} | Modify the information about a specific existing bandwidthAllocation by sending updates on the data structure

[**BandwidthAllocationPATCH**](BwmApi.md#BandwidthAllocationPATCH) | **Patch** /bw_allocations/{allocationId} | Modify the information about a specific existing bandwidthAllocation by sending updates on the data structure

[**bandwidthAllocationPOST**](BwmApi.md#bandwidthAllocationPOST) | **POST** /bw_allocations | Create a bandwidthAllocation resource

[**BandwidthAllocationPOST**](BwmApi.md#BandwidthAllocationPOST) | **Post** /bw_allocations | Create a bandwidthAllocation resource

[**bandwidthAllocationPUT**](BwmApi.md#bandwidthAllocationPUT) | **PUT** /bw_allocations/{allocationId} | Update the information about a specific bandwidthAllocation

[**BandwidthAllocationPUT**](BwmApi.md#BandwidthAllocationPUT) | **Put** /bw_allocations/{allocationId} | Update the information about a specific bandwidthAllocation







# **BandwidthAllocationDELETE**

<a name="bandwidthAllocationDELETE"></a>

> BandwidthAllocationDELETE(ctx, allocationId)

# **bandwidthAllocationDELETE**

> bandwidthAllocationDELETE(allocationId)



Remove a specific bandwidthAllocation

Remove a specific bandwidthAllocation





    Used in &#39;Unregister from Bandwidth Management Service&#39; procedure as described in clause 6.2.3.

Used in 'Unregister from Bandwidth Management Service' procedure as described in clause 6.2.3.





### Parameters

### Required Parameters





Name | Type | Description  | Notes

Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

------------- | ------------- | ------------- | -------------

 **allocationId** | **String**| Represents a bandwidth allocation instance | [default to null]

 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.

  **allocationId** | **string**| Represents a bandwidth allocation instance | 





### Return type

### Return type





null (empty response body)

 (empty response body)





### Authorization

### Authorization
@@ -39,23 +37,24 @@ No authorization required 
 - **Content-Type**: Not defined

 - **Content-Type**: Not defined

 - **Accept**: application/problem+json

 - **Accept**: application/problem+json





<a name="bandwidthAllocationGET"></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)

# **bandwidthAllocationGET**

> BwInfo bandwidthAllocationGET(allocationId)





# **BandwidthAllocationGET**

> BwInfo BandwidthAllocationGET(ctx, allocationId)

Retrieve information about a specific bandwidthAllocation

Retrieve information about a specific bandwidthAllocation





    Retrieves information about a bandwidthAllocation resource. Typically used in &#39;Get configured bandwidth allocation from Bandwidth Management Service&#39; procedure as described in clause 6.2.5.

Retrieves information about a bandwidthAllocation resource. Typically used in 'Get configured bandwidth allocation from Bandwidth Management Service' procedure as described in clause 6.2.5.





### Parameters

### Required Parameters





Name | Type | Description  | Notes

Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

------------- | ------------- | ------------- | -------------

 **allocationId** | **String**| Represents a bandwidth allocation instance | [default to null]

 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.

  **allocationId** | **string**| Represents a bandwidth allocation instance | 





### Return type

### Return type





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

[**BwInfo**](BwInfo.md)





### Authorization

### Authorization
@@ -66,25 +65,32 @@ 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="bandwidthAllocationListGET"></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)

# **bandwidthAllocationListGET**

> List bandwidthAllocationListGET(app\_instance\_id, app\_name, session\_id)





# **BandwidthAllocationListGET**

> []BwInfo BandwidthAllocationListGET(ctx, optional)

Retrieve information about a list of bandwidthAllocation resources

Retrieve information about a list of bandwidthAllocation resources





    Retrieves information about a list of bandwidthAllocation resources. Typically used in &#39;Get configured bandwidth allocation from Bandwidth Management Service&#39; procedure as described in clause 6.2.5.

Retrieves information about a list of bandwidthAllocation resources. Typically used in 'Get configured bandwidth allocation from Bandwidth Management Service' procedure as described in clause 6.2.5.





### 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 bandwidth allocation of a list of MEC application instances. app_instance_id corresponds to appInsId defined in table 7.2.2-1. 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 bandwidth allocation of a list of MEC application instances. app_name corresponds to appName defined in table 7.2.2-1. See note. | [optional] [default to null]

 **optional** | ***BwmApiBandwidthAllocationListGETOpts** | 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 bandwidth allocation of a list of sessions. session_id corresponds to allocationId defined in table 7.2.2-1. See note. | [optional] [default to null]



### Optional Parameters

Optional parameters are passed through a pointer to a BwmApiBandwidthAllocationListGETOpts 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 bandwidth allocation of a list of MEC application instances. app_instance_id corresponds to appInsId defined in table 7.2.2-1. 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 bandwidth allocation of a list of MEC application instances. app_name corresponds to appName defined in table 7.2.2-1. See note. | 

 **sessionId** | [**optional.Interface of []string**](string.md)| A MEC application instance may use session_id as an input parameter to query the bandwidth allocation of a list of sessions. session_id corresponds to allocationId defined in table 7.2.2-1. See note. | 





### Return type

### Return type





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

[**[]BwInfo**](BwInfo.md)





### Authorization

### Authorization
@@ -95,24 +101,25 @@ 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="bandwidthAllocationPATCH"></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)

# **bandwidthAllocationPATCH**

> BwInfo bandwidthAllocationPATCH(allocationId, BwInfoDeltas)





# **BandwidthAllocationPATCH**

> BwInfo BandwidthAllocationPATCH(ctx, body, allocationId)

Modify the information about a specific existing bandwidthAllocation by sending updates on the data structure

Modify the information about a specific existing bandwidthAllocation by sending updates on the data structure





    Updates the information about a bandwidthAllocation resource. As specified in ETSI GS MEC 009 [6], the PATCH HTTP method updates a resource on top of the existing resource state by just including the changes (&#39;deltas&#39;) in the request body.

Updates the information about a bandwidthAllocation resource. As specified in ETSI GS MEC 009 [6], the PATCH HTTP method updates a resource on top of the existing resource state by just including the changes ('deltas') in the request body.





### Parameters

### Required Parameters





Name | Type | Description  | Notes

Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

------------- | ------------- | ------------- | -------------

 **allocationId** | **String**| Represents a bandwidth allocation instance | [default to null]

 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.

 **BwInfoDeltas** | [**BwInfoDeltas**](../Models/BwInfoDeltas.md)| Description of the changes to instruct the server how to modify the resource representation. |

  **body** | [**BwInfoDeltas**](BwInfoDeltas.md)| Description of the changes to instruct the server how to modify the resource representation. | 

  **allocationId** | **string**| Represents a bandwidth allocation instance | 





### Return type

### Return type





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

[**BwInfo**](BwInfo.md)





### Authorization

### Authorization
@@ -123,23 +130,24 @@ 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="bandwidthAllocationPOST"></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)

# **bandwidthAllocationPOST**

> BwInfo bandwidthAllocationPOST(BwInfo)





# **BandwidthAllocationPOST**

> BwInfo BandwidthAllocationPOST(ctx, body)

Create a bandwidthAllocation resource

Create a bandwidthAllocation resource





    Used to create a bandwidthAllocation resource. Typically used in &#39;Register to Bandwidth Management Service&#39; procedure as described in clause 6.2.1.

Used to create a bandwidthAllocation resource. Typically used in 'Register to Bandwidth Management Service' procedure as described in clause 6.2.1.





### Parameters

### Required Parameters





Name | Type | Description  | Notes

Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

------------- | ------------- | ------------- | -------------

 **BwInfo** | [**BwInfo**](../Models/BwInfo.md)| Entity body in the request contains BwInfo to be created. |

 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.

  **body** | [**BwInfo**](BwInfo.md)| Entity body in the request contains BwInfo to be created. | 





### Return type

### Return type





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

[**BwInfo**](BwInfo.md)





### Authorization

### Authorization
@@ -150,24 +158,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="bandwidthAllocationPUT"></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)

# **bandwidthAllocationPUT**

> BwInfo bandwidthAllocationPUT(allocationId, BwInfo)





# **BandwidthAllocationPUT**

> BwInfo BandwidthAllocationPUT(ctx, body, allocationId)

Update the information about a specific bandwidthAllocation

Update the information about a specific bandwidthAllocation





    Updates the information about a bandwidthAllocation resource. As specified in ETSI GS MEC 009 [6], the PUT HTTP method has &#39;replace&#39; semantics.

Updates the information about a bandwidthAllocation resource. 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

------------- | ------------- | ------------- | -------------

------------- | ------------- | ------------- | -------------

 **allocationId** | **String**| Represents a bandwidth allocation instance | [default to null]

 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.

 **BwInfo** | [**BwInfo**](../Models/BwInfo.md)| BwInfo with updated information is included as entity body of the request. |

  **body** | [**BwInfo**](BwInfo.md)| BwInfo with updated information is included as entity body of the request. | 

  **allocationId** | **string**| Represents a bandwidth allocation instance | 





### Return type

### Return type





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

[**BwInfo**](BwInfo.md)





### Authorization

### Authorization
@@ -178,3 +187,5 @@ No authorization required 
 - **Content-Type**: application/json

 - **Content-Type**: application/json

 - **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-bwm/Apis/LocationApi.md

+13 −13
Original line number Original line Diff line number Diff line 
# LocationApi

# {{classname}}





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

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





Method | HTTP request | Description

Method | HTTP request | Description

------------- | ------------- | -------------

------------- | ------------- | -------------

[**mec011AppTerminationPOST**](LocationApi.md#mec011AppTerminationPOST) | **POST** /notifications/mec011/appTermination | MEC011 Application Termination notification for self termination

[**Mec011AppTerminationPOST**](LocationApi.md#Mec011AppTerminationPOST) | **Post** /notifications/mec011/appTermination | MEC011 Application Termination notification for self termination





<a name="mec011AppTerminationPOST"></a>

# **mec011AppTerminationPOST**

> mec011AppTerminationPOST(AppTerminationNotification)





# **Mec011AppTerminationPOST**

> Mec011AppTerminationPOST(ctx, body)

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
@@ -34,3 +32,5 @@ No authorization required 
 - **Content-Type**: application/json

 - **Content-Type**: application/json

 - **Accept**: Not defined

 - **Accept**: Not defined





[[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-bwm/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-bwm/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-bwm/Models/BwInfo.md

+10 −10
Original line number Original line Diff line number Diff line 
# BwInfo

# BwInfo

## Properties





## Properties

Name | Type | Description | Notes

Name | Type | Description | Notes

------------ | ------------- | ------------- | -------------

------------ | ------------- | ------------- | -------------

**allocationId** | [**String**](string.md) | Bandwidth allocation instance identifier | [optional] [default to null]

**AllocationId** | **string** | Bandwidth allocation instance identifier | [optional] [default to null]

**allocationDirection** | [**String**](string.md) | The direction of the requested BW allocation: 00 &#x3D; Downlink (towards the UE) 01 &#x3D; Uplink (towards the application/session) 10 &#x3D; Symmetrical | [default to null]

**AllocationDirection** | **string** | The direction of the requested BW allocation: 00 &#x3D; Downlink (towards the UE) 01 &#x3D; Uplink (towards the application/session) 10 &#x3D; Symmetrical | [default to null]

**appInsId** | [**String**](string.md) | Application instance identifier | [default to null]

**AppInsId** | **string** | Application instance identifier | [default to null]

**appName** | [**String**](string.md) | Name of the application | [optional] [default to null]

**AppName** | **string** | Name of the application | [optional] [default to null]

**fixedAllocation** | [**String**](string.md) | Size of requested fixed BW allocation in [bps] | [default to null]

**FixedAllocation** | **string** | Size of requested fixed BW allocation in [bps] | [default to null]

**fixedBWPriority** | [**String**](string.md) | Indicates the allocation priority when dealing with several applications or sessions in parallel. Values are not defined in the present document | [optional] [default to null]

**FixedBWPriority** | **string** | Indicates the allocation priority when dealing with several applications or sessions in parallel. Values are not defined in the present document | [optional] [default to null]

**requestType** | [**Integer**](integer.md) | Numeric value (0 - 255) corresponding to specific type of consumer as following: 0 &#x3D; APPLICATION_SPECIFIC_BW_ALLOCATION 1 &#x3D; SESSION_SPECIFIC_BW_ALLOCATION | [default to null]

**RequestType** | **int32** | Numeric value (0 - 255) corresponding to specific type of consumer as following: 0 &#x3D; APPLICATION_SPECIFIC_BW_ALLOCATION 1 &#x3D; SESSION_SPECIFIC_BW_ALLOCATION | [default to null]

**sessionFilter** | [**List**](BwInfo_sessionFilter.md) | Session filtering criteria, applicable when requestType is set as SESSION_SPECIFIC_BW_ALLOCATION. Any filtering criteria shall define a single session only. In case multiple sessions match sessionFilter the request shall be rejected | [optional] [default to null]

**SessionFilter** | [**[]BwInfoSessionFilter**](BwInfo_sessionFilter.md) | Session filtering criteria, applicable when requestType is set as SESSION_SPECIFIC_BW_ALLOCATION. Any filtering criteria shall define a single session only. In case multiple sessions match sessionFilter the request shall be rejected | [optional] [default to null]

**timeStamp** | [**BwInfo_timeStamp**](BwInfo_timeStamp.md) |  | [optional] [default to null]

**TimeStamp** | [***BwInfoTimeStamp**](BwInfo_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)