Переглянути джерело

Documentation updates for interactive sessions

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Sebastiaan van Stijn 8 роки тому
батько
коміт
b8b8a9c837
2 змінених файлів з 7 додано та 1 видалено
  1. 4 1
      api/swagger.yaml
  2. 3 0
      docs/api/version-history.md

+ 4 - 1
api/swagger.yaml

@@ -8508,6 +8508,9 @@ paths:
       description: |
       description: |
         Start a new interactive session with a server. Session allows server to call back to the client for advanced capabilities.
         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
         ### Hijacking
 
 
         This endpoint hijacks the HTTP connection to HTTP2 transport that allows the client to expose gPRC services on that connection.
         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"
           description: "server error"
           schema:
           schema:
             $ref: "#/definitions/ErrorResponse"
             $ref: "#/definitions/ErrorResponse"
-      tags: ["Session"]
+      tags: ["Session (experimental)"]

+ 3 - 0
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 /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.
 * `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`).
 * `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
 ## v1.30 API changes