Commit 081a9382 authored by Yann Garcia's avatar Yann Garcia
Browse files

Update docs folder

parent 30440d36

docs/meep-sandbox-api/ApplicationInfo.md

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



## Properties

Name | Type | Description | Notes

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

**Id** | **string** | Application Instance UUID | [optional] [default to null]

**Name** | **string** | Application name | [default to null]

**NodeName** | **string** | Name of node where application instance is running | [default to null]

**Type_** | **string** | Application Type | [optional] [default to null]

**Persist** | **bool** | Reserved for internal platform usage | [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/meep-sandbox-api/AuthorizationApi.md

+6 −6
Original line number Diff line number Diff line
@@ -4,14 +4,14 @@ All URIs are relative to *http://localhost/sandbox-api/v1* 


Method | HTTP request | Description

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

[**Login**](AuthorizationApi.md#Login) | **Post** /login | Initiate OAuth login procedure and creates MEC Sandbox

[**Logout**](AuthorizationApi.md#Logout) | **Post** /logout | Terminates User Session and User Sandbox

[**Login**](AuthorizationApi.md#Login) | **Post** /login | Initiate OAuth login procedure and creates a MEC Sandbox instance

[**Logout**](AuthorizationApi.md#Logout) | **Post** /logout | Terminates User Session and delete the Sandbox instance



# **Login**

> Sandbox Login(ctx, provider)

Initiate OAuth login procedure and creates MEC Sandbox

Initiate OAuth login procedure and creates a MEC Sandbox instance



Redirect the browser to the provider login page and creates your MEC Sandbox on successful login and authorization

Initiate OAuth login procedure and creates a MEC Sandbox instance



### Required Parameters
@@ -37,9 +37,9 @@ No authorization required 


# **Logout**

> Logout(ctx, sandboxName)

Terminates User Session and User Sandbox

Terminates User Session and delete the Sandbox instance



Terminates User Session and User Sandbox

Terminates User Session and delete the Sandbox instance



### Required Parameters

docs/meep-sandbox-api/SandboxAppInstancesApi.md

+69 −5
Original line number Diff line number Diff line
@@ -4,16 +4,51 @@ All URIs are relative to *http://localhost/sandbox-api/v1* 


Method | HTTP request | Description

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

[**SandboxAppInstancesGET**](SandboxAppInstancesApi.md#SandboxAppInstancesGET) | **Get** /sandboxAppInstances | get the list of the available application instance identifier

[**SandboxAppInstancesDELETE**](SandboxAppInstancesApi.md#SandboxAppInstancesDELETE) | **Delete** /sandboxAppInstances/{sandbox_name}/{app_instance_id} | Delete an existing application instance

[**SandboxAppInstancesGET**](SandboxAppInstancesApi.md#SandboxAppInstancesGET) | **Get** /sandboxAppInstances/{sandbox_name} | Get the list of the available application instance identifiers

[**SandboxAppInstancesPOST**](SandboxAppInstancesApi.md#SandboxAppInstancesPOST) | **Post** /sandboxAppInstances/{sandbox_name} | Create a new application instance identifier



# **SandboxAppInstancesDELETE**

> SandboxAppInstancesDELETE(ctx, sandboxName, appInstanceId)

Delete an existing application instance



This method removes an existing application instance



### Required Parameters



Name | Type | Description  | Notes

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

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

  **sandboxName** | **string**| Sandbox identifier | 

  **appInstanceId** | **string**| It uniquely identifies a MEC application instance identifier | 



### Return type



 (empty response body)



### Authorization



No authorization required



### HTTP request headers



 - **Content-Type**: Not defined

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



# **SandboxAppInstancesGET**

> []SandboxAppInstances SandboxAppInstancesGET(ctx, )

get the list of the available application instance identifier

> []SandboxAppInstances SandboxAppInstancesGET(ctx, sandboxName)

Get the list of the available application instance identifiers



This method retrieves the list of the available application instance identifier.

This method retrieves the list of the available application instance identifiers



### Required Parameters

This endpoint does not need any parameter.



Name | Type | Description  | Notes

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

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

  **sandboxName** | **string**| Sandbox identifier | 



### Return type
@@ -30,3 +65,32 @@ No authorization required 


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



# **SandboxAppInstancesPOST**

> []ApplicationInfo SandboxAppInstancesPOST(ctx, body, sandboxName)

Create a new application instance identifier



This method creates a new application instance



### Required Parameters



Name | Type | Description  | Notes

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

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

  **body** | [**ApplicationInfo**](ApplicationInfo.md)| Pet to add to the store | 

  **sandboxName** | **string**| Sandbox identifier | 



### Return type



[**[]ApplicationInfo**](ApplicationInfo.md)



### Authorization



No authorization required



### HTTP request headers



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

 - **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/meep-sandbox-api/SandboxLogsSubscriptionsApi.md

+10 −5
Original line number Diff line number Diff line
@@ -4,11 +4,11 @@ All URIs are relative to *http://localhost/sandbox-api/v1* 


Method | HTTP request | Description

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

[**SandboxLogsSubscriptionsDELETE**](SandboxLogsSubscriptionsApi.md#SandboxLogsSubscriptionsDELETE) | **Delete** /sandboxLogsSubscriptions/{subscription_reference} | Subscription to receive logs from the sandbox

[**SandboxLogsSubscriptionsPOST**](SandboxLogsSubscriptionsApi.md#SandboxLogsSubscriptionsPOST) | **Post** /sandboxLogsSubscriptions | Subscription to receive logs from the sandbox

[**SandboxLogsSubscriptionsDELETE**](SandboxLogsSubscriptionsApi.md#SandboxLogsSubscriptionsDELETE) | **Delete** /sandboxLogsSubscriptions/{sandbox_name}/{subscription_reference} | Subscription to receive logs from the sandbox

[**SandboxLogsSubscriptionsPOST**](SandboxLogsSubscriptionsApi.md#SandboxLogsSubscriptionsPOST) | **Post** /sandboxLogsSubscriptions/{sandbox_name} | Subscription to receive logs from the sandbox



# **SandboxLogsSubscriptionsDELETE**

> SandboxLogsSubscriptionsDELETE(ctx, subscriptionReference)

> SandboxLogsSubscriptionsDELETE(ctx, sandboxName, subscriptionReference)

Subscription to receive logs from the sandbox



This method is used to receive logs from the sandbox.
@@ -18,6 +18,7 @@ This method is used to receive logs from the sandbox. 
Name | Type | Description  | Notes

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

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

  **sandboxName** | **string**| Sandbox identifier | 

  **subscriptionReference** | **string**| It uniquely identifies subscription reference to receive logs from the sandbox | 



### Return type
@@ -36,13 +37,17 @@ No authorization required 
[[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)



# **SandboxLogsSubscriptionsPOST**

> []SandboxLogsSubscriptions SandboxLogsSubscriptionsPOST(ctx, )

> []SandboxLogsSubscriptions SandboxLogsSubscriptionsPOST(ctx, sandboxName)

Subscription to receive logs from the sandbox



This method is used to receive logs from the sandbox.



### Required Parameters

This endpoint does not need any parameter.



Name | Type | Description  | Notes

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

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

  **sandboxName** | **string**| Sandbox identifier | 



### Return type

docs/meep-sandbox-api/SandboxMECServicesApi.md

+2 −32
Original line number Diff line number Diff line
@@ -4,12 +4,11 @@ All URIs are relative to *http://localhost/sandbox-api/v1* 


Method | HTTP request | Description

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

[**SandboxMecServicesGET**](SandboxMECServicesApi.md#SandboxMecServicesGET) | **Get** /sandboxMecServices | get the list of the available MEC services

[**SandboxMecServicesPOST**](SandboxMECServicesApi.md#SandboxMecServicesPOST) | **Post** /sandboxMecServices/{mec_service_name} | select the MEC services to use

[**SandboxMecServicesGET**](SandboxMECServicesApi.md#SandboxMecServicesGET) | **Get** /sandboxMecServices/{sandbox_name} | Get the list of the available MEC services



# **SandboxMecServicesGET**

> []SandboxMecServices SandboxMecServicesGET(ctx, sandboxName)

get the list of the available MEC services

Get the list of the available MEC services



This method retrieves the list of the available MEC services.
@@ -35,32 +34,3 @@ No authorization required 


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

# **SandboxMecServicesPOST**

> []SandboxMecServices SandboxMecServicesPOST(ctx, sandboxName, mecServiceName)

select the MEC services to use



This method selects the MEC service to be used.



### Required Parameters



Name | Type | Description  | Notes

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

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

  **sandboxName** | **string**| Sandbox identifier | 

  **mecServiceName** | **string**| It uniquely identifies a MEC service to use | 



### Return type



[**[]SandboxMecServices**](SandboxMecServices.md)



### Authorization



No authorization required



### HTTP request headers



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