summaryrefslogtreecommitdiff
path: root/pkg/api/server/docs.go
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2020-01-22 17:43:57 -0500
committerGitHub <noreply@github.com>2020-01-22 17:43:57 -0500
commitac3a6b80b0ccd2f9592110811ccf6fd844110b9e (patch)
tree5f788ecb4b9a1f412c7b7ae0d61bdf0a6765b513 /pkg/api/server/docs.go
parent8b377a79c240e4480339358db3b87263ec6cfef3 (diff)
parentda1186ae639c8101f05e4350986fdab0b1bd3566 (diff)
downloadpodman-ac3a6b80b0ccd2f9592110811ccf6fd844110b9e.tar.gz
podman-ac3a6b80b0ccd2f9592110811ccf6fd844110b9e.tar.bz2
podman-ac3a6b80b0ccd2f9592110811ccf6fd844110b9e.zip
Merge pull request #4936 from jwhonce/wip/swagger2
[CI:DOCS] Enable swagger validation for each PR
Diffstat (limited to 'pkg/api/server/docs.go')
-rw-r--r--pkg/api/server/docs.go29
1 files changed, 29 insertions, 0 deletions
diff --git a/pkg/api/server/docs.go b/pkg/api/server/docs.go
new file mode 100644
index 000000000..e028c6302
--- /dev/null
+++ b/pkg/api/server/docs.go
@@ -0,0 +1,29 @@
+// Package api Provides a container compatible interface. (Experimental)
+//
+// This documentation describes the HTTP Libpod interface. It is to be considered
+// only as experimental as this point. The endpoints, parameters, inputs, and
+// return values can all change.
+//
+// Terms Of Service:
+//
+// Schemes: http, https
+// Host: podman.io
+// BasePath: /
+// Version: 0.0.1
+// License: Apache-2.0 https://opensource.org/licenses/Apache-2.0
+// Contact: Podman <podman@lists.podman.io> https://podman.io/community/
+// Extensions:
+// x-logo:
+// - url: https://raw.githubusercontent.com/containers/libpod/master/logo/podman-logo.png
+// - altText: "Podman logo"
+//
+// Produces:
+// - application/json
+// - text/plain
+// - text/html
+//
+// Consumes:
+// - application/json
+// - application/x-tar
+// swagger:meta
+package server