diff options
| author | Brent Baude <bbaude@redhat.com> | 2020-01-20 13:59:40 -0600 |
|---|---|---|
| committer | Brent Baude <bbaude@redhat.com> | 2020-01-20 13:59:55 -0600 |
| commit | f432999023d3529d60849987c885c6784f2ef1f0 (patch) | |
| tree | 3a3e20e9c925b80fd3a516c6fad497293754d4b8 | |
| parent | 9be64300d46341ab345f8c760b7a79cced7db3f9 (diff) | |
| download | podman-f432999023d3529d60849987c885c6784f2ef1f0.tar.gz podman-f432999023d3529d60849987c885c6784f2ef1f0.tar.bz2 podman-f432999023d3529d60849987c885c6784f2ef1f0.zip | |
[CI:DOCS] Add logo and dev statement
Add statement to the info section stating this is experimental only for now. Also add the podman logo to the right-hand navigation.
Signed-off-by: Brent Baude <bbaude@redhat.com>
| -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 |