containers
/
podman
mirror of https://github.com/containers/podman.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[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>
This commit is contained in:
TomSweeneyRedHat 2020-06-11 16:02:02 -04:00
parent 1f05606fac
commit 05b90a04b2
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
pkg/api/server/docs.go
View File

@ -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: