Infrastructure Provider API (Node/Express)¶
Overview¶
Version information¶
Version : 1.0.0
License information¶
License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
URI scheme¶
Host : 127.0.0.1:3000
BasePath : /api/v1
Tags¶
- InfrastructureProvider
Paths¶
Get all Infrastructure Provider¶
1 | POST /api/v1/infracloud
|
Description¶
Add new Infrastrcture provider
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Body | inp required |
The InP provider definition | inp |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | The InP has been successfully updated. | Message |
Consumes¶
application/json
Tags¶
- InfrastructureProvider
Get all Infrastructure Provider¶
1 | GET /api/v1/infracloud
|
Description¶
Get all Infrastructure Provider
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | A list of Infrastructure Provider | provider |
Produces¶
application/json
Tags¶
- InfrastructureProvider
Get all ressource of a specific Infrastructure Provider¶
1 | GET /api/v1/infracloud/{id}
|
Description¶
Get all ressource of a specific Infrastructure Provider
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | id required |
id of infrastruture provider | integer |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | A list of ressource | < inp > array |
Produces¶
application/json
Tags¶
- InfrastructureProvider
Update a infrastructure Provide¶
1 | PUT /api/v1/infracloud/{id}
|
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | id required |
The id of the InP you want to update. | number | |
| Body | inp required |
The InP you want update with. | inp |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | The InP has been successfully updated. | Message |
Consumes¶
application/json
Produces¶
application/json
Tags¶
- InfrastructureProvider
Delete a infrastructure Provider¶
1 | DELETE /api/v1/infracloud/{id}
|
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | id required |
The id of the InP you want to update. | number |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | The InP has been successfully updated. | Message |
Consumes¶
application/json
Produces¶
application/json
Tags¶
- InfrastructureProvider
add new ressource of specific Infrastruture Provider¶
1 | POST /api/v1/infracloud/{id}/resource/
|
Description¶
add new ressource of specific Infrastruture Provider
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | id required |
id of infrastruture provider | integer | |
| Path | ressource required |
id of infrastruture provider | < resource > array |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Return message | Message |
Consumes¶
application/json
Produces¶
application/json
Tags¶
- InfrastructureProvider
get all ressource of specific Infrastruture Provider¶
1 | GET /api/v1/infracloud/{id}/resource/
|
Description¶
get all ressource of specific Infrastruture Provider
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | id required |
id of infrastruture provider | integer |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Return a specific ressources Node | No Content |
Produces¶
application/json
Tags¶
- InfrastructureProvider
get a specific ressource of a specific Infrastructure Provider¶
1 | GET /api/v1/infracloud/{id}/resource/{id_ressource}
|
Description¶
get a specific ressource by ID
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | id required |
id of infrastruture provider | integer | |
| Path | id_ressource required |
id of of provider ressource | integer |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Return a specific ressources Node | resource |
Produces¶
application/json
Tags¶
- InfrastructureProvider
update a specific ressource of a specific Infrastructure Provider¶
1 | PUT /api/v1/infracloud/{id}/resource/{id_ressource}
|
Description¶
update a specific ressource by ID
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | id required |
id of infrastruture provider | integer | |
| Path | id_ressource required |
id of of provider ressource | integer | |
| Body | ressource required |
id of of provider ressource | resource |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Return a specific ressources Node | Message |
Produces¶
application/json
Tags¶
- InfrastructureProvider
delete a specific ressource of a specific Infrastructure Provider¶
1 | DELETE /api/v1/infracloud/{id}/resource/{id_ressource}
|
Description¶
delete a specific ressource by ID
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | id required |
id of infrastruture provider | integer | |
| Path | id_ressource required |
id of of provider ressource | integer |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Return a specific ressources Node | Message |
Produces¶
application/json
Tags¶
- InfrastructureProvider
Get characteristics of a specific resource¶
1 | GET /api/v1/infracloud/{id}/ressource/{id_ressource}/shared
|
Description¶
Get characteristics of a specific resource
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | id required |
id of infrastruture provider | integer | |
| Path | id_ressource required |
id of infrastruture provider | integer |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Return a specific ressources Node | virtualenv |
Produces¶
application/json
Tags¶
- InfrastructureProvider
Get characteristics of a specific resource¶
1 | PUT /api/v1/infracloud/{id}/ressource/{id_ressource}/shared
|
Description¶
Get characteristics of a specific resource
Parameters¶
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | id required |
id of infrastruture provider | integer | |
| Path | id_ressource required |
id of infrastruture provider | integer | |
| Body | shared_env required |
id of infrastruture provider | virtualenv |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Return a specific ressources Node | Message |
Produces¶
application/json
Tags¶
- InfrastructureProvider
Definitions¶
VirtualEnvStatus¶
Type : enum (start, stop, error)
VirtualEnvType¶
Type : enum (VM, container, sandbox)
access_network_support¶
| Name | Description | Schema |
|---|---|---|
| cellular optional |
cellular | |
| ethernet optional |
string | |
| wlan optional |
wlan |
cellular¶
| Name | Description | Schema |
|---|---|---|
| _2G optional |
string | |
| _3G optional |
string | |
| _4G optional |
string | |
| _5G optional |
string |
frequency_band¶
| Name | Description | Schema |
|---|---|---|
| _24Ghz optional |
string | |
| _5Ghz optional |
string |
inp¶
| Name | Description | Schema |
|---|---|---|
| description optional |
string | |
| email optional |
string | |
| id optional |
integer | |
| login optional |
string | |
| name optional |
string | |
| nwType optional |
networkType | |
| password optional |
string |
interface_mode¶
| Name | Description | Schema |
|---|---|---|
| IBSS optional |
string | |
| managed optional |
string | |
| monitor optional |
string |
isolation_support¶
| Name | Description | Schema |
|---|---|---|
| container optional |
string | |
| sandbox optional |
string | |
| virtualmachine optional |
string |
networkType¶
Type : enum (Enterprise, Hotspot Operator, Device)
nw_iface¶
| Name | Description | Schema |
|---|---|---|
| id optional |
integer | |
| mac optional |
string | |
| name optional |
string | |
| status optional |
string | |
| type optional |
string |
provider¶
| Name | Description | Schema |
|---|---|---|
| description optional |
string | |
| email optional |
string | |
| id optional |
integer | |
| name optional |
string | |
| nwType optional |
networkType | |
| resource optional |
< resource > array |
resource¶
| Name | Description | Schema |
|---|---|---|
| access_network_support optional |
access_network_support | |
| containers optional |
virtualenv | |
| cpu_shared optional |
string | |
| cpu_type optional |
string | |
| description optional |
string | |
| host_manager optional |
string | |
| id optional |
integer | |
| isolation_support optional |
isolation_support | |
| max_storage optional |
string | |
| name optional |
string | |
| networkinterfaces optional |
< nw_iface > array | |
| nw_shared optional |
string | |
| shared_env optional |
string | |
| ssid optional |
string | |
| storage_shared optional |
string | |
| type optional |
ressourceType | |
| uri_manager optional |
string |
ressourceType¶
Type : enum (AP, Device, MEC server)
virtualenv¶
| Name | Description | Schema |
|---|---|---|
| id optional |
integer | |
| name optional |
string | |
| status optional |
VirtualEnvStatus | |
| type optional |
VirtualEnvType | |
| uri optional |
string |
wlan¶
| Name | Description | Schema |
|---|---|---|
| frequency_band optional |
frequency_band | |
| interface_mode optional |
interface_mode | |
| virtual_vif_support optional |
string |