summaryrefslogtreecommitdiff
path: root/pkg/api/server
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2020-06-11 14:43:44 -0400
committerGitHub <noreply@github.com>2020-06-11 14:43:44 -0400
commit1f05606fac7e5835cd76ef407a64597df3251aae (patch)
tree206a90dc7404821a01e5ff18702b65eaf8b49891 /pkg/api/server
parent1408dbfa4d7d9cffc7607a768f92a4fcaf3c8651 (diff)
parentdee1bf0d2f99389e0906568f5379ff89ef4ea1fe (diff)
downloadpodman-1f05606fac7e5835cd76ef407a64597df3251aae.tar.gz
podman-1f05606fac7e5835cd76ef407a64597df3251aae.tar.bz2
podman-1f05606fac7e5835cd76ef407a64597df3251aae.zip
Merge pull request #6564 from TomSweeneyRedHat/dev/tsweeney/apidocstart
[CI:DOCS] Add quick start directions to APIv2 Dock
Diffstat (limited to 'pkg/api/server')
-rw-r--r--pkg/api/server/docs.go18
1 files changed, 18 insertions, 0 deletions
diff --git a/pkg/api/server/docs.go b/pkg/api/server/docs.go
index c989c7927..d9e0a7eba 100644
--- a/pkg/api/server/docs.go
+++ b/pkg/api/server/docs.go
@@ -4,6 +4,24 @@
// only as experimental as this point. The endpoints, parameters, inputs, and
// return values can all change.
//
+// To start the service and keep it running for 5,000 seconds (-t 0 runs forever):
+// podman system service -t 5000 &
+//
+// You can then use cURL on the socket using requests documented below.
+//
+// NOTE: if you install the package podman-docker, it will create a symbolic
+// link for /var/run/docker.sock to /run/podman/podman.sock
+//
+// See podman-service(1) for more information.
+//
+// Quick Examples:
+// 'podman info'
+// curl --unix-socket /run/podman/podman.sock http://d/v1.0.0/libpod/info
+// 'podman pull quay.io/containers/podman'
+// curl -XPOST --unix-socket /run/podman/podman.sock -v 'http://d/v1.0.0/images/create?fromImage=quay.io%2Fcontainers%2Fpodman'
+// 'podman list images'
+// curl --unix-socket /run/podman/podman.sock -v 'http://d/v1.0.0/libpod/images/json' | jq
+//
// Terms Of Service:
//
// Schemes: http, https