Kaynağa Gözat

Merge pull request #391 from thaJeztah/19.03_backport_session_endpoint_docs_updates

[19.03 backport] API: update docs that /session left experimental in V1.39
Andrew Hsu 5 yıl önce
ebeveyn
işleme
2ae5cbcf05
2 değiştirilmiş dosya ile 4 ekleme ve 4 silme
  1. 1 4
      api/swagger.yaml
  2. 3 0
      docs/api/version-history.md

+ 1 - 4
api/swagger.yaml

@@ -10379,9 +10379,6 @@ 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.
@@ -10415,4 +10412,4 @@ paths:
           description: "server error"
           description: "server error"
           schema:
           schema:
             $ref: "#/definitions/ErrorResponse"
             $ref: "#/definitions/ErrorResponse"
-      tags: ["Session (experimental)"]
+      tags: ["Session"]

+ 3 - 0
docs/api/version-history.md

@@ -87,6 +87,9 @@ keywords: "API, Docker, rcli, REST, documentation"
 * `POST /swarm/init` now accepts a `DefaultAddrPool` property to set global scope default address pool
 * `POST /swarm/init` now accepts a `DefaultAddrPool` property to set global scope default address pool
 * `POST /swarm/init` now accepts a `SubnetSize` property to set global scope networks by giving the
 * `POST /swarm/init` now accepts a `SubnetSize` property to set global scope networks by giving the
   length of the subnet masks for every such network
   length of the subnet masks for every such network
+* `POST /session` (added in [V1.31](#v131-api-changes) is no longer experimental.
+  This endpoint can be used to run interactive long-running protocols between the
+  client and the daemon.
 
 
 ## V1.38 API changes
 ## V1.38 API changes