ivankelly commented on a change in pull request #721: Issue 674: Documentation for HTTP endpoints URL: https://github.com/apache/bookkeeper/pull/721#discussion_r150514855
########## File path: site/docs/latest/admin/http.md ########## @@ -0,0 +1,317 @@ +--- +title: BookKeeper http endpoints +--- + +This document is to introducing BookKeeper http endpoints that could be used for BookKeeper administration. +If user want to use this feature, parameter "httpServerEnabled" need to be set to "true" in file conf/bk_server.conf. + +## All the endpoints + +Currently all the http endpoints could be divided into these 4 components: +1. Heartbeat: heartbeat for a specific bookie. +1. Config: doing the server configuration for a specific bookie. +1. Ledger: http endpoints related to ledgers. +1. Bookie: http endpoints related to bookies. +1. AutoRecovery: http endpoints related to auto recovery. + +## Heartbeat + +### Endpoint: /heartbeat +* Method: GET +* Description: Get heartbeat status for a specific bookie +* Response: + +| Code | Description | +|:-------|:------------| +|200 | Successful operation | + +## Config + +### Endpoint: /api/v1/config/server_config +1. Method: GET + * Description: Get value of all configured values overridden on local server config + * Response: + + | Code | Description | + |:-------|:------------| + |200 | Successful operation | + |403 | Don't have permission | + |404 | Error handling | Review comment: What does "Error handling" mean? Shouldn't this be "Not found"? ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
