Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
koho committed Jun 15, 2020
1 parent 0431395 commit 10c7dc5
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,14 @@ Method: GET
Headers:
- Authorization: {token}

ContentType: JSON

Response:
- `code`: Status code. If no errors occurred, it should be zero. Otherwise, it's a nonzero value.
- `msg`: Message about calling result.
- `name`: Name of the service.
- `status`: The Service status(bool). It's `true` when the service is running.

Description:
- `name`: Service name.
- `token`: API token for authorization.
Expand All @@ -23,6 +31,14 @@ Method: GET
Headers:
- Authorization: {token}

ContentType: JSON

Response:
- `code`: Status code. If no errors occurred, it should be zero. Otherwise, it's a nonzero value.
- `msg`: Message about calling result.
- `name`: Name of the service.
- `action`: The control action of the service.

Description:
- `name`: Service name.
- `action`: Control action(start|stop).
Expand Down

0 comments on commit 10c7dc5

Please sign in to comment.