- See previously: BP REST API chat summary (January 28)
- In attendance: @boonebgorges @espellcaste @im4th & 👀 @johnjamesjacoby
- Slack archive.
BP REST API
A huge work has been accomplished by @espellcaste 💪 so far from the feature as a plugin “BP REST” and we think the 5.0.0 release will be a good time to bring the REST API within BuddyPress core. As explained in #7156 it will introduce 14 BuddyPress endpoints and you’ll soon be able to play with activity updates, groups, members, private messages and extended profile fields using REST requests 🙌
8 other endpoints (eg: blogs, friends) will arrive in 6.0.0.
BP REST Documentation
As @boonebgorges said during the chat, this part is very important for us to help you build great BuddyPress plugins thanks to this new API. We’ve been looking for a nice tool to generate this documentation out of the endpoints schemas and we think we’ve found a good solution to start. We now have to put up a website to host this documentation. I’ll take care of sketching out the next steps of this site and @boonebgorges will be able to help for the domain name.
Let’s start using the API within BuddyPress core!
The best way to help you discover the BP REST API potential is to use it ourselves 😉. We plan to do so by improving how Group members are managed within the Group Manage screen (front-end) and the Group Admin screen (back-end). Below is a video demo to let you discover a bit early how it should look like on the front-end of your community site.
You can follow our progress from the #8045 ticket.
How to include the BP REST API into the BuddyPress plugin package?
We’ve been discussing about it for about 30 mins during the chat and we haven’t decided yet how this will happen. We have 2 options:
- Carry on maintaining it from GitHub.com and include it during the BuddyPress plugin’s build process (that’s what we’re doing for BP Default & BP CLI)
- Merge it into BuddyPress Core.
There are “pros” and “cons” for both options. For example, maintaining it from GitHub can be confusing for contributors because it adds a second place to report for this part of BuddyPress as @boonebgorges noted. It’s also problematic regarding the history of how the decisions were made: it would be “tied up in two places“. @espellcaste also expressed his preference, despite the fact working in GitHub is more convenient, about keeping things “in house” (we have less control about the future of GitHub). Finally @boonebgorges also explained we could keep it on GitHub for a couple of releases before bringing it home as “once we go Trac, we cannot go Back“.
Another relative point on this subjet: how plugins should behave if they are both activated?
- Should the plugin BP REST take over BuddyPress ? Meaning all endpoints can be maintained from the GitHub repository.
- Should it be BuddyPress? Meaning the BP REST plugin would only be used to develop the 8 remaining endpoints.
We agreed we still have time until the first beta release to decide, but if you have ideas or recommandations : please share them in comments 😊
About the 5.0.0 release schedule
We agreed on a first date : 5.0.0-beta1 will be released around August 15.
As discussed during the chat, it will give us the time to work on the documentation site and decide about the « BP REST API including » strategy.
It should also give us the time to clear the tickets list of the milestone, there are around 10 tickets left and you are very welcome to give us a hand testing or suggesting patches.
Until Beta1 we will have a dev chat every other Wednesday at 19:00 UTC in #BuddyPress. Here is the planning of our next meetings:
- June 26
- July 10
- July 24
- August 7
- August 21 (probably dedicated to the results and 1st feedbacks about 5.0.0-beta1)
- To be confirmed for the other dates.
If you are going to Berlin to attend to the WCEU 2019: have fun, make good connections and learn great things! @johnjamesjacoby will be there, don’t hesitate to enjoy his conference 👌 and chat with him about BuddyPress 😍
You can also decide to give a hand to BuddyPress during this WordCamp thanks to the contributing area! We’ll be very happy to help from where we are 😁