Commit af50cd39 authored by Yann Garcia's avatar Yann Garcia
Browse files

Update docs/api-app-support

parent 69de4cc5
Loading
Loading
Loading
Loading
+349 −231
Original line number Diff line number Diff line
# MecAppSupportApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**applicationsConfirmReadyPOST**](MecAppSupportApi.md#applicationsConfirmReadyPOST) | **POST** /applications/{appInstanceId}/confirm_ready | 
[**applicationsConfirmTerminationPOST**](MecAppSupportApi.md#applicationsConfirmTerminationPOST) | **POST** /applications/{appInstanceId}/confirm_termination | 
[**ApplicationsRegistrationDELETE**](MecAppSupportApi.md#ApplicationsRegistrationDELETE) | **Delete** /registrations/{appInstanceId} |
[**ApplicationsRegistrationGET**](MecAppSupportApi.md#ApplicationsRegistrationGET) | **Get** /registrations/{appInstanceId} |
[**ApplicationsRegistrationPUT**](MecAppSupportApi.md#ApplicationsRegistrationPUT) | **Put** /registrations/{appInstanceId} |
[**ApplicationsRegistrationsPOST**](MecAppSupportApi.md#ApplicationsRegistrationsPOST) | **Post** /registrations |
[**applicationsSubscriptionDELETE**](MecAppSupportApi.md#applicationsSubscriptionDELETE) | **DELETE** /applications/{appInstanceId}/subscriptions/{subscriptionId} | 
[**applicationsSubscriptionGET**](MecAppSupportApi.md#applicationsSubscriptionGET) | **GET** /applications/{appInstanceId}/subscriptions/{subscriptionId} | 
[**applicationsSubscriptionsGET**](MecAppSupportApi.md#applicationsSubscriptionsGET) | **GET** /applications/{appInstanceId}/subscriptions | 
@@ -70,6 +74,120 @@ No authorization required
- **Content-Type**: application/json
- **Accept**: application/problem+json, text/plain

<a name="applicationsRegistrationDELETE"></a>
# **applicationsRegistrationDELETE**
> applicationsRegistrationDELETE(ctx, appInstanceId)



    This method may be used by the MEC application instance to notify the MEC platform that it is up and running. 

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
 **appInstanceId** | **String**| Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager. | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/problem+json, text/plain

<a name="applicationsRegistrationGET"></a>
# **applicationsRegistrationGET**
> AppInfo applicationsRegistrationGET(ctx, appInstanceId)



    The GET method may be used by the MEC application instance to retrieve information about the existing MEC application instance registration to the MEC platform.

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
 **appInstanceId** | **String**| Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager. | 

### Return type

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

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json, application/problem+json, text/plain

<a name="applicationsRegistrationPUT"></a>
# **applicationsRegistrationPUT**
> AppInfo applicationsRegistrationPUT(ctx, body, appInstanceId)



    The PUT method may be used by the MEC application instance to update its registration to the MEC platform.

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
 **body** | [**AppInfo**](../Models/AppInfo.md)| Message content in the request contains the profile of the application, calling the MEC platform to update the existing MEC application instance registration. | 
 **appInstanceId** | **String**| Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager. | 

### Return type

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

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/problem+json, text/plain

<a name="applicationsRegistrationsPOST"></a>
# **applicationsRegistrationsPOST**
> AppInfo applicationsRegistrationsPOST(ctx, body)



   The POST method may be used by the MEC application instance to request its registration to the MEC platform.

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
  **body** | [**AppInfo**](../Models/AppInfo.md)| Entity body in the request contains BwInfo to be created. | 

### Return type

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

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json, application/problem+json, text/plain


<a name="applicationsSubscriptionDELETE"></a>
# **applicationsSubscriptionDELETE**
> applicationsSubscriptionDELETE(appInstanceId, subscriptionId)
@@ -96,7 +214,7 @@ No authorization required
### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/problem+json, text/plain, 
- **Accept**: application/problem+json, text/plain

<a name="applicationsSubscriptionGET"></a>
# **applicationsSubscriptionGET**
+20 −0
Original line number Diff line number Diff line
# AppInfo

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AppName** | **string** | Name of the application. It shall be consistent with the appName in the AppD, if an AppD is available. | [default to null]
**AppProvider** | **string** | Provider of the application. It shall be consistent with the appProvider in the AppD, if an AppD is available. See note 1. | [optional] [default to null]
**AppCategory** | [***CategoryRef**](CategoryRef.md) |  | [optional] [default to null]
**AppDId** | **string** | The application descriptor identifier. It is managed by the application provider to identify the application descriptor in a globally unique way. Shall be present if the application instance is instantiated by the MEC Management. | [optional] [default to null]
**AppInstanceId** | **string** | Identifier of the application instance. Shall be present if the application instance is instantiated by the MEC Management. | [optional] [default to null]
**Endpoint** | [***OneOfAppInfoEndpoint**](OneOfAppInfoEndpoint.md) | This type represents information about a transport endpoint | [optional] [default to null]
**AppServiceRequired** | [**[]ServiceDependency**](ServiceDependency.md) | Describes services a MEC application requires to run. ServiceDependency is defined in ETSI GS MEC 010-2 [4]. It shall not be provided if an AppD is available. | [optional] [default to null]
**AppServiceOptional** | [**[]ServiceDependency**](ServiceDependency.md) | Describes services a MEC application may use if available. ServiceDependency is defined in ETSI GS MEC 010-2 [4]. It shall not be provided if an AppD is available. | [optional] [default to null]
**AppFeatureRequired** | [**[]FeatureDependency**](FeatureDependency.md) | Describes features a MEC application requires to run. FeatureDependency is defined in ETSI GS MEC 010-2 [4]. It shall not be provided if an AppD is available. | [optional] [default to null]
**AppFeatureOptional** | [**[]FeatureDependency**](FeatureDependency.md) | Describes features a MEC application may use if available. FeatureDependency is defined in ETSI GS MEC 010-2 [4]. It shall not be provided if an AppD is available. | [optional] [default to null]
**IsInsByMec** | **bool** | Indicate whether the application instance is instantiated by the MEC Management. Default to FALSE if absent. | [optional] [default to null]
**AppProfile** | [***AppProfile**](AppProfile.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)
+22 −0
Original line number Diff line number Diff line
# AppProfile

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**EasId** | **string** | The identifier of the EAS | [default to null]
**EndPt** | [***OneOfAppProfileEndPt**](OneOfAppProfileEndPt.md) | The version of the feature. | [default to null]
**AcIds** | **[]string** | Identities of the Application Clients that can be served by the EAS | [default to null]
**ProvId** | **string** | Identifier of the ASP that provides the EAS. | [optional] [default to null]
**Type_** | **string** | The category or type of EAS. | [optional] [default to null]
**Scheds** | **[]string** | The availability schedule of the EAS. | [default to null]
**SvcArea** | **string** | The list of geographical and topological areas that the EAS serves. ACs in the UE that are outside the area will not be served. | [optional] [default to null]
**SvcKpi** | **string** | Service characteristics provided by the EAS. | [optional] [default to null]
**PermLvl** | **[]string** | level of service permissions supported by the EAS. | [default to null]
**EasFeats** | **[]string** | Service features supported by the EAS. | [default to null]
**SvcContSupp** | **[]string** | The ACR scenarios supported by the EAS for service continuity. | [default to null]
**AppLocs** | **[]string** | List of DNAI(s) and the N6 traffic information associated with the EAS. | [default to null]
**AvlRep** | **int32** | The period indicating to the EES, how often the EES needs to check the EAS&#x27;s availability after a successful registration. | [optional] [default to null]
**Status** | **string** | EAS status information.  | [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)
+12 −0
Original line number Diff line number Diff line
# CategoryRef

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Href** | **string** | Reference of the catalogue | [default to null]
**Id** | **string** | Unique identifier of the category | [default to null]
**Name** | **string** | Name of the category, example values include RNI, Location &amp; Bandwidth Management | [default to null]
**Version** | **string** | Category version | [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)
+10 −0
Original line number Diff line number Diff line
# EndPointInfoAddress

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Host** | **string** | Host portion of the address | [default to null]
**Port** | **int32** | Port portion of the address | [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