Commit Graph

88 Commits

Author SHA1 Message Date
David Karlsson cf7bff250d bump engine version in examples
Signed-off-by: David Karlsson <david.karlsson@docker.com>
2023-05-19 17:44:44 +02:00
David Karlsson 3ef912be0f add engine api v1.43
Signed-off-by: David Karlsson <david.karlsson@docker.com>
2023-05-19 17:32:25 +02:00
Sebastiaan van Stijn 9fa5f6973d
engine: update API information for v23.0
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-05-03 15:06:52 +02:00
Usha Mandya 5cc09b6b5f
Merge pull request #16619 from Briscoooe/patch-1
Update Docker Engine Python SDK example to use Python 3 syntax
2023-03-07 14:22:47 +00:00
andregri f87b16b502
Pass StopOptions to ContainerStop function
Fix #16744

**options** argument in **ContainerStop** [function](https://github.com/moby/moby/blob/master/daemon/stop.go#L23) can't be **nil**
2023-02-18 19:03:28 +01:00
Sebastiaan van Stijn 77bb40ce7b
engine: api: add API v1.42 (docker v23.0.0)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-02-01 20:24:59 +01:00
Briscoooe ffa23d972e
Update Python example to use Python 3 syntax 2023-01-28 21:23:02 +00:00
msadiq058 29e169c2b5
Update examples.md for golang (#16062)
* Update examples.md for golang

calling, `defer cli.Close()`
to close the underline transport used by the client

* fixed indentation

* added cli.close() call in index.md

Co-authored-by: Mohd Sadiq <mohd.sadiq@akridata.com>
2022-11-03 17:52:00 +01:00
Jerae Duffin e973f0394a removed wording 2022-08-04 22:44:57 -05:00
Rahul De 0a6ef09f05
Add contajners to unofficial libs 2022-01-15 09:57:05 +00:00
Ryan Harvey cd53a8b852 Close io.ReadClosers in examples 2021-11-24 10:12:40 +00:00
Sebastiaan van Stijn 1583678203
Add missing code-hints, and minor markdown edits
- Add missing code-hints (console, yaml)
- Consistently add an empty line after code-blocks
- Combine some examples where the output and the command were
  put in separate blocks. With the "console" code-hint, this
  is no longer nescessary.
- fix indentation in cloud/ecs-integration.md, which caused the
  numbered-list to be interrupted.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-16 12:59:23 +02:00
Sebastiaan van Stijn 2477916f59
engine/api: use "console" for shell examples
This allows for easier copying of the commands, without selecting the
prompt.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-06 17:20:01 +02:00
Sebastiaan van Stijn c88e4718cf
Merge pull request #12706 from aofdev/patch-2
Update examples.md (Add parameter platform value is nil)
2021-04-23 16:27:34 +02:00
Visarut Phusua 1fc1f0e4c9
Add parameter platform value is nil
- Run a container in the background
- Commit a container
2021-04-20 00:51:47 +07:00
Visarut Phusua ce3c977b70
Add parameter platform value is nil 2021-04-20 00:39:49 +07:00
Sebastiaan van Stijn 48b9da14ba
engine/api: add redirects and link for archived API versions
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-01-05 16:18:42 +01:00
Christian Clauss 1878deaf57
print() is a function in Python 3
Python 2 died on 1/1/2020 and legacy print statements are syntax errors in all currently supported versions of CPython.
2020-12-24 13:34:12 +01:00
Sebastiaan van Stijn 3ed7250644
Update engine reference for 20.10 release
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-12-09 00:50:04 +01:00
Sebastiaan van Stijn dc55bab431
engine/api: fix cURL examples for different cURL versions
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-28 17:57:07 +01:00
Rahul De c11ad3cd06
[#10166] Add clojure client 2020-10-25 09:33:09 +01:00
Sebastiaan van Stijn 393d3f6566
Add rel="noopener" to external links
See https://web.dev/external-anchors-use-rel-noopener/

Using noopener, as that addresses the security issue. "noreferer" blocks
the REFERER header, which may still be useful for some target URLs.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-12 13:09:30 +02:00
Sebastiaan van Stijn c821fe1871
Add missing descriptions, and move reference index page
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-07 11:23:20 +02:00
Nicolas De loof d75734b741
ECS local simulation (#11352)
* Document ECS local simulation mode

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>

* List "jocker" as SDK java implementation

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>

* Style updates

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
2020-09-10 16:07:21 +01:00
Sebastiaan van Stijn e9750cda78
engine/api: fix incorrect ID on "http" tab
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-08-04 15:26:56 +02:00
Frederic Hemberger e529754f96
examples.md: Actually use `ctx` variable in Go example
"List and manage containers" Go example:
`ctx := context.Background()` was defined but never used.
Follow the structure of the other examples instead.
2020-08-02 10:20:54 +02:00
Chris Crone 9b6fff076e
Merge pull request #10887 from carthurs/master
Basic go example was not working with v1.41
2020-07-16 14:09:17 +02:00
Andre Almar 6f38ea561b
Fixing ImageList Go code
Original: on line 18 we have `images, err := cli.ImageList(context.Background(), types.ImageListOptions{})` which gives us an error of:

```
# command-line-arguments
./main.go:12:2: ctx declared but not used
```

*Fix:* on line 18 we need to have `images, err := cli.ImageList(ctx, types.ImageListOptions{})`
2020-06-29 16:01:24 -03:00
Chris Arthurs 14e83cac6d
Basic go example was not working with v1.41
Fixed go example:
1) so that it actually compiles, and
2) so that you get to see the output `hello world` in visual studio code's console (`Tty: true,`).
2020-05-25 14:28:51 +01:00
Sebastiaan van Stijn 777c5d23da
engine: use relative markdown links
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-23 13:03:32 +02:00
Sebastiaan van Stijn d813acb6e1
Engine: reorganize install topic
- Move getting started overview to /get-started/overview/
- Move engine installation files under /engine/
- Redirect the top-level /install/ to /get-docker/
- Updated titles in left-hand navigation
- Added back some pages to the navigation that were
  currently not included.
- Reduce some steps in the installation pages
- Move devicemapper prerequisites to the devicemapper
  storage driver page.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-06 10:50:28 +02:00
Sebastiaan van Stijn 770cdeecb1
Engine API: use filename instead of custom api_version property
Now that the files are named `<api-version>.md`, we no longer need
to set a custom `api_version` property; instead we can use the filename
to detect what API version we're rendering.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-25 14:00:57 +01:00
Sebastiaan van Stijn 6dab89c905
Engine API: unify APIs: fetch from single branch
The upstream (moby/moby) repository is unifying all API swagger files
to be in the release branch. With that change, it is no longer needed
to fetch each version of the API separately, and instead all versions
can be fetched at once.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-25 14:00:55 +01:00
Sebastiaan van Stijn b7cf4b0888
Merge pull request #10332 from usha-mandya/engine-api-patch
Fix Engine API toc
2020-02-25 13:43:10 +01:00
Sebastiaan van Stijn 16d565cae6
API remove section about enterprise API version mismatch
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-24 17:15:27 +01:00
Sebastiaan van Stijn 3a223f799c
SDK: fix some minor issues in go examples
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-24 17:15:25 +01:00
Sebastiaan van Stijn c7c1a59dab
API docs: recommend using version negotiation
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-24 17:15:23 +01:00
Sebastiaan van Stijn 9774d43d65
SDK: remove reference to obsolete Go version
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-24 17:15:21 +01:00
Sebastiaan van Stijn d021c47d26
Remove duplicated API reference from SDK docs
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-24 17:15:19 +01:00
Sebastiaan van Stijn c4309a1ef7
Remove duplicated SDK content from API overview
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-24 17:15:17 +01:00
Sebastiaan van Stijn ee407ac0ef
Move SDK examples under "sdk"
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-24 17:15:06 +01:00
Sebastiaan van Stijn f757d8a14b
Engine API: use template for API reference pages
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-02-24 13:58:30 +01:00
Usha Mandya 1566e01673 Moved topics under engine/api/ 2020-02-21 16:44:41 +00:00
Sebastiaan van Stijn 05d91b90f3
Add Engine API version v1.40
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-06-13 15:05:36 +02:00
Sebastiaan van Stijn eac39d66cd
Share redoc JavaScript between API versions
This is similar to the changes made in  docker/docker.github.io#5607
(32958e7c60), but which appear
to didn't make their way into newer versions that were added.

The redoc JavaScript is a big file, and there's no need
to keep a separate copy for each version of the API.

This patch removes the copy per-version and moves the script
to a central location.

Size of the API directory:

before: 5.961.110 bytes (6 MB on disk)
after:     15.570 bytes (74 KB on disk)

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-06-13 14:59:21 +02:00
Sebastiaan van Stijn aae9bfc276
Rename / remove edge-related variables
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-01-14 22:44:58 +01:00
Maria Bermudez 1cdb109de0 Add new directories for Engine API versions 2018-11-06 13:02:43 -08:00
gbarr01 f36f3ec156 Update engine API docs, fetch script, and matrix 2018-03-22 16:52:53 -07:00
Joao Fernandes c9dcb9733c Revert "Update engine API docs, fetch script, and matrix"
This reverts commit 119bda6e17.
2018-03-22 11:58:07 -07:00
gbarr01 119bda6e17 Update engine API docs, fetch script, and matrix 2018-03-22 11:14:27 -07:00