From bc575f1560460ebd45c843ac1686d605fb9a898a Mon Sep 17 00:00:00 2001 From: peaklabs-dev <122374094+peaklabs-dev@users.noreply.github.com> Date: Mon, 12 Jan 2026 21:42:46 +0100 Subject: [PATCH] chore(api): regenerate openapi docs --- openapi.json | 89 +++++++++++++++++++++++++++++++++++++--------------- openapi.yaml | 37 +++++++++------------- 2 files changed, 78 insertions(+), 48 deletions(-) diff --git a/openapi.json b/openapi.json index 9c31f7628..9fdec634f 100644 --- a/openapi.json +++ b/openapi.json @@ -326,10 +326,6 @@ "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." @@ -340,7 +336,20 @@ }, "docker_compose_domains": { "type": "array", - "description": "The Docker Compose domains." + "description": "Array of URLs to be applied to containers of a dockercompose application.", + "items": { + "properties": { + "name": { + "type": "string", + "description": "The service name as defined in docker-compose." + }, + "domain": { + "type": "string", + "description": "Comma-separated list of URLs (e.g. \"http:\/\/app.coolify.io,https:\/\/app2.coolify.io\")" + } + }, + "type": "object" + } }, "watch_paths": { "type": "string", @@ -746,10 +755,6 @@ "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." @@ -760,7 +765,20 @@ }, "docker_compose_domains": { "type": "array", - "description": "The Docker Compose domains." + "description": "Array of URLs to be applied to containers of a dockercompose application.", + "items": { + "properties": { + "name": { + "type": "string", + "description": "The service name as defined in docker-compose." + }, + "domain": { + "type": "string", + "description": "Comma-separated list of URLs (e.g. \"http:\/\/app.coolify.io,https:\/\/app2.coolify.io\")" + } + }, + "type": "object" + } }, "watch_paths": { "type": "string", @@ -1166,10 +1184,6 @@ "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." @@ -1180,7 +1194,20 @@ }, "docker_compose_domains": { "type": "array", - "description": "The Docker Compose domains." + "description": "Array of URLs to be applied to containers of a dockercompose application.", + "items": { + "properties": { + "name": { + "type": "string", + "description": "The service name as defined in docker-compose." + }, + "domain": { + "type": "string", + "description": "Comma-separated list of URLs (e.g. \"http:\/\/app.coolify.io,https:\/\/app2.coolify.io\")" + } + }, + "type": "object" + } }, "watch_paths": { "type": "string", @@ -1318,8 +1345,8 @@ "tags": [ "Applications" ], - "summary": "Create (Dockerfile)", - "description": "Create new application based on a simple Dockerfile.", + "summary": "Create (Dockerfile without git)", + "description": "Create new application based on a simple Dockerfile (without git).", "operationId": "create-dockerfile-application", "requestBody": { "description": "Application object that needs to be created.", @@ -1667,8 +1694,8 @@ "tags": [ "Applications" ], - "summary": "Create (Docker Image)", - "description": "Create new application based on a prebuilt docker image", + "summary": "Create (Docker Image without git)", + "description": "Create new application based on a prebuilt docker image (without git).", "operationId": "create-dockerimage-application", "requestBody": { "description": "Application object that needs to be created.", @@ -1999,8 +2026,8 @@ "tags": [ "Applications" ], - "summary": "Create (Docker Compose)", - "description": "Create new application based on a docker-compose file.", + "summary": "Create (Docker Compose) (Deprecated)", + "description": "Create new application based on a docker-compose file (without git).", "operationId": "create-dockercompose-application", "requestBody": { "description": "Application object that needs to be created.", @@ -2153,6 +2180,7 @@ } } }, + "deprecated": true, "security": [ { "bearerAuth": [] @@ -2558,10 +2586,6 @@ "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." @@ -2572,7 +2596,20 @@ }, "docker_compose_domains": { "type": "array", - "description": "The Docker Compose domains." + "description": "Array of URLs to be applied to containers of a dockercompose application.", + "items": { + "properties": { + "name": { + "type": "string", + "description": "The service name as defined in docker-compose." + }, + "domain": { + "type": "string", + "description": "Comma-separated list of URLs (e.g. \"http:\/\/app.coolify.io,https:\/\/app2.coolify.io\")" + } + }, + "type": "object" + } }, "watch_paths": { "type": "string", diff --git a/openapi.yaml b/openapi.yaml index 198322328..383481a8d 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -237,9 +237,6 @@ paths: 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.' @@ -248,7 +245,8 @@ paths: description: 'The Docker Compose custom build command.' docker_compose_domains: type: array - description: 'The Docker Compose domains.' + description: 'Array of URLs to be applied to containers of a dockercompose application.' + items: { properties: { name: { type: string, description: 'The service name as defined in docker-compose.' }, domain: { type: string, description: 'Comma-separated list of URLs (e.g. "http://app.coolify.io,https://app2.coolify.io")' } }, type: object } watch_paths: type: string description: 'The watch paths.' @@ -511,9 +509,6 @@ paths: 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.' @@ -522,7 +517,8 @@ paths: description: 'The Docker Compose custom build command.' docker_compose_domains: type: array - description: 'The Docker Compose domains.' + description: 'Array of URLs to be applied to containers of a dockercompose application.' + items: { properties: { name: { type: string, description: 'The service name as defined in docker-compose.' }, domain: { type: string, description: 'Comma-separated list of URLs (e.g. "http://app.coolify.io,https://app2.coolify.io")' } }, type: object } watch_paths: type: string description: 'The watch paths.' @@ -785,9 +781,6 @@ paths: 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.' @@ -796,7 +789,8 @@ paths: description: 'The Docker Compose custom build command.' docker_compose_domains: type: array - description: 'The Docker Compose domains.' + description: 'Array of URLs to be applied to containers of a dockercompose application.' + items: { properties: { name: { type: string, description: 'The service name as defined in docker-compose.' }, domain: { type: string, description: 'Comma-separated list of URLs (e.g. "http://app.coolify.io,https://app2.coolify.io")' } }, type: object } watch_paths: type: string description: 'The watch paths.' @@ -860,8 +854,8 @@ paths: post: tags: - Applications - summary: 'Create (Dockerfile)' - description: 'Create new application based on a simple Dockerfile.' + summary: 'Create (Dockerfile without git)' + description: 'Create new application based on a simple Dockerfile (without git).' operationId: create-dockerfile-application requestBody: description: 'Application object that needs to be created.' @@ -1081,8 +1075,8 @@ paths: post: tags: - Applications - summary: 'Create (Docker Image)' - description: 'Create new application based on a prebuilt docker image' + summary: 'Create (Docker Image without git)' + description: 'Create new application based on a prebuilt docker image (without git).' operationId: create-dockerimage-application requestBody: description: 'Application object that needs to be created.' @@ -1293,8 +1287,8 @@ paths: post: tags: - Applications - summary: 'Create (Docker Compose)' - description: 'Create new application based on a docker-compose file.' + summary: 'Create (Docker Compose) (Deprecated)' + description: 'Create new application based on a docker-compose file (without git).' operationId: create-dockercompose-application requestBody: description: 'Application object that needs to be created.' @@ -1374,6 +1368,7 @@ paths: warning: { type: string, example: 'Using the same domain for multiple resources can cause routing conflicts and unpredictable behavior.' } conflicts: { type: array, items: { properties: { domain: { type: string, example: example.com }, resource_name: { type: string, example: 'My Application' }, resource_uuid: { type: string, nullable: true, example: abc123-def456 }, resource_type: { type: string, enum: [application, service, instance], example: application }, message: { type: string, example: "Domain example.com is already in use by application 'My Application'" } }, type: object } } type: object + deprecated: true security: - bearerAuth: [] @@ -1665,9 +1660,6 @@ paths: 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.' @@ -1676,7 +1668,8 @@ paths: description: 'The Docker Compose custom build command.' docker_compose_domains: type: array - description: 'The Docker Compose domains.' + description: 'Array of URLs to be applied to containers of a dockercompose application.' + items: { properties: { name: { type: string, description: 'The service name as defined in docker-compose.' }, domain: { type: string, description: 'Comma-separated list of URLs (e.g. "http://app.coolify.io,https://app2.coolify.io")' } }, type: object } watch_paths: type: string description: 'The watch paths.'