From e7feac848aa1d2383474694aa3a64498cade8308 Mon Sep 17 00:00:00 2001 From: Andras Bacsai Date: Tue, 9 Jul 2024 14:12:36 +0200 Subject: [PATCH] descriptions --- .../Api/ApplicationsController.php | 726 +++++++++--------- 1 file changed, 362 insertions(+), 364 deletions(-) diff --git a/app/Http/Controllers/Api/ApplicationsController.php b/app/Http/Controllers/Api/ApplicationsController.php index 2d2b390e6..da3b986be 100644 --- a/app/Http/Controllers/Api/ApplicationsController.php +++ b/app/Http/Controllers/Api/ApplicationsController.php @@ -115,66 +115,66 @@ public function applications(Request $request) type: 'object', required: ['project_uuid', 'server_uuid', 'environment_name', 'git_repository', 'git_branch', 'build_pack', 'ports_exposes'], properties: [ - 'project_uuid' => ['type' => 'string'], - 'server_uuid' => ['type' => 'string'], - 'environment_name' => ['type' => 'string'], - 'destination_uuid' => ['type' => 'string'], - 'name' => ['type' => 'string'], - 'description' => ['type' => 'string'], - 'domains' => ['type' => 'string'], - 'git_repository' => ['type' => 'string'], - 'git_branch' => ['type' => 'string'], - 'git_commit_sha' => ['type' => 'string'], - 'docker_registry_image_name' => ['type' => 'string'], - 'docker_registry_image_tag' => ['type' => 'string'], - 'build_pack' => ['type' => 'string', 'enum' => ['nixpacks', 'static', 'dockerfile', 'dockercompose']], - 'is_static' => ['type' => 'boolean'], - 'install_command' => ['type' => 'string'], - 'build_command' => ['type' => 'string'], - 'start_command' => ['type' => 'string'], - 'ports_exposes' => ['type' => 'string'], - 'ports_mappings' => ['type' => 'string'], - 'base_directory' => ['type' => 'string'], - 'publish_directory' => ['type' => 'string'], - 'health_check_enabled' => ['type' => 'boolean'], - 'health_check_path' => ['type' => 'string'], - 'health_check_port' => ['type' => 'integer'], - 'health_check_host' => ['type' => 'string'], - 'health_check_method' => ['type' => 'string'], - 'health_check_return_code' => ['type' => 'integer'], - 'health_check_scheme' => ['type' => 'string'], - 'health_check_response_text' => ['type' => 'string'], - 'health_check_interval' => ['type' => 'integer'], - 'health_check_timeout' => ['type' => 'integer'], - 'health_check_retries' => ['type' => 'integer'], - 'health_check_start_period' => ['type' => 'integer'], - 'limits_memory' => ['type' => 'string'], - 'limits_memory_swap' => ['type' => 'string'], - 'limits_memory_swappiness' => ['type' => 'integer'], - 'limits_memory_reservation' => ['type' => 'string'], - 'limits_cpus' => ['type' => 'string'], - 'limits_cpuset' => ['type' => 'string'], - 'limits_cpu_shares' => ['type' => 'string'], - 'custom_labels' => ['type' => 'string'], - 'custom_docker_run_options' => ['type' => 'string'], - 'post_deployment_command' => ['type' => 'string'], - 'post_deployment_command_container' => ['type' => 'string'], - 'pre_deployment_command' => ['type' => 'string'], - 'pre_deployment_command_container' => ['type' => 'string'], - 'manual_webhook_secret_github' => ['type' => 'string'], - 'manual_webhook_secret_gitlab' => ['type' => 'string'], - 'manual_webhook_secret_bitbucket' => ['type' => 'string'], - 'manual_webhook_secret_gitea' => ['type' => 'string'], - 'redirect' => ['type' => 'string'], - // 'github_app_uuid' => ['type' => 'string'], - 'instant_deploy' => ['type' => 'boolean'], - 'dockerfile' => ['type' => 'string'], - 'docker_compose_location' => ['type' => 'string'], - 'docker_compose_raw' => ['type' => 'string'], - 'docker_compose_custom_start_command' => ['type' => 'string'], - 'docker_compose_custom_build_command' => ['type' => 'string'], - 'docker_compose_domains' => ['type' => 'array'], - 'watch_paths' => ['type' => 'string'], + 'project_uuid' => ['type' => 'string', 'description' => 'The project UUID.'], + 'server_uuid' => ['type' => 'string', 'description' => 'The server UUID.'], + 'environment_name' => ['type' => 'string', 'description' => 'The environment name.'], + 'git_repository' => ['type' => 'string', 'description' => 'The git repository URL.'], + 'git_branch' => ['type' => 'string', 'description' => 'The git branch.'], + 'build_pack' => ['type' => 'string', 'enum' => ['nixpacks', 'static', 'dockerfile', 'dockercompose'], 'description' => 'The build pack type.'], + 'ports_exposes' => ['type' => 'string', 'description' => 'The ports to expose.'], + 'destination_uuid' => ['type' => 'string', 'description' => 'The destination UUID.'], + 'name' => ['type' => 'string', 'description' => 'The application name.'], + 'description' => ['type' => 'string', 'description' => 'The application description.'], + 'domains' => ['type' => 'string', 'description' => 'The application domains.'], + 'git_commit_sha' => ['type' => 'string', 'description' => 'The git commit SHA.'], + 'docker_registry_image_name' => ['type' => 'string', 'description' => 'The docker registry image name.'], + 'docker_registry_image_tag' => ['type' => 'string', 'description' => 'The docker registry image tag.'], + 'is_static' => ['type' => 'boolean', 'description' => 'The flag to indicate if the application is static.'], + 'install_command' => ['type' => 'string', 'description' => 'The install command.'], + 'build_command' => ['type' => 'string', 'description' => 'The build command.'], + 'start_command' => ['type' => 'string', 'description' => 'The start command.'], + 'ports_mappings' => ['type' => 'string', 'description' => 'The ports mappings.'], + 'base_directory' => ['type' => 'string', 'description' => 'The base directory for all commands.'], + 'publish_directory' => ['type' => 'string', 'description' => 'The publish directory.'], + 'health_check_enabled' => ['type' => 'boolean', 'description' => 'Health check enabled.'], + 'health_check_path' => ['type' => 'string', 'description' => 'Health check path.'], + 'health_check_port' => ['type' => 'string', 'nullable' => true, 'description' => 'Health check port.'], + 'health_check_host' => ['type' => 'string', 'nullable' => true, 'description' => 'Health check host.'], + 'health_check_method' => ['type' => 'string', 'description' => 'Health check method.'], + 'health_check_return_code' => ['type' => 'integer', 'description' => 'Health check return code.'], + 'health_check_scheme' => ['type' => 'string', 'description' => 'Health check scheme.'], + 'health_check_response_text' => ['type' => 'string', 'nullable' => true, 'description' => 'Health check response text.'], + 'health_check_interval' => ['type' => 'integer', 'description' => 'Health check interval in seconds.'], + 'health_check_timeout' => ['type' => 'integer', 'description' => 'Health check timeout in seconds.'], + 'health_check_retries' => ['type' => 'integer', 'description' => 'Health check retries count.'], + 'health_check_start_period' => ['type' => 'integer', 'description' => 'Health check start period in seconds.'], + 'limits_memory' => ['type' => 'string', 'description' => 'Memory limit.'], + 'limits_memory_swap' => ['type' => 'string', 'description' => 'Memory swap limit.'], + 'limits_memory_swappiness' => ['type' => 'integer', 'description' => 'Memory swappiness.'], + 'limits_memory_reservation' => ['type' => 'string', 'description' => 'Memory reservation.'], + 'limits_cpus' => ['type' => 'string', 'description' => 'CPU limit.'], + 'limits_cpuset' => ['type' => 'string', 'nullable' => true, 'description' => 'CPU set.'], + 'limits_cpu_shares' => ['type' => 'integer', 'description' => 'CPU shares.'], + 'custom_labels' => ['type' => 'string', 'description' => 'Custom labels.'], + 'custom_docker_run_options' => ['type' => 'string', 'description' => 'Custom docker run options.'], + 'post_deployment_command' => ['type' => 'string', 'description' => 'Post deployment command.'], + 'post_deployment_command_container' => ['type' => 'string', 'description' => 'Post deployment command container.'], + 'pre_deployment_command' => ['type' => 'string', 'description' => 'Pre deployment command.'], + 'pre_deployment_command_container' => ['type' => 'string', 'description' => 'Pre deployment command container.'], + 'manual_webhook_secret_github' => ['type' => 'string', 'description' => 'Manual webhook secret for Github.'], + 'manual_webhook_secret_gitlab' => ['type' => 'string', 'description' => 'Manual webhook secret for Gitlab.'], + 'manual_webhook_secret_bitbucket' => ['type' => 'string', 'description' => 'Manual webhook secret for Bitbucket.'], + 'manual_webhook_secret_gitea' => ['type' => 'string', 'description' => 'Manual webhook secret for Gitea.'], + 'redirect' => ['type' => 'string', 'nullable' => true, 'description' => 'How to set redirect with Traefik / Caddy. www<->non-www.', 'enum' => ['www', 'non-www', 'both']], + // 'github_app_uuid' => ['type' => 'string', 'description' => 'The Github App UUID.'], + 'instant_deploy' => ['type' => 'boolean', 'description' => 'The flag to indicate if the application should be deployed instantly.'], + 'dockerfile' => ['type' => 'string', 'description' => 'The Dockerfile content.'], + 'docker_compose_location' => ['type' => 'string', 'description' => 'The Docker Compose location.'], + 'docker_compose_raw' => ['type' => 'string', 'description' => 'The Docker Compose raw content.'], + 'docker_compose_custom_start_command' => ['type' => 'string', 'description' => 'The Docker Compose custom start command.'], + 'docker_compose_custom_build_command' => ['type' => 'string', 'description' => 'The Docker Compose custom build command.'], + 'docker_compose_domains' => ['type' => 'array', 'description' => 'The Docker Compose domains.'], + 'watch_paths' => ['type' => 'string', 'description' => 'The watch paths.'], ], )), ]), @@ -216,66 +216,66 @@ public function create_public_application(Request $request) type: 'object', required: ['project_uuid', 'server_uuid', 'environment_name', 'github_app_uuid', 'git_repository', 'git_branch', 'build_pack', 'ports_exposes'], properties: [ - 'project_uuid' => ['type' => 'string'], - 'server_uuid' => ['type' => 'string'], - 'environment_name' => ['type' => 'string'], - 'github_app_uuid' => ['type' => 'string'], - 'destination_uuid' => ['type' => 'string'], - 'name' => ['type' => 'string'], - 'description' => ['type' => 'string'], - 'domains' => ['type' => 'string'], - 'git_repository' => ['type' => 'string'], - 'git_branch' => ['type' => 'string'], - 'git_commit_sha' => ['type' => 'string'], - 'docker_registry_image_name' => ['type' => 'string'], - 'docker_registry_image_tag' => ['type' => 'string'], - 'build_pack' => ['type' => 'string', 'enum' => ['nixpacks', 'static', 'dockerfile', 'dockercompose']], - 'is_static' => ['type' => 'boolean'], - 'install_command' => ['type' => 'string'], - 'build_command' => ['type' => 'string'], - 'start_command' => ['type' => 'string'], - 'ports_exposes' => ['type' => 'string'], - 'ports_mappings' => ['type' => 'string'], - 'base_directory' => ['type' => 'string'], - 'publish_directory' => ['type' => 'string'], - 'health_check_enabled' => ['type' => 'boolean'], - 'health_check_path' => ['type' => 'string'], - 'health_check_port' => ['type' => 'integer'], - 'health_check_host' => ['type' => 'string'], - 'health_check_method' => ['type' => 'string'], - 'health_check_return_code' => ['type' => 'integer'], - 'health_check_scheme' => ['type' => 'string'], - 'health_check_response_text' => ['type' => 'string'], - 'health_check_interval' => ['type' => 'integer'], - 'health_check_timeout' => ['type' => 'integer'], - 'health_check_retries' => ['type' => 'integer'], - 'health_check_start_period' => ['type' => 'integer'], - 'limits_memory' => ['type' => 'string'], - 'limits_memory_swap' => ['type' => 'string'], - 'limits_memory_swappiness' => ['type' => 'integer'], - 'limits_memory_reservation' => ['type' => 'string'], - 'limits_cpus' => ['type' => 'string'], - 'limits_cpuset' => ['type' => 'string'], - 'limits_cpu_shares' => ['type' => 'string'], - 'custom_labels' => ['type' => 'string'], - 'custom_docker_run_options' => ['type' => 'string'], - 'post_deployment_command' => ['type' => 'string'], - 'post_deployment_command_container' => ['type' => 'string'], - 'pre_deployment_command' => ['type' => 'string'], - 'pre_deployment_command_container' => ['type' => 'string'], - 'manual_webhook_secret_github' => ['type' => 'string'], - 'manual_webhook_secret_gitlab' => ['type' => 'string'], - 'manual_webhook_secret_bitbucket' => ['type' => 'string'], - 'manual_webhook_secret_gitea' => ['type' => 'string'], - 'redirect' => ['type' => 'string'], - 'instant_deploy' => ['type' => 'boolean'], - 'dockerfile' => ['type' => 'string'], - 'docker_compose_location' => ['type' => 'string'], - 'docker_compose_raw' => ['type' => 'string'], - 'docker_compose_custom_start_command' => ['type' => 'string'], - 'docker_compose_custom_build_command' => ['type' => 'string'], - 'docker_compose_domains' => ['type' => 'array'], - 'watch_paths' => ['type' => 'string'], + 'project_uuid' => ['type' => 'string', 'description' => 'The project UUID.'], + 'server_uuid' => ['type' => 'string', 'description' => 'The server UUID.'], + 'environment_name' => ['type' => 'string', 'description' => 'The environment name.'], + 'github_app_uuid' => ['type' => 'string', 'description' => 'The Github App UUID.'], + 'git_repository' => ['type' => 'string', 'description' => 'The git repository URL.'], + 'git_branch' => ['type' => 'string', 'description' => 'The git branch.'], + 'ports_exposes' => ['type' => 'string', 'description' => 'The ports to expose.'], + 'destination_uuid' => ['type' => 'string', 'description' => 'The destination UUID.'], + 'build_pack' => ['type' => 'string', 'enum' => ['nixpacks', 'static', 'dockerfile', 'dockercompose'], 'description' => 'The build pack type.'], + 'name' => ['type' => 'string', 'description' => 'The application name.'], + 'description' => ['type' => 'string', 'description' => 'The application description.'], + 'domains' => ['type' => 'string', 'description' => 'The application domains.'], + 'git_commit_sha' => ['type' => 'string', 'description' => 'The git commit SHA.'], + 'docker_registry_image_name' => ['type' => 'string', 'description' => 'The docker registry image name.'], + 'docker_registry_image_tag' => ['type' => 'string', 'description' => 'The docker registry image tag.'], + 'is_static' => ['type' => 'boolean', 'description' => 'The flag to indicate if the application is static.'], + 'install_command' => ['type' => 'string', 'description' => 'The install command.'], + 'build_command' => ['type' => 'string', 'description' => 'The build command.'], + 'start_command' => ['type' => 'string', 'description' => 'The start command.'], + 'ports_mappings' => ['type' => 'string', 'description' => 'The ports mappings.'], + 'base_directory' => ['type' => 'string', 'description' => 'The base directory for all commands.'], + 'publish_directory' => ['type' => 'string', 'description' => 'The publish directory.'], + 'health_check_enabled' => ['type' => 'boolean', 'description' => 'Health check enabled.'], + 'health_check_path' => ['type' => 'string', 'description' => 'Health check path.'], + 'health_check_port' => ['type' => 'string', 'nullable' => true, 'description' => 'Health check port.'], + 'health_check_host' => ['type' => 'string', 'nullable' => true, 'description' => 'Health check host.'], + 'health_check_method' => ['type' => 'string', 'description' => 'Health check method.'], + 'health_check_return_code' => ['type' => 'integer', 'description' => 'Health check return code.'], + 'health_check_scheme' => ['type' => 'string', 'description' => 'Health check scheme.'], + 'health_check_response_text' => ['type' => 'string', 'nullable' => true, 'description' => 'Health check response text.'], + 'health_check_interval' => ['type' => 'integer', 'description' => 'Health check interval in seconds.'], + 'health_check_timeout' => ['type' => 'integer', 'description' => 'Health check timeout in seconds.'], + 'health_check_retries' => ['type' => 'integer', 'description' => 'Health check retries count.'], + 'health_check_start_period' => ['type' => 'integer', 'description' => 'Health check start period in seconds.'], + 'limits_memory' => ['type' => 'string', 'description' => 'Memory limit.'], + 'limits_memory_swap' => ['type' => 'string', 'description' => 'Memory swap limit.'], + 'limits_memory_swappiness' => ['type' => 'integer', 'description' => 'Memory swappiness.'], + 'limits_memory_reservation' => ['type' => 'string', 'description' => 'Memory reservation.'], + 'limits_cpus' => ['type' => 'string', 'description' => 'CPU limit.'], + 'limits_cpuset' => ['type' => 'string', 'nullable' => true, 'description' => 'CPU set.'], + 'limits_cpu_shares' => ['type' => 'integer', 'description' => 'CPU shares.'], + 'custom_labels' => ['type' => 'string', 'description' => 'Custom labels.'], + 'custom_docker_run_options' => ['type' => 'string', 'description' => 'Custom docker run options.'], + 'post_deployment_command' => ['type' => 'string', 'description' => 'Post deployment command.'], + 'post_deployment_command_container' => ['type' => 'string', 'description' => 'Post deployment command container.'], + 'pre_deployment_command' => ['type' => 'string', 'description' => 'Pre deployment command.'], + 'pre_deployment_command_container' => ['type' => 'string', 'description' => 'Pre deployment command container.'], + 'manual_webhook_secret_github' => ['type' => 'string', 'description' => 'Manual webhook secret for Github.'], + 'manual_webhook_secret_gitlab' => ['type' => 'string', 'description' => 'Manual webhook secret for Gitlab.'], + 'manual_webhook_secret_bitbucket' => ['type' => 'string', 'description' => 'Manual webhook secret for Bitbucket.'], + 'manual_webhook_secret_gitea' => ['type' => 'string', 'description' => 'Manual webhook secret for Gitea.'], + 'redirect' => ['type' => 'string', 'nullable' => true, 'description' => 'How to set redirect with Traefik / Caddy. www<->non-www.', 'enum' => ['www', 'non-www', 'both']], + 'instant_deploy' => ['type' => 'boolean', 'description' => 'The flag to indicate if the application should be deployed instantly.'], + 'dockerfile' => ['type' => 'string', 'description' => 'The Dockerfile content.'], + 'docker_compose_location' => ['type' => 'string', 'description' => 'The Docker Compose location.'], + 'docker_compose_raw' => ['type' => 'string', 'description' => 'The Docker Compose raw content.'], + 'docker_compose_custom_start_command' => ['type' => 'string', 'description' => 'The Docker Compose custom start command.'], + 'docker_compose_custom_build_command' => ['type' => 'string', 'description' => 'The Docker Compose custom build command.'], + 'docker_compose_domains' => ['type' => 'array', 'description' => 'The Docker Compose domains.'], + 'watch_paths' => ['type' => 'string', 'description' => 'The watch paths.'], ], )), ]), @@ -315,68 +315,68 @@ public function create_private_gh_app_application(Request $request) mediaType: 'application/json', schema: new OA\Schema( type: 'object', - required: ['project_uuid', 'server_uuid', 'environment_name', 'private_key_uuid', 'git_repository', 'git_branch', 'build_pack', 'ports_exposes'], + required: ['project_uuid', 'server_uuid', 'environment_name', 'private_key_uuid', 'git_repository', 'git_branch', 'build_pack', 'ports_exposes'], properties: [ - 'project_uuid' => ['type' => 'string'], - 'server_uuid' => ['type' => 'string'], - 'environment_name' => ['type' => 'string'], - 'private_key_uuid' => ['type' => 'string'], - 'destination_uuid' => ['type' => 'string'], - 'name' => ['type' => 'string'], - 'description' => ['type' => 'string'], - 'domains' => ['type' => 'string'], - 'git_repository' => ['type' => 'string'], - 'git_branch' => ['type' => 'string'], - 'git_commit_sha' => ['type' => 'string'], - 'docker_registry_image_name' => ['type' => 'string'], - 'docker_registry_image_tag' => ['type' => 'string'], - 'build_pack' => ['type' => 'string', 'enum' => ['nixpacks', 'static', 'dockerfile', 'dockercompose']], - 'is_static' => ['type' => 'boolean'], - 'install_command' => ['type' => 'string'], - 'build_command' => ['type' => 'string'], - 'start_command' => ['type' => 'string'], - 'ports_exposes' => ['type' => 'string'], - 'ports_mappings' => ['type' => 'string'], - 'base_directory' => ['type' => 'string'], - 'publish_directory' => ['type' => 'string'], - 'health_check_enabled' => ['type' => 'boolean'], - 'health_check_path' => ['type' => 'string'], - 'health_check_port' => ['type' => 'integer'], - 'health_check_host' => ['type' => 'string'], - 'health_check_method' => ['type' => 'string'], - 'health_check_return_code' => ['type' => 'integer'], - 'health_check_scheme' => ['type' => 'string'], - 'health_check_response_text' => ['type' => 'string'], - 'health_check_interval' => ['type' => 'integer'], - 'health_check_timeout' => ['type' => 'integer'], - 'health_check_retries' => ['type' => 'integer'], - 'health_check_start_period' => ['type' => 'integer'], - 'limits_memory' => ['type' => 'string'], - 'limits_memory_swap' => ['type' => 'string'], - 'limits_memory_swappiness' => ['type' => 'integer'], - 'limits_memory_reservation' => ['type' => 'string'], - 'limits_cpus' => ['type' => 'string'], - 'limits_cpuset' => ['type' => 'string'], - 'limits_cpu_shares' => ['type' => 'string'], - 'custom_labels' => ['type' => 'string'], - 'custom_docker_run_options' => ['type' => 'string'], - 'post_deployment_command' => ['type' => 'string'], - 'post_deployment_command_container' => ['type' => 'string'], - 'pre_deployment_command' => ['type' => 'string'], - 'pre_deployment_command_container' => ['type' => 'string'], - 'manual_webhook_secret_github' => ['type' => 'string'], - 'manual_webhook_secret_gitlab' => ['type' => 'string'], - 'manual_webhook_secret_bitbucket' => ['type' => 'string'], - 'manual_webhook_secret_gitea' => ['type' => 'string'], - 'redirect' => ['type' => 'string'], - 'instant_deploy' => ['type' => 'boolean'], - 'dockerfile' => ['type' => 'string'], - 'docker_compose_location' => ['type' => 'string'], - 'docker_compose_raw' => ['type' => 'string'], - 'docker_compose_custom_start_command' => ['type' => 'string'], - 'docker_compose_custom_build_command' => ['type' => 'string'], - 'docker_compose_domains' => ['type' => 'array'], - 'watch_paths' => ['type' => 'string'], + 'project_uuid' => ['type' => 'string', 'description' => 'The project UUID.'], + 'server_uuid' => ['type' => 'string', 'description' => 'The server UUID.'], + 'environment_name' => ['type' => 'string', 'description' => 'The environment name.'], + 'private_key_uuid' => ['type' => 'string', 'description' => 'The private key UUID.'], + 'git_repository' => ['type' => 'string', 'description' => 'The git repository URL.'], + 'git_branch' => ['type' => 'string', 'description' => 'The git branch.'], + 'ports_exposes' => ['type' => 'string', 'description' => 'The ports to expose.'], + 'destination_uuid' => ['type' => 'string', 'description' => 'The destination UUID.'], + 'build_pack' => ['type' => 'string', 'enum' => ['nixpacks', 'static', 'dockerfile', 'dockercompose'], 'description' => 'The build pack type.'], + 'name' => ['type' => 'string', 'description' => 'The application name.'], + 'description' => ['type' => 'string', 'description' => 'The application description.'], + 'domains' => ['type' => 'string', 'description' => 'The application domains.'], + 'git_commit_sha' => ['type' => 'string', 'description' => 'The git commit SHA.'], + 'docker_registry_image_name' => ['type' => 'string', 'description' => 'The docker registry image name.'], + 'docker_registry_image_tag' => ['type' => 'string', 'description' => 'The docker registry image tag.'], + 'is_static' => ['type' => 'boolean', 'description' => 'The flag to indicate if the application is static.'], + 'install_command' => ['type' => 'string', 'description' => 'The install command.'], + 'build_command' => ['type' => 'string', 'description' => 'The build command.'], + 'start_command' => ['type' => 'string', 'description' => 'The start command.'], + 'ports_mappings' => ['type' => 'string', 'description' => 'The ports mappings.'], + 'base_directory' => ['type' => 'string', 'description' => 'The base directory for all commands.'], + 'publish_directory' => ['type' => 'string', 'description' => 'The publish directory.'], + 'health_check_enabled' => ['type' => 'boolean', 'description' => 'Health check enabled.'], + 'health_check_path' => ['type' => 'string', 'description' => 'Health check path.'], + 'health_check_port' => ['type' => 'string', 'nullable' => true, 'description' => 'Health check port.'], + 'health_check_host' => ['type' => 'string', 'nullable' => true, 'description' => 'Health check host.'], + 'health_check_method' => ['type' => 'string', 'description' => 'Health check method.'], + 'health_check_return_code' => ['type' => 'integer', 'description' => 'Health check return code.'], + 'health_check_scheme' => ['type' => 'string', 'description' => 'Health check scheme.'], + 'health_check_response_text' => ['type' => 'string', 'nullable' => true, 'description' => 'Health check response text.'], + 'health_check_interval' => ['type' => 'integer', 'description' => 'Health check interval in seconds.'], + 'health_check_timeout' => ['type' => 'integer', 'description' => 'Health check timeout in seconds.'], + 'health_check_retries' => ['type' => 'integer', 'description' => 'Health check retries count.'], + 'health_check_start_period' => ['type' => 'integer', 'description' => 'Health check start period in seconds.'], + 'limits_memory' => ['type' => 'string', 'description' => 'Memory limit.'], + 'limits_memory_swap' => ['type' => 'string', 'description' => 'Memory swap limit.'], + 'limits_memory_swappiness' => ['type' => 'integer', 'description' => 'Memory swappiness.'], + 'limits_memory_reservation' => ['type' => 'string', 'description' => 'Memory reservation.'], + 'limits_cpus' => ['type' => 'string', 'description' => 'CPU limit.'], + 'limits_cpuset' => ['type' => 'string', 'nullable' => true, 'description' => 'CPU set.'], + 'limits_cpu_shares' => ['type' => 'integer', 'description' => 'CPU shares.'], + 'custom_labels' => ['type' => 'string', 'description' => 'Custom labels.'], + 'custom_docker_run_options' => ['type' => 'string', 'description' => 'Custom docker run options.'], + 'post_deployment_command' => ['type' => 'string', 'description' => 'Post deployment command.'], + 'post_deployment_command_container' => ['type' => 'string', 'description' => 'Post deployment command container.'], + 'pre_deployment_command' => ['type' => 'string', 'description' => 'Pre deployment command.'], + 'pre_deployment_command_container' => ['type' => 'string', 'description' => 'Pre deployment command container.'], + 'manual_webhook_secret_github' => ['type' => 'string', 'description' => 'Manual webhook secret for Github.'], + 'manual_webhook_secret_gitlab' => ['type' => 'string', 'description' => 'Manual webhook secret for Gitlab.'], + 'manual_webhook_secret_bitbucket' => ['type' => 'string', 'description' => 'Manual webhook secret for Bitbucket.'], + 'manual_webhook_secret_gitea' => ['type' => 'string', 'description' => 'Manual webhook secret for Gitea.'], + 'redirect' => ['type' => 'string', 'nullable' => true, 'description' => 'How to set redirect with Traefik / Caddy. www<->non-www.', 'enum' => ['www', 'non-www', 'both']], + 'instant_deploy' => ['type' => 'boolean', 'description' => 'The flag to indicate if the application should be deployed instantly.'], + 'dockerfile' => ['type' => 'string', 'description' => 'The Dockerfile content.'], + 'docker_compose_location' => ['type' => 'string', 'description' => 'The Docker Compose location.'], + 'docker_compose_raw' => ['type' => 'string', 'description' => 'The Docker Compose raw content.'], + 'docker_compose_custom_start_command' => ['type' => 'string', 'description' => 'The Docker Compose custom start command.'], + 'docker_compose_custom_build_command' => ['type' => 'string', 'description' => 'The Docker Compose custom build command.'], + 'docker_compose_domains' => ['type' => 'array', 'description' => 'The Docker Compose domains.'], + 'watch_paths' => ['type' => 'string', 'description' => 'The watch paths.'], ], )), ]), @@ -418,50 +418,51 @@ public function create_private_deploy_key_application(Request $request) type: 'object', required: ['project_uuid', 'server_uuid', 'environment_name', 'dockerfile'], properties: [ - 'project_uuid' => ['type' => 'string'], - 'server_uuid' => ['type' => 'string'], - 'environment_name' => ['type' => 'string'], - 'dockerfile' => ['type' => 'string'], - 'destination_uuid' => ['type' => 'string'], - 'name' => ['type' => 'string'], - 'description' => ['type' => 'string'], - 'domains' => ['type' => 'string'], - 'docker_registry_image_name' => ['type' => 'string'], - 'docker_registry_image_tag' => ['type' => 'string'], - 'ports_exposes' => ['type' => 'string'], - 'ports_mappings' => ['type' => 'string'], - 'base_directory' => ['type' => 'string'], - 'health_check_enabled' => ['type' => 'boolean'], - 'health_check_path' => ['type' => 'string'], - 'health_check_port' => ['type' => 'integer'], - 'health_check_host' => ['type' => 'string'], - 'health_check_method' => ['type' => 'string'], - 'health_check_return_code' => ['type' => 'integer'], - 'health_check_scheme' => ['type' => 'string'], - 'health_check_response_text' => ['type' => 'string'], - 'health_check_interval' => ['type' => 'integer'], - 'health_check_timeout' => ['type' => 'integer'], - 'health_check_retries' => ['type' => 'integer'], - 'health_check_start_period' => ['type' => 'integer'], - 'limits_memory' => ['type' => 'string'], - 'limits_memory_swap' => ['type' => 'string'], - 'limits_memory_swappiness' => ['type' => 'integer'], - 'limits_memory_reservation' => ['type' => 'string'], - 'limits_cpus' => ['type' => 'string'], - 'limits_cpuset' => ['type' => 'string'], - 'limits_cpu_shares' => ['type' => 'string'], - 'custom_labels' => ['type' => 'string'], - 'custom_docker_run_options' => ['type' => 'string'], - 'post_deployment_command' => ['type' => 'string'], - 'post_deployment_command_container' => ['type' => 'string'], - 'pre_deployment_command' => ['type' => 'string'], - 'pre_deployment_command_container' => ['type' => 'string'], - 'manual_webhook_secret_github' => ['type' => 'string'], - 'manual_webhook_secret_gitlab' => ['type' => 'string'], - 'manual_webhook_secret_bitbucket' => ['type' => 'string'], - 'manual_webhook_secret_gitea' => ['type' => 'string'], - 'redirect' => ['type' => 'string'], - 'instant_deploy' => ['type' => 'boolean'], + 'project_uuid' => ['type' => 'string', 'description' => 'The project UUID.'], + 'server_uuid' => ['type' => 'string', 'description' => 'The server UUID.'], + 'environment_name' => ['type' => 'string', 'description' => 'The environment name.'], + 'dockerfile' => ['type' => 'string', 'description' => 'The Dockerfile content.'], + 'build_pack' => ['type' => 'string', 'enum' => ['nixpacks', 'static', 'dockerfile', 'dockercompose'], 'description' => 'The build pack type.'], + 'ports_exposes' => ['type' => 'string', 'description' => 'The ports to expose.'], + 'destination_uuid' => ['type' => 'string', 'description' => 'The destination UUID.'], + 'name' => ['type' => 'string', 'description' => 'The application name.'], + 'description' => ['type' => 'string', 'description' => 'The application description.'], + 'domains' => ['type' => 'string', 'description' => 'The application domains.'], + 'docker_registry_image_name' => ['type' => 'string', 'description' => 'The docker registry image name.'], + 'docker_registry_image_tag' => ['type' => 'string', 'description' => 'The docker registry image tag.'], + 'ports_mappings' => ['type' => 'string', 'description' => 'The ports mappings.'], + 'base_directory' => ['type' => 'string', 'description' => 'The base directory for all commands.'], + 'health_check_enabled' => ['type' => 'boolean', 'description' => 'Health check enabled.'], + 'health_check_path' => ['type' => 'string', 'description' => 'Health check path.'], + 'health_check_port' => ['type' => 'string', 'nullable' => true, 'description' => 'Health check port.'], + 'health_check_host' => ['type' => 'string', 'nullable' => true, 'description' => 'Health check host.'], + 'health_check_method' => ['type' => 'string', 'description' => 'Health check method.'], + 'health_check_return_code' => ['type' => 'integer', 'description' => 'Health check return code.'], + 'health_check_scheme' => ['type' => 'string', 'description' => 'Health check scheme.'], + 'health_check_response_text' => ['type' => 'string', 'nullable' => true, 'description' => 'Health check response text.'], + 'health_check_interval' => ['type' => 'integer', 'description' => 'Health check interval in seconds.'], + 'health_check_timeout' => ['type' => 'integer', 'description' => 'Health check timeout in seconds.'], + 'health_check_retries' => ['type' => 'integer', 'description' => 'Health check retries count.'], + 'health_check_start_period' => ['type' => 'integer', 'description' => 'Health check start period in seconds.'], + 'limits_memory' => ['type' => 'string', 'description' => 'Memory limit.'], + 'limits_memory_swap' => ['type' => 'string', 'description' => 'Memory swap limit.'], + 'limits_memory_swappiness' => ['type' => 'integer', 'description' => 'Memory swappiness.'], + 'limits_memory_reservation' => ['type' => 'string', 'description' => 'Memory reservation.'], + 'limits_cpus' => ['type' => 'string', 'description' => 'CPU limit.'], + 'limits_cpuset' => ['type' => 'string', 'nullable' => true, 'description' => 'CPU set.'], + 'limits_cpu_shares' => ['type' => 'integer', 'description' => 'CPU shares.'], + 'custom_labels' => ['type' => 'string', 'description' => 'Custom labels.'], + 'custom_docker_run_options' => ['type' => 'string', 'description' => 'Custom docker run options.'], + 'post_deployment_command' => ['type' => 'string', 'description' => 'Post deployment command.'], + 'post_deployment_command_container' => ['type' => 'string', 'description' => 'Post deployment command container.'], + 'pre_deployment_command' => ['type' => 'string', 'description' => 'Pre deployment command.'], + 'pre_deployment_command_container' => ['type' => 'string', 'description' => 'Pre deployment command container.'], + 'manual_webhook_secret_github' => ['type' => 'string', 'description' => 'Manual webhook secret for Github.'], + 'manual_webhook_secret_gitlab' => ['type' => 'string', 'description' => 'Manual webhook secret for Gitlab.'], + 'manual_webhook_secret_bitbucket' => ['type' => 'string', 'description' => 'Manual webhook secret for Bitbucket.'], + 'manual_webhook_secret_gitea' => ['type' => 'string', 'description' => 'Manual webhook secret for Gitea.'], + 'redirect' => ['type' => 'string', 'nullable' => true, 'description' => 'How to set redirect with Traefik / Caddy. www<->non-www.', 'enum' => ['www', 'non-www', 'both']], + 'instant_deploy' => ['type' => 'boolean', 'description' => 'The flag to indicate if the application should be deployed instantly.'], ], )), ]), @@ -503,51 +504,48 @@ public function create_dockerfile_application(Request $request) type: 'object', required: ['project_uuid', 'server_uuid', 'environment_name', 'docker_registry_image_name', 'ports_exposes'], properties: [ - 'project_uuid' => ['type' => 'string'], - 'server_uuid' => ['type' => 'string'], - 'environment_name' => ['type' => 'string'], - 'docker_registry_image_name' => ['type' => 'string'], - 'docker_registry_image_tag' => ['type' => 'string'], - 'destination_uuid' => ['type' => 'string'], - 'name' => ['type' => 'string'], - 'description' => ['type' => 'string'], - 'domains' => ['type' => 'string'], - 'git_repository' => ['type' => 'string'], - 'git_branch' => ['type' => 'string'], - 'git_commit_sha' => ['type' => 'string'], - 'ports_exposes' => ['type' => 'string'], - 'ports_mappings' => ['type' => 'string'], - 'health_check_enabled' => ['type' => 'boolean'], - 'health_check_path' => ['type' => 'string'], - 'health_check_port' => ['type' => 'integer'], - 'health_check_host' => ['type' => 'string'], - 'health_check_method' => ['type' => 'string'], - 'health_check_return_code' => ['type' => 'integer'], - 'health_check_scheme' => ['type' => 'string'], - 'health_check_response_text' => ['type' => 'string'], - 'health_check_interval' => ['type' => 'integer'], - 'health_check_timeout' => ['type' => 'integer'], - 'health_check_retries' => ['type' => 'integer'], - 'health_check_start_period' => ['type' => 'integer'], - 'limits_memory' => ['type' => 'string'], - 'limits_memory_swap' => ['type' => 'string'], - 'limits_memory_swappiness' => ['type' => 'integer'], - 'limits_memory_reservation' => ['type' => 'string'], - 'limits_cpus' => ['type' => 'string'], - 'limits_cpuset' => ['type' => 'string'], - 'limits_cpu_shares' => ['type' => 'string'], - 'custom_labels' => ['type' => 'string'], - 'custom_docker_run_options' => ['type' => 'string'], - 'post_deployment_command' => ['type' => 'string'], - 'post_deployment_command_container' => ['type' => 'string'], - 'pre_deployment_command' => ['type' => 'string'], - 'pre_deployment_command_container' => ['type' => 'string'], - 'manual_webhook_secret_github' => ['type' => 'string'], - 'manual_webhook_secret_gitlab' => ['type' => 'string'], - 'manual_webhook_secret_bitbucket' => ['type' => 'string'], - 'manual_webhook_secret_gitea' => ['type' => 'string'], - 'redirect' => ['type' => 'string'], - 'instant_deploy' => ['type' => 'boolean'], + 'project_uuid' => ['type' => 'string', 'description' => 'The project UUID.'], + 'server_uuid' => ['type' => 'string', 'description' => 'The server UUID.'], + 'environment_name' => ['type' => 'string', 'description' => 'The environment name.'], + 'docker_registry_image_name' => ['type' => 'string', 'description' => 'The docker registry image name.'], + 'docker_registry_image_tag' => ['type' => 'string', 'description' => 'The docker registry image tag.'], + 'ports_exposes' => ['type' => 'string', 'description' => 'The ports to expose.'], + 'destination_uuid' => ['type' => 'string', 'description' => 'The destination UUID.'], + 'name' => ['type' => 'string', 'description' => 'The application name.'], + 'description' => ['type' => 'string', 'description' => 'The application description.'], + 'domains' => ['type' => 'string', 'description' => 'The application domains.'], + 'ports_mappings' => ['type' => 'string', 'description' => 'The ports mappings.'], + 'health_check_enabled' => ['type' => 'boolean', 'description' => 'Health check enabled.'], + 'health_check_path' => ['type' => 'string', 'description' => 'Health check path.'], + 'health_check_port' => ['type' => 'string', 'nullable' => true, 'description' => 'Health check port.'], + 'health_check_host' => ['type' => 'string', 'nullable' => true, 'description' => 'Health check host.'], + 'health_check_method' => ['type' => 'string', 'description' => 'Health check method.'], + 'health_check_return_code' => ['type' => 'integer', 'description' => 'Health check return code.'], + 'health_check_scheme' => ['type' => 'string', 'description' => 'Health check scheme.'], + 'health_check_response_text' => ['type' => 'string', 'nullable' => true, 'description' => 'Health check response text.'], + 'health_check_interval' => ['type' => 'integer', 'description' => 'Health check interval in seconds.'], + 'health_check_timeout' => ['type' => 'integer', 'description' => 'Health check timeout in seconds.'], + 'health_check_retries' => ['type' => 'integer', 'description' => 'Health check retries count.'], + 'health_check_start_period' => ['type' => 'integer', 'description' => 'Health check start period in seconds.'], + 'limits_memory' => ['type' => 'string', 'description' => 'Memory limit.'], + 'limits_memory_swap' => ['type' => 'string', 'description' => 'Memory swap limit.'], + 'limits_memory_swappiness' => ['type' => 'integer', 'description' => 'Memory swappiness.'], + 'limits_memory_reservation' => ['type' => 'string', 'description' => 'Memory reservation.'], + 'limits_cpus' => ['type' => 'string', 'description' => 'CPU limit.'], + 'limits_cpuset' => ['type' => 'string', 'nullable' => true, 'description' => 'CPU set.'], + 'limits_cpu_shares' => ['type' => 'integer', 'description' => 'CPU shares.'], + 'custom_labels' => ['type' => 'string', 'description' => 'Custom labels.'], + 'custom_docker_run_options' => ['type' => 'string', 'description' => 'Custom docker run options.'], + 'post_deployment_command' => ['type' => 'string', 'description' => 'Post deployment command.'], + 'post_deployment_command_container' => ['type' => 'string', 'description' => 'Post deployment command container.'], + 'pre_deployment_command' => ['type' => 'string', 'description' => 'Pre deployment command.'], + 'pre_deployment_command_container' => ['type' => 'string', 'description' => 'Pre deployment command container.'], + 'manual_webhook_secret_github' => ['type' => 'string', 'description' => 'Manual webhook secret for Github.'], + 'manual_webhook_secret_gitlab' => ['type' => 'string', 'description' => 'Manual webhook secret for Gitlab.'], + 'manual_webhook_secret_bitbucket' => ['type' => 'string', 'description' => 'Manual webhook secret for Bitbucket.'], + 'manual_webhook_secret_gitea' => ['type' => 'string', 'description' => 'Manual webhook secret for Gitea.'], + 'redirect' => ['type' => 'string', 'nullable' => true, 'description' => 'How to set redirect with Traefik / Caddy. www<->non-www.', 'enum' => ['www', 'non-www', 'both']], + 'instant_deploy' => ['type' => 'boolean', 'description' => 'The flag to indicate if the application should be deployed instantly.'], ], )), ]), @@ -589,14 +587,14 @@ public function create_dockerimage_application(Request $request) type: 'object', required: ['project_uuid', 'server_uuid', 'environment_name', 'docker_compose_raw'], properties: [ - 'project_uuid' => ['type' => 'string'], - 'server_uuid' => ['type' => 'string'], - 'environment_name' => ['type' => 'string'], - 'docker_compose_raw' => ['type' => 'string'], - 'destination_uuid' => ['type' => 'string'], - 'name' => ['type' => 'string'], - 'description' => ['type' => 'string'], - 'instant_deploy' => ['type' => 'boolean'], + 'project_uuid' => ['type' => 'string', 'description' => 'The project UUID.'], + 'server_uuid' => ['type' => 'string', 'description' => 'The server UUID.'], + 'environment_name' => ['type' => 'string', 'description' => 'The environment name.'], + 'docker_compose_raw' => ['type' => 'string', 'description' => 'The Docker Compose raw content.'], + 'destination_uuid' => ['type' => 'string', 'description' => 'The destination UUID if the server has more than one destinations.'], + 'name' => ['type' => 'string', 'description' => 'The application name.'], + 'description' => ['type' => 'string', 'description' => 'The application description.'], + 'instant_deploy' => ['type' => 'boolean', 'description' => 'The flag to indicate if the application should be deployed instantly.'], ], )), ]), @@ -1307,66 +1305,66 @@ public function delete_by_uuid(Request $request) schema: new OA\Schema( type: 'object', properties: [ - 'project_uuid' => ['type' => 'string'], - 'server_uuid' => ['type' => 'string'], - 'environment_name' => ['type' => 'string'], - 'destination_uuid' => ['type' => 'string'], - 'name' => ['type' => 'string'], - 'description' => ['type' => 'string'], - 'domains' => ['type' => 'string'], - 'git_repository' => ['type' => 'string'], - 'git_branch' => ['type' => 'string'], - 'git_commit_sha' => ['type' => 'string'], - 'docker_registry_image_name' => ['type' => 'string'], - 'docker_registry_image_tag' => ['type' => 'string'], - 'build_pack' => ['type' => 'string', 'enum' => ['nixpacks', 'static', 'dockerfile', 'dockercompose']], - 'is_static' => ['type' => 'boolean'], - 'install_command' => ['type' => 'string'], - 'build_command' => ['type' => 'string'], - 'start_command' => ['type' => 'string'], - 'ports_exposes' => ['type' => 'string'], - 'ports_mappings' => ['type' => 'string'], - 'base_directory' => ['type' => 'string'], - 'publish_directory' => ['type' => 'string'], - 'health_check_enabled' => ['type' => 'boolean'], - 'health_check_path' => ['type' => 'string'], - 'health_check_port' => ['type' => 'integer'], - 'health_check_host' => ['type' => 'string'], - 'health_check_method' => ['type' => 'string'], - 'health_check_return_code' => ['type' => 'integer'], - 'health_check_scheme' => ['type' => 'string'], - 'health_check_response_text' => ['type' => 'string'], - 'health_check_interval' => ['type' => 'integer'], - 'health_check_timeout' => ['type' => 'integer'], - 'health_check_retries' => ['type' => 'integer'], - 'health_check_start_period' => ['type' => 'integer'], - 'limits_memory' => ['type' => 'string'], - 'limits_memory_swap' => ['type' => 'string'], - 'limits_memory_swappiness' => ['type' => 'integer'], - 'limits_memory_reservation' => ['type' => 'string'], - 'limits_cpus' => ['type' => 'string'], - 'limits_cpuset' => ['type' => 'string'], - 'limits_cpu_shares' => ['type' => 'string'], - 'custom_labels' => ['type' => 'string'], - 'custom_docker_run_options' => ['type' => 'string'], - 'post_deployment_command' => ['type' => 'string'], - 'post_deployment_command_container' => ['type' => 'string'], - 'pre_deployment_command' => ['type' => 'string'], - 'pre_deployment_command_container' => ['type' => 'string'], - 'manual_webhook_secret_github' => ['type' => 'string'], - 'manual_webhook_secret_gitlab' => ['type' => 'string'], - 'manual_webhook_secret_bitbucket' => ['type' => 'string'], - 'manual_webhook_secret_gitea' => ['type' => 'string'], - 'redirect' => ['type' => 'string'], - 'github_app_uuid' => ['type' => 'string'], - 'instant_deploy' => ['type' => 'boolean'], - 'dockerfile' => ['type' => 'string'], - 'docker_compose_location' => ['type' => 'string'], - 'docker_compose_raw' => ['type' => 'string'], - 'docker_compose_custom_start_command' => ['type' => 'string'], - 'docker_compose_custom_build_command' => ['type' => 'string'], - 'docker_compose_domains' => ['type' => 'array'], - 'watch_paths' => ['type' => 'string'], + 'project_uuid' => ['type' => 'string', 'description' => 'The project UUID.'], + 'server_uuid' => ['type' => 'string', 'description' => 'The server UUID.'], + 'environment_name' => ['type' => 'string', 'description' => 'The environment name.'], + 'github_app_uuid' => ['type' => 'string', 'description' => 'The Github App UUID.'], + 'git_repository' => ['type' => 'string', 'description' => 'The git repository URL.'], + 'git_branch' => ['type' => 'string', 'description' => 'The git branch.'], + 'ports_exposes' => ['type' => 'string', 'description' => 'The ports to expose.'], + 'destination_uuid' => ['type' => 'string', 'description' => 'The destination UUID.'], + 'build_pack' => ['type' => 'string', 'enum' => ['nixpacks', 'static', 'dockerfile', 'dockercompose'], 'description' => 'The build pack type.'], + 'name' => ['type' => 'string', 'description' => 'The application name.'], + 'description' => ['type' => 'string', 'description' => 'The application description.'], + 'domains' => ['type' => 'string', 'description' => 'The application domains.'], + 'git_commit_sha' => ['type' => 'string', 'description' => 'The git commit SHA.'], + 'docker_registry_image_name' => ['type' => 'string', 'description' => 'The docker registry image name.'], + 'docker_registry_image_tag' => ['type' => 'string', 'description' => 'The docker registry image tag.'], + 'is_static' => ['type' => 'boolean', 'description' => 'The flag to indicate if the application is static.'], + 'install_command' => ['type' => 'string', 'description' => 'The install command.'], + 'build_command' => ['type' => 'string', 'description' => 'The build command.'], + 'start_command' => ['type' => 'string', 'description' => 'The start command.'], + 'ports_mappings' => ['type' => 'string', 'description' => 'The ports mappings.'], + 'base_directory' => ['type' => 'string', 'description' => 'The base directory for all commands.'], + 'publish_directory' => ['type' => 'string', 'description' => 'The publish directory.'], + 'health_check_enabled' => ['type' => 'boolean', 'description' => 'Health check enabled.'], + 'health_check_path' => ['type' => 'string', 'description' => 'Health check path.'], + 'health_check_port' => ['type' => 'string', 'nullable' => true, 'description' => 'Health check port.'], + 'health_check_host' => ['type' => 'string', 'nullable' => true, 'description' => 'Health check host.'], + 'health_check_method' => ['type' => 'string', 'description' => 'Health check method.'], + 'health_check_return_code' => ['type' => 'integer', 'description' => 'Health check return code.'], + 'health_check_scheme' => ['type' => 'string', 'description' => 'Health check scheme.'], + 'health_check_response_text' => ['type' => 'string', 'nullable' => true, 'description' => 'Health check response text.'], + 'health_check_interval' => ['type' => 'integer', 'description' => 'Health check interval in seconds.'], + 'health_check_timeout' => ['type' => 'integer', 'description' => 'Health check timeout in seconds.'], + 'health_check_retries' => ['type' => 'integer', 'description' => 'Health check retries count.'], + 'health_check_start_period' => ['type' => 'integer', 'description' => 'Health check start period in seconds.'], + 'limits_memory' => ['type' => 'string', 'description' => 'Memory limit.'], + 'limits_memory_swap' => ['type' => 'string', 'description' => 'Memory swap limit.'], + 'limits_memory_swappiness' => ['type' => 'integer', 'description' => 'Memory swappiness.'], + 'limits_memory_reservation' => ['type' => 'string', 'description' => 'Memory reservation.'], + 'limits_cpus' => ['type' => 'string', 'description' => 'CPU limit.'], + 'limits_cpuset' => ['type' => 'string', 'nullable' => true, 'description' => 'CPU set.'], + 'limits_cpu_shares' => ['type' => 'integer', 'description' => 'CPU shares.'], + 'custom_labels' => ['type' => 'string', 'description' => 'Custom labels.'], + 'custom_docker_run_options' => ['type' => 'string', 'description' => 'Custom docker run options.'], + 'post_deployment_command' => ['type' => 'string', 'description' => 'Post deployment command.'], + 'post_deployment_command_container' => ['type' => 'string', 'description' => 'Post deployment command container.'], + 'pre_deployment_command' => ['type' => 'string', 'description' => 'Pre deployment command.'], + 'pre_deployment_command_container' => ['type' => 'string', 'description' => 'Pre deployment command container.'], + 'manual_webhook_secret_github' => ['type' => 'string', 'description' => 'Manual webhook secret for Github.'], + 'manual_webhook_secret_gitlab' => ['type' => 'string', 'description' => 'Manual webhook secret for Gitlab.'], + 'manual_webhook_secret_bitbucket' => ['type' => 'string', 'description' => 'Manual webhook secret for Bitbucket.'], + 'manual_webhook_secret_gitea' => ['type' => 'string', 'description' => 'Manual webhook secret for Gitea.'], + 'redirect' => ['type' => 'string', 'nullable' => true, 'description' => 'How to set redirect with Traefik / Caddy. www<->non-www.', 'enum' => ['www', 'non-www', 'both']], + 'instant_deploy' => ['type' => 'boolean', 'description' => 'The flag to indicate if the application should be deployed instantly.'], + 'dockerfile' => ['type' => 'string', 'description' => 'The Dockerfile content.'], + 'docker_compose_location' => ['type' => 'string', 'description' => 'The Docker Compose location.'], + 'docker_compose_raw' => ['type' => 'string', 'description' => 'The Docker Compose raw content.'], + 'docker_compose_custom_start_command' => ['type' => 'string', 'description' => 'The Docker Compose custom start command.'], + 'docker_compose_custom_build_command' => ['type' => 'string', 'description' => 'The Docker Compose custom build command.'], + 'docker_compose_domains' => ['type' => 'array', 'description' => 'The Docker Compose domains.'], + 'watch_paths' => ['type' => 'string', 'description' => 'The watch paths.'], ], )), ]), @@ -1611,13 +1609,13 @@ public function envs(Request $request) type: 'object', required: ['key', 'value'], properties: [ - 'key' => ['type' => 'string'], - 'value' => ['type' => 'string'], - 'is_preview' => ['type' => 'boolean'], - 'is_build_time' => ['type' => 'boolean'], - 'is_literal' => ['type' => 'boolean'], - 'is_multiline' => ['type' => 'boolean'], - 'is_shown_once' => ['type' => 'boolean'], + 'key' => ['type' => 'string', 'description' => 'The key of the environment variable.'], + 'value' => ['type' => 'string', 'description' => 'The value of the environment variable.'], + 'is_preview' => ['type' => 'boolean', 'description' => 'The flag to indicate if the environment variable is used in preview deployments.'], + 'is_build_time' => ['type' => 'boolean', 'description' => 'The flag to indicate if the environment variable is used in build time.'], + 'is_literal' => ['type' => 'boolean', 'description' => 'The flag to indicate if the environment variable is a literal, nothing espaced.'], + 'is_multiline' => ['type' => 'boolean', 'description' => 'The flag to indicate if the environment variable is multiline.'], + 'is_shown_once' => ['type' => 'boolean', 'description' => 'The flag to indicate if the environment variable\'s value is shown on the UI.'], ], ), ), @@ -1798,13 +1796,13 @@ public function update_env_by_uuid(Request $request) 'items' => new OA\Schema( type: 'object', properties: [ - 'key' => ['type' => 'string'], - 'value' => ['type' => 'string'], - 'is_preview' => ['type' => 'boolean'], - 'is_build_time' => ['type' => 'boolean'], - 'is_literal' => ['type' => 'boolean'], - 'is_multiline' => ['type' => 'boolean'], - 'is_shown_once' => ['type' => 'boolean'], + 'key' => ['type' => 'string', 'description' => 'The key of the environment variable.'], + 'value' => ['type' => 'string', 'description' => 'The value of the environment variable.'], + 'is_preview' => ['type' => 'boolean', 'description' => 'The flag to indicate if the environment variable is used in preview deployments.'], + 'is_build_time' => ['type' => 'boolean', 'description' => 'The flag to indicate if the environment variable is used in build time.'], + 'is_literal' => ['type' => 'boolean', 'description' => 'The flag to indicate if the environment variable is a literal, nothing espaced.'], + 'is_multiline' => ['type' => 'boolean', 'description' => 'The flag to indicate if the environment variable is multiline.'], + 'is_shown_once' => ['type' => 'boolean', 'description' => 'The flag to indicate if the environment variable\'s value is shown on the UI.'], ], ), ], @@ -1982,13 +1980,13 @@ public function create_bulk_envs(Request $request) schema: new OA\Schema( type: 'object', properties: [ - 'key' => ['type' => 'string'], - 'value' => ['type' => 'string'], - 'is_preview' => ['type' => 'boolean'], - 'is_build_time' => ['type' => 'boolean'], - 'is_literal' => ['type' => 'boolean'], - 'is_multiline' => ['type' => 'boolean'], - 'is_shown_once' => ['type' => 'boolean'], + 'key' => ['type' => 'string', 'description' => 'The key of the environment variable.'], + 'value' => ['type' => 'string', 'description' => 'The value of the environment variable.'], + 'is_preview' => ['type' => 'boolean', 'description' => 'The flag to indicate if the environment variable is used in preview deployments.'], + 'is_build_time' => ['type' => 'boolean', 'description' => 'The flag to indicate if the environment variable is used in build time.'], + 'is_literal' => ['type' => 'boolean', 'description' => 'The flag to indicate if the environment variable is a literal, nothing espaced.'], + 'is_multiline' => ['type' => 'boolean', 'description' => 'The flag to indicate if the environment variable is multiline.'], + 'is_shown_once' => ['type' => 'boolean', 'description' => 'The flag to indicate if the environment variable\'s value is shown on the UI.'], ], ), ), @@ -2246,9 +2244,9 @@ public function delete_env_by_uuid(Request $request) schema: new OA\Schema( type: 'object', properties: [ - 'message' => ['type' => 'string', 'example' => 'Deployment request queued.'], - 'deployment_uuid' => ['type' => 'string', 'example' => 'doogksw'], - 'deployment_api_url' => ['type' => 'string'], + 'message' => ['type' => 'string', 'example' => 'Deployment request queued.', 'description' => 'Message.'], + 'deployment_uuid' => ['type' => 'string', 'example' => 'doogksw', 'description' => 'UUID of the deployment.'], + 'deployment_api_url' => ['type' => 'string', 'description' => 'URL to check deployment status.'], ]) ), ]), @@ -2406,8 +2404,8 @@ public function action_stop(Request $request) type: 'object', properties: [ 'message' => ['type' => 'string', 'example' => 'Restart request queued.'], - 'deployment_uuid' => ['type' => 'string', 'example' => 'doogksw'], - 'deployment_api_url' => ['type' => 'string'], + 'deployment_uuid' => ['type' => 'string', 'example' => 'doogksw', 'description' => 'UUID of the deployment.'], + 'deployment_api_url' => ['type' => 'string', 'description' => 'URL to check deployment status.'], ] ) ),