Commit 69ac0fe3 authored by Yann Garcia's avatar Yann Garcia
Browse files

Add meep-sandbox-api docs

parent b51c6d7b
Loading
Loading
Loading
Loading
+65 −0
Original line number Diff line number Diff line
# {{classname}}

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**
> Sandbox Login(ctx, provider)
Initiate OAuth login procedure and creates MEC Sandbox

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

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
  **provider** | **string**| Oauth provider | 

### Return type

[**Sandbox**](Sandbox.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)

# **Logout**
> Logout(ctx, sandboxName)
Terminates User Session and User Sandbox

Terminates User Session and User Sandbox

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
  **sandboxName** | **string**| Sandbox 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)
+11 −0
Original line number Diff line number Diff line
# CellularDomainConfig

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Mnc** | **string** | Mobile Network Code part of PLMN identity as defined in ETSI TS 136 413 | [optional] [default to null]
**Mcc** | **string** | Mobile Country Code part of PLMN identity as defined in ETSI TS 136 413 | [optional] [default to null]
**DefaultCellId** | **string** | The E-UTRAN Cell Identity as defined in ETSI TS 136 413 if no cellId is defined for the cell or if not applicable | [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)
+9 −0
Original line number Diff line number Diff line
# CellularPoaConfig

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**CellId** | **string** | The E-UTRAN Cell Identity as defined in ETSI TS 136 413 including the ID of the eNB serving the cell | [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)
+9 −0
Original line number Diff line number Diff line
# ConnectivityConfig

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Model** | **string** | Connectivity Model: <li>OPEN: Any node in the scenario can communicate with any node <li>PDU: Terminal nodes (UE) require a PDU session to the target DN | [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)
+10 −0
Original line number Diff line number Diff line
# CpuConfig

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Min** | **float32** | Minimum requested CPU | [optional] [default to null]
**Max** | **float32** | Maximum requested CPU | [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)
Loading