summaryrefslogtreecommitdiff
path: root/docs/api
Commit message (Collapse)AuthorAgeFilesLines
* Merge pull request #45469 from thaJeztah/deprecate_virtualsize_STEP2Akihiro Suda2023-05-161-0/+4
|\ | | | | API: omit deprecated VirtualSize field for API v1.44 and up
| * API: omit deprecated VirtualSize field for API v1.44 and upSebastiaan van Stijn2023-05-061-0/+4
| | | | | | | | | | | | | | | | This field is deprecated since 1261fe69a3586bb102182aa885197822419c768c, and will now be omitted on API v1.44 and up for the `GET /images/json`, `GET /images/{id}/json`, and `GET /system/df` endpoints. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* | docs/api: version-history: also mention /system/df for VirtualSizeSebastiaan van Stijn2023-05-061-3/+3
|/ | | | | | | | Commit 1261fe69a3586bb102182aa885197822419c768c deprecated the VirtualSize field, but forgot to mention that it's also included in the /system/df endpoint. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* API: bump version to 1.44Sebastiaan van Stijn2023-05-061-0/+4
| | | | | | | The 24.0 branch was created, so changes in master/main should now be targeting the next version of the API (1.44). Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* api: synchronize api/swagger.yaml with docs/api/v1.43.yamlSebastiaan van Stijn2023-05-051-36/+47
| | | | | | | | | | | | - forward-port changes from 0ffaa6c7858f0a5d85318efda43a2d20a684eae2 to api/swagger.yaml (v1.44-dev) - backports the changes to v1.43; - Update container OOMKilled flag immediately 57d2d6ef621cc126ca904e8fc98fbacbd345790a - Add no-new-privileges to SecurityOptions returned by /info eb7738221c3b6a6a1c1f46e4f38357473feddfc4 - API: deprecate VirtualSize field for /images/json and /images/{id}/json 1261fe69a3586bb102182aa885197822419c768c - api/types/container: create type for changes endpoint dbb48e4b29e124aef6716ee8ad6856bf696235ca - builder-next/prune: Handle "until" filter timestamps 54a125f67703ab51ed8a004b625439dfafa7aa6c Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* API: deprecate VirtualSize field for /images/json and /images/{id}/jsonSebastiaan van Stijn2023-04-181-0/+3
| | | | | | | | | In versions of Docker before v1.10, this field was calculated from the image itself and all of its parent images. Images are now stored self-contained, and no longer use a parent-chain, making this field an equivalent of the Size field. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* Add no-new-privileges to SecurityOptions returned by /infoAlbin Kerouanton2023-04-181-0/+3
| | | | Signed-off-by: Albin Kerouanton <albinker@gmail.com>
* api: Remove <none> in Repo(Tags|Digests) for >= 1.43Paweł Gronowski2023-02-271-0/+3
| | | | | | | | | Deprecate `<none>:<none>` and `<none>@<none>` magic strings included in `RepoTags` and `RepoDigests`. Produce an empty arrays instead and leave the presentation of untagged/dangling images up to the client. Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
* daemon: add annotations to container HostConfigCory Snider2023-02-232-1/+10
| | | | | | | Allow clients to set annotations on a container which will applied to the container's OCI spec. Signed-off-by: Cory Snider <csnider@mirantis.com>
* docs/api: add v1.43 OpenAPI definitionsCory Snider2023-02-211-0/+12153
| | | | Signed-off-by: Cory Snider <csnider@mirantis.com>
* docs: api: synchronise versioned API docs (v1.39 - v1.41)Sebastiaan van Stijn2023-01-103-25/+58
| | | | | | | | | | | | synchronises some fixes between these API versions for the documentation, including fixes from: - 52a9f1689a2ed4f5f8b73af4f35107cd4626f5b5 - 345346d7c6e26c0c94e4feedc52648b5bb730844 - 18f85467e7d6da952deaca4661ce2778496c8498 - 1557892c37fb09fe391c45e4c6e42af36c1432f6 Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* docs: api: synchronise versioned API docs (v1.42)Sebastiaan van Stijn2023-01-101-0/+5
| | | | | | | | | | synchronises some fixes between these API versions for the documentation, including fixes from: - 18f85467e7d6da952deaca4661ce2778496c8498 - 345346d7c6e26c0c94e4feedc52648b5bb730844 Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* Merge pull request #44061 from fussybeaver/44059-swagger-create-image-infoSebastiaan van Stijn2023-01-101-0/+2
|\ | | | | api: swagger: add errorDetail to CreateImageInfo
| * api: docs: add errorDetail to CreateImageInfo (v1.42)Niel Drummond2022-08-301-0/+2
| | | | | | | | Signed-off-by: Niel Drummond <niel@drummond.lu>
* | Merge pull request #44216 from cpuguy83/volume_unnamed_labelSebastiaan van Stijn2022-10-052-0/+2
|\ \ | | | | | | Volume prune: only prune anonymous volumes by default
| * | Volume prune: only prune anonymous volumes by defaultBrian Goff2022-10-042-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This adds a new filter argument to the volume prune endpoint "all". When this is not set, or it is a false-y value, then only anonymous volumes are considered for pruning. When `all` is set to a truth-y value, you get the old behavior. This is an API change, but I think one that is what most people would want. Signed-off-by: Brian Goff <cpuguy83@gmail.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* | | docs: swagger: update description for default builder versionSebastiaan van Stijn2022-10-041-1/+11
|/ / | | | | | | | | | | | | | | Commit 7b153b9e28b53779215de209736310f9266b3f2f updated the main swagger file, but didn't update the v1.42 version used for the documentation as it wasn't created yet at the time. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* | swagger: update links to logoCrazyMax2022-09-2718-18/+18
|/ | | | Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
* Merge pull request #43657 from thaJeztah/default_builder_versionSebastiaan van Stijn2022-08-181-0/+12
|\ | | | | api: set default "Builder-Version" to "2" (BuildKit) on Linux
| * api: set default "Builder-Version" to "2" (BuildKit) on LinuxSebastiaan van Stijn2022-05-291-0/+12
| | | | | | | | | | | | | | | | | | | | | | | | Starting with the 22.06 release, buildx is the default client for docker build, which uses BuildKit as builder. This patch changes the default builder version as advertised by the daemon to "2" (BuildKit), so that pre-22.06 CLIs with BuildKit support (but no buildx installed) also default to using BuildKit when interacting with a 22.06 (or up) daemon. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* | vendor: github.com/moby/swarmkit/v2 v2.0.0-20220721174824-48dd89375d0aSebastiaan van Stijn2022-08-091-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | full diff: https://github.com/moby/swarmkit/compare/6068d1894d46...48dd89375d0a3e8a333c52bce1e6297e0b192d06 Finishes off the work to change references to cluster volumes in the API from using "csi" as the magic word to "cluster". This reflects that the volumes are "cluster volumes", not "csi volumes". Notably, there is no change to the plugin definitions being "csinode" and "csicontroller". This terminology is appropriate with regards to plugins because it accurates reflects what the plugin is. Signed-off-by: Drew Erny <derny@mirantis.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* | api: swagger: fix invalid example value (API v1.39-v1.41)Sebastiaan van Stijn2022-08-043-3/+3
| | | | | | | | | | | | This was introduced in 43956c1bfc7abc5eb06b59fe7f6a6b37e5062fc1 Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* | api: swagger: document BuildCache fields (API v1.39-v1.41)Sebastiaan van Stijn2022-08-043-0/+159
| | | | | | | | Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* | api: swagger: document BuildCache fields (API v1.42)Sebastiaan van Stijn2022-08-041-2/+43
| | | | | | | | Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* | api: add BuildCache.Parents for API >= v1.42Sebastiaan van Stijn2022-08-041-0/+2
| | | | | | | | | | | | This field was added to replace the deprecated "Parent" field. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* | api: deprecate BuildCache.Parent in API >= v1.42Sebastiaan van Stijn2022-08-041-0/+2
| | | | | | | | | | | | | | This field has been deprecated in BuildKit, so this follows the deprecation in the Engine API. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* | docs: api: add missing "platform" query-arg on create (v1.42)Sebastiaan van Stijn2022-07-291-0/+22
| | | | | | | | | | | | | | | | Commit 7a9cb29fb980c0ab3928272cdc24c7089b2fcf64 added a new "platform" query- parameter to the `POST /containers/create` endpoint, but did not update the swagger file and documentation. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* | docs: api: add missing "platform" query-arg on create (v1.41)Sebastiaan van Stijn2022-07-291-0/+22
| | | | | | | | | | | | | | | | Commit 7a9cb29fb980c0ab3928272cdc24c7089b2fcf64 added a new "platform" query- parameter to the `POST /containers/create` endpoint, but did not update the swagger file and documentation. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* | api: swagger: add missing "platform" query-arg on createSebastiaan van Stijn2022-07-291-0/+16
| | | | | | | | | | | | | | | | Commit 7a9cb29fb980c0ab3928272cdc24c7089b2fcf64 added a new "platform" query- parameter to the `POST /containers/create` endpoint, but did not update the swagger file and documentation. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* | Merge pull request #43796 from thaJeztah/api_bumpSebastiaan van Stijn2022-07-131-0/+6
|\ \ | | | | | | API: bump version to 1.43
| * | API: bump version to 1.43Sebastiaan van Stijn2022-07-121-0/+6
| | | | | | | | | | | | | | | | | | | | | The 22.06 branch was created, so changes in master/main should now be targeting the next version of the API (1.43). Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* | | docs: add API v1.42Sebastiaan van Stijn2022-07-121-0/+12068
|/ / | | | | | | Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* | container/exec: Support ConsoleSizePaweł Gronowski2022-06-241-0/+2
| | | | | | | | | | | | | | | | | | Now client have the possibility to set the console size of the executed process immediately at the creation. This makes a difference for example when executing commands that output some kind of text user interface which is bounded by the console dimensions. Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
* | docs: api: adjust ContainerWaitResponse error as optionalNiel Drummond2022-05-303-3/+3
|/ | | | Signed-off-by: Niel Drummond <niel@drummond.lu>
* Annotate some swagger documented types as int64Tobias Gesellchen2022-05-231-2/+10
| | | | | | | | Using the swagger.yaml to generate api models will create incompatible field types. Some inconsistencies had already been mentioned at #39131. I've added more fixes from real life experience, some only occurring on Windows. Closes #39131 Signed-off-by: Tobias Gesellchen <tobias@gesellix.de>
* introduce CreateMountpoint for parity between binds and mountsNicolas De Loof2022-05-191-0/+4
| | | | Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
* daemon/linux: Set console size on creationPaweł Gronowski2022-05-191-0/+3
| | | | | | | | | | | | On Linux the daemon was not respecting the HostConfig.ConsoleSize property and relied on cli initializing the tty size after the container was created. This caused a delay between container creation and the tty actually being resized. This is also a small change to the api description, because HostConfig.ConsoleSize is no longer Windows-only. Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
* docs: api: /containers/{id}/attach/ws: remove unsupported query-args < v1.42Sebastiaan van Stijn2022-05-1824-297/+0
| | | | | | | | | | These query-args were documented, but not actually supported until ea6760138c35c607a0b51ad041051374d8304e68 (API v1.42). This removes them from the documentation, as these arguments were ignored (and defaulted to `true` (enabled)) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* docs: api: add note about websocket attach streamsSebastiaan van Stijn2022-05-181-2/+7
| | | | | | | Slightly make the change in API v1.42 more visible, and add a snippet about what users should do to preserve the pre-v1.41 behavior. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* Merge pull request #43322 from ndeloof/websocket_streamsSebastiaan van Stijn2022-05-181-0/+2
|\ | | | | wsContainersAttach attach to stdin/out/err streams as requested
| * wsContainersAttach attach to stdin/out/err streams as requestedNicolas De Loof2022-05-171-0/+2
| | | | | | | | Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
* | Rename Reservation to Reservations in the open APIDjordje Lukic2022-05-1717-17/+17
|/ | | | | | The correct name for this property is, and always was "Reservations" Signed-off-by: Djordje Lukic <djordje.lukic@docker.com>
* Add Swarm cluster volume supportsDrew Erny2022-05-131-0/+10
| | | | | | Adds code to support Cluster Volumes in Swarm using CSI drivers. Signed-off-by: Drew Erny <derny@mirantis.com>
* Make it explicit raw|multiplexed stream implementation being usedNicolas De Loof2022-05-121-0/+4
| | | | | | fix #35761 Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
* api: docs: move VolumeListResponse to definitions (v1.39-v1.41)Sebastiaan van Stijn2022-04-213-54/+60
| | | | Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* Merge pull request #43206 from ↵Sebastiaan van Stijn2022-04-211-0/+3
|\ | | | | | | | | thaJeztah/having_such_a_good_time_im_having_a_ball API: add "signal" parameter to container stop and restart endpoints
| * API: add "signal" parameter to container stop and restart endpointsSebastiaan van Stijn2022-04-201-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Containers can have a default stop-signal (`--stop-signal` / `STOPSIGNAL`) and timeout (`--stop-timeout`). It is currently not possible to update either of these after the container is created (`docker update` does not allow updating them), and while either of these can be overridden through some commands, we currently do not have a command that can override *both*: command | stop-signal | stop-timeout | notes ----------------|-------------|--------------|---------------------------- docker kill | yes | DNA | only sends a single signal docker restart | no | yes | docker stop | no | yes | As a result, if a user wants to stop a container with a custom signal and timeout, the only option is to do this manually: docker kill -s <custom signal> mycontainer # wait <desired timeout> # press ^C to cancel the graceful stop # forcibly kill the container docker kill mycontainer This patch adds a new `signal` query parameter to the container "stop" and "restart" endpoints. This parameter can be added as a new flag on the CLI, which would allow stopping and restarting with a custom timeout and signal, for example: docker stop --signal=SIGWINCH --time=120 mycontainer docker restart --signal=SIGWINCH --time=120 mycontainer Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* | Merge pull request #43461 from thaJeztah/api_document_ContainerConfigSebastiaan van Stijn2022-04-2012-9/+102
|\ \ | |/ |/| api: improve documentation of ContainerConfig type
| * api: docs: improve documentation of ContainerConfig type (API v1.30-v1.41)Sebastiaan van Stijn2022-04-1912-9/+102
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | ContainerConfig is used in multiple locations (for example, both for Image.Config and Image.ContainerConfig). Unfortunately, swagger does not allow documenting individual uses if a type is used; for this type, the content is _optional_ when used as Image.ContainerConfig (which is set by the classic builder, which does a "commit" of a container, but not used when building an image with BuildKit). This patch attempts to address this confusion by documenting that "it may be empty (or fields not propagated) if it's used for the Image.ContainerConfig field". Perhaps alternatives are possible (aliasing the type?) but we can look at those in a follow-up. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
* | docs: api: document ImageSummary fields (api v1.39-v1.41)Sebastiaan van Stijn2022-04-203-90/+237
|/ | | | Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
View Lorry Controller Status