Commit fcbd9c43 authored by Kevin Di Lallo's avatar Kevin Di Lallo
Browse files

update api docs

parent 7c159f49

docs/api-ams/.openapi-generator/FILES

+2 −3
Original line number Diff line number Diff line
@@ -7,21 +7,20 @@ Models/AdjacentAppInfoSubscription.md 
Models/AdjacentAppInfoSubscriptionFilterCriteria.md

Models/AdjacentAppInfoSubscriptionLinks.md

Models/AdjacentAppInstanceInfo.md

Models/AppMobilityServiceLevel.md

Models/AppTerminationNotification.md

Models/AppTerminationNotificationLinks.md

Models/AssociateId.md

Models/CommunicationInterface.md

Models/ContextTransferState.md

Models/ExpiryNotification.md

Models/ExpiryNotificationLinks.md

Models/InlineNotification.md

Models/InlineSubscription.md

Models/LinkType.md

Models/MECHostInformation.md

Models/MobilityProcedureNotification.md

Models/MobilityProcedureNotificationTargetAppInfo.md

Models/MobilityProcedureSubscription.md

Models/MobilityProcedureSubscriptionFilterCriteria.md

Models/MobilityStatus.md

Models/OperationActionType.md

Models/ProblemDetails.md

Models/RegistrationInfo.md

docs/api-ams/Apis/AmsiApi.md

+8 −8
Original line number Diff line number Diff line
@@ -213,7 +213,7 @@ No authorization required 


<a name="subByIdGET"></a>

# **subByIdGET**

> oneOf&lt;MobilityProcedureSubscription,AdjacentAppInfoSubscription&gt; subByIdGET(subscriptionId)

> InlineSubscription subByIdGET(subscriptionId)



Retrieve information about this subscription.
@@ -227,7 +227,7 @@ Name | Type | Description | Notes 


### Return type



[**oneOf&lt;MobilityProcedureSubscription,AdjacentAppInfoSubscription&gt;**](../Models/oneOf&lt;MobilityProcedureSubscription,AdjacentAppInfoSubscription&gt;.md)

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



### Authorization
@@ -240,7 +240,7 @@ No authorization required 


<a name="subByIdPUT"></a>

# **subByIdPUT**

> oneOf&lt;MobilityProcedureSubscription,AdjacentAppInfoSubscription&gt; subByIdPUT(subscriptionId, UNKNOWN\_BASE\_TYPE)

> InlineSubscription subByIdPUT(subscriptionId, InlineSubscription)



update the existing individual subscription.
@@ -251,11 +251,11 @@ update the existing individual subscription. 
Name | Type | Description  | Notes

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

 **subscriptionId** | **String**| Refers to created subscription, where the AMS API allocates a unique resource name for this subscription | [default to null]

 **UNKNOWN\_BASE\_TYPE** | [**UNKNOWN_BASE_TYPE**](../Models/UNKNOWN_BASE_TYPE.md)|  |

 **InlineSubscription** | [**InlineSubscription**](../Models/InlineSubscription.md)|  |



### Return type



[**oneOf&lt;MobilityProcedureSubscription,AdjacentAppInfoSubscription&gt;**](../Models/oneOf&lt;MobilityProcedureSubscription,AdjacentAppInfoSubscription&gt;.md)

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



### Authorization
@@ -295,7 +295,7 @@ No authorization required 


<a name="subPOST"></a>

# **subPOST**

> oneOf&lt;MobilityProcedureSubscription,AdjacentAppInfoSubscription&gt; subPOST(UNKNOWN\_BASE\_TYPE)

> InlineSubscription subPOST(InlineSubscription)



Create a new subscription to Application Mobility Service notifications.
@@ -305,11 +305,11 @@ Create a new subscription to Application Mobility Service notifications. 


Name | Type | Description  | Notes

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

 **UNKNOWN\_BASE\_TYPE** | [**UNKNOWN_BASE_TYPE**](../Models/UNKNOWN_BASE_TYPE.md)|  |

 **InlineSubscription** | [**InlineSubscription**](../Models/InlineSubscription.md)|  |



### Return type



[**oneOf&lt;MobilityProcedureSubscription,AdjacentAppInfoSubscription&gt;**](../Models/oneOf&lt;MobilityProcedureSubscription,AdjacentAppInfoSubscription&gt;.md)

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



### Authorization

docs/api-ams/Models/ContextTransferState.md

deleted100644 → 0
+0 −8
Original line number Diff line number Diff line 
# ContextTransferState

## Properties



Name | Type | Description | Notes

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



[[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-ams/Models/InlineNotification.md

0 → 100644
+14 −0
Original line number Diff line number Diff line 
# InlineNotification

## Properties



Name | Type | Description | Notes

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

**associateId** | [**List**](AssociateId.md) | 0 to N identifiers to associate the information for specific UE(s) and flow(s). | [optional] [default to null]

**mobilityStatus** | [**Integer**](integer.md) | Indicate the status of the UE mobility. Values are defined as following:      1 &#x3D; INTERHOST_MOVEOUT_TRIGGERED.      2 &#x3D; INTERHOST_MOVEOUT_COMPLETED.      3 &#x3D; INTERHOST_MOVEOUT_FAILED.       Other values are reserved. | [default to null]

**notificationType** | [**String**](string.md) | Shall be set to \\\&quot;AdjacentAppInfoNotification\\\&quot;. | [default to null]

**targetAppInfo** | [**MobilityProcedureNotification_targetAppInfo**](MobilityProcedureNotification_targetAppInfo.md) |  | [optional] [default to null]

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

**adjacentAppInfo** | [**List**](AdjacentAppInfoNotification_adjacentAppInfo.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)

docs/api-ams/Models/InlineSubscription.md

0 → 100644
+13 −0
Original line number Diff line number Diff line 
# InlineSubscription

## Properties



Name | Type | Description | Notes

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

**\_links** | [**AdjacentAppInfoSubscription__links**](AdjacentAppInfoSubscription__links.md) |  | [optional] [default to null]

**callbackReference** | [**URI**](URI.md) | URI selected by the service consumer, to receive notifications on the subscribed RNIS information. This shall be included in the request and response. | [default to null]

**expiryDeadline** | [**TimeStamp**](TimeStamp.md) |  | [optional] [default to null]

**filterCriteria** | [**AdjacentAppInfoSubscription_filterCriteria**](AdjacentAppInfoSubscription_filterCriteria.md) |  | [default to null]

**subscriptionType** | [**String**](string.md) | Shall be set to \&quot;AdjacentAppInfoSubscription\&quot;. | [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)