Skip to content

Issue-553 Documentation for new API (WIP)#728

Closed
eolivelli wants to merge 1 commit intoapache:masterfrom
eolivelli:newapi-docs
Closed

Issue-553 Documentation for new API (WIP)#728
eolivelli wants to merge 1 commit intoapache:masterfrom
eolivelli:newapi-docs

Conversation

@eolivelli
Copy link
Copy Markdown
Contributor

Add documentation for new API

@eolivelli eolivelli requested review from jiazhai and sijie November 15, 2017 13:10
@eolivelli eolivelli self-assigned this Nov 15, 2017
@eolivelli
Copy link
Copy Markdown
Contributor Author

@sijie can you take a first look ?

Copy link
Copy Markdown
Member

@jiazhai jiazhai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

currently +1 for this.

@jiazhai
Copy link
Copy Markdown
Member

jiazhai commented Nov 15, 2017

Seems #727 is going on, could we merge this after that, and change some of the description according to it?

@asfgit
Copy link
Copy Markdown

asfgit commented Nov 15, 2017

FAILURE

--none--

@sijie
Copy link
Copy Markdown
Member

sijie commented Nov 15, 2017

The API documentation should be the final change after we sort out all the api related issues.


## New API

Since 4.6 BookKeeper provides a new client API which leverages Java CompletableFuture facility.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you need also document

  • delete op
  • append api in WriteHandle
  • read api in ReadHandle

Also you need to update ledgeradv api page as well.

@sijie
Copy link
Copy Markdown
Member

sijie commented Nov 20, 2017

@eolivelli can you help pick this up? This will be blocking 4.6.0.

@eolivelli
Copy link
Copy Markdown
Contributor Author

Yes. I stopped for a while. I will address comments today

@sijie
Copy link
Copy Markdown
Member

sijie commented Nov 20, 2017

@eolivelli this issue has higher priority than BP18. would appreciate you help completed this. if you don't have time, I am okay to take it.

@eolivelli
Copy link
Copy Markdown
Contributor Author

I am doing this today (for me is early morning now), I will update the pr soon. I know this is a priority.
On 4.6 we have some other blocker, like the LedgerEntries stuff.

I think you are faster for many reasons.
You can pick this up and finish the work.
I am sorry

@sijie
Copy link
Copy Markdown
Member

sijie commented Nov 20, 2017

@eolivelli it is not clear to me. are you picking this up, or not?

regarding other blockers, we are trying to clean them up this week.

@eolivelli
Copy link
Copy Markdown
Contributor Author

Please pick this up, I think it is better.

@sijie
Copy link
Copy Markdown
Member

sijie commented Nov 23, 2017

@eolivelli I sent the pull request #764 . I will close this one since there is no activity on this one anymore.

@sijie sijie closed this Nov 23, 2017
@sijie sijie removed their assignment Nov 23, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants