Commit 21545b15 authored by Yann Garcia's avatar Yann Garcia
Browse files

Merging InterDigital AdvantEDGE 'develop' branch into ETSI 'STF625_TASK4'... 

Merging InterDigital AdvantEDGE 'develop' branch into ETSI 'STF625_TASK4' branch - Second round: Adding MEC016
parent bec5eccd

.meepctl-repocfg.yaml

+5 −5
Original line number Diff line number Diff line
@@ -38,7 +38,7 @@ repo: 
    # platform ingress configuration

    ingress:

      # host name

      host: my-platform-fqdn

      host: mec-platform.etsi.org

      # enable https only (redirect http requests to https port)

      https-only: false

      # bind to host ports (true) or node ports (false)
@@ -48,9 +48,9 @@ repo: 
      # https config

      https-port: 443

      # certificate authority (none|self-signed|lets-encrypt) default: none

      ca: self-signed

      ca: lets-encrypt

      # lets-encrypt production server (true) or staging server (false)

      le-server-prod: false

      le-server-prod: true



    # authentication & authorization config

    auth:
@@ -73,7 +73,7 @@ repo: 
        # access token url

        token-url: https://github.com/login/oauth/access_token

        # OAuth redirect URI

        redirect-uri: https://my-platform-fqdn/auth/v1/authorize

        redirect-uri: https://mec-platform.etsi.org/auth/v1/authorize

        # OAuth k8s secret (data: client-id, secret)

        secret: meep-oauth-github

      # GitLab OAuth provider config
@@ -85,7 +85,7 @@ repo: 
        # access token url

        token-url: https://gitlab.com/oauth/token

        # OAuth redirect URI

        redirect-uri: https://my-platform-fqdn/auth/v1/authorize

        redirect-uri: https://mec-platform.etsi.org/auth/v1/authorize

        # GitLab api url

        # api-url: https://gitlab.com

        # OAuth k8s secret (data: client-id, secret)

docs/api-dai/Apis/AppTermApi.md

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

# {{classname}}



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



Method | HTTP request | Description

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

[**mec011AppTerminationPOST**](AppTermApi.md#mec011AppTerminationPOST) | **POST** /subscriptions/{subscriptionId} | MEC011 Application Termination notification for self termination





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

# **mec011AppTerminationPOST**

> mec011AppTerminationPOST(subscriptionId, AppTerminationNotification)

[**Mec011AppTerminationPOST**](AppTermApi.md#Mec011AppTerminationPOST) | **Post** /subscriptions/{subscriptionId} | MEC011 Application Termination notification for self termination



# **Mec011AppTerminationPOST**

> Mec011AppTerminationPOST(ctx, body, subscriptionId)

MEC011 Application Termination notification for self termination



Terminates itself.



### Parameters

### Required Parameters



Name | Type | Description  | Notes

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

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

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

  **subscriptionId** | **string**| Refers to created subscription, where the VIS API allocates a unique resource name for this subscription | 



### Return type



null (empty response body)

 (empty response body)



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

 - **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-dai/Apis/DevAppApi.md

+69 −59
Original line number Diff line number Diff line 
# DevAppApi

# {{classname}}



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



Method | HTTP request | Description

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

[**appLocationAvailabilityPOST**](DevAppApi.md#appLocationAvailabilityPOST) | **POST** /obtain_app_loc_availability | Obtain the location constraints for a new application context.

[**devAppContextDELETE**](DevAppApi.md#devAppContextDELETE) | **DELETE** /app_contexts/{contextId} | Deletion of an existing application context.

[**devAppContextPUT**](DevAppApi.md#devAppContextPUT) | **PUT** /app_contexts/{contextId} | Updating the callbackReference and/or appLocation of an existing application context.

[**devAppContextsPOST**](DevAppApi.md#devAppContextsPOST) | **POST** /app_contexts | Creation of a new application context.

[**meAppListGET**](DevAppApi.md#meAppListGET) | **GET** /app_list | Get available application information.





<a name="appLocationAvailabilityPOST"></a>

# **appLocationAvailabilityPOST**

> ApplicationLocationAvailability appLocationAvailabilityPOST(ApplicationLocationAvailability)



[**AppLocationAvailabilityPOST**](DevAppApi.md#AppLocationAvailabilityPOST) | **Post** /obtain_app_loc_availability | Obtain the location constraints for a new application context.

[**DevAppContextDELETE**](DevAppApi.md#DevAppContextDELETE) | **Delete** /app_contexts/{contextId} | Deletion of an existing application context.

[**DevAppContextPUT**](DevAppApi.md#DevAppContextPUT) | **Put** /app_contexts/{contextId} | Updating the callbackReference and/or appLocation of an existing application context.

[**DevAppContextsPOST**](DevAppApi.md#DevAppContextsPOST) | **Post** /app_contexts | Creation of a new application context.

[**MeAppListGET**](DevAppApi.md#MeAppListGET) | **Get** /app_list | Get available application information.



# **AppLocationAvailabilityPOST**

> ApplicationLocationAvailability AppLocationAvailabilityPOST(ctx, body)

Obtain the location constraints for a new application context.



Used to obtain the locations available for instantiation of a specific user application in the MEC system.



### Parameters

### Required Parameters



Name | Type | Description  | Notes

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

 **ApplicationLocationAvailability** | [**ApplicationLocationAvailability**](../Models/ApplicationLocationAvailability.md)| Entity body in the request contains the user application information for the MEC system to evaluate the locations available for instantiation of that application. |

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

  **body** | [**ApplicationLocationAvailability**](ApplicationLocationAvailability.md)| Entity body in the request contains the user application information for the MEC system to evaluate the locations available for instantiation of that application. | 



### Return type



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

[**ApplicationLocationAvailability**](ApplicationLocationAvailability.md)



### Authorization
@@ -38,23 +36,24 @@ No authorization required 
 - **Content-Type**: application/json

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



<a name="devAppContextDELETE"></a>

# **devAppContextDELETE**

> devAppContextDELETE(contextId)

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



# **DevAppContextDELETE**

> DevAppContextDELETE(ctx, contextId)

Deletion of an existing application context.



Used to delete the resource that represents the existing application context.



### Parameters

### Required Parameters



Name | Type | Description  | Notes

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

 **contextId** | **String**| Uniquely identifies the application context in the MEC system. It is assigned by the MEC system. | [default to null]

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

  **contextId** | **string**| Uniquely identifies the application context in the MEC system. It is assigned by the MEC system. | 



### Return type



null (empty response body)

 (empty response body)



### Authorization
@@ -65,24 +64,25 @@ No authorization required 
 - **Content-Type**: Not defined

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



<a name="devAppContextPUT"></a>

# **devAppContextPUT**

> devAppContextPUT(contextId, AppContext)

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



# **DevAppContextPUT**

> DevAppContextPUT(ctx, body, contextId)

Updating the callbackReference and/or appLocation of an existing application context.



Used to update the callback reference and/or application location constraints of an existing application context. Upon successful operation, the target resource is updated with the new application context information.



### Parameters

### Required Parameters



Name | Type | Description  | Notes

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

 **contextId** | **String**| Uniquely identifies the application context in the MEC system. It is assigned by the MEC system. | [default to null]

 **AppContext** | [**AppContext**](../Models/AppContext.md)| Only the callbackReference and/or appLocation attribute values are allowed to be updated. Other attributes and their values shall remain untouched. |

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

  **body** | [**AppContext**](AppContext.md)| Only the callbackReference and/or appLocation attribute values are allowed to be updated. Other attributes and their values shall remain untouched. | 

  **contextId** | **string**| Uniquely identifies the application context in the MEC system. It is assigned by the MEC system. | 



### Return type



null (empty response body)

 (empty response body)



### Authorization
@@ -93,23 +93,24 @@ No authorization required 
 - **Content-Type**: application/json

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



<a name="devAppContextsPOST"></a>

# **devAppContextsPOST**

> AppContext devAppContextsPOST(AppContext)

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



# **DevAppContextsPOST**

> AppContext DevAppContextsPOST(ctx, body)

Creation of a new application context.



Used to create a new application context. Upon success, the response contains entity body describing the created application context.



### Parameters

### Required Parameters



Name | Type | Description  | Notes

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

 **AppContext** | [**AppContext**](../Models/AppContext.md)| Entity body in the request contains the Application Context as requested by the device application. |

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

  **body** | [**AppContext**](AppContext.md)| Entity body in the request contains the Application Context as requested by the device application. | 



### Return type



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

[**AppContext**](AppContext.md)



### Authorization
@@ -120,27 +121,34 @@ No authorization required 
 - **Content-Type**: application/json

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



<a name="meAppListGET"></a>

# **meAppListGET**

> ApplicationList meAppListGET(appName, appProvider, appSoftVersion, vendorId, serviceCont)

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



# **MeAppListGET**

> ApplicationList MeAppListGET(ctx, optional)

Get available application information.



Used to query information about the available MEC applications.



### Parameters

### Required Parameters



Name | Type | Description  | Notes

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

 **appName** | [**List**](../Models/String.md)| Name to identify the MEC application. | [optional] [default to null]

 **appProvider** | [**List**](../Models/String.md)| Provider of the MEC application. | [optional] [default to null]

 **appSoftVersion** | [**List**](../Models/String.md)| Software version of the MEC application. | [optional] [default to null]

 **vendorId** | [**List**](../Models/String.md)| Vendor identifier | [optional] [default to null]

 **serviceCont** | **Integer**| Required service continuity mode for this application. Permitted values: 0 &#x3D; SERVICE_CONTINUITY_NOT_REQUIRED. 1 &#x3D; SERVICE_CONTINUITY_REQUIRED. | [optional] [default to null] [enum: 0, 1]

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

 **optional** | ***DevAppApiMeAppListGETOpts** | optional parameters | nil if no parameters



### Optional Parameters

Optional parameters are passed through a pointer to a DevAppApiMeAppListGETOpts struct

Name | Type | Description  | Notes

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

 **appName** | [**optional.Interface of []string**](string.md)| Name to identify the MEC application. | 

 **appProvider** | [**optional.Interface of []string**](string.md)| Provider of the MEC application. | 

 **appSoftVersion** | [**optional.Interface of []string**](string.md)| Software version of the MEC application. | 

 **vendorId** | [**optional.Interface of []string**](string.md)| Vendor identifier | 

 **serviceCont** | **optional.Int32**| Required service continuity mode for this application. Permitted values: 0 &#x3D; SERVICE_CONTINUITY_NOT_REQUIRED. 1 &#x3D; SERVICE_CONTINUITY_REQUIRED. | 



### Return type



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

[**ApplicationList**](ApplicationList.md)



### Authorization
@@ -151,3 +159,5 @@ No authorization required 
 - **Content-Type**: Not defined

 - **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-dai/Apis/UnsupportedApi.md

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

# {{classname}}



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



Method | HTTP request | Description

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

[**individualSubscriptionDELETE**](UnsupportedApi.md#individualSubscriptionDELETE) | **DELETE** /subscriptions/{subscriptionId} | Used to cancel the existing subscription.





<a name="individualSubscriptionDELETE"></a>

# **individualSubscriptionDELETE**

> individualSubscriptionDELETE(subscriptionId)

[**IndividualSubscriptionDELETE**](UnsupportedApi.md#IndividualSubscriptionDELETE) | **Delete** /subscriptions/{subscriptionId} | Used to cancel the existing subscription.



# **IndividualSubscriptionDELETE**

> IndividualSubscriptionDELETE(ctx, subscriptionId)

Used to cancel the existing subscription.



Used to cancel the existing subscription.



### Parameters

### Required Parameters



Name | Type | Description  | Notes

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

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

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

  **subscriptionId** | **string**| Refers to created subscription, where the VIS API allocates a unique resource name for this subscription | 



### Return type



null (empty response body)

 (empty response body)



### Authorization
@@ -34,3 +32,5 @@ No authorization required 
 - **Content-Type**: Not defined

 - **Accept**: application/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-dai/Models/AddressChangeNotification.md

+5 −5
Original line number Diff line number Diff line 
# AddressChangeNotification

## Properties



## Properties

Name | Type | Description | Notes

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

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

**contextId** | [**String**](string.md) | Uniquely identifies the application context in the MEC system. | [default to null]

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

**referenceURI** | [**URI**](URI.md) | Address of the user application. Used as the reference URI for the application. Assigned by the MEC system. | [default to null]

**AppInstanceId** | **string** | Identifier of the user application instance. | [default to null]

**ContextId** | **string** | Uniquely identifies the application context in the MEC system. | [default to null]

**NotificationType** | **string** | Shall be set to \&quot;AddressChangeNotification\&quot;. | [default to null]

**ReferenceURI** | **string** | Address of the user application. Used as the reference URI for the application. Assigned by the MEC system. | [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)