Initial draft of HTTP API docs #773
Conversation
|
By analyzing the blame information on this pull request, we identified @juliandunn, @TrevorBramble and @ryankeairns to be potential reviewers |
| # Monitor services through the HTTP API | ||
| When a service starts, the supervisor exposes the status of leader elections, gossip rumors, health, and other information through an HTTP API endpoint. This information can be useful in monitoring service health, results of leader elections, and so on. | ||
|
|
||
| Every supervisor has an HTTP API that provides information on: |
There was a problem hiding this comment.
the phraseology isn't quite right, because the user is expecting to read a list of nouns and instead gets handed a set of endpoints. Maybe just something like "The HTTP API provides a variety of information on the following endpoints"
|
Looks good overall; as a stretch goal I would say to show examples of each type of content |
|
☔ The latest upstream changes (presumably 1428c85) made this pull request unmergeable. Please resolve the merge conflicts. |
|
you want to rebase this and then we can take it? |
|
Sure. I'll add the ref content in another PR. Also squashing a couple commits. |
Signed-off-by: David Wrede <[email protected]>
|
cool, let's take it |
|
📌 Commit 6f01292 has been approved by |
Signed-off-by: David Wrede <[email protected]> Pull request: #773 Approved by: juliandunn
|
☀️ Test successful - travis |
Feel free to leave comments on the how to topic while I flesh out the ref topic. Once the ref topic is done, I'll add it to this PR.
Signed-off-by: David Wrede [email protected]