Skip to content
This repository was archived by the owner on Oct 26, 2019. It is now read-only.

Commit f1e785b

Browse files
committed
Generate 1.29 version
1 parent 5548438 commit f1e785b

32 files changed

+756
-32
lines changed

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
},
2525
"extra": {
2626
"branch-alias": {
27-
"4.1.28": "4.1.28.x-dev"
27+
"4.1.29": "4.1.29.x-dev"
2828
}
2929
},
3030
"minimum-stability": "dev",

docker-swagger.yaml

Lines changed: 141 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ produces:
1919
consumes:
2020
- "application/json"
2121
- "text/plain"
22-
basePath: "/v1.28"
22+
basePath: "/v1.29"
2323
info:
2424
title: "Docker Engine API"
25-
version: "1.28"
25+
version: "1.29"
2626
x-logo:
2727
url: "https://docs.docker.com/images/logo-docker-main.png"
2828
description: |
@@ -44,18 +44,19 @@ info:
4444
4545
The API is usually changed in each release of Docker, so API calls are versioned to ensure that clients don't break.
4646
47-
For Docker Engine 17.04, the API version is 1.28. To lock to this version, you prefix the URL with `/v1.28`. For example, calling `/info` is the same as calling `/v1.28/info`.
47+
For Docker Engine 17.05, the API version is 1.29. To lock to this version, you prefix the URL with `/v1.29`. For example, calling `/info` is the same as calling `/v1.29/info`.
4848
4949
Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine.
5050
5151
In previous versions of Docker, it was possible to access the API without providing a version. This behaviour is now deprecated will be removed in a future version of Docker.
5252
5353
The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer Docker daemons.
5454
55-
This documentation is for version 1.28 of the API, which was introduced with Docker 17.04. Use this table to find documentation for previous versions of the API:
55+
This documentation is for version 1.29 of the API, which was introduced with Docker 17.05. Use this table to find documentation for previous versions of the API:
5656
5757
Docker version | API version | Changes
5858
----------------|-------------|---------
59+
17.04.x | [1.28](https://docs.docker.com/engine/api/v1.28/) | [API changes](https://docs.docker.com/engine/api/version-history/#v1-28-api-changes)
5960
17.03.1 | [1.27](https://docs.docker.com/engine/api/v1.27/) | [API changes](https://docs.docker.com/engine/api/version-history/#v1-27-api-changes)
6061
1.13.1 & 17.03.0 | [1.26](https://docs.docker.com/engine/api/v1.26/) | [API changes](https://docs.docker.com/engine/api/version-history/#v1-26-api-changes)
6162
1.13.0 | [1.25](https://docs.docker.com/engine/api/v1.25/) | [API changes](https://docs.docker.com/engine/api/version-history/#v1-25-api-changes)
@@ -244,6 +245,9 @@ definitions:
244245
ReadOnly:
245246
description: "Whether the mount should be read-only."
246247
type: "boolean"
248+
Consistency:
249+
description: "The consistency requirement for the mount: `default`, `consistent`, `cached`, or `delegated`."
250+
type: "string"
247251
BindOptions:
248252
description: "Optional configuration for the `bind` type."
249253
type: "object"
@@ -502,6 +506,9 @@ definitions:
502506
Retries:
503507
description: "The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit."
504508
type: "integer"
509+
StartPeriod:
510+
description: "Start period for the container to initialize before starting health-retries countdown in nanoseconds. 0 means inherit."
511+
type: "integer"
505512

506513
HostConfig:
507514
description: "Container configuration that depends on the host we are running on"
@@ -750,7 +757,7 @@ definitions:
750757
default: false
751758
Env:
752759
description: |
753-
A list of environment variables to set inside the container in the form `["VAR=value", ...]`
760+
A list of environment variables to set inside the container in the form `["VAR=value", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value.
754761
type: "array"
755762
items:
756763
type: "string"
@@ -1113,6 +1120,8 @@ definitions:
11131120
type: "boolean"
11141121
Attachable:
11151122
type: "boolean"
1123+
Ingress:
1124+
type: "boolean"
11161125
Containers:
11171126
type: "object"
11181127
additionalProperties:
@@ -1141,6 +1150,7 @@ definitions:
11411150
foo: "bar"
11421151
Internal: false
11431152
Attachable: false
1153+
Ingress: false
11441154
Containers:
11451155
19a4d5d687db25203351ed79d478946f861258f018fe384f229f2efa4b23513c:
11461156
Name: "test"
@@ -1444,11 +1454,17 @@ definitions:
14441454
- WorkDir
14451455
- Network
14461456
- Linux
1457+
- PidHost
14471458
- PropagatedMount
1459+
- IpcHost
14481460
- Mounts
14491461
- Env
14501462
- Args
14511463
properties:
1464+
DockerVersion:
1465+
description: "Docker Version used to create the plugin"
1466+
type: "string"
1467+
x-nullable: false
14521468
Description:
14531469
type: "string"
14541470
x-nullable: false
@@ -1512,6 +1528,12 @@ definitions:
15121528
PropagatedMount:
15131529
type: "string"
15141530
x-nullable: false
1531+
IpcHost:
1532+
type: "boolean"
1533+
x-nullable: false
1534+
PidHost:
1535+
type: "boolean"
1536+
x-nullable: false
15151537
Mounts:
15161538
type: "array"
15171539
items:
@@ -2274,6 +2296,12 @@ definitions:
22742296
description: "The fraction of tasks that may fail during an update before the failure action is invoked, specified as a floating point number between 0 and 1."
22752297
type: "number"
22762298
default: 0
2299+
Order:
2300+
description: "The order of operations when rolling out an updated task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down."
2301+
type: "string"
2302+
enum:
2303+
- "stop-first"
2304+
- "start-first"
22772305
RollbackConfig:
22782306
description: "Specification for the rollback strategy of the service."
22792307
type: "object"
@@ -2300,6 +2328,12 @@ definitions:
23002328
description: "The fraction of tasks that may fail during a rollback before the failure action is invoked, specified as a floating point number between 0 and 1."
23012329
type: "number"
23022330
default: 0
2331+
Order:
2332+
description: "The order of operations when rolling back a task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down."
2333+
type: "string"
2334+
enum:
2335+
- "stop-first"
2336+
- "start-first"
23032337
Networks:
23042338
description: "Array of network names or IDs to attach the service to."
23052339
type: "array"
@@ -6191,6 +6225,7 @@ paths:
61916225
EnableIPv6: false
61926226
Internal: false
61936227
Attachable: false
6228+
Ingress: false
61946229
IPAM:
61956230
Driver: "default"
61966231
Config:
@@ -6217,6 +6252,7 @@ paths:
62176252
EnableIPv6: false
62186253
Internal: false
62196254
Attachable: false
6255+
Ingress: false
62206256
IPAM:
62216257
Driver: "default"
62226258
Config: []
@@ -6230,6 +6266,7 @@ paths:
62306266
EnableIPv6: false
62316267
Internal: false
62326268
Attachable: false
6269+
Ingress: false
62336270
IPAM:
62346271
Driver: "default"
62356272
Config: []
@@ -6249,6 +6286,7 @@ paths:
62496286
- `id=<network-id>` Matches all or part of a network ID.
62506287
- `label=<key>` or `label=<key>=<value>` of a network label.
62516288
- `name=<network-name>` Matches all or part of a network name.
6289+
- `scope=["swarm"|"global"|"local"]` Filters networks by scope (`swarm`, `global`, or `local`).
62526290
- `type=["custom"|"builtin"]` Filters networks by type. The `custom` keyword returns all user-defined networks.
62536291
type: "string"
62546292
tags: ["Network"]
@@ -6362,6 +6400,9 @@ paths:
63626400
Attachable:
63636401
description: "Globally scoped network is manually attachable by regular containers from workers in swarm mode."
63646402
type: "boolean"
6403+
Ingress:
6404+
description: "Ingress network is the network which provides the routing-mesh in swarm mode."
6405+
type: "boolean"
63656406
IPAM:
63666407
description: "Optional custom IP scheme for the network."
63676408
$ref: "#/definitions/IPAM"
@@ -6395,6 +6436,7 @@ paths:
63956436
foo: "bar"
63966437
Internal: true
63976438
Attachable: false
6439+
Ingress: false
63986440
Options:
63996441
com.docker.network.bridge.default_bridge: "true"
64006442
com.docker.network.bridge.enable_icc: "true"
@@ -7394,6 +7436,7 @@ paths:
73947436
73957437
- `id=<service id>`
73967438
- `label=<service label>`
7439+
- `mode=["replicated"|"global"]`
73977440
- `name=<service name>`
73987441
tags: ["Service"]
73997442
/services/create:
@@ -7462,6 +7505,7 @@ paths:
74627505
DriverConfig: {}
74637506
Labels:
74647507
com.example.something: "something-value"
7508+
Hosts: ["10.10.10.10 host1", "ABCD:EF01:2345:6789:ABCD:EF01:2345:6789 host2"]
74657509
User: "33"
74667510
DNSConfig:
74677511
Nameservers: ["8.8.8.8"]
@@ -7536,6 +7580,11 @@ paths:
75367580
description: "ID or name of service."
75377581
required: true
75387582
type: "string"
7583+
- name: "insertDefaults"
7584+
in: "query"
7585+
description: "Fill empty fields with default values."
7586+
type: "boolean"
7587+
default: false
75397588
tags: ["Service"]
75407589
delete:
75417590
summary: "Delete a service"
@@ -7677,12 +7726,12 @@ paths:
76777726
schema:
76787727
type: "string"
76797728
404:
7680-
description: "no such container"
7729+
description: "no such service"
76817730
schema:
76827731
$ref: "#/definitions/ErrorResponse"
76837732
examples:
76847733
application/json:
7685-
message: "No such container: c2ada9df5af8"
7734+
message: "No such service: c2ada9df5af8"
76867735
500:
76877736
description: "server error"
76887737
schema:
@@ -7695,11 +7744,11 @@ paths:
76957744
- name: "id"
76967745
in: "path"
76977746
required: true
7698-
description: "ID or name of the container"
7747+
description: "ID or name of the service"
76997748
type: "string"
77007749
- name: "details"
77017750
in: "query"
7702-
description: "Show extra details provided to logs."
7751+
description: "Show service context and extra details provided to logs."
77037752
type: "boolean"
77047753
default: false
77057754
- name: "follow"
@@ -7912,6 +7961,86 @@ paths:
79127961
required: true
79137962
type: "string"
79147963
tags: ["Task"]
7964+
/tasks/{id}/logs:
7965+
get:
7966+
summary: "Get task logs"
7967+
description: |
7968+
Get `stdout` and `stderr` logs from a task.
7969+
7970+
**Note**: This endpoint works only for services with the `json-file` or `journald` logging drivers.
7971+
operationId: "TaskLogs"
7972+
produces:
7973+
- "application/vnd.docker.raw-stream"
7974+
- "application/json"
7975+
responses:
7976+
101:
7977+
description: "logs returned as a stream"
7978+
schema:
7979+
type: "string"
7980+
format: "binary"
7981+
200:
7982+
description: "logs returned as a string in response body"
7983+
schema:
7984+
type: "string"
7985+
404:
7986+
description: "no such task"
7987+
schema:
7988+
$ref: "#/definitions/ErrorResponse"
7989+
examples:
7990+
application/json:
7991+
message: "No such task: c2ada9df5af8"
7992+
500:
7993+
description: "server error"
7994+
schema:
7995+
$ref: "#/definitions/ErrorResponse"
7996+
503:
7997+
description: "node is not part of a swarm"
7998+
schema:
7999+
$ref: "#/definitions/ErrorResponse"
8000+
parameters:
8001+
- name: "id"
8002+
in: "path"
8003+
required: true
8004+
description: "ID of the task"
8005+
type: "string"
8006+
- name: "details"
8007+
in: "query"
8008+
description: "Show task context and extra details provided to logs."
8009+
type: "boolean"
8010+
default: false
8011+
- name: "follow"
8012+
in: "query"
8013+
description: |
8014+
Return the logs as a stream.
8015+
8016+
This will return a `101` HTTP response with a `Connection: upgrade` header, then hijack the HTTP connection to send raw output. For more information about hijacking and the stream format, [see the documentation for the attach endpoint](#operation/ContainerAttach).
8017+
type: "boolean"
8018+
default: false
8019+
- name: "stdout"
8020+
in: "query"
8021+
description: "Return logs from `stdout`"
8022+
type: "boolean"
8023+
default: false
8024+
- name: "stderr"
8025+
in: "query"
8026+
description: "Return logs from `stderr`"
8027+
type: "boolean"
8028+
default: false
8029+
- name: "since"
8030+
in: "query"
8031+
description: "Only return logs since this time, as a UNIX timestamp"
8032+
type: "integer"
8033+
default: 0
8034+
- name: "timestamps"
8035+
in: "query"
8036+
description: "Add timestamps to every log line"
8037+
type: "boolean"
8038+
default: false
8039+
- name: "tail"
8040+
in: "query"
8041+
description: "Only return this number of log lines from the end of the logs. Specify as an integer or `all` to output all log lines."
8042+
type: "string"
8043+
default: "all"
79158044
/secrets:
79168045
get:
79178046
summary: "List secrets"
@@ -7948,6 +8077,9 @@ paths:
79488077
description: |
79498078
A JSON encoded value of the filters (a `map[string][]string`) to process on the secrets list. Available filters:
79508079
8080+
- `id=<secret id>`
8081+
- `label=<key> or label=<key>=value`
8082+
- `name=<secret name>`
79518083
- `names=<secret name>`
79528084
tags: ["Secret"]
79538085
/secrets/create:

src/Client.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,15 @@ class Client extends \Jane\OpenApiRuntime\Client\Psr7HttplugResource
2323
use Resource\SwarmResourceTrait;
2424
use Resource\ServiceResourceTrait;
2525
use Resource\TaskResourceTrait;
26+
use Resource\DefaultResourceTrait;
2627
use Resource\SecretResourceTrait;
2728

2829
public static function create($httpClient = null)
2930
{
3031
if (null === $httpClient) {
3132
$httpClient = \Http\Discovery\HttpClientDiscovery::find();
3233
$plugins = [];
33-
$uri = \Http\Discovery\UriFactoryDiscovery::find()->createUri('v1.28');
34+
$uri = \Http\Discovery\UriFactoryDiscovery::find()->createUri('v1.29');
3435
$plugins[] = new \Http\Client\Common\Plugin\AddPathPlugin($uri);
3536
$httpClient = new \Http\Client\Common\PluginClient($httpClient, $plugins);
3637
}

src/ClientAsync.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ class ClientAsync extends \Jane\OpenApiRuntime\Client\AmpArtaxResource
2323
use Resource\SwarmAsyncResourceTrait;
2424
use Resource\ServiceAsyncResourceTrait;
2525
use Resource\TaskAsyncResourceTrait;
26+
use Resource\DefaultAsyncResourceTrait;
2627
use Resource\SecretAsyncResourceTrait;
2728

2829
public static function create($httpClient = null)

src/Exception/ServiceLogsNotFoundException.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ class ServiceLogsNotFoundException extends \RuntimeException implements ClientEx
1616

1717
public function __construct(\Docker\API\Model\ErrorResponse $errorResponse)
1818
{
19-
parent::__construct('no such container', 404);
19+
parent::__construct('no such service', 404);
2020
$this->errorResponse = $errorResponse;
2121
}
2222

0 commit comments

Comments
 (0)