From 608fdeb2169851ce3aee6415645f0eddc9d24dbe Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Fri, 5 Sep 2025 18:08:23 +0200 Subject: [PATCH] api/swagger: remove temporary "full" example for image config MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This example was added in 5e0e34fafdb4cd9904aac420dbb6dd4aa11c04c8 so that the deprecated fields could be omitted from the example. Those fields were removed from the swagger in 4dc961d0e922381b8cd5e05223f172f3145c7494, but the temporary example was not removed. This patch removes the example, in favor of the per-field examples, which were already in place. Signed-off-by: Sebastiaan van Stijn (cherry picked from commit 7bfbb6e8ca62f92216543e8473a8183bf00557e1) Signed-off-by: Paweł Gronowski --- api/swagger.yaml | 31 ------------------------------- docs/api/v1.51.yaml | 31 ------------------------------- 2 files changed, 62 deletions(-) diff --git a/api/swagger.yaml b/api/swagger.yaml index 1401fa7153..fd69add127 100644 --- a/api/swagger.yaml +++ b/api/swagger.yaml @@ -1531,37 +1531,6 @@ definitions: items: type: "string" example: ["/bin/sh", "-c"] - # FIXME(thaJeztah): temporarily using a full example to remove some "omitempty" fields. Remove once the fields are removed. - example: - "User": "web:web" - "ExposedPorts": { - "80/tcp": {}, - "443/tcp": {} - } - "Env": ["PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"] - "Cmd": ["/bin/sh"] - "Healthcheck": { - "Test": ["string"], - "Interval": 0, - "Timeout": 0, - "Retries": 0, - "StartPeriod": 0, - "StartInterval": 0 - } - "ArgsEscaped": true - "Volumes": { - "/app/data": {}, - "/app/config": {} - } - "WorkingDir": "/public/" - "Entrypoint": [] - "OnBuild": [] - "Labels": { - "com.example.some-label": "some-value", - "com.example.some-other-label": "some-other-value" - } - "StopSignal": "SIGTERM" - "Shell": ["/bin/sh", "-c"] NetworkingConfig: description: | diff --git a/docs/api/v1.51.yaml b/docs/api/v1.51.yaml index 1401fa7153..fd69add127 100644 --- a/docs/api/v1.51.yaml +++ b/docs/api/v1.51.yaml @@ -1531,37 +1531,6 @@ definitions: items: type: "string" example: ["/bin/sh", "-c"] - # FIXME(thaJeztah): temporarily using a full example to remove some "omitempty" fields. Remove once the fields are removed. - example: - "User": "web:web" - "ExposedPorts": { - "80/tcp": {}, - "443/tcp": {} - } - "Env": ["PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"] - "Cmd": ["/bin/sh"] - "Healthcheck": { - "Test": ["string"], - "Interval": 0, - "Timeout": 0, - "Retries": 0, - "StartPeriod": 0, - "StartInterval": 0 - } - "ArgsEscaped": true - "Volumes": { - "/app/data": {}, - "/app/config": {} - } - "WorkingDir": "/public/" - "Entrypoint": [] - "OnBuild": [] - "Labels": { - "com.example.some-label": "some-value", - "com.example.some-other-label": "some-other-value" - } - "StopSignal": "SIGTERM" - "Shell": ["/bin/sh", "-c"] NetworkingConfig: description: |