summaryrefslogtreecommitdiff
path: root/pkg/api/server/docs.go
diff options
context:
space:
mode:
Diffstat (limited to 'pkg/api/server/docs.go')
-rw-r--r--pkg/api/server/docs.go10
1 files changed, 6 insertions, 4 deletions
diff --git a/pkg/api/server/docs.go b/pkg/api/server/docs.go
index 124c16092..1aaf31117 100644
--- a/pkg/api/server/docs.go
+++ b/pkg/api/server/docs.go
@@ -1,8 +1,10 @@
-// Package api Provides a container compatible interface. (Experimental)
+// Package api Provides a container compatible interface.
//
-// 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.
+// This documentation describes the Podman v2.0 RESTful API.
+// It replaces the Podman v1.0 API and was initially delivered
+// along with Podman v2.0. It consists of a Docker-compatible
+// API and a Libpod API providing support for Podman’s unique
+// features such as pods.
//
// To start the service and keep it running for 5,000 seconds (-t 0 runs forever):
//