beenull/moby
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

api: fix description about logs

Browse source 
Signed-off-by: Akihiro Suda <suda.akihiro@lab.ntt.co.jp>
This commit is contained in:
Akihiro Suda 2019-03-02 17:06:31 +09:00
parent 32157f9b12
commit d2281bbfa3
1 changed files with 17 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

57
api/swagger.yaml
View file

@ -5177,15 +5177,15 @@ paths:
Note: This endpoint works only for containers with the `json-file` or `journald` logging driver. Note: This endpoint works only for containers with the `json-file` or `journald` logging driver.
operationId: "ContainerLogs" operationId: "ContainerLogs"
responses: responses:
101: 200:
description: "logs returned as a stream" description: |
logs returned as a stream in response body.
For the stream format, [see the documentation for the attach endpoint](#operation/ContainerAttach).
Note that unlike the attach endpoint, the logs endpoint does not upgrade the connection and does not
set Content-Type.
schema: schema:
type: "string" type: "string"
format: "binary" format: "binary"
200:
description: "logs returned as a string in response body"
schema:
type: "string"
404: 404:
description: "no such container" description: "no such container"
schema: schema:
@ -5205,10 +5205,7 @@ paths:
type: "string" type: "string"
- name: "follow" - name: "follow"
in: "query" in: "query"
description: | description: "Keep connection after returning logs."
Return the logs as a stream.
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).
type: "boolean" type: "boolean"
default: false default: false
- name: "stdout" - name: "stdout"
@ -9569,23 +9566,16 @@ paths:
get: get:
summary: "Get service logs" summary: "Get service logs"
description: | description: |
Get `stdout` and `stderr` logs from a service. Get `stdout` and `stderr` logs from a service. See also [`/containers/{id}/logs`](#operation/ContainerLogs).
**Note**: This endpoint works only for services with the `json-file` or `journald` logging drivers. **Note**: This endpoint works only for services with the `local`, `json-file` or `journald` logging drivers.
operationId: "ServiceLogs" operationId: "ServiceLogs"
produces:
- "application/vnd.docker.raw-stream"
- "application/json"
responses: responses:
101: 200:
description: "logs returned as a stream" description: "logs returned as a stream in response body"
schema: schema:
type: "string" type: "string"
format: "binary" format: "binary"
200:
description: "logs returned as a string in response body"
schema:
type: "string"
404: 404:
description: "no such service" description: "no such service"
schema: schema:
@ -9614,10 +9604,7 @@ paths:
default: false default: false
- name: "follow" - name: "follow"
in: "query" in: "query"
description: | description: "Keep connection after returning logs."
Return the logs as a stream.
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).
type: "boolean" type: "boolean"
default: false default: false
- name: "stdout" - name: "stdout"
@ -9826,23 +9813,16 @@ paths:
get: get:
summary: "Get task logs" summary: "Get task logs"
description: | description: |
Get `stdout` and `stderr` logs from a task. Get `stdout` and `stderr` logs from a task. See also [`/containers/{id}/logs`](#operation/ContainerLogs).
**Note**: This endpoint works only for services with the `json-file` or `journald` logging drivers. **Note**: This endpoint works only for services with the `local`, `json-file` or `journald` logging drivers.
operationId: "TaskLogs" operationId: "TaskLogs"
produces:
- "application/vnd.docker.raw-stream"
- "application/json"
responses: responses:
101: 200:
description: "logs returned as a stream" description: "logs returned as a stream in response body"
schema: schema:
type: "string" type: "string"
format: "binary" format: "binary"
200:
description: "logs returned as a string in response body"
schema:
type: "string"
404: 404:
description: "no such task" description: "no such task"
schema: schema:
@ -9871,10 +9851,7 @@ paths:
default: false default: false
- name: "follow" - name: "follow"
in: "query" in: "query"
description: | description: "Keep connection after returning logs."
Return the logs as a stream.
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).
type: "boolean" type: "boolean"
default: false default: false
- name: "stdout" - name: "stdout"