Browse code

Merge pull request #38819 from AkihiroSuda/fix-logs-docs

api: fix description about logs

Sebastiaan van Stijn authored on 2019/04/04 00:11:51
Showing 1 changed files
... ...
@@ -5177,15 +5177,15 @@ paths:
5177 5177
         Note: This endpoint works only for containers with the `json-file` or `journald` logging driver.
5178 5178
       operationId: "ContainerLogs"
5179 5179
       responses:
5180
-        101:
5181
-          description: "logs returned as a stream"
5182
-          schema:
5183
-            type: "string"
5184
-            format: "binary"
5185 5180
         200:
5186
-          description: "logs returned as a string in response body"
5181
+          description: |
5182
+                  logs returned as a stream in response body.
5183
+                  For the stream format, [see the documentation for the attach endpoint](#operation/ContainerAttach).
5184
+                  Note that unlike the attach endpoint, the logs endpoint does not upgrade the connection and does not
5185
+                  set Content-Type.
5187 5186
           schema:
5188 5187
             type: "string"
5188
+            format: "binary"
5189 5189
         404:
5190 5190
           description: "no such container"
5191 5191
           schema:
... ...
@@ -5205,10 +5205,7 @@ paths:
5205 5205
           type: "string"
5206 5206
         - name: "follow"
5207 5207
           in: "query"
5208
-          description: |
5209
-            Return the logs as a stream.
5210
-
5211
-            This will return a `101` HTTP response with a `Connection: upgrade` header, then hijack the HTTP connection to send raw output. For more information about hijacking and the stream format, [see the documentation for the attach endpoint](#operation/ContainerAttach).
5208
+          description: "Keep connection after returning logs."
5212 5209
           type: "boolean"
5213 5210
           default: false
5214 5211
         - name: "stdout"
... ...
@@ -9569,23 +9566,16 @@ paths:
9569 9569
     get:
9570 9570
       summary: "Get service logs"
9571 9571
       description: |
9572
-        Get `stdout` and `stderr` logs from a service.
9572
+        Get `stdout` and `stderr` logs from a service. See also [`/containers/{id}/logs`](#operation/ContainerLogs).
9573 9573
 
9574
-        **Note**: This endpoint works only for services with the `json-file` or `journald` logging drivers.
9574
+        **Note**: This endpoint works only for services with the `local`, `json-file` or `journald` logging drivers.
9575 9575
       operationId: "ServiceLogs"
9576
-      produces:
9577
-        - "application/vnd.docker.raw-stream"
9578
-        - "application/json"
9579 9576
       responses:
9580
-        101:
9581
-          description: "logs returned as a stream"
9582
-          schema:
9583
-            type: "string"
9584
-            format: "binary"
9585 9577
         200:
9586
-          description: "logs returned as a string in response body"
9578
+          description: "logs returned as a stream in response body"
9587 9579
           schema:
9588 9580
             type: "string"
9581
+            format: "binary"
9589 9582
         404:
9590 9583
           description: "no such service"
9591 9584
           schema:
... ...
@@ -9614,10 +9604,7 @@ paths:
9614 9614
           default: false
9615 9615
         - name: "follow"
9616 9616
           in: "query"
9617
-          description: |
9618
-            Return the logs as a stream.
9619
-
9620
-            This will return a `101` HTTP response with a `Connection: upgrade` header, then hijack the HTTP connection to send raw output. For more information about hijacking and the stream format, [see the documentation for the attach endpoint](#operation/ContainerAttach).
9617
+          description: "Keep connection after returning logs."
9621 9618
           type: "boolean"
9622 9619
           default: false
9623 9620
         - name: "stdout"
... ...
@@ -9826,23 +9813,16 @@ paths:
9826 9826
     get:
9827 9827
       summary: "Get task logs"
9828 9828
       description: |
9829
-        Get `stdout` and `stderr` logs from a task.
9829
+        Get `stdout` and `stderr` logs from a task. See also [`/containers/{id}/logs`](#operation/ContainerLogs).
9830 9830
 
9831
-        **Note**: This endpoint works only for services with the `json-file` or `journald` logging drivers.
9831
+        **Note**: This endpoint works only for services with the `local`, `json-file` or `journald` logging drivers.
9832 9832
       operationId: "TaskLogs"
9833
-      produces:
9834
-        - "application/vnd.docker.raw-stream"
9835
-        - "application/json"
9836 9833
       responses:
9837
-        101:
9838
-          description: "logs returned as a stream"
9839
-          schema:
9840
-            type: "string"
9841
-            format: "binary"
9842 9834
         200:
9843
-          description: "logs returned as a string in response body"
9835
+          description: "logs returned as a stream in response body"
9844 9836
           schema:
9845 9837
             type: "string"
9838
+            format: "binary"
9846 9839
         404:
9847 9840
           description: "no such task"
9848 9841
           schema:
... ...
@@ -9871,10 +9851,7 @@ paths:
9871 9871
           default: false
9872 9872
         - name: "follow"
9873 9873
           in: "query"
9874
-          description: |
9875
-            Return the logs as a stream.
9876
-
9877
-            This will return a `101` HTTP response with a `Connection: upgrade` header, then hijack the HTTP connection to send raw output. For more information about hijacking and the stream format, [see the documentation for the attach endpoint](#operation/ContainerAttach).
9874
+          description: "Keep connection after returning logs."
9878 9875
           type: "boolean"
9879 9876
           default: false
9880 9877
         - name: "stdout"