...

Motivation

Github #278 introduces http module <...>BookKeeper Http Endpoint module. However there are only two endpoints, which is “/heartbeat” and “/api/config/serverConfig”, defined in #278. In order to fully leverage the http modules, we need The goal is to add more endpoints to this http endpointmodules.

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:

...

3. Config:

...

 {...}

1, Overview

Provide Http EndPoints for these components:

* Components:

    * Root endpoint: List all the available endpoints

    * Config: Do the configuration.

    * Bookkeeper : API related to BookKeeper.

    * Ledger: API related to ledgers

    * Bookie: API related to Bookie

    * Recover: API related to Recover

 

All API access is over HTTPS. All data is sent and received as JSON.
The common REST API Pattern will be:

/api/v1/<component>/<action>

 

...

 

4. Ledgers

5. Bookies

6. Recover

7. ...

 

 

Compatibility, Deprecation, and Migration Plan

...