summaryrefslogtreecommitdiff
path: root/pkg/api/server/docs.go
diff options
context:
space:
mode:
authorTomSweeneyRedHat <tsweeney@redhat.com>2020-06-11 16:02:02 -0400
committerTomSweeneyRedHat <tsweeney@redhat.com>2020-06-11 16:02:06 -0400
commit05b90a04b27a1dc65535e4f2bf42980dd6593a57 (patch)
tree2914c20a2e0e15383da50334cad89b9b85b209a1 /pkg/api/server/docs.go
parent1f05606fac7e5835cd76ef407a64597df3251aae (diff)
downloadpodman-05b90a04b27a1dc65535e4f2bf42980dd6593a57.tar.gz
podman-05b90a04b27a1dc65535e4f2bf42980dd6593a57.tar.bz2
podman-05b90a04b27a1dc65535e4f2bf42980dd6593a57.zip
[CI:DOCS] Fix carriage returns in API v2 header
ReadTheDocs was wrapping lines and removing leading spaces unless there a blank line in between. This adds the blank lines to make the examples more readable on https://docs.podman.io/en/latest/_static/api.html Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
Diffstat (limited to 'pkg/api/server/docs.go')
-rw-r--r--pkg/api/server/docs.go7
1 files changed, 7 insertions, 0 deletions
diff --git a/pkg/api/server/docs.go b/pkg/api/server/docs.go
index d9e0a7eba..124c16092 100644
--- a/pkg/api/server/docs.go
+++ b/pkg/api/server/docs.go
@@ -5,6 +5,7 @@
// 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.
@@ -15,11 +16,17 @@
// 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: