api: swagger: POST /networks/create: document Scope, ConfigOnly, Conf…

…igFrom Adds missing documentation for Scope, ConfigOnly, and ConfigFrom. The ConfigOnly and ConfigFrom fields were added in 9ee7b4d, but not documented in the API docs / swagger. Signed-off-by: Sebastiaan van Stijn <[email protected]>
trebonian · May 27, 2024 · 4412553 · 4412553
1 parent 8b7a54f
commit 4412553
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/api/swagger.yaml b/api/swagger.yaml
@@ -10174,6 +10174,11 @@ paths:
                 type: "string"
                 default: "bridge"
                 example: "bridge"
+              Scope:
+                description: |
+                  The level at which the network exists (e.g. `swarm` for cluster-wide
+                  or `local` for machine level).
+                type: "string"
               Internal:
                 description: "Restrict external access to the network."
                 type: "boolean"
@@ -10189,6 +10194,21 @@ paths:
                   in swarm mode.
                 type: "boolean"
                 example: false
+              ConfigOnly:
+                description: |
+                  Creates a config-only network. Config-only networks are placeholder
+                  networks for network configurations to be used by other networks.
+                  Config-only networks cannot be used directly to run containers
+                  or services.
+                type: "boolean"
+                default: false
+                example: false
+              ConfigFrom:
+                description: |
+                  Specifies the source which will provide the configuration for
+                  this network. The specified network must be an existing
+                  config-only network; see ConfigOnly.
+                $ref: "#/definitions/ConfigReference"
               IPAM:
                 description: "Optional custom IP scheme for the network."
                 $ref: "#/definitions/IPAM"