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

updated API docs

parent 67a31bff

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

0 → 100644
+23 −0
Original line number Diff line number Diff line 
# OpenAPI Generator Ignore

# Generated by openapi-generator https://github.com/openapitools/openapi-generator



# Use this file to prevent files from being overwritten by the generator.

# The patterns follow closely to .gitignore or .dockerignore.



# As an example, the C# client generator defines ApiClient.cs.

# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:

#ApiClient.cs



# You can match any string of characters against a directory, file or extension with a single asterisk (*):

#foo/*/qux

# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux



# You can recursively match patterns against a directory, file or extension with a double asterisk (**):

#foo/**/qux

# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux



# You can also negate patterns with an exclamation (!).

# For example, you can ignore all files in a docs folder with the file extension .md:

#docs/*.md

# Then explicitly reverse the ignore rule for a single file:

#!docs/README.md

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

0 → 100644
+33 −0
Original line number Diff line number Diff line 
.openapi-generator-ignore

Apis/AmsiApi.md

Apis/UnsupportedApi.md

Models/AdjacentAppInfoNotification.md

Models/AdjacentAppInfoNotificationAdjacentAppInfo.md

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

Models/RegistrationInfoDeviceInformation.md

Models/SubscriptionLinkList.md

Models/SubscriptionLinkListLinks.md

Models/SubscriptionLinkListSubscription.md

Models/TimeStamp.md

README.md

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

0 → 100644
+1 −0
Original line number Diff line number Diff line 
5.0.0-beta2
 
 No newline at end of file

docs/api-ams/Apis/AmsiApi.md

0 → 100644
+322 −0
Original line number Diff line number Diff line 
# AmsiApi



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



Method | HTTP request | Description

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

[**appMobilityServiceByIdDELETE**](AmsiApi.md#appMobilityServiceByIdDELETE) | **DELETE** /app_mobility_services/{appMobilityServiceId} |  deregister the individual application mobility service

[**appMobilityServiceByIdGET**](AmsiApi.md#appMobilityServiceByIdGET) | **GET** /app_mobility_services/{appMobilityServiceId} | Retrieve information about this individual application mobility service

[**appMobilityServiceByIdPUT**](AmsiApi.md#appMobilityServiceByIdPUT) | **PUT** /app_mobility_services/{appMobilityServiceId} |  update the existing individual application mobility service

[**appMobilityServiceGET**](AmsiApi.md#appMobilityServiceGET) | **GET** /app_mobility_services |  Retrieve information about the registered application mobility service.

[**appMobilityServicePOST**](AmsiApi.md#appMobilityServicePOST) | **POST** /app_mobility_services | Create a new application mobility service for the service requester.

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

[**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.





<a name="appMobilityServiceByIdDELETE"></a>

# **appMobilityServiceByIdDELETE**

> appMobilityServiceByIdDELETE(appMobilityServiceId)



 deregister the individual application mobility service



     deregister the individual application mobility service



### Parameters



Name | Type | Description  | Notes

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

 **appMobilityServiceId** | **String**| It uniquely identifies the created individual application mobility service | [default to null]



### Return type



null (empty response body)



### Authorization



No authorization required



### HTTP request headers



- **Content-Type**: Not defined

- **Accept**: application/json



<a name="appMobilityServiceByIdGET"></a>

# **appMobilityServiceByIdGET**

> RegistrationInfo appMobilityServiceByIdGET(appMobilityServiceId)



Retrieve information about this individual application mobility service



    Retrieve information about this individual application mobility service



### Parameters



Name | Type | Description  | Notes

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

 **appMobilityServiceId** | **String**| It uniquely identifies the created individual application mobility service | [default to null]



### Return type



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



### Authorization



No authorization required



### HTTP request headers



- **Content-Type**: Not defined

- **Accept**: application/json



<a name="appMobilityServiceByIdPUT"></a>

# **appMobilityServiceByIdPUT**

> RegistrationInfo appMobilityServiceByIdPUT(appMobilityServiceId, RegistrationInfo)



 update the existing individual application mobility service



     update the existing individual application mobility service



### Parameters



Name | Type | Description  | Notes

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

 **appMobilityServiceId** | **String**| It uniquely identifies the created individual application mobility service | [default to null]

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



### Return type



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



### Authorization



No authorization required



### HTTP request headers



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

- **Accept**: application/json



<a name="appMobilityServiceGET"></a>

# **appMobilityServiceGET**

> List appMobilityServiceGET(filter, all\_fields, fields, exclude\_fields, exclude\_default)



 Retrieve information about the registered application mobility service.



     Retrieve information about the registered application mobility service.



### Parameters



Name | Type | Description  | Notes

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

 **filter** | **String**| Attribute-based filtering parameters according to ETSI GS MEC 011 | [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]

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



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



### Authorization



No authorization required



### HTTP request headers



- **Content-Type**: Not defined

- **Accept**: application/json



<a name="appMobilityServicePOST"></a>

# **appMobilityServicePOST**

> RegistrationInfo appMobilityServicePOST(RegistrationInfo)



Create a new application mobility service for the service requester.



    Create a new application mobility service for the service requester.



### Parameters



Name | Type | Description  | Notes

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

 **RegistrationInfo** | [**RegistrationInfo**](../Models/RegistrationInfo.md)| Application mobility service to be created |



### Return type



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



### Authorization



No authorization required



### HTTP request headers



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

- **Accept**: application/json



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

# **mec011AppTerminationPOST**

> mec011AppTerminationPOST(AppTerminationNotification)



MEC011 Application Termination notification for self termination



    Terminates itself.



### Parameters



Name | Type | Description  | Notes

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

 **AppTerminationNotification** | [**AppTerminationNotification**](../Models/AppTerminationNotification.md)| Termination notification details |



### Return type



null (empty response body)



### Authorization



No authorization required



### HTTP request headers



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

- **Accept**: Not defined



<a name="subByIdDELETE"></a>

# **subByIdDELETE**

> subByIdDELETE(subscriptionId)



cancel the existing individual subscription



    cancel the existing individual subscription



### Parameters



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]



### Return type



null (empty response body)



### Authorization



No authorization required



### HTTP request headers



- **Content-Type**: Not defined

- **Accept**: application/json



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

# **subByIdGET**

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



Retrieve information about this subscription.



    Retrieve information about this subscription.



### Parameters



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]



### Return type



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



### Authorization



No authorization required



### HTTP request headers



- **Content-Type**: Not defined

- **Accept**: application/json



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

# **subByIdPUT**

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



update the existing individual subscription.



    update the existing individual subscription.



### Parameters



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



### Return type



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



### Authorization



No authorization required



### HTTP request headers



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

- **Accept**: application/json



<a name="subGET"></a>

# **subGET**

> SubscriptionLinkList subGET(subscriptionType)



Retrieve information about the subscriptions for this requestor.



    Retrieve information about the subscriptions for this requestor.



### Parameters



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]



### Return type



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



### Authorization



No authorization required



### HTTP request headers



- **Content-Type**: Not defined

- **Accept**: application/json



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

# **subPOST**

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



Create a new subscription to Application Mobility Service notifications.



    Create a new subscription to Application Mobility Service notifications.



### Parameters



Name | Type | Description  | Notes

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

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



### Return type



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



### Authorization



No authorization required



### HTTP request headers



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

- **Accept**: application/json

docs/api-ams/Apis/UnsupportedApi.md

0 → 100644
+68 −0
Original line number Diff line number Diff line 
# UnsupportedApi



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



Method | HTTP request | Description

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

[**adjAppInstGET**](UnsupportedApi.md#adjAppInstGET) | **GET** /queries/adjacent_app_instances | Retrieve information about this subscription.

[**appMobilityServiceDerPOST**](UnsupportedApi.md#appMobilityServiceDerPOST) | **POST** /app_mobility_services/{appMobilityServiceId}/deregister_task |  deregister the individual application mobility service





<a name="adjAppInstGET"></a>

# **adjAppInstGET**

> List adjAppInstGET(filter, all\_fields, fields, exclude\_fields, exclude\_default)



Retrieve information about this subscription.



    Retrieve information about this subscription.



### Parameters



Name | Type | Description  | Notes

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

 **filter** | **String**| Attribute-based filtering parameters according to ETSI GS MEC 011 | [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]

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



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



### Authorization



No authorization required



### HTTP request headers



- **Content-Type**: Not defined

- **Accept**: application/json



<a name="appMobilityServiceDerPOST"></a>

# **appMobilityServiceDerPOST**

> appMobilityServiceDerPOST(appMobilityServiceId)



 deregister the individual application mobility service



     deregister the individual application mobility service



### Parameters



Name | Type | Description  | Notes

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

 **appMobilityServiceId** | **String**| It uniquely identifies the created individual application mobility service | [default to null]



### Return type



null (empty response body)



### Authorization



No authorization required



### HTTP request headers



- **Content-Type**: Not defined

- **Accept**: application/json