diff options
| author | Jhon Honce <jhonce@redhat.com> | 2020-01-22 10:41:35 -0700 |
|---|---|---|
| committer | Jhon Honce <jhonce@redhat.com> | 2020-01-22 15:17:14 -0700 |
| commit | da1186ae639c8101f05e4350986fdab0b1bd3566 (patch) | |
| tree | dfc8a73189dc16f9f36b3cf9f56f571ccbc4cfc3 /pkg/api/server/docs.go | |
| parent | c42383f70a7832faf1ba920d6c9e169a88b0e4d9 (diff) | |
| download | podman-da1186ae639c8101f05e4350986fdab0b1bd3566.tar.gz podman-da1186ae639c8101f05e4350986fdab0b1bd3566.tar.bz2 podman-da1186ae639c8101f05e4350986fdab0b1bd3566.zip | |
Enable swagger validation for each PR
* Update swagger:operation's to pass validation
* 'name' path parameter now used throughout API
* Added #/response/ok for 200 returns, TBD values have been replaced
with legal values.
Signed-off-by: Jhon Honce <jhonce@redhat.com>
Diffstat (limited to 'pkg/api/server/docs.go')
| -rw-r--r-- | pkg/api/server/docs.go | 29 |
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 |