Skip to content

Commit

Permalink
Update API.md
Browse files Browse the repository at this point in the history
Fix some linebreak formatting issues
  • Loading branch information
z-bsod authored Apr 5, 2021
1 parent ae68660 commit 698cae4
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@ As of API version 0.2, there are two API endpoints:
## List of active streams
You can query for a list of active streams, by sending a GET request to
`localhost:8080/api/streams/`

Here's an example query and the expected result:

`$ curl http://localhost:8080/api/v0.2/streams/`
`$ curl http://localhost:8080/api/v0.2/streams/`\
Response example:
```json
{
Expand All @@ -22,7 +23,8 @@ i.e. There are two active streams in the `live` app, namely foo and bar. More in

## Query Stream information
If you know the app and name of the stream you want to query, you can request more information,with a query like this:
`$ curl http://localhost:8080/api/v0.2/streams/foo/`

`$ curl http://localhost:8080/api/v0.2/streams/foo/`\
Response example:
```json
{
Expand All @@ -36,5 +38,4 @@ Response example:
]
}
}

```

0 comments on commit 698cae4

Please sign in to comment.