diff options
| author | Matthew Heon <mheon@redhat.com> | 2020-06-29 14:26:07 -0400 |
|---|---|---|
| committer | Matthew Heon <matthew.heon@pm.me> | 2020-07-06 13:36:59 -0400 |
| commit | 56c873c14e68c0cb63488ad7ded60e831c2d4194 (patch) | |
| tree | 403909889611c7e38b153a67d4dc9417721e70f5 /docs | |
| parent | 042675b9b3376eb3960b98aa2298a278ddaecd3e (diff) | |
| download | podman-56c873c14e68c0cb63488ad7ded60e831c2d4194.tar.gz podman-56c873c14e68c0cb63488ad7ded60e831c2d4194.tar.bz2 podman-56c873c14e68c0cb63488ad7ded60e831c2d4194.zip | |
Add a note on the APIs supported by `system service`
This makes it clear that we target compatibility with a specific
Docker version (v1.40), but do not reject other versions. It also
adds a link to documentation on the Podman-specific API.
Signed-off-by: Matthew Heon <mheon@redhat.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/markdown/podman-system-service.1.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-system-service.1.md b/docs/source/markdown/podman-system-service.1.md index 3ae414f7a..7d18a6832 100644 --- a/docs/source/markdown/podman-system-service.1.md +++ b/docs/source/markdown/podman-system-service.1.md @@ -13,6 +13,10 @@ If no endpoint is provided, defaults will be used. The default endpoint for a r service is *unix:/run/podman/podman.sock* and rootless is *unix:/$XDG_RUNTIME_DIR/podman/podman.sock* (for example *unix:/run/user/1000/podman/podman.sock*) +The REST API provided by **podman system service** is split into two parts: a compatibility layer offering support for the Docker v1.40 API, and a Podman-native Libpod layer. +Documentation for the latter is available at *https://docs.podman.io/en/latest/_static/api.html*. +Both APIs are versioned, but the server will not reject requests with an unsupported version set. + ## OPTIONS **--time**, **-t** |