Update Compose reference API to v2.17.0 (#16943)

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.42"
 docker_ce_version: "23.0.0"
 compose_v1_version: "1.29.2"
-compose_version: "v2.16.0"
+compose_version: "v2.17.0"
 compose_file_v3: "3.9"
 compose_file_v2: "2.4"
 machine_version: "0.16.0"

_data/compose-cli/docker_compose.yaml

@@ -63,12 +63,19 @@ long: |-
 
     ### Use `-p` to specify a project name
 
-    Each configuration has a project name. If you supply a `-p` flag, you can specify a project name. If you don’t
+    Each configuration has a project name. Compose sets the project name using
-    specify the flag, Compose uses the current directory name.
+    the following mechanisms, in order of precedence:
-    Project name can also be set by `COMPOSE_PROJECT_NAME` environment variable.
+    - The `-p` command line flag
-
+    - The `COMPOSE_PROJECT_NAME` environment variable
-    Many Compose subcommands can be run without a Compose file by passing
+    - The top level `name:` variable from the config file (or the last `name:`
-    the project name.
+    from a series of config files specified using `-f`)
+    - The `basename` of the project directory containing the config file (or
+    containing the first config file specified using `-f`)
+    - The `basename` of the current directory if no config file is specified
+    Project names must contain only lowercase letters, decimal digits, dashes,
+    and underscores, and must begin with a lowercase letter or decimal digit. If
+    the `basename` of the project directory or current directory violates this
+    constraint, you must use one of the other mechanisms.
 
     ```console
     $ docker compose -p my_project ps -a
@@ -198,7 +205,8 @@ options:
       kubernetes: false
       swarm: false
     - option: env-file
-      value_type: string
+      value_type: stringArray
+      default_value: '[]'
       description: Specify an alternate environment file.
       deprecated: false
       hidden: false

_data/compose-cli/docker_compose_convert.yaml

@@ -0,0 +1,140 @@
+command: docker compose convert
+aliases: docker compose convert, docker compose config
+short: Converts the compose file to platform's canonical format
+long: |-
+    `docker compose convert` renders the actual data model to be applied on the target platform. When used with the Docker engine,
+    it merges the Compose files set by `-f` flags, resolves variables in the Compose file, and expands short-notation into
+    the canonical format.
+
+    To allow smooth migration from docker-compose, this subcommand declares alias `docker compose config`
+usage: docker compose convert [OPTIONS] [SERVICE...]
+pname: docker compose
+plink: docker_compose.yaml
+options:
+    - option: format
+      value_type: string
+      default_value: yaml
+      description: 'Format the output. Values: [yaml | json]'
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: hash
+      value_type: string
+      description: Print the service config hash, one per line.
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: images
+      value_type: bool
+      default_value: "false"
+      description: Print the image names, one per line.
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: no-consistency
+      value_type: bool
+      default_value: "false"
+      description: |
+        Don't check model consistency - warning: may produce invalid Compose output
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: no-interpolate
+      value_type: bool
+      default_value: "false"
+      description: Don't interpolate environment variables.
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: no-normalize
+      value_type: bool
+      default_value: "false"
+      description: Don't normalize compose model.
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: output
+      shorthand: o
+      value_type: string
+      description: Save to file (default to stdout)
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: profiles
+      value_type: bool
+      default_value: "false"
+      description: Print the profile names, one per line.
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: quiet
+      shorthand: q
+      value_type: bool
+      default_value: "false"
+      description: Only validate the configuration, don't print anything.
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: resolve-image-digests
+      value_type: bool
+      default_value: "false"
+      description: Pin image tags to digests.
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: services
+      value_type: bool
+      default_value: "false"
+      description: Print the service names, one per line.
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: volumes
+      value_type: bool
+      default_value: "false"
+      description: Print the volume names, one per line.
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+deprecated: false
+experimental: false
+experimentalcli: false
+kubernetes: false
+swarm: false
+

_data/compose-cli/docker_compose_restart.yaml

@@ -15,6 +15,16 @@ usage: docker compose restart [OPTIONS] [SERVICE...]
 pname: docker compose
 plink: docker_compose.yaml
 options:
+    - option: no-deps
+      value_type: bool
+      default_value: "false"
+      description: Don't restart dependent services.
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
     - option: timeout
       shorthand: t
       value_type: int

_data/compose-cli/docker_compose_up.yaml

@@ -231,18 +231,6 @@ options:
       experimentalcli: false
       kubernetes: false
       swarm: false
-    - option: timeout
-      shorthand: t
-      value_type: int
-      default_value: "10"
-      description: |
-        Use this timeout in seconds for container shutdown when attached or when containers are already running.
-      deprecated: false
-      hidden: false
-      experimental: false
-      experimentalcli: false
-      kubernetes: false
-      swarm: false
     - option: timestamps
       value_type: bool
       default_value: "false"
@@ -263,6 +251,28 @@ options:
       experimentalcli: false
       kubernetes: false
       swarm: false
+    - option: wait-timeout
+      value_type: int
+      default_value: "0"
+      description: timeout waiting for application to be running|healthy.
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: waitTimeout
+      shorthand: t
+      value_type: int
+      default_value: "10"
+      description: |
+        Use this waitTimeout in seconds for container shutdown when attached or when containers are already running.
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
 deprecated: false
 experimental: false
 experimentalcli: false