diff options
| -rw-r--r-- | docs/source/Reference.rst | 2 | ||||
| -rw-r--r-- | pkg/api/Makefile | 2 | ||||
| -rw-r--r-- | pkg/api/server/server.go | 10 |
3 files changed, 11 insertions, 3 deletions
diff --git a/docs/source/Reference.rst b/docs/source/Reference.rst index 8f41f2b3e..c6a131bc7 100644 --- a/docs/source/Reference.rst +++ b/docs/source/Reference.rst @@ -1,4 +1,4 @@ Reference ========= -Check out our new `API documentation <_static/api.html>`_ +Check out our new in-development `API documentation <_static/api.html>`_ diff --git a/pkg/api/Makefile b/pkg/api/Makefile index 3d70376df..8a1556800 100644 --- a/pkg/api/Makefile +++ b/pkg/api/Makefile @@ -1,3 +1,5 @@ +export GO111MODULE=off + SWAGGER_OUT ?= swagger.yaml swagger: diff --git a/pkg/api/server/server.go b/pkg/api/server/server.go index 2bda5ad01..9abedb359 100644 --- a/pkg/api/server/server.go +++ b/pkg/api/server/server.go @@ -1,6 +1,8 @@ -// Package serviceapi Provides a Container compatible interface. +// Package serviceapi Provides a Container compatible interface (EXPERIMENTAL) // -// This documentation describes the HTTP LibPod interface +// This documentation describes the HTTP LibPod interface. It is to be consider +// only as experimental as this point. The endpoints, parameters, inputs, and +// return values can all change. // // Schemes: http, https // Host: podman.io @@ -8,6 +10,10 @@ // 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/ +// InfoExtensions: +// x-logo: +// - url: https://raw.githubusercontent.com/containers/libpod/master/logo/podman-logo.png +// - altText: "Podman logo" // // Consumes: // - application/json |