summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2020-01-21 16:13:37 +0100
committerGitHub <noreply@github.com>2020-01-21 16:13:37 +0100
commitfb2bd26f7331ee3a1ca9690d9c2960ccadebc68f (patch)
treea31e3b68db08305f128418700e7080a44d6dca5a
parent9be64300d46341ab345f8c760b7a79cced7db3f9 (diff)
parentbf6f7c6fd87879581eb6dce578ea74dcdbc9abbf (diff)
downloadpodman-fb2bd26f7331ee3a1ca9690d9c2960ccadebc68f.tar.gz
podman-fb2bd26f7331ee3a1ca9690d9c2960ccadebc68f.tar.bz2
podman-fb2bd26f7331ee3a1ca9690d9c2960ccadebc68f.zip
Merge pull request #4914 from baude/apidevel
[CI:DOCS] Add logo and dev statement
-rw-r--r--.copr/Makefile2
-rw-r--r--docs/source/Reference.rst2
-rw-r--r--pkg/api/Makefile2
-rw-r--r--pkg/api/server/server.go10
4 files changed, 13 insertions, 3 deletions
diff --git a/.copr/Makefile b/.copr/Makefile
index 465a52b15..ff99cd5c6 100644
--- a/.copr/Makefile
+++ b/.copr/Makefile
@@ -5,6 +5,8 @@ outdir := $(CURDIR)
topdir := $(CURDIR)/rpmbuild
SHORT_COMMIT ?= $(shell git rev-parse --short=8 HEAD)
+export GO111MODULE=off
+
srpm:
mkdir -p $(topdir)
sh $(current_dir)/prepare.sh
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