You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**Deprecated**: this field is kept for backward compatibility, but
1746
+
will be removed in API v1.45.
1737
1747
$ref: "#/definitions/ContainerConfig"
1738
1748
DockerVersion:
1739
1749
description: |
@@ -2448,6 +2458,11 @@ definitions:
2448
2458
example:
2449
2459
- "container_1"
2450
2460
- "container_2"
2461
+
MacAddress:
2462
+
description: |
2463
+
MAC address for the endpoint on this network. The network driver might ignore this parameter.
2464
+
type: "string"
2465
+
example: "02:42:ac:11:00:04"
2451
2466
Aliases:
2452
2467
type: "array"
2453
2468
items:
@@ -2498,11 +2513,6 @@ definitions:
2498
2513
type: "integer"
2499
2514
format: "int64"
2500
2515
example: 64
2501
-
MacAddress:
2502
-
description: |
2503
-
MAC address for the endpoint on this network.
2504
-
type: "string"
2505
-
example: "02:42:ac:11:00:04"
2506
2516
DriverOpts:
2507
2517
description: |
2508
2518
DriverOpts is a mapping of driver options and values. These options
@@ -3942,6 +3952,44 @@ definitions:
3942
3952
- "remove"
3943
3953
- "orphaned"
3944
3954
3955
+
ContainerStatus:
3956
+
type: "object"
3957
+
description: "represents the status of a container."
3958
+
properties:
3959
+
ContainerID:
3960
+
type: "string"
3961
+
PID:
3962
+
type: "integer"
3963
+
ExitCode:
3964
+
type: "integer"
3965
+
3966
+
PortStatus:
3967
+
type: "object"
3968
+
description: "represents the port status of a task's host ports whose service has published host ports"
3969
+
properties:
3970
+
Ports:
3971
+
type: "array"
3972
+
items:
3973
+
$ref: "#/definitions/EndpointPortConfig"
3974
+
3975
+
TaskStatus:
3976
+
type: "object"
3977
+
description: "represents the status of a task."
3978
+
properties:
3979
+
Timestamp:
3980
+
type: "string"
3981
+
format: "dateTime"
3982
+
State:
3983
+
$ref: "#/definitions/TaskState"
3984
+
Message:
3985
+
type: "string"
3986
+
Err:
3987
+
type: "string"
3988
+
ContainerStatus:
3989
+
$ref: "#/definitions/ContainerStatus"
3990
+
PortStatus:
3991
+
$ref: "#/definitions/PortStatus"
3992
+
3945
3993
Task:
3946
3994
type: "object"
3947
3995
properties:
@@ -3977,26 +4025,7 @@ definitions:
3977
4025
AssignedGenericResources:
3978
4026
$ref: "#/definitions/GenericResources"
3979
4027
Status:
3980
-
type: "object"
3981
-
properties:
3982
-
Timestamp:
3983
-
type: "string"
3984
-
format: "dateTime"
3985
-
State:
3986
-
$ref: "#/definitions/TaskState"
3987
-
Message:
3988
-
type: "string"
3989
-
Err:
3990
-
type: "string"
3991
-
ContainerStatus:
3992
-
type: "object"
3993
-
properties:
3994
-
ContainerID:
3995
-
type: "string"
3996
-
PID:
3997
-
type: "integer"
3998
-
ExitCode:
3999
-
type: "integer"
4028
+
$ref: "#/definitions/TaskStatus"
4000
4029
DesiredState:
4001
4030
$ref: "#/definitions/TaskState"
4002
4031
JobIteration:
@@ -4212,7 +4241,10 @@ definitions:
4212
4241
- "stop-first"
4213
4242
- "start-first"
4214
4243
Networks:
4215
-
description: "Specifies which networks the service should attach to."
4244
+
description: |
4245
+
Specifies which networks the service should attach to.
4246
+
4247
+
Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec should be used instead.
4216
4248
type: "array"
4217
4249
items:
4218
4250
$ref: "#/definitions/NetworkAttachmentConfig"
@@ -4454,6 +4486,37 @@ definitions:
4454
4486
description: "The image ID of an image that was deleted"
4455
4487
type: "string"
4456
4488
4489
+
ServiceCreateResponse:
4490
+
type: "object"
4491
+
description: |
4492
+
contains the information returned to a client on the
4493
+
creation of a new service.
4494
+
properties:
4495
+
ID:
4496
+
description: "The ID of the created service."
4497
+
type: "string"
4498
+
x-nullable: false
4499
+
example: "ak7w3gjqoa3kuz8xcpnyy0pvl"
4500
+
Warning:
4501
+
description: |
4502
+
Optional warning message.
4503
+
4504
+
deprecated: this is only kept for backwards compatibility and will be removed.
4505
+
type: "string"
4506
+
x-nullable: true
4507
+
example: "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found"
4508
+
Warnings:
4509
+
description: |
4510
+
Optional warning message.
4511
+
4512
+
FIXME(thaJeztah): this should have "omitempty" in the generated type.
4513
+
type: "array"
4514
+
x-nullable: true
4515
+
items:
4516
+
type: "string"
4517
+
example:
4518
+
- "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found"
4519
+
4457
4520
ServiceUpdateResponse:
4458
4521
type: "object"
4459
4522
properties:
@@ -4463,7 +4526,8 @@ definitions:
4463
4526
items:
4464
4527
type: "string"
4465
4528
example:
4466
-
Warning: "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found"
4529
+
Warnings:
4530
+
- "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found"
4467
4531
4468
4532
ContainerSummary:
4469
4533
type: "object"
@@ -5734,22 +5798,22 @@ definitions:
5734
5798
type: "integer"
5735
5799
format: "int64"
5736
5800
example: 3987495
5737
-
# TODO Not yet including these fields for now, as they are nil / omitted in our response.
5738
-
# urls:
5739
-
# description: |
5740
-
# List of URLs from which this object MAY be downloaded.
5741
-
# type: "array"
5742
-
# items:
5743
-
# type: "string"
5744
-
# format: "uri"
5745
-
# annotations:
5746
-
# description: |
5747
-
# Arbitrary metadata relating to the targeted content.
5748
-
# type: "object"
5749
-
# additionalProperties:
5750
-
# type: "string"
5751
-
# platform:
5752
-
# $ref: "#/definitions/OCIPlatform"
5801
+
# TODO Not yet including these fields for now, as they are nil / omitted in our response.
5802
+
# urls:
5803
+
# description: |
5804
+
# List of URLs from which this object MAY be downloaded.
5805
+
# type: "array"
5806
+
# items:
5807
+
# type: "string"
5808
+
# format: "uri"
5809
+
# annotations:
5810
+
# description: |
5811
+
# Arbitrary metadata relating to the targeted content.
5812
+
# type: "object"
5813
+
# additionalProperties:
5814
+
# type: "string"
5815
+
# platform:
5816
+
# $ref: "#/definitions/OCIPlatform"
5753
5817
5754
5818
OCIPlatform:
5755
5819
type: "object"
@@ -8001,6 +8065,7 @@ paths:
8001
8065
- `label=key` or `label="key=value"` of an image label
8002
8066
- `reference`=(`<image-name>[:<tag>]`)
8003
8067
- `since`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`)
8068
+
- `until=<timestamp>`
8004
8069
type: "string"
8005
8070
- name: "shared-size"
8006
8071
in: "query"
@@ -10017,6 +10082,7 @@ paths:
10017
10082
/networks/{id}/connect:
10018
10083
post:
10019
10084
summary: "Connect a container to a network"
10085
+
description: "The network must be either a local-scoped network or a swarm-scoped network with the `attachable` option set. A network cannot be re-attached to a running container"
10020
10086
operationId: "NetworkConnect"
10021
10087
consumes:
10022
10088
- "application/json"
@@ -10028,7 +10094,7 @@ paths:
10028
10094
schema:
10029
10095
$ref: "#/definitions/ErrorResponse"
10030
10096
403:
10031
-
description: "Operation not supported for swarm scoped networks"
10097
+
description: "Operation forbidden or not supported for swarm scoped networks"
10032
10098
schema:
10033
10099
$ref: "#/definitions/ErrorResponse"
10034
10100
404:
@@ -10063,6 +10129,7 @@ paths:
10063
10129
IPAMConfig:
10064
10130
IPv4Address: "172.24.56.89"
10065
10131
IPv6Address: "2001:db8::5689"
10132
+
MacAddress: "02:42:ac:12:05:02"
10066
10133
tags: ["Network"]
10067
10134
10068
10135
/networks/{id}/disconnect:
@@ -11056,18 +11123,7 @@ paths:
11056
11123
201:
11057
11124
description: "no error"
11058
11125
schema:
11059
-
type: "object"
11060
-
title: "ServiceCreateResponse"
11061
-
properties:
11062
-
ID:
11063
-
description: "The ID of the created service."
11064
-
type: "string"
11065
-
Warning:
11066
-
description: "Optional warning message"
11067
-
type: "string"
11068
-
example:
11069
-
ID: "ak7w3gjqoa3kuz8xcpnyy0pvl"
11070
-
Warning: "unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found"
Copy file name to clipboardExpand all lines: api-model-v1-41/docs/ContainerConfig.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
23
23
**workingDir** | **kotlin.String** | The working directory for commands to run in. | [optional]
24
24
**entrypoint** | **kotlin.collections.MutableList<kotlin.String>** | The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). | [optional]
25
25
**networkDisabled** | **kotlin.Boolean** | Disable networking for the container. | [optional]
26
-
**macAddress** | **kotlin.String** | MAC address of the container. | [optional]
26
+
**macAddress** | **kotlin.String** | MAC address of the container. Deprecated: this field is deprecated in API v1.44 and up. Use EndpointSettings.MacAddress instead. | [optional]
27
27
**onBuild** | **kotlin.collections.MutableList<kotlin.String>** | `ONBUILD` metadata that were defined in the image's `Dockerfile`. | [optional]
Copy file name to clipboardExpand all lines: api-model-v1-41/docs/ContainerCreateRequest.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
23
23
**workingDir** | **kotlin.String** | The working directory for commands to run in. | [optional]
24
24
**entrypoint** | **kotlin.collections.MutableList<kotlin.String>** | The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[\"\"]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`). | [optional]
25
25
**networkDisabled** | **kotlin.Boolean** | Disable networking for the container. | [optional]
26
-
**macAddress** | **kotlin.String** | MAC address of the container. | [optional]
26
+
**macAddress** | **kotlin.String** | MAC address of the container. Deprecated: this field is deprecated in API v1.44 and up. Use EndpointSettings.MacAddress instead. | [optional]
27
27
**onBuild** | **kotlin.collections.MutableList<kotlin.String>** | `ONBUILD` metadata that were defined in the image's `Dockerfile`. | [optional]
**globalIPv6Address** | **kotlin.String** | Global IPv6 address. | [optional]
17
18
**globalIPv6PrefixLen** | **kotlin.Long** | Mask length of the global IPv6 address. | [optional]
18
-
**macAddress** | **kotlin.String** | MAC address for the endpoint on this network. | [optional]
19
19
**driverOpts** | **kotlin.collections.MutableMap<kotlin.String, kotlin.String>** | DriverOpts is a mapping of driver options and values. These options are passed directly to the driver and are driver specific. | [optional]
0 commit comments