Skip to content

Commit 0c3b8cc

Browse files
committed
api: Document version in /build
It was introduced in API v1.38 but wasn't documented. Signed-off-by: Paweł Gronowski <[email protected]>
1 parent 8ee908e commit 0c3b8cc

8 files changed

Lines changed: 80 additions & 0 deletions

File tree

api/swagger.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8331,6 +8331,16 @@ paths:
83318331
description: "BuildKit output configuration"
83328332
type: "string"
83338333
default: ""
8334+
- name: "version"
8335+
in: "query"
8336+
type: "string"
8337+
default: "1"
8338+
enum: ["1", "2"]
8339+
description: |
8340+
Version of the builder backend to use.
8341+
8342+
- `1` is the first generation classic (deprecated) builder in the Docker daemon (default)
8343+
- `2` is [BuildKit](https://github.com/moby/buildkit)
83348344
responses:
83358345
200:
83368346
description: "no error"

docs/api/v1.38.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6356,6 +6356,16 @@ paths:
63566356
description: "Target build stage"
63576357
type: "string"
63586358
default: ""
6359+
- name: "version"
6360+
in: "query"
6361+
type: "string"
6362+
default: "1"
6363+
enum: ["1", "2"]
6364+
description: |
6365+
Version of the builder backend to use.
6366+
6367+
- `1` is the first generation classic (deprecated) builder in the Docker daemon (default)
6368+
- `2` is [BuildKit](https://github.com/moby/buildkit)
63596369
responses:
63606370
200:
63616371
description: "no error"

docs/api/v1.39.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7390,6 +7390,16 @@ paths:
73907390
description: "Target build stage"
73917391
type: "string"
73927392
default: ""
7393+
- name: "version"
7394+
in: "query"
7395+
type: "string"
7396+
default: "1"
7397+
enum: ["1", "2"]
7398+
description: |
7399+
Version of the builder backend to use.
7400+
7401+
- `1` is the first generation classic (deprecated) builder in the Docker daemon (default)
7402+
- `2` is [BuildKit](https://github.com/moby/buildkit)
73937403
responses:
73947404
200:
73957405
description: "no error"

docs/api/v1.40.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7701,6 +7701,16 @@ paths:
77017701
description: "BuildKit output configuration"
77027702
type: "string"
77037703
default: ""
7704+
- name: "version"
7705+
in: "query"
7706+
type: "string"
7707+
default: "1"
7708+
enum: ["1", "2"]
7709+
description: |
7710+
Version of the builder backend to use.
7711+
7712+
- `1` is the first generation classic (deprecated) builder in the Docker daemon (default)
7713+
- `2` is [BuildKit](https://github.com/moby/buildkit)
77047714
responses:
77057715
200:
77067716
description: "no error"

docs/api/v1.41.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7906,6 +7906,16 @@ paths:
79067906
description: "BuildKit output configuration"
79077907
type: "string"
79087908
default: ""
7909+
- name: "version"
7910+
in: "query"
7911+
type: "string"
7912+
default: "1"
7913+
enum: ["1", "2"]
7914+
description: |
7915+
Version of the builder backend to use.
7916+
7917+
- `1` is the first generation classic (deprecated) builder in the Docker daemon (default)
7918+
- `2` is [BuildKit](https://github.com/moby/buildkit)
79097919
responses:
79107920
200:
79117921
description: "no error"

docs/api/v1.42.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8156,6 +8156,16 @@ paths:
81568156
description: "BuildKit output configuration"
81578157
type: "string"
81588158
default: ""
8159+
- name: "version"
8160+
in: "query"
8161+
type: "string"
8162+
default: "1"
8163+
enum: ["1", "2"]
8164+
description: |
8165+
Version of the builder backend to use.
8166+
8167+
- `1` is the first generation classic (deprecated) builder in the Docker daemon (default)
8168+
- `2` is [BuildKit](https://github.com/moby/buildkit)
81598169
responses:
81608170
200:
81618171
description: "no error"

docs/api/v1.43.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8174,6 +8174,16 @@ paths:
81748174
description: "BuildKit output configuration"
81758175
type: "string"
81768176
default: ""
8177+
- name: "version"
8178+
in: "query"
8179+
type: "string"
8180+
default: "1"
8181+
enum: ["1", "2"]
8182+
description: |
8183+
Version of the builder backend to use.
8184+
8185+
- `1` is the first generation classic (deprecated) builder in the Docker daemon (default)
8186+
- `2` is [BuildKit](https://github.com/moby/buildkit)
81778187
responses:
81788188
200:
81798189
description: "no error"

docs/api/v1.44.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8327,6 +8327,16 @@ paths:
83278327
description: "BuildKit output configuration"
83288328
type: "string"
83298329
default: ""
8330+
- name: "version"
8331+
in: "query"
8332+
type: "string"
8333+
default: "1"
8334+
enum: ["1", "2"]
8335+
description: |
8336+
Version of the builder backend to use.
8337+
8338+
- `1` is the first generation classic (deprecated) builder in the Docker daemon (default)
8339+
- `2` is [BuildKit](https://github.com/moby/buildkit)
83308340
responses:
83318341
200:
83328342
description: "no error"

0 commit comments

Comments
 (0)