Skip to content

chore: use dynamic api version in example #21379

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 8, 2024
Merged

chore: use dynamic api version in example #21379

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions content/reference/api/engine/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,15 +99,21 @@
that incorporates the API version with the features you need.
- When using `curl` directly, specify the version as the first part of the URL.
For instance, if the endpoint is `/containers/` you can use
`/v1.47/containers/`.
`/v{{% param "latest_engine_api_version" %}}/containers/`.

Check failure on line 102 in content/reference/api/engine/_index.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'param'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'param'?", "location": {"path": "content/reference/api/engine/_index.md", "range": {"start": {"line": 102, "column": 10}}}, "severity": "ERROR"}
- To force the Docker CLI or the Docker Engine SDKs to use an older version
of the API than the version reported by `docker version`, set the
environment variable `DOCKER_API_VERSION` to the correct version. This works
on Linux, Windows, or macOS clients.

{{% apiVersionPrevious.inline %}}
{{- $version := site.Params.latest_engine_api_version }}
{{- $parts := strings.Split $version "." }}
{{- $major := cast.ToInt (index $parts 0) }}
{{- $minor := cast.ToInt (index $parts 1) }}
```console
$ DOCKER_API_VERSION=1.46
$ DOCKER_API_VERSION={{ $major }}.{{ math.Sub $minor 1 }}
```
{{% /apiVersionPrevious.inline %}}

While the environment variable is set, that version of the API is used, even
if the Docker daemon supports a newer version. This environment variable
Expand Down