summaryrefslogtreecommitdiff
path: root/pkg/api/server
diff options
context:
space:
mode:
authorMatthew Heon <matthew.heon@pm.me>2020-05-14 16:58:42 -0400
committerMatthew Heon <matthew.heon@pm.me>2020-05-14 17:00:19 -0400
commit1641f4fc0d7c1d2f3e64e37d51fb50ededd8ddbb (patch)
treec7abd074fd4d4fd8473ca1527e2ff20acddc1efb /pkg/api/server
parent08d04c2e0512cd67e81965f4f6aee26a83fd4046 (diff)
downloadpodman-1641f4fc0d7c1d2f3e64e37d51fb50ededd8ddbb.tar.gz
podman-1641f4fc0d7c1d2f3e64e37d51fb50ededd8ddbb.tar.bz2
podman-1641f4fc0d7c1d2f3e64e37d51fb50ededd8ddbb.zip
Update API documentation for Inspect
Most importantly, note the pruning behavior of compat Inspect. Less importantly, note that the Tty parameter to Start is only ignored, as opposed to being not supported. Signed-off-by: Matthew Heon <matthew.heon@pm.me>
Diffstat (limited to 'pkg/api/server')
-rw-r--r--pkg/api/server/register_exec.go6
1 files changed, 3 insertions, 3 deletions
diff --git a/pkg/api/server/register_exec.go b/pkg/api/server/register_exec.go
index f1f1cc7e9..1571de90b 100644
--- a/pkg/api/server/register_exec.go
+++ b/pkg/api/server/register_exec.go
@@ -100,7 +100,7 @@ func (s *APIServer) registerExecHandlers(r *mux.Router) error {
// description: Detach from the command. Not presently supported.
// Tty:
// type: boolean
- // description: Allocate a pseudo-TTY. Not presently supported.
+ // description: Allocate a pseudo-TTY. Presently ignored.
// produces:
// - application/json
// responses:
@@ -153,7 +153,7 @@ func (s *APIServer) registerExecHandlers(r *mux.Router) error {
// tags:
// - exec (compat)
// summary: Inspect an exec instance
- // description: Return low-level information about an exec instance.
+ // description: Return low-level information about an exec instance. Stale (stopped) exec sessions will be auto-removed after inspect runs.
// parameters:
// - in: path
// name: id
@@ -267,7 +267,7 @@ func (s *APIServer) registerExecHandlers(r *mux.Router) error {
// description: Detach from the command. Not presently supported.
// Tty:
// type: boolean
- // description: Allocate a pseudo-TTY. Not presently supported.
+ // description: Allocate a pseudo-TTY. Presently ignored.
// produces:
// - application/json
// responses: