Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add swagger tags & use markdown in description #41

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions swagger.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ info:
Note that the endpoints in this spec are all *service-specific*. dcos-log
is designed to be put behind Admin Router, which provides security for these
endpoints. Therefore, on a DC/OS cluster, the final URL to query will resemble:
http://<host>/system/v1/agent/<agent-id>/logs/v1/<endpoint>
For more information, please consult the project documentation located at
<https://github.com/dcos/dcos-log>.
`http://{cluster-url}/system/v1/agent/{agent-id}/logs/v1/{resource-path}`
For more information, see
[DC/OS Logging](http://localhost:3000/docs/latest/monitoring/logging/) or
the [DC/OS Log Source](https://github.com/dcos/dcos-log).
basePath: "/v1"
parameters:
filter:
Expand Down Expand Up @@ -62,6 +63,8 @@ paths:
get:
description: |
Gets a range of logs from the beggining of the journal.
tags:
- range
parameters:
- $ref: "#/parameters/filter"
- $ref: "#/parameters/limit"
Expand All @@ -85,6 +88,8 @@ paths:
get:
description: |
Download compressed logs.
tags:
- range
parameters:
- $ref: "#/parameters/filter"
- $ref: "#/parameters/limit"
Expand All @@ -109,6 +114,8 @@ paths:
get:
description: |
Gets a range of task logs.
tags:
- range
parameters:
- $ref: "#/parameters/filter"
- $ref: "#/parameters/limit"
Expand All @@ -132,6 +139,8 @@ paths:
get:
description: |
Download compressed task logs.
tags:
- range
parameters:
- $ref: "#/parameters/filter"
- $ref: "#/parameters/limit"
Expand All @@ -156,6 +165,8 @@ paths:
get:
description: |
Stream the log entries back to client with Server-Sent-Events.
tags:
- stream
parameters:
- $ref: "#/parameters/filter"
- $ref: "#/parameters/limit"
Expand All @@ -177,6 +188,8 @@ paths:
get:
description: |
Stream the task log entries back to client with Server-Sent-Events.
tags:
- stream
parameters:
- $ref: "#/parameters/filter"
- $ref: "#/parameters/limit"
Expand All @@ -198,6 +211,8 @@ paths:
get:
description: |
Get all available unique values for a given field.
tags:
- fields
responses:
200:
description: Successful response.
Expand Down