From 32bcbdfe657c8bd37c6ee88ac76a47533495442e Mon Sep 17 00:00:00 2001 From: Milas Bowman Date: Mon, 1 Aug 2022 16:06:08 -0400 Subject: [PATCH 1/6] api: swagger: add missing "force" query arg on plugin disable This has been around for a long time - since v17.04 (API v1.28) but was never documented. It allows removing a plugin even if it's still in use. Signed-off-by: Milas Bowman (cherry picked from commit eb0edeafddb65794dbd958267d89a2f7981b02c8) Signed-off-by: Sebastiaan van Stijn --- api/swagger.yaml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/api/swagger.yaml b/api/swagger.yaml index 98da60c89e..00b8690d5b 100644 --- a/api/swagger.yaml +++ b/api/swagger.yaml @@ -10363,6 +10363,12 @@ paths: default if omitted. required: true type: "string" + - name: "force" + in: "query" + description: | + Force disable a plugin even if still in use. + required: false + type: "boolean" tags: ["Plugin"] /plugins/{name}/upgrade: post: From 50fb65f0f534d85c9e8aed1ee3fefadfbc1d5eda Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Sun, 2 Jul 2023 12:50:28 +0200 Subject: [PATCH 2/6] docs: api: amend changelog for API 1.28 for "force" option This option was added in 8cb2229cd18c53bdbf36301f26db565a50027d6a for API version 1.28, but forgot to update the documentation and version history. Signed-off-by: Sebastiaan van Stijn (cherry picked from commit aba8e04ab1e6536bf51fd27f1941d2410b04d028) Signed-off-by: Sebastiaan van Stijn --- docs/api/version-history.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/api/version-history.md b/docs/api/version-history.md index f5f20f503d..da04e3f2d3 100644 --- a/docs/api/version-history.md +++ b/docs/api/version-history.md @@ -475,6 +475,7 @@ keywords: "API, Docker, rcli, REST, documentation" * `POST /services/create` and `POST /services/(id or name)/update` now accept an optional `RollbackConfig` object which specifies rollback options. * `GET /services` now supports a `mode` filter to filter services based on the service mode (either `global` or `replicated`). * `POST /containers/(name)/update` now supports updating `NanoCpus` that represents CPU quota in units of 10-9 CPUs. +* `POST /plugins/{name}/disable` now accepts a `force` query-parameter to disable a plugin even if still in use. ## v1.27 API changes From b732cfd3928e5efb4bdd36154503a9d1a1f42c69 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Sun, 2 Jul 2023 13:02:32 +0200 Subject: [PATCH 3/6] docs: api v1.43: add missing "force" query arg on plugin disable This option was added in 8cb2229cd18c53bdbf36301f26db565a50027d6a for API version 1.28, but forgot to update the documentation and version history. Signed-off-by: Sebastiaan van Stijn (cherry picked from commit 85ccb25eb8ef72837e50330acf390d7b44157e8b) Signed-off-by: Sebastiaan van Stijn --- docs/api/v1.43.yaml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/api/v1.43.yaml b/docs/api/v1.43.yaml index 98da60c89e..00b8690d5b 100644 --- a/docs/api/v1.43.yaml +++ b/docs/api/v1.43.yaml @@ -10363,6 +10363,12 @@ paths: default if omitted. required: true type: "string" + - name: "force" + in: "query" + description: | + Force disable a plugin even if still in use. + required: false + type: "boolean" tags: ["Plugin"] /plugins/{name}/upgrade: post: From b5aacf8161c99dcd6e04304b14846db7c5094951 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Sun, 2 Jul 2023 13:02:45 +0200 Subject: [PATCH 4/6] docs: api v1.42: add missing "force" query arg on plugin disable This option was added in 8cb2229cd18c53bdbf36301f26db565a50027d6a for API version 1.28, but forgot to update the documentation and version history. Signed-off-by: Sebastiaan van Stijn (cherry picked from commit a4bdfb963fbb6f8d3f86c4731033362224b5c083) Signed-off-by: Sebastiaan van Stijn --- docs/api/v1.42.yaml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/api/v1.42.yaml b/docs/api/v1.42.yaml index 7b3dbd65b3..cb9c2491d3 100644 --- a/docs/api/v1.42.yaml +++ b/docs/api/v1.42.yaml @@ -10345,6 +10345,12 @@ paths: default if omitted. required: true type: "string" + - name: "force" + in: "query" + description: | + Force disable a plugin even if still in use. + required: false + type: "boolean" tags: ["Plugin"] /plugins/{name}/upgrade: post: From 7adb590e162da0974b32741e499d0973d3c9255d Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Sun, 2 Jul 2023 13:02:57 +0200 Subject: [PATCH 5/6] docs: api v1.41: add missing "force" query arg on plugin disable This option was added in 8cb2229cd18c53bdbf36301f26db565a50027d6a for API version 1.28, but forgot to update the documentation and version history. Signed-off-by: Sebastiaan van Stijn (cherry picked from commit 892e9f2c23ad20009c8d3f4c6b5fdf7ff772f0e4) Signed-off-by: Sebastiaan van Stijn --- docs/api/v1.41.yaml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/api/v1.41.yaml b/docs/api/v1.41.yaml index 0b9e655900..e0545039d3 100644 --- a/docs/api/v1.41.yaml +++ b/docs/api/v1.41.yaml @@ -9967,6 +9967,12 @@ paths: default if omitted. required: true type: "string" + - name: "force" + in: "query" + description: | + Force disable a plugin even if still in use. + required: false + type: "boolean" tags: ["Plugin"] /plugins/{name}/upgrade: post: From 5892aae60fe4ef681720606afed51e67fc2a7f86 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Sun, 2 Jul 2023 13:04:06 +0200 Subject: [PATCH 6/6] docs: api v1.28 - v1.40: add missing "force" query arg on plugin disable This option was added in 8cb2229cd18c53bdbf36301f26db565a50027d6a for API version 1.28, but forgot to update the documentation and version history. Signed-off-by: Sebastiaan van Stijn (cherry picked from commit f6258f70cb43b12654e2c185ea0aea234485013d) Signed-off-by: Sebastiaan van Stijn --- docs/api/v1.28.yaml | 6 ++++++ docs/api/v1.29.yaml | 6 ++++++ docs/api/v1.30.yaml | 6 ++++++ docs/api/v1.31.yaml | 6 ++++++ docs/api/v1.32.yaml | 6 ++++++ docs/api/v1.33.yaml | 6 ++++++ docs/api/v1.34.yaml | 6 ++++++ docs/api/v1.35.yaml | 6 ++++++ docs/api/v1.36.yaml | 6 ++++++ docs/api/v1.37.yaml | 6 ++++++ docs/api/v1.38.yaml | 6 ++++++ docs/api/v1.39.yaml | 6 ++++++ docs/api/v1.40.yaml | 6 ++++++ 13 files changed, 78 insertions(+) diff --git a/docs/api/v1.28.yaml b/docs/api/v1.28.yaml index 52c2fa4165..44bb67f025 100644 --- a/docs/api/v1.28.yaml +++ b/docs/api/v1.28.yaml @@ -6839,6 +6839,12 @@ paths: description: "The name of the plugin. The `:latest` tag is optional, and is the default if omitted." required: true type: "string" + - name: "force" + in: "query" + description: | + Force disable a plugin even if still in use. + required: false + type: "boolean" tags: ["Plugin"] /plugins/{name}/upgrade: post: diff --git a/docs/api/v1.29.yaml b/docs/api/v1.29.yaml index d675b7c619..ed69b68892 100644 --- a/docs/api/v1.29.yaml +++ b/docs/api/v1.29.yaml @@ -6881,6 +6881,12 @@ paths: description: "The name of the plugin. The `:latest` tag is optional, and is the default if omitted." required: true type: "string" + - name: "force" + in: "query" + description: | + Force disable a plugin even if still in use. + required: false + type: "boolean" tags: ["Plugin"] /plugins/{name}/upgrade: post: diff --git a/docs/api/v1.30.yaml b/docs/api/v1.30.yaml index e3c8e4280e..535a6205e2 100644 --- a/docs/api/v1.30.yaml +++ b/docs/api/v1.30.yaml @@ -7105,6 +7105,12 @@ paths: description: "The name of the plugin. The `:latest` tag is optional, and is the default if omitted." required: true type: "string" + - name: "force" + in: "query" + description: | + Force disable a plugin even if still in use. + required: false + type: "boolean" tags: ["Plugin"] /plugins/{name}/upgrade: post: diff --git a/docs/api/v1.31.yaml b/docs/api/v1.31.yaml index e38e6eb9aa..8535ffe237 100644 --- a/docs/api/v1.31.yaml +++ b/docs/api/v1.31.yaml @@ -7203,6 +7203,12 @@ paths: description: "The name of the plugin. The `:latest` tag is optional, and is the default if omitted." required: true type: "string" + - name: "force" + in: "query" + description: | + Force disable a plugin even if still in use. + required: false + type: "boolean" tags: ["Plugin"] /plugins/{name}/upgrade: post: diff --git a/docs/api/v1.32.yaml b/docs/api/v1.32.yaml index 1dfd274f44..b843bc6340 100644 --- a/docs/api/v1.32.yaml +++ b/docs/api/v1.32.yaml @@ -8248,6 +8248,12 @@ paths: description: "The name of the plugin. The `:latest` tag is optional, and is the default if omitted." required: true type: "string" + - name: "force" + in: "query" + description: | + Force disable a plugin even if still in use. + required: false + type: "boolean" tags: ["Plugin"] /plugins/{name}/upgrade: post: diff --git a/docs/api/v1.33.yaml b/docs/api/v1.33.yaml index 1d4034fbd0..3fa7eb43d5 100644 --- a/docs/api/v1.33.yaml +++ b/docs/api/v1.33.yaml @@ -8257,6 +8257,12 @@ paths: description: "The name of the plugin. The `:latest` tag is optional, and is the default if omitted." required: true type: "string" + - name: "force" + in: "query" + description: | + Force disable a plugin even if still in use. + required: false + type: "boolean" tags: ["Plugin"] /plugins/{name}/upgrade: post: diff --git a/docs/api/v1.34.yaml b/docs/api/v1.34.yaml index 966b090e59..d90d4dbbf8 100644 --- a/docs/api/v1.34.yaml +++ b/docs/api/v1.34.yaml @@ -8298,6 +8298,12 @@ paths: description: "The name of the plugin. The `:latest` tag is optional, and is the default if omitted." required: true type: "string" + - name: "force" + in: "query" + description: | + Force disable a plugin even if still in use. + required: false + type: "boolean" tags: ["Plugin"] /plugins/{name}/upgrade: post: diff --git a/docs/api/v1.35.yaml b/docs/api/v1.35.yaml index 2591fb6a2e..a3ed149466 100644 --- a/docs/api/v1.35.yaml +++ b/docs/api/v1.35.yaml @@ -8310,6 +8310,12 @@ paths: description: "The name of the plugin. The `:latest` tag is optional, and is the default if omitted." required: true type: "string" + - name: "force" + in: "query" + description: | + Force disable a plugin even if still in use. + required: false + type: "boolean" tags: ["Plugin"] /plugins/{name}/upgrade: post: diff --git a/docs/api/v1.36.yaml b/docs/api/v1.36.yaml index aa808e48b4..d5f4da5440 100644 --- a/docs/api/v1.36.yaml +++ b/docs/api/v1.36.yaml @@ -8354,6 +8354,12 @@ paths: description: "The name of the plugin. The `:latest` tag is optional, and is the default if omitted." required: true type: "string" + - name: "force" + in: "query" + description: | + Force disable a plugin even if still in use. + required: false + type: "boolean" tags: ["Plugin"] /plugins/{name}/upgrade: post: diff --git a/docs/api/v1.37.yaml b/docs/api/v1.37.yaml index 79496b06ef..b9290e1fea 100644 --- a/docs/api/v1.37.yaml +++ b/docs/api/v1.37.yaml @@ -8397,6 +8397,12 @@ paths: description: "The name of the plugin. The `:latest` tag is optional, and is the default if omitted." required: true type: "string" + - name: "force" + in: "query" + description: | + Force disable a plugin even if still in use. + required: false + type: "boolean" tags: ["Plugin"] /plugins/{name}/upgrade: post: diff --git a/docs/api/v1.38.yaml b/docs/api/v1.38.yaml index 4d1a28e548..af7b11817d 100644 --- a/docs/api/v1.38.yaml +++ b/docs/api/v1.38.yaml @@ -8458,6 +8458,12 @@ paths: description: "The name of the plugin. The `:latest` tag is optional, and is the default if omitted." required: true type: "string" + - name: "force" + in: "query" + description: | + Force disable a plugin even if still in use. + required: false + type: "boolean" tags: ["Plugin"] /plugins/{name}/upgrade: post: diff --git a/docs/api/v1.39.yaml b/docs/api/v1.39.yaml index 5e565b4dc1..b7d7943af5 100644 --- a/docs/api/v1.39.yaml +++ b/docs/api/v1.39.yaml @@ -9445,6 +9445,12 @@ paths: default if omitted. required: true type: "string" + - name: "force" + in: "query" + description: | + Force disable a plugin even if still in use. + required: false + type: "boolean" tags: ["Plugin"] /plugins/{name}/upgrade: post: diff --git a/docs/api/v1.40.yaml b/docs/api/v1.40.yaml index 818f849390..98df085393 100644 --- a/docs/api/v1.40.yaml +++ b/docs/api/v1.40.yaml @@ -9760,6 +9760,12 @@ paths: default if omitted. required: true type: "string" + - name: "force" + in: "query" + description: | + Force disable a plugin even if still in use. + required: false + type: "boolean" tags: ["Plugin"] /plugins/{name}/upgrade: post: