Add example buildargs usage

Signed-off-by: Jon Surrell <jon.surrell@gmail.com> Upstream-commit: 344c73ac672cd4d4f70a08b5a41b6835d9873926 Component: engine
2018-02-12 14:09:37 +01:00
parent 535cb21e7e
commit 4816de08ce
1 changed files with 6 additions and 0 deletions
@@ -6178,6 +6178,12 @@ paths:
            uses the buildargs as the environment context for commands run via the `Dockerfile` RUN
            instruction, or for variable expansion in other `Dockerfile` instructions. This is not meant for
            passing secret values.
+
+
+            For example, the build arg `FOO=bar` would become `{"FOO":"bar"}` in JSON. This would result in the
+            the query parameter `buildargs={"FOO":"bar"}`. Note that `{"FOO":"bar"}` should be URI component encoded.
+
+
            [Read more about the buildargs instruction.](https://docs.docker.com/engine/reference/builder/#arg)
          type: "string"
        - name: "shmsize"