Skip to content

An open-source, self-hostable PaaS alternative to Vercel, Heroku & Netlify that lets you easily deploy static sites, databases, full-stack applications and 360+ one-click services on your own servers.

fix(api): correct service and application OpenAPI schemas

Andras Bacsai64667574f6fd
diff --git a/app/Http/Controllers/Api/ServicesController.php b/app/Http/Controllers/Api/ServicesController.php
index aa9afe0adc..9fa512c6bc 100644
--- a/app/Http/Controllers/Api/ServicesController.php
+++ b/app/Http/Controllers/Api/ServicesController.php
@@ -1053,11 +1053,6 @@ class ServicesController extends Controller
properties: [
'name' => ['type' => 'string', 'description' => 'The service name.'],
'description' => ['type' => 'string', 'description' => 'The service description.'],
- 'project_uuid' => ['type' => 'string', 'description' => 'The project UUID.'],
- 'environment_name' => ['type' => 'string', 'description' => 'The environment name.'],
- 'environment_uuid' => ['type' => 'string', 'description' => 'The environment UUID.'],
- 'server_uuid' => ['type' => 'string', 'description' => 'The server UUID.'],
- 'destination_uuid' => ['type' => 'string', 'description' => 'The destination UUID.'],
'instant_deploy' => ['type' => 'boolean', 'description' => 'The flag to indicate if the service should be deployed instantly.'],
'connect_to_docker_network' => ['type' => 'boolean', 'default' => false, 'description' => 'Connect the service to the predefined docker network.'],
'docker_compose_raw' => ['type' => 'string', 'description' => 'The base64 encoded Docker Compose content.'],
@@ -1942,7 +1937,7 @@ class ServicesController extends Controller
),
]
)]
- public function move_by_uuid(Request $request): \Illuminate\Http\JsonResponse
+ public function move_by_uuid(Request $request): JsonResponse
{
$teamId = getTeamIdFromToken();
if (is_null($teamId)) {
diff --git a/app/Models/Application.php b/app/Models/Application.php
index ca247c8e8b..732142b0de 100644
--- a/app/Models/Application.php
+++ b/app/Models/Application.php
@@ -111,7 +111,7 @@ use Symfony\Component\Yaml\Yaml;
'is_http_basic_auth_enabled' => ['type' => 'boolean', 'description' => 'HTTP Basic Authentication enabled.'],
'http_basic_auth_username' => ['type' => 'string', 'nullable' => true, 'description' => 'Username for HTTP Basic Authentication'],
'http_basic_auth_password' => ['type' => 'string', 'nullable' => true, 'description' => 'Password for HTTP Basic Authentication'],
- 'settings' => new OA\Property(ref: '#/components/schemas/ApplicationSetting'),
+ new OA\Property(property: 'settings', ref: '#/components/schemas/ApplicationSetting'),
]
)]
diff --git a/openapi.json b/openapi.json
index 4a3a932ca5..093b610100 100644
--- a/openapi.json
+++ b/openapi.json
@@ -12731,30 +12731,779 @@
"bearerAuth": []
}
]
+ },
+ "post": {
+ "tags": [
+ "Service applications"
+ ],
+ "summary": "Get service application logs",
+ "description": "Get Docker logs for a single compose service container.",
+ "operationId": "post-service-application-logs-by-service-and-app-uuid",
+ "parameters": [
+ {
+ "name": "uuid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "app_uuid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "lines",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "format": "int32",
+ "default": 100
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Logs.",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "properties": {
+ "logs": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#\/components\/responses\/400"
+ },
+ "401": {
+ "$ref": "#\/components\/responses\/401"
+ },
+ "404": {
+ "$ref": "#\/components\/responses\/404"
+ },
+ "501": {
+ "description": "Swarm not supported."
+ }
+ },
+ "security": [
+ {
+ "bearerAuth": []
+ }
+ ]
+ }
+ },
+ "\/services\/{uuid}\/applications\/{app_uuid}\/start": {
+ "get": {
+ "tags": [
+ "Service applications"
+ ],
+ "summary": "Start or redeploy service application container",
+ "description": "Runs docker compose up for a single compose service (no-deps), optionally pulling the image and rebuilding.",
+ "operationId": "start-service-application-by-service-and-app-uuid",
+ "parameters": [
+ {
+ "name": "uuid",
+ "in": "path",
+ "description": "Service UUID.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "app_uuid",
+ "in": "path",
+ "description": "Service application UUID.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "force",
+ "in": "query",
+ "description": "When true, passes --build to docker compose up.",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ },
+ {
+ "name": "latest",
+ "in": "query",
+ "description": "When true, pulls the image for this compose service before up.",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Deploy request queued.",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "properties": {
+ "message": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#\/components\/responses\/401"
+ },
+ "404": {
+ "$ref": "#\/components\/responses\/404"
+ },
+ "501": {
+ "description": "Swarm not supported."
+ }
+ },
+ "security": [
+ {
+ "bearerAuth": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "Service applications"
+ ],
+ "summary": "Start or redeploy service application container",
+ "description": "Runs docker compose up for a single compose service (no-deps), optionally pulling the image and rebuilding.",
+ "operationId": "post-start-service-application-by-service-and-app-uuid",
+ "parameters": [
+ {
+ "name": "uuid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "app_uuid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "force",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ },
+ {
+ "name": "latest",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Deploy request queued.",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "properties": {
+ "message": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#\/components\/responses\/400"
+ },
+ "401": {
+ "$ref": "#\/components\/responses\/401"
+ },
+ "404": {
+ "$ref": "#\/components\/responses\/404"
+ },
+ "501": {
+ "description": "Swarm not supported."
+ }
+ },
+ "security": [
+ {
+ "bearerAuth": []
+ }
+ ]
+ }
+ },
+ "\/services\/{uuid}\/applications\/{app_uuid}\/restart": {
+ "get": {
+ "tags": [
+ "Service applications"
+ ],
+ "summary": "Restart service application container",
+ "description": "Restarts a single compose service container (docker restart).",
+ "operationId": "restart-service-application-by-service-and-app-uuid",
+ "parameters": [
+ {
+ "name": "uuid",
+ "in": "path",
+ "description": "Service UUID.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "app_uuid",
+ "in": "path",
+ "description": "Service application UUID.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Restart queued.",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "properties": {
+ "message": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#\/components\/responses\/401"
+ },
+ "404": {
+ "$ref": "#\/components\/responses\/404"
+ },
+ "501": {
+ "description": "Swarm not supported."
+ }
+ },
+ "security": [
+ {
+ "bearerAuth": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "Service applications"
+ ],
+ "summary": "Restart service application container",
+ "description": "Restarts a single compose service container.",
+ "operationId": "post-restart-service-application-by-service-and-app-uuid",
+ "parameters": [
+ {
+ "name": "uuid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "app_uuid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Restart queued.",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "properties": {
+ "message": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#\/components\/responses\/400"
+ },
+ "401": {
+ "$ref": "#\/components\/responses\/401"
+ },
+ "404": {
+ "$ref": "#\/components\/responses\/404"
+ },
+ "501": {
+ "description": "Swarm not supported."
+ }
+ },
+ "security": [
+ {
+ "bearerAuth": []
+ }
+ ]
+ }
+ },
+ "\/services\/{uuid}\/applications\/{app_uuid}\/stop": {
+ "get": {
+ "tags": [
+ "Service applications"
+ ],
+ "summary": "Stop service application container",
+ "description": "Stops a single compose service container (docker stop).",
+ "operationId": "stop-service-application-by-service-and-app-uuid",
+ "parameters": [
+ {
+ "name": "uuid",
+ "in": "path",
+ "description": "Service UUID.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "app_uuid",
+ "in": "path",
+ "description": "Service application UUID.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Stop queued.",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "properties": {
+ "message": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#\/components\/responses\/401"
+ },
+ "404": {
+ "$ref": "#\/components\/responses\/404"
+ },
+ "501": {
+ "description": "Swarm not supported."
+ }
+ },
+ "security": [
+ {
+ "bearerAuth": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "Service applications"
+ ],
+ "summary": "Stop service application container",
+ "description": "Stops a single compose service container.",
+ "operationId": "post-stop-service-application-by-service-and-app-uuid",
+ "parameters": [
+ {
+ "name": "uuid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "app_uuid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Stop queued.",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "properties": {
+ "message": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#\/components\/responses\/400"
+ },
+ "401": {
+ "$ref": "#\/components\/responses\/401"
+ },
+ "404": {
+ "$ref": "#\/components\/responses\/404"
+ },
+ "501": {
+ "description": "Swarm not supported."
+ }
+ },
+ "security": [
+ {
+ "bearerAuth": []
+ }
+ ]
+ }
+ },
+ "\/services\/{uuid}\/databases": {
+ "get": {
+ "tags": [
+ "Service databases"
+ ],
+ "summary": "List service databases",
+ "description": "List compose databases for a single service.",
+ "operationId": "list-service-databases-by-service-uuid",
+ "parameters": [
+ {
+ "name": "uuid",
+ "in": "path",
+ "description": "Service UUID.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Service databases.",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#\/components\/responses\/401"
+ },
+ "404": {
+ "$ref": "#\/components\/responses\/404"
+ }
+ },
+ "security": [
+ {
+ "bearerAuth": []
+ }
+ ]
+ }
+ },
+ "\/services\/{uuid}\/databases\/{database_uuid}": {
+ "get": {
+ "tags": [
+ "Service databases"
+ ],
+ "summary": "Get service database",
+ "description": "Get a compose database by service UUID and database UUID.",
+ "operationId": "get-service-database-by-service-and-database-uuid",
+ "parameters": [
+ {
+ "name": "uuid",
+ "in": "path",
+ "description": "Service UUID.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "database_uuid",
+ "in": "path",
+ "description": "Service database UUID.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Service database.",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#\/components\/responses\/401"
+ },
+ "404": {
+ "$ref": "#\/components\/responses\/404"
+ }
+ },
+ "security": [
+ {
+ "bearerAuth": []
+ }
+ ]
+ },
+ "patch": {
+ "tags": [
+ "Service databases"
+ ],
+ "summary": "Update service database",
+ "description": "Update mutable fields for a compose service database.",
+ "operationId": "patch-service-database-by-service-and-database-uuid",
+ "parameters": [
+ {
+ "name": "uuid",
+ "in": "path",
+ "description": "Service UUID.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "database_uuid",
+ "in": "path",
+ "description": "Service database UUID.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "properties": {
+ "human_name": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "image": {
+ "type": "string"
+ },
+ "exclude_from_status": {
+ "type": "boolean"
+ },
+ "is_log_drain_enabled": {
+ "type": "boolean"
+ },
+ "is_public": {
+ "type": "boolean"
+ },
+ "public_port": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "maximum": 65535,
+ "minimum": 1
+ },
+ "public_port_timeout": {
+ "type": [
+ "integer",
+ "null"
+ ],
+ "minimum": 1
+ }
+ },
+ "type": "object",
+ "additionalProperties": false
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Updated service database.",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#\/components\/responses\/400"
+ },
+ "401": {
+ "$ref": "#\/components\/responses\/401"
+ },
+ "404": {
+ "$ref": "#\/components\/responses\/404"
+ },
+ "422": {
+ "$ref": "#\/components\/responses\/422"
+ }
+ },
+ "security": [
+ {
+ "bearerAuth": []
+ }
+ ]
}
},
- "\/services\/{uuid}\/applications\/{app_uuid}\/start": {
+ "\/services\/{uuid}\/databases\/{database_uuid}\/logs": {
"get": {
"tags": [
- "Service applications"
+ "Service databases"
],
- "summary": "Start or redeploy service application container",
- "description": "Runs docker compose up for a single compose service (no-deps), optionally pulling the image and rebuilding.",
- "operationId": "start-service-application-by-service-and-app-uuid",
+ "summary": "Get service database logs",
+ "description": "Get Docker logs for a compose database container.",
+ "operationId": "get-service-database-logs-by-service-and-database-uuid",
"parameters": [
{
"name": "uuid",
"in": "path",
- "description": "Service UUID.",
"required": true,
"schema": {
"type": "string"
}
},
{
- "name": "app_uuid",
+ "name": "database_uuid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "lines",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "format": "int32",
+ "default": 100
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Logs.",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "properties": {
+ "logs": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ }
+ }
+ },
+ "400": {
+ "$ref": "#\/components\/responses\/400"
+ },
+ "401": {
+ "$ref": "#\/components\/responses\/401"
+ },
+ "404": {
+ "$ref": "#\/components\/responses\/404"
+ },
+ "501": {
+ "description": "Swarm not supported."
+ }
+ },
+ "security": [
+ {
+ "bearerAuth": []
+ }
+ ]
+ }
+ },
+ "\/services\/{uuid}\/databases\/{database_uuid}\/start": {
+ "post": {
+ "tags": [
+ "Service databases"
+ ],
+ "summary": "Start or redeploy service database container",
+ "description": "Run docker compose up for a single compose database.",
+ "operationId": "start-service-database-by-service-and-database-uuid",
+ "parameters": [
+ {
+ "name": "uuid",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "database_uuid",
"in": "path",
- "description": "Service application UUID.",
"required": true,
"schema": {
"type": "string"
@@ -12763,7 +13512,6 @@
{
"name": "force",
"in": "query",
- "description": "When true, passes --build to docker compose up.",
"required": false,
"schema": {
"type": "boolean",
@@ -12773,7 +13521,6 @@
{
"name": "latest",
"in": "query",
- "description": "When true, pulls the image for this compose service before up.",
"required": false,
"schema": {
"type": "boolean",
@@ -12797,6 +13544,9 @@
}
}
},
+ "400": {
+ "$ref": "#\/components\/responses\/400"
+ },
"401": {
"$ref": "#\/components\/responses\/401"
},
@@ -12814,28 +13564,26 @@
]
}
},
- "\/services\/{uuid}\/applications\/{app_uuid}\/restart": {
- "get": {
+ "\/services\/{uuid}\/databases\/{database_uuid}\/restart": {
+ "post": {
"tags": [
- "Service applications"
+ "Service databases"
],
- "summary": "Restart service application container",
- "description": "Restarts a single compose service container (docker restart).",
- "operationId": "restart-service-application-by-service-and-app-uuid",
+ "summary": "Restart service database container",
+ "description": "Restart a compose database container.",
+ "operationId": "restart-service-database-by-service-and-database-uuid",
"parameters": [
{
"name": "uuid",
"in": "path",
- "description": "Service UUID.",
"required": true,
"schema": {
"type": "string"
}
},
{
- "name": "app_uuid",
+ "name": "database_uuid",
"in": "path",
- "description": "Service application UUID.",
"required": true,
"schema": {
"type": "string"
@@ -12858,6 +13606,9 @@
}
}
},
+ "400": {
+ "$ref": "#\/components\/responses\/400"
+ },
"401": {
"$ref": "#\/components\/responses\/401"
},
@@ -12875,28 +13626,26 @@
]
}
},
- "\/services\/{uuid}\/applications\/{app_uuid}\/stop": {
- "get": {
+ "\/services\/{uuid}\/databases\/{database_uuid}\/stop": {
+ "post": {
"tags": [
- "Service applications"
+ "Service databases"
],
- "summary": "Stop service application container",
- "description": "Stops a single compose service container (docker stop).",
- "operationId": "stop-service-application-by-service-and-app-uuid",
+ "summary": "Stop service database container",
+ "description": "Stop a compose database container.",
+ "operationId": "stop-service-database-by-service-and-database-uuid",
"parameters": [
{
"name": "uuid",
"in": "path",
- "description": "Service UUID.",
"required": true,
"schema": {
"type": "string"
}
},
{
- "name": "app_uuid",
+ "name": "database_uuid",
"in": "path",
- "description": "Service application UUID.",
"required": true,
"schema": {
"type": "string"
@@ -12919,6 +13668,9 @@
}
}
},
+ "400": {
+ "$ref": "#\/components\/responses\/400"
+ },
"401": {
"$ref": "#\/components\/responses\/401"
},
@@ -13338,26 +14090,6 @@
"type": "string",
"description": "The service description."
},
- "project_uuid": {
- "type": "string",
- "description": "The project UUID."
- },
- "environment_name": {
- "type": "string",
- "description": "The environment name."
- },
- "environment_uuid": {
- "type": "string",
- "description": "The environment UUID."
- },
- "server_uuid": {
- "type": "string",
- "description": "The server UUID."
- },
- "destination_uuid": {
- "type": "string",
- "description": "The destination UUID."
- },
"instant_deploy": {
"type": "boolean",
"description": "The flag to indicate if the service should be deployed instantly."
@@ -15514,7 +16246,7 @@
"nullable": true,
"description": "Password for HTTP Basic Authentication"
},
- "": {
+ "settings": {
"$ref": "#\/components\/schemas\/ApplicationSetting"
}
},
@@ -16568,6 +17300,10 @@
"name": "Service applications",
"description": "Service applications"
},
+ {
+ "name": "Service databases",
+ "description": "Service databases"
+ },
{
"name": "Services",
"description": "Services"
diff --git a/openapi.yaml b/openapi.yaml
index 6dfe91e0a9..0619409910 100644
--- a/openapi.yaml
+++ b/openapi.yaml
@@ -8173,6 +8173,53 @@ paths:
security:
-
bearerAuth: []
+ post:
+ tags:
+ - 'Service applications'
+ summary: 'Get service application logs'
+ description: 'Get Docker logs for a single compose service container.'
+ operationId: post-service-application-logs-by-service-and-app-uuid
+ parameters:
+ -
+ name: uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ -
+ name: app_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ -
+ name: lines
+ in: query
+ required: false
+ schema:
+ type: integer
+ format: int32
+ default: 100
+ responses:
+ '200':
+ description: Logs.
+ content:
+ application/json:
+ schema:
+ properties:
+ logs: { type: string }
+ type: object
+ '400':
+ $ref: '#/components/responses/400'
+ '401':
+ $ref: '#/components/responses/401'
+ '404':
+ $ref: '#/components/responses/404'
+ '501':
+ description: 'Swarm not supported.'
+ security:
+ -
+ bearerAuth: []
'/services/{uuid}/applications/{app_uuid}/start':
get:
tags:
@@ -8229,6 +8276,59 @@ paths:
security:
-
bearerAuth: []
+ post:
+ tags:
+ - 'Service applications'
+ summary: 'Start or redeploy service application container'
+ description: 'Runs docker compose up for a single compose service (no-deps), optionally pulling the image and rebuilding.'
+ operationId: post-start-service-application-by-service-and-app-uuid
+ parameters:
+ -
+ name: uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ -
+ name: app_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ -
+ name: force
+ in: query
+ required: false
+ schema:
+ type: boolean
+ default: false
+ -
+ name: latest
+ in: query
+ required: false
+ schema:
+ type: boolean
+ default: false
+ responses:
+ '200':
+ description: 'Deploy request queued.'
+ content:
+ application/json:
+ schema:
+ properties:
+ message: { type: string }
+ type: object
+ '400':
+ $ref: '#/components/responses/400'
+ '401':
+ $ref: '#/components/responses/401'
+ '404':
+ $ref: '#/components/responses/404'
+ '501':
+ description: 'Swarm not supported.'
+ security:
+ -
+ bearerAuth: []
'/services/{uuid}/applications/{app_uuid}/restart':
get:
tags:
@@ -8269,6 +8369,45 @@ paths:
security:
-
bearerAuth: []
+ post:
+ tags:
+ - 'Service applications'
+ summary: 'Restart service application container'
+ description: 'Restarts a single compose service container.'
+ operationId: post-restart-service-application-by-service-and-app-uuid
+ parameters:
+ -
+ name: uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ -
+ name: app_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ description: 'Restart queued.'
+ content:
+ application/json:
+ schema:
+ properties:
+ message: { type: string }
+ type: object
+ '400':
+ $ref: '#/components/responses/400'
+ '401':
+ $ref: '#/components/responses/401'
+ '404':
+ $ref: '#/components/responses/404'
+ '501':
+ description: 'Swarm not supported.'
+ security:
+ -
+ bearerAuth: []
'/services/{uuid}/applications/{app_uuid}/stop':
get:
tags:
@@ -8309,6 +8448,359 @@ paths:
security:
-
bearerAuth: []
+ post:
+ tags:
+ - 'Service applications'
+ summary: 'Stop service application container'
+ description: 'Stops a single compose service container.'
+ operationId: post-stop-service-application-by-service-and-app-uuid
+ parameters:
+ -
+ name: uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ -
+ name: app_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ description: 'Stop queued.'
+ content:
+ application/json:
+ schema:
+ properties:
+ message: { type: string }
+ type: object
+ '400':
+ $ref: '#/components/responses/400'
+ '401':
+ $ref: '#/components/responses/401'
+ '404':
+ $ref: '#/components/responses/404'
+ '501':
+ description: 'Swarm not supported.'
+ security:
+ -
+ bearerAuth: []
+ '/services/{uuid}/databases':
+ get:
+ tags:
+ - 'Service databases'
+ summary: 'List service databases'
+ description: 'List compose databases for a single service.'
+ operationId: list-service-databases-by-service-uuid
+ parameters:
+ -
+ name: uuid
+ in: path
+ description: 'Service UUID.'
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ description: 'Service databases.'
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ type: object
+ '401':
+ $ref: '#/components/responses/401'
+ '404':
+ $ref: '#/components/responses/404'
+ security:
+ -
+ bearerAuth: []
+ '/services/{uuid}/databases/{database_uuid}':
+ get:
+ tags:
+ - 'Service databases'
+ summary: 'Get service database'
+ description: 'Get a compose database by service UUID and database UUID.'
+ operationId: get-service-database-by-service-and-database-uuid
+ parameters:
+ -
+ name: uuid
+ in: path
+ description: 'Service UUID.'
+ required: true
+ schema:
+ type: string
+ -
+ name: database_uuid
+ in: path
+ description: 'Service database UUID.'
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ description: 'Service database.'
+ content:
+ application/json:
+ schema:
+ type: object
+ '401':
+ $ref: '#/components/responses/401'
+ '404':
+ $ref: '#/components/responses/404'
+ security:
+ -
+ bearerAuth: []
+ patch:
+ tags:
+ - 'Service databases'
+ summary: 'Update service database'
+ description: 'Update mutable fields for a compose service database.'
+ operationId: patch-service-database-by-service-and-database-uuid
+ parameters:
+ -
+ name: uuid
+ in: path
+ description: 'Service UUID.'
+ required: true
+ schema:
+ type: string
+ -
+ name: database_uuid
+ in: path
+ description: 'Service database UUID.'
+ required: true
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ human_name:
+ type: [string, 'null']
+ description:
+ type: [string, 'null']
+ image:
+ type: string
+ exclude_from_status:
+ type: boolean
+ is_log_drain_enabled:
+ type: boolean
+ is_public:
+ type: boolean
+ public_port:
+ type: [integer, 'null']
+ maximum: 65535
+ minimum: 1
+ public_port_timeout:
+ type: [integer, 'null']
+ minimum: 1
+ type: object
+ additionalProperties: false
+ responses:
+ '200':
+ description: 'Updated service database.'
+ content:
+ application/json:
+ schema:
+ type: object
+ '400':
+ $ref: '#/components/responses/400'
+ '401':
+ $ref: '#/components/responses/401'
+ '404':
+ $ref: '#/components/responses/404'
+ '422':
+ $ref: '#/components/responses/422'
+ security:
+ -
+ bearerAuth: []
+ '/services/{uuid}/databases/{database_uuid}/logs':
+ get:
+ tags:
+ - 'Service databases'
+ summary: 'Get service database logs'
+ description: 'Get Docker logs for a compose database container.'
+ operationId: get-service-database-logs-by-service-and-database-uuid
+ parameters:
+ -
+ name: uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ -
+ name: database_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ -
+ name: lines
+ in: query
+ required: false
+ schema:
+ type: integer
+ format: int32
+ default: 100
+ responses:
+ '200':
+ description: Logs.
+ content:
+ application/json:
+ schema:
+ properties:
+ logs: { type: string }
+ type: object
+ '400':
+ $ref: '#/components/responses/400'
+ '401':
+ $ref: '#/components/responses/401'
+ '404':
+ $ref: '#/components/responses/404'
+ '501':
+ description: 'Swarm not supported.'
+ security:
+ -
+ bearerAuth: []
+ '/services/{uuid}/databases/{database_uuid}/start':
+ post:
+ tags:
+ - 'Service databases'
+ summary: 'Start or redeploy service database container'
+ description: 'Run docker compose up for a single compose database.'
+ operationId: start-service-database-by-service-and-database-uuid
+ parameters:
+ -
+ name: uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ -
+ name: database_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ -
+ name: force
+ in: query
+ required: false
+ schema:
+ type: boolean
+ default: false
+ -
+ name: latest
+ in: query
+ required: false
+ schema:
+ type: boolean
+ default: false
+ responses:
+ '200':
+ description: 'Deploy request queued.'
+ content:
+ application/json:
+ schema:
+ properties:
+ message: { type: string }
+ type: object
+ '400':
+ $ref: '#/components/responses/400'
+ '401':
+ $ref: '#/components/responses/401'
+ '404':
+ $ref: '#/components/responses/404'
+ '501':
+ description: 'Swarm not supported.'
+ security:
+ -
+ bearerAuth: []
+ '/services/{uuid}/databases/{database_uuid}/restart':
+ post:
+ tags:
+ - 'Service databases'
+ summary: 'Restart service database container'
+ description: 'Restart a compose database container.'
+ operationId: restart-service-database-by-service-and-database-uuid
+ parameters:
+ -
+ name: uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ -
+ name: database_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ description: 'Restart queued.'
+ content:
+ application/json:
+ schema:
+ properties:
+ message: { type: string }
+ type: object
+ '400':
+ $ref: '#/components/responses/400'
+ '401':
+ $ref: '#/components/responses/401'
+ '404':
+ $ref: '#/components/responses/404'
+ '501':
+ description: 'Swarm not supported.'
+ security:
+ -
+ bearerAuth: []
+ '/services/{uuid}/databases/{database_uuid}/stop':
+ post:
+ tags:
+ - 'Service databases'
+ summary: 'Stop service database container'
+ description: 'Stop a compose database container.'
+ operationId: stop-service-database-by-service-and-database-uuid
+ parameters:
+ -
+ name: uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ -
+ name: database_uuid
+ in: path
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ description: 'Stop queued.'
+ content:
+ application/json:
+ schema:
+ properties:
+ message: { type: string }
+ type: object
+ '400':
+ $ref: '#/components/responses/400'
+ '401':
+ $ref: '#/components/responses/401'
+ '404':
+ $ref: '#/components/responses/404'
+ '501':
+ description: 'Swarm not supported.'
+ security:
+ -
+ bearerAuth: []
/services:
get:
tags:
@@ -8550,21 +9042,6 @@ paths:
description:
type: string
description: 'The service description.'
- project_uuid:
- type: string
- description: 'The project UUID.'
- environment_name:
- type: string
- description: 'The environment name.'
- environment_uuid:
- type: string
- description: 'The environment UUID.'
- server_uuid:
- type: string
- description: 'The server UUID.'
- destination_uuid:
- type: string
- description: 'The destination UUID.'
instant_deploy:
type: boolean
description: 'The flag to indicate if the service should be deployed instantly.'
@@ -9967,7 +10444,7 @@ components:
type: string
nullable: true
description: 'Password for HTTP Basic Authentication'
- '':
+ settings:
$ref: '#/components/schemas/ApplicationSetting'
type: object
ApplicationDeploymentQueue:
@@ -10700,6 +11177,9 @@ tags:
-
name: 'Service applications'
description: 'Service applications'
+ -
+ name: 'Service databases'
+ description: 'Service databases'
-
name: Services
description: Services