From 3821f2cd577da4d7d9302bcb586952125af6dff3 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Thu, 22 Jun 2017 15:36:56 -0700 Subject: [PATCH] Documentation updates for interactive sessions Signed-off-by: Sebastiaan van Stijn Upstream-commit: b8b8a9c837889c8851aade242ab1a1be0a8e7cf4 Component: engine --- components/engine/api/swagger.yaml | 5 ++++- components/engine/docs/api/version-history.md | 3 +++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/components/engine/api/swagger.yaml b/components/engine/api/swagger.yaml index f8493d5e9f..b4c1bd8b15 100644 --- a/components/engine/api/swagger.yaml +++ b/components/engine/api/swagger.yaml @@ -8508,6 +8508,9 @@ paths: description: | Start a new interactive session with a server. Session allows server to call back to the client for advanced capabilities. + > **Note**: This endpoint is *experimental* and only available if the daemon is started with experimental + > features enabled. The specifications for this endpoint may still change in a future version of the API. + ### Hijacking This endpoint hijacks the HTTP connection to HTTP2 transport that allows the client to expose gPRC services on that connection. @@ -8541,4 +8544,4 @@ paths: description: "server error" schema: $ref: "#/definitions/ErrorResponse" - tags: ["Session"] + tags: ["Session (experimental)"] diff --git a/components/engine/docs/api/version-history.md b/components/engine/docs/api/version-history.md index e546559957..1d19d56dce 100644 --- a/components/engine/docs/api/version-history.md +++ b/components/engine/docs/api/version-history.md @@ -22,6 +22,9 @@ keywords: "API, Docker, rcli, REST, documentation" * `POST /secrets/(name)/update` now returns status code 400 instead of 500 when updating a secret's content which is not the labels. * `POST /nodes/(name)/update` now returns status code 400 instead of 500 when demoting last node fails. * `GET /networks/(id or name)` now takes an optional query parameter `scope` that will filter the network based on the scope (`local`, `swarm`, or `global`). +* `POST /session` is a new endpoint that can be used for running interactive long-running protocols between client and + the daemon. This endpoint is experimental and only available if the daemon is started with experimental features + enabled. ## v1.30 API changes