From e232b9d122df061f00cd6eddce5dd3814bfc4f74 Mon Sep 17 00:00:00 2001 From: yusing Date: Tue, 23 Dec 2025 17:18:13 +0800 Subject: [PATCH] chore(swagger): update swagger regarding new docker config structure --- internal/api/v1/docs/swagger.json | 75 +++++++++++++++++++++++++++++-- internal/api/v1/docs/swagger.yaml | 42 ++++++++++++++--- 2 files changed, 108 insertions(+), 9 deletions(-) diff --git a/internal/api/v1/docs/swagger.json b/internal/api/v1/docs/swagger.json index ce63ac61..9cea7db6 100644 --- a/internal/api/v1/docs/swagger.json +++ b/internal/api/v1/docs/swagger.json @@ -2458,8 +2458,8 @@ "x-nullable": false, "x-omitempty": false }, - "docker_host": { - "type": "string", + "docker_cfg": { + "$ref": "#/definitions/DockerProviderConfig", "x-nullable": false, "x-omitempty": false }, @@ -2715,7 +2715,7 @@ "required": [ "container_id", "container_name", - "docker_host" + "docker_cfg" ], "properties": { "container_id": { @@ -2728,7 +2728,24 @@ "x-nullable": false, "x-omitempty": false }, - "docker_host": { + "docker_cfg": { + "$ref": "#/definitions/DockerProviderConfig", + "x-nullable": false, + "x-omitempty": false + } + }, + "x-nullable": false, + "x-omitempty": false + }, + "DockerProviderConfig": { + "type": "object", + "properties": { + "tls": { + "$ref": "#/definitions/DockerTLSConfig", + "x-nullable": false, + "x-omitempty": false + }, + "url": { "type": "string", "x-nullable": false, "x-omitempty": false @@ -2737,6 +2754,27 @@ "x-nullable": false, "x-omitempty": false }, + "DockerTLSConfig": { + "type": "object", + "required": [ + "ca_file" + ], + "properties": { + "ca_file": { + "type": "string", + "x-nullable": false, + "x-omitempty": false + }, + "cert_file": { + "type": "string" + }, + "key_file": { + "type": "string" + } + }, + "x-nullable": false, + "x-omitempty": false + }, "ErrorResponse": { "type": "object", "properties": { @@ -3430,6 +3468,11 @@ "x-nullable": false, "x-omitempty": false }, + "no_loading_page": { + "type": "boolean", + "x-nullable": false, + "x-omitempty": false + }, "proxmox": { "$ref": "#/definitions/ProxmoxConfig", "x-nullable": false, @@ -4234,6 +4277,12 @@ ], "x-nullable": true }, + "index": { + "description": "Index file to serve for single-page app mode", + "type": "string", + "x-nullable": false, + "x-omitempty": false + }, "load_balance": { "allOf": [ { @@ -4315,6 +4364,12 @@ "x-nullable": false, "x-omitempty": false }, + "spa": { + "description": "Single-page app mode: serves index for non-existent paths", + "type": "boolean", + "x-nullable": false, + "x-omitempty": false + }, "ssl_certificate": { "description": "Path to client certificate", "type": "string", @@ -5354,6 +5409,12 @@ ], "x-nullable": true }, + "index": { + "description": "Index file to serve for single-page app mode", + "type": "string", + "x-nullable": false, + "x-omitempty": false + }, "load_balance": { "allOf": [ { @@ -5435,6 +5496,12 @@ "x-nullable": false, "x-omitempty": false }, + "spa": { + "description": "Single-page app mode: serves index for non-existent paths", + "type": "boolean", + "x-nullable": false, + "x-omitempty": false + }, "ssl_certificate": { "description": "Path to client certificate", "type": "string", diff --git a/internal/api/v1/docs/swagger.yaml b/internal/api/v1/docs/swagger.yaml index 4f1bdcf7..e6744d88 100644 --- a/internal/api/v1/docs/swagger.yaml +++ b/internal/api/v1/docs/swagger.yaml @@ -57,8 +57,8 @@ definitions: type: string container_name: type: string - docker_host: - type: string + docker_cfg: + $ref: '#/definitions/DockerProviderConfig' errors: type: string idlewatcher_config: @@ -192,12 +192,30 @@ definitions: type: string container_name: type: string - docker_host: - type: string + docker_cfg: + $ref: '#/definitions/DockerProviderConfig' required: - container_id - container_name - - docker_host + - docker_cfg + type: object + DockerProviderConfig: + properties: + tls: + $ref: '#/definitions/DockerTLSConfig' + url: + type: string + type: object + DockerTLSConfig: + properties: + ca_file: + type: string + cert_file: + type: string + key_file: + type: string + required: + - ca_file type: object ErrorResponse: properties: @@ -517,6 +535,8 @@ definitions: description: "0: no idle watcher.\nPositive: idle watcher with idle timeout.\nNegative: idle watcher as a dependency.\tIdleTimeout time.Duration `json:\"idle_timeout\" json_ext:\"duration\"`" + no_loading_page: + type: boolean proxmox: $ref: '#/definitions/ProxmoxConfig' start_endpoint: @@ -897,6 +917,9 @@ definitions: allOf: - $ref: '#/definitions/IdlewatcherConfig' x-nullable: true + index: + description: Index file to serve for single-page app mode + type: string load_balance: allOf: - $ref: '#/definitions/LoadBalancerConfig' @@ -944,6 +967,9 @@ definitions: - udp - fileserver type: string + spa: + description: 'Single-page app mode: serves index for non-existent paths' + type: boolean ssl_certificate: description: Path to client certificate type: string @@ -1504,6 +1530,9 @@ definitions: allOf: - $ref: '#/definitions/IdlewatcherConfig' x-nullable: true + index: + description: Index file to serve for single-page app mode + type: string load_balance: allOf: - $ref: '#/definitions/LoadBalancerConfig' @@ -1551,6 +1580,9 @@ definitions: - udp - fileserver type: string + spa: + description: 'Single-page app mode: serves index for non-existent paths' + type: boolean ssl_certificate: description: Path to client certificate type: string