Status
Current state: "WIP/Under Discussion"
Discussion thread: N/A
JIRA: N/A
Released: 4.6.0
Motivation
Github #278 introduces http module <...>. However there are only two endpoints defined in #278. In order to fully leverage the http modules, we need to add more endpoints to this http endpoint.
Public Interfaces
N/A
Proposed Changes
Common Pattern:
/api/v1/<component>/<action>
- Components:
- config
- bookie
- ..
1 . Overview
api uri patten, media type (json), ...
2. Components:
- config
- ledgers
- bookies
- ...
3. Config:
- Get the server configuration used by a bookie
GET /api/v1/config/serverConfig - Response
- Status: 200 (OK)
- Json Response
- Unknown macro: {...}
4. Ledgers
5. Bookies
6. Recover
7. ...
Compatibility, Deprecation, and Migration Plan
This is a new component introduced in 4.6.0. So there is no migration required. You can still enable http endpint by setting `...` to true.
Test Plan
- Unit test
- will support backward compatibility test in future when there is more version introduced.
Rejected Alternatives
N/A