FastAPI 0.1.0
api
DELETE /api/v2/codebox/{session_id}/{path}
Proxy
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
| OAuth2PasswordBearer | header | string | N/A | No | |
| factory-id | header | string | default | No | |
| path | path | string | No | ||
| session_id | path | string | No |
Response 200 OK
application/json
Schema of the response body
Response 422 Unprocessable Entity
application/json
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /api/v2/codebox/{session_id}/{path}
Proxy
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
| OAuth2PasswordBearer | header | string | N/A | No | |
| factory-id | header | string | default | No | |
| path | path | string | No | ||
| session_id | path | string | No |
Response 200 OK
application/json
Schema of the response body
Response 422 Unprocessable Entity
application/json
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /api/v2/codebox/{session_id}/{path}
Proxy
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
| OAuth2PasswordBearer | header | string | N/A | No | |
| factory-id | header | string | default | No | |
| path | path | string | No | ||
| session_id | path | string | No |
Response 200 OK
application/json
Schema of the response body
Response 422 Unprocessable Entity
application/json
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
PUT /api/v2/codebox/{session_id}/{path}
Proxy
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
| OAuth2PasswordBearer | header | string | N/A | No | |
| factory-id | header | string | default | No | |
| path | path | string | No | ||
| session_id | path | string | No |
Response 200 OK
application/json
Schema of the response body
Response 422 Unprocessable Entity
application/json
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
POST /api/v2/factory/
Create a new factory.
Description Create a new factory.
** Token Authentication Required **
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
| OAuth2PasswordBearer | header | string | N/A | No | |
| action | query | string | create | No |
Request body
application/json
{
"name": "string",
"image": null,
"cpu": null,
"memory": null,
"target_port": null,
"cooldown_period": null,
"network_enabled": true,
"max_sessions": null,
"ready_sessions": null,
"env_vars": null,
"custom_image": null,
"registry_server": null,
"registry_username": null,
"registry_password": null
}
This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
{
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"cpu": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cpu"
},
"memory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Memory"
},
"target_port": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Target Port"
},
"cooldown_period": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Cooldown Period"
},
"network_enabled": {
"type": "boolean",
"title": "Network Enabled",
"default": true
},
"max_sessions": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Max Sessions"
},
"ready_sessions": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Ready Sessions"
},
"env_vars": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Env Vars"
},
"custom_image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Custom Image"
},
"registry_server": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Registry Server"
},
"registry_username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Registry Username"
},
"registry_password": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Registry Password"
}
},
"type": "object",
"required": [
"name"
],
"title": "FactoryCreate"
}
Response 200 OK
application/json
Schema of the response body
{
"type": "object",
"title": "Response Create Factory Api V2 Factory Post"
}
Response 422 Unprocessable Entity
application/json
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
GET /api/v2/factory/
List all factories.
Description List all factories for the authenticated user.
** Token Authentication Required **
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
| OAuth2PasswordBearer | header | string | N/A | No |
Response 200 OK
application/json
Schema of the response body
{
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "object"
}
},
"title": "Response List Factories Api V2 Factory Get"
}
PUT /api/v2/factory/{factory_id}
Update a factory.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
| OAuth2PasswordBearer | header | string | N/A | No | |
| factory_id | path | string | No |
Request body
application/json
{
"name": "string",
"image": null,
"cpu": null,
"memory": null,
"target_port": null,
"cooldown_period": null,
"network_enabled": true,
"max_sessions": null,
"ready_sessions": null,
"env_vars": null,
"custom_image": null,
"registry_server": null,
"registry_username": null,
"registry_password": null
}
This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
{
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image"
},
"cpu": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cpu"
},
"memory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Memory"
},
"target_port": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Target Port"
},
"cooldown_period": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Cooldown Period"
},
"network_enabled": {
"type": "boolean",
"title": "Network Enabled",
"default": true
},
"max_sessions": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Max Sessions"
},
"ready_sessions": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Ready Sessions"
},
"env_vars": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Env Vars"
},
"custom_image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Custom Image"
},
"registry_server": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Registry Server"
},
"registry_username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Registry Username"
},
"registry_password": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Registry Password"
}
},
"type": "object",
"required": [
"name"
],
"title": "FactoryCreate"
}
Response 200 OK
application/json
Schema of the response body
{
"type": "object",
"title": "Response Update Factory Api V2 Factory Factory Id Put"
}
Response 422 Unprocessable Entity
application/json
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
DELETE /api/v2/factory/{factory_id}
Delete a factory.
Description Delete a factory.
** Token Authentication Required **
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
| OAuth2PasswordBearer | header | string | N/A | No | |
| factory_id | path | string | No |
Response 200 OK
application/json
"string"
This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"type": "string",
"title": "Response Delete Factory Api V2 Factory Factory Id Delete"
}
Response 422 Unprocessable Entity
application/json
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
Schemas
FactoryCreate
| Name | Type |
|---|---|
| cooldown_period | |
| cpu | |
| custom_image | |
| env_vars | |
| image | |
| max_sessions | |
| memory | |
| name | string |
| network_enabled | boolean |
| ready_sessions | |
| registry_password | |
| registry_server | |
| registry_username | |
| target_port |
HTTPValidationError
| Name | Type |
|---|---|
| detail | Array<ValidationError> |
ValidationError
| Name | Type |
|---|---|
| loc | Array<> |
| msg | string |
| type | string |
Security schemes
| Name | Type | Scheme | Description |
|---|---|---|---|
| OAuth2PasswordBearer | oauth2 |