Commit 9a347c80 authored by Yann Garcia's avatar Yann Garcia
Browse files

Update MEC-021 docs

parent b9e3d7d5

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

+12 −3
Original line number Diff line number Diff line
@@ -7,26 +7,35 @@ 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/CommunicationInterfaceIpAddresses.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/MobilityProcedureNotificationLinks.md

Models/MobilityProcedureNotificationTargetAppInfo.md

Models/MobilityProcedureSubscription.md

Models/MobilityProcedureSubscriptionFilterCriteria.md

Models/MobilityProcedureSubscriptionLinks.md

Models/MobilityStatus.md

Models/OperationActionType.md

Models/ProblemDetails.md

Models/RegistrationInfo.md

Models/RegistrationInfoDeviceInformation.md

Models/RegistrationInfoServiceConsumerId.md

Models/SubscriptionLinkList.md

Models/SubscriptionLinkListLinks.md

Models/SubscriptionLinkListSubscription.md

Models/SubscriptionType.md

Models/TestNotification.md

Models/TestNotificationLinks.md

Models/TimeStamp.md

Models/Type.md

Models/WebsockNotifConfig.md

README.md

docs/api-ams/Apis/AmsiApi.md

+14 −14
Original line number Diff line number Diff line 
# AmsiApi



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

All URIs are relative to *https://localhost/amsi/v1*



Method | HTTP request | Description

------------- | ------------- | -------------
@@ -13,8 +13,8 @@ Method | HTTP request | Description 
[**subByIdDELETE**](AmsiApi.md#subByIdDELETE) | **DELETE** /subscriptions/{subscriptionId} | cancel the existing individual subscription

[**subByIdGET**](AmsiApi.md#subByIdGET) | **GET** /subscriptions/{subscriptionId} | Retrieve information about this subscription.

[**subByIdPUT**](AmsiApi.md#subByIdPUT) | **PUT** /subscriptions/{subscriptionId} | update the existing individual subscription.

[**subGET**](AmsiApi.md#subGET) | **GET** /subscriptions/ | Retrieve information about the subscriptions for this requestor.

[**subPOST**](AmsiApi.md#subPOST) | **POST** /subscriptions/ | Create a new subscription to Application Mobility Service notifications.

[**subGET**](AmsiApi.md#subGET) | **GET** /subscriptions | Retrieve information about the subscriptions for this requestor.

[**subPOST**](AmsiApi.md#subPOST) | **POST** /subscriptions | Create a new subscription to Application Mobility Service notifications.





<a name="appMobilityServiceByIdDELETE"></a>
@@ -213,7 +213,7 @@ No authorization required 


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

# **subByIdGET**

> InlineSubscription subByIdGET(subscriptionId)

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



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


### Return type



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

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



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


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

# **subByIdPUT**

> InlineSubscription subByIdPUT(subscriptionId, InlineSubscription)

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



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]

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

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



### Return type



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

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



### Authorization
@@ -278,7 +278,7 @@ Retrieve information about the subscriptions for this requestor. 


Name | Type | Description  | Notes

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

 **subscriptionType** | **String**| Query parameter to filter on a specific subscription type. Permitted values: mobility_proc or adj_app_info | [optional] [default to null]

 **subscriptionType** | **String**| Query parameter to filter on a specific subscription type. Permitted values: mobility_proc or adj_app_info | [default to null]



### Return type
@@ -295,7 +295,7 @@ No authorization required 


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

# **subPOST**

> InlineSubscription subPOST(InlineSubscription)

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



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

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

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

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



### Return type



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

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



### Authorization

docs/api-ams/Apis/UnsupportedApi.md

+4 −4
Original line number Diff line number Diff line 
# UnsupportedApi



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

All URIs are relative to *https://localhost/amsi/v1*



Method | HTTP request | Description

------------- | ------------- | -------------
@@ -20,10 +20,10 @@ Retrieve information about this subscription. 


Name | Type | Description  | Notes

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

 **filter** | **String**| Attribute-based filtering parameters according to ETSI GS MEC 011 | [optional] [default to null]

 **filter** | **String**| Attribute-based filtering parameters according to ETSI GS MEC 009 | [optional] [default to null]

 **all\_fields** | **String**| Include all complex attributes in the response. | [optional] [default to null]

 **fields** | **String**| Complex attributes to be included into the response. See clause 6.18 in ETSI GS MEC 011 | [optional] [default to null]

 **exclude\_fields** | **String**| Complex attributes to be excluded from the response.See clause 6.18 in ETSI GS MEC 011 | [optional] [default to null]

 **fields** | **String**| Complex attributes to be included into the response. See clause 6.18 in ETSI GS MEC 009 | [optional] [default to null]

 **exclude\_fields** | **String**| Complex attributes to be excluded from the response.See clause 6.18 in ETSI GS MEC 009 | [optional] [default to null]

 **exclude\_default** | **String**| Indicates to exclude the following complex attributes from the response  See clause 6.18 in ETSI GS MEC 011 for details. | [optional] [default to null]



### Return type

docs/api-ams/Models/AdjacentAppInfoNotification.md

+4 −2
Original line number Diff line number Diff line
@@ -3,9 +3,11 @@ 


Name | Type | Description | Notes

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

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

**adjacentAppInfo** | [**List**](AdjacentAppInfoNotification_adjacentAppInfo.md) |  | [optional] [default to null]

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

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

**associateId** | [**List**](AssociateId.md) | 1 to N identifiers to associate the information for specific | [optional] [default to null]

**adjacentAppInfo** | [**List**](AdjacentAppInfoNotificationAdjacentAppInfo.md) |  | [optional] [default to null]

**\_links** | [**MobilityProcedureNotification__links**](MobilityProcedureNotification__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)

docs/api-ams/Models/AdjacentAppInfoNotificationAdjacentAppInfo.md

+2 −2
Original line number Diff line number Diff line
@@ -3,8 +3,8 @@ 


Name | Type | Description | Notes

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

**appInstanceId** | [**String**](string.md) | Identifiers of the target application instance. | [default to null]

**commInterface** | [**CommunicationInterface**](CommunicationInterface.md) |  | [optional] [default to null]

**appInstanceId** | [**String**](string.md) | Identifier of the adjacent application instance. | [default to null]

**commInterface** | [**List**](CommunicationInterface.md) | If present, it represents the communication interface(s) information of the application instance. | [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)