diff options
| author | TomSweeneyRedHat <tsweeney@redhat.com> | 2020-07-25 13:54:45 -0400 |
|---|---|---|
| committer | TomSweeneyRedHat <tsweeney@redhat.com> | 2020-07-25 13:57:40 -0400 |
| commit | ba6a182155c6a0e68699448d9c847e9f5f1c451e (patch) | |
| tree | 7af5209dd49e9ed35ed084fcf1b2d643f3f6bfa1 /pkg/api/server/docs.go | |
| parent | c2deeff10101a5d9da70ecf496f8bdfc4ec99fb4 (diff) | |
| download | podman-ba6a182155c6a0e68699448d9c847e9f5f1c451e.tar.gz podman-ba6a182155c6a0e68699448d9c847e9f5f1c451e.tar.bz2 podman-ba6a182155c6a0e68699448d9c847e9f5f1c451e.zip | |
Remove 'experimental' from API doc
The v2.0 reference [page](http://docs.podman.io/en/latest/Reference.html)
lists the API as experimental. Removed that word and reworked the first
paragraph a bit based on verbiage that @mheon put together for the
API intro blog.
Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
Diffstat (limited to 'pkg/api/server/docs.go')
| -rw-r--r-- | pkg/api/server/docs.go | 10 |
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): // |