Update Compose reference API to v2.20.0 (#17718)

Signed-off-by: GitHub <noreply@github.com>
Co-authored-by: glours <glours@users.noreply.github.com>

_config.yml

@@ -45,7 +45,7 @@ exclude:
 latest_engine_api_version: "1.43"
 docker_ce_version: "24.0.0"
 compose_v1_version: "1.29.2"
-compose_version: "v2.19.1"
+compose_version: "v2.20.0"
 compose_file_v3: "3.8"
 compose_file_v2: "2.4"
 machine_version: "0.16.0"

_data/compose-cli/docker_compose.yaml

@@ -171,6 +171,7 @@ cname:
     - docker compose unpause
     - docker compose up
     - docker compose version
+    - docker compose wait
 clink:
     - docker_compose_build.yaml
     - docker_compose_config.yaml
@@ -197,6 +198,7 @@ clink:
     - docker_compose_unpause.yaml
     - docker_compose_up.yaml
     - docker_compose_version.yaml
+    - docker_compose_wait.yaml
 options:
     - option: ansi
       value_type: string
@@ -345,6 +347,7 @@ options:
       kubernetes: false
       swarm: false
 deprecated: false
+hidden: false
 experimental: false
 experimentalcli: false
 kubernetes: false

_data/compose-cli/docker_compose_alpha.yaml

@@ -21,6 +21,7 @@ inherited_options:
       kubernetes: false
       swarm: false
 deprecated: false
+hidden: true
 experimental: false
 experimentalcli: true
 kubernetes: false

_data/compose-cli/docker_compose_alpha_viz.yaml

@@ -69,6 +69,7 @@ inherited_options:
       kubernetes: false
       swarm: false
 deprecated: false
+hidden: false
 experimental: false
 experimentalcli: true
 kubernetes: false

_data/compose-cli/docker_compose_alpha_watch.yaml

@@ -29,6 +29,7 @@ inherited_options:
       kubernetes: false
       swarm: false
 deprecated: false
+hidden: false
 experimental: false
 experimentalcli: true
 kubernetes: false

_data/compose-cli/docker_compose_build.yaml

@@ -24,6 +24,15 @@ options:
       experimentalcli: false
       kubernetes: false
       swarm: false
+    - option: builder
+      value_type: string
+      description: Set builder to use.
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
     - option: compress
       value_type: bool
       default_value: "true"
@@ -150,6 +159,7 @@ inherited_options:
       kubernetes: false
       swarm: false
 deprecated: false
+hidden: false
 experimental: false
 experimentalcli: false
 kubernetes: false

_data/compose-cli/docker_compose_config.yaml

@@ -152,6 +152,7 @@ inherited_options:
       kubernetes: false
       swarm: false
 deprecated: false
+hidden: false
 experimental: false
 experimentalcli: false
 kubernetes: false

_data/compose-cli/docker_compose_cp.yaml

@@ -10,7 +10,7 @@ options:
     - option: all
       value_type: bool
       default_value: "false"
-      description: Copy to all the containers of the service.
+      description: copy to all the containers of the service.
       deprecated: true
       hidden: true
       experimental: false
@@ -42,8 +42,7 @@ options:
     - option: index
       value_type: int
       default_value: "0"
-      description: |
-        Index of the container if there are multiple instances of a service .
+      description: index of the container if service has multiple replicas
       deprecated: false
       hidden: false
       experimental: false
@@ -62,6 +61,7 @@ inherited_options:
       kubernetes: false
       swarm: false
 deprecated: false
+hidden: false
 experimental: false
 experimentalcli: false
 kubernetes: false

_data/compose-cli/docker_compose_create.yaml

@@ -90,6 +90,7 @@ inherited_options:
       kubernetes: false
       swarm: false
 deprecated: false
+hidden: false
 experimental: false
 experimentalcli: false
 kubernetes: false

_data/compose-cli/docker_compose_down.yaml

@@ -73,6 +73,7 @@ inherited_options:
       kubernetes: false
       swarm: false
 deprecated: false
+hidden: false
 experimental: false
 experimentalcli: false
 kubernetes: false

_data/compose-cli/docker_compose_events.yaml

@@ -46,6 +46,7 @@ inherited_options:
       kubernetes: false
       swarm: false
 deprecated: false
+hidden: false
 experimental: false
 experimentalcli: false
 kubernetes: false

_data/compose-cli/docker_compose_exec.yaml

@@ -33,9 +33,8 @@ options:
       swarm: false
     - option: index
       value_type: int
-      default_value: "1"
-      description: |
-        index of the container if there are multiple instances of a service [default: 1].
+      default_value: "0"
+      description: index of the container if service has multiple replicas
       deprecated: false
       hidden: false
       experimental: false
@@ -118,6 +117,7 @@ inherited_options:
       kubernetes: false
       swarm: false
 deprecated: false
+hidden: false
 experimental: false
 experimentalcli: false
 kubernetes: false

_data/compose-cli/docker_compose_images.yaml

@@ -38,6 +38,7 @@ inherited_options:
       kubernetes: false
       swarm: false
 deprecated: false
+hidden: false
 experimental: false
 experimentalcli: false
 kubernetes: false

_data/compose-cli/docker_compose_kill.yaml

@@ -43,6 +43,7 @@ inherited_options:
       kubernetes: false
       swarm: false
 deprecated: false
+hidden: false
 experimental: false
 experimentalcli: false
 kubernetes: false

_data/compose-cli/docker_compose_logs.yaml

@@ -91,6 +91,7 @@ inherited_options:
       kubernetes: false
       swarm: false
 deprecated: false
+hidden: false
 experimental: false
 experimentalcli: false
 kubernetes: false

_data/compose-cli/docker_compose_ls.yaml

@@ -58,6 +58,7 @@ inherited_options:
       kubernetes: false
       swarm: false
 deprecated: false
+hidden: false
 experimental: false
 experimentalcli: false
 kubernetes: false

_data/compose-cli/docker_compose_pause.yaml

@@ -17,6 +17,7 @@ inherited_options:
       kubernetes: false
       swarm: false
 deprecated: false
+hidden: false
 experimental: false
 experimentalcli: false
 kubernetes: false

_data/compose-cli/docker_compose_port.yaml

@@ -7,7 +7,7 @@ plink: docker_compose.yaml
 options:
     - option: index
       value_type: int
-      default_value: "1"
+      default_value: "0"
       description: index of the container if service has multiple replicas
       deprecated: false
       hidden: false
@@ -37,6 +37,7 @@ inherited_options:
       kubernetes: false
       swarm: false
 deprecated: false
+hidden: false
 experimental: false
 experimentalcli: false
 kubernetes: false

_data/compose-cli/docker_compose_ps.yaml

@@ -180,6 +180,7 @@ examples: |-
     The `docker compose ps` command currently only supports the `--filter status=<status>`
     option, but additional filter options may be added in the future.
 deprecated: false
+hidden: false
 experimental: false
 experimentalcli: false
 kubernetes: false

_data/compose-cli/docker_compose_pull.yaml

@@ -124,6 +124,7 @@ examples: |-
     `docker compose pull` will try to pull image for services with a build section. If pull fails, it will let
     user know this service image MUST be built. You can skip this by setting `--ignore-buildable` flag
 deprecated: false
+hidden: false
 experimental: false
 experimentalcli: false
 kubernetes: false

_data/compose-cli/docker_compose_push.yaml

@@ -66,6 +66,7 @@ inherited_options:
       kubernetes: false
       swarm: false
 deprecated: false
+hidden: false
 experimental: false
 experimentalcli: false
 kubernetes: false

_data/compose-cli/docker_compose_restart.yaml

@@ -48,6 +48,7 @@ inherited_options:
       kubernetes: false
       swarm: false
 deprecated: false
+hidden: false
 experimental: false
 experimentalcli: false
 kubernetes: false

_data/compose-cli/docker_compose_rm.yaml

@@ -76,6 +76,7 @@ inherited_options:
       kubernetes: false
       swarm: false
 deprecated: false
+hidden: false
 experimental: false
 experimentalcli: false
 kubernetes: false

_data/compose-cli/docker_compose_run.yaml

@@ -286,6 +286,7 @@ inherited_options:
       kubernetes: false
       swarm: false
 deprecated: false
+hidden: false
 experimental: false
 experimentalcli: false
 kubernetes: false

_data/compose-cli/docker_compose_start.yaml

@@ -16,6 +16,7 @@ inherited_options:
       kubernetes: false
       swarm: false
 deprecated: false
+hidden: false
 experimental: false
 experimentalcli: false
 kubernetes: false

_data/compose-cli/docker_compose_stop.yaml

@@ -29,6 +29,7 @@ inherited_options:
       kubernetes: false
       swarm: false
 deprecated: false
+hidden: false
 experimental: false
 experimentalcli: false
 kubernetes: false

_data/compose-cli/docker_compose_top.yaml

@@ -23,6 +23,7 @@ examples: |-
     root   142353   142331   2    15:33   ?     00:00:00   ping localhost -c 5
     ```
 deprecated: false
+hidden: false
 experimental: false
 experimentalcli: false
 kubernetes: false

_data/compose-cli/docker_compose_unpause.yaml

@@ -16,6 +16,7 @@ inherited_options:
       kubernetes: false
       swarm: false
 deprecated: false
+hidden: false
 experimental: false
 experimentalcli: false
 kubernetes: false

_data/compose-cli/docker_compose_up.yaml

@@ -285,6 +285,7 @@ inherited_options:
       kubernetes: false
       swarm: false
 deprecated: false
+hidden: false
 experimental: false
 experimentalcli: false
 kubernetes: false

_data/compose-cli/docker_compose_version.yaml

@@ -37,6 +37,7 @@ inherited_options:
       kubernetes: false
       swarm: false
 deprecated: false
+hidden: false
 experimental: false
 experimentalcli: false
 kubernetes: false

_data/compose-cli/docker_compose_wait.yaml

@@ -0,0 +1,35 @@
+command: docker compose wait
+short: Block until the first service container stops
+long: Block until the first service container stops
+usage: docker compose wait SERVICE [SERVICE...] [OPTIONS]
+pname: docker compose
+plink: docker_compose.yaml
+options:
+    - option: down-project
+      value_type: bool
+      default_value: "false"
+      description: Drops project when the first container stops
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+inherited_options:
+    - option: dry-run
+      value_type: bool
+      default_value: "false"
+      description: Execute command in dry run mode
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+deprecated: false
+hidden: false
+experimental: false
+experimentalcli: false
+kubernetes: false
+swarm: false
+