Changeset 14026 for trunk/docs/contributor/code/README.md

Timestamp:

09/27/2024 09:11:27 PM (15 months ago)

Author:

espellcaste

Message:

Include the V2 of the BP REST API in BuddyPress core.

We are officially deprecating the V1 of the BP REST API. And bundling the new, default, V2 of the BP REST API inside BuddyPress core. Previously, the V1 was developed as a plugin in a separate repo (​https://github.com/buddypress/BP-REST).

• One of the main differences between the V1 and V2 is how objects are returned. Single items are no longer returned as an array;
• We have a new BP_Test_REST_Controller_Testcase for testing the new API endpoints;
• We changed the names of our controllers to follow our autoloader rules;
• Removed the BP-REST plugin from wp-env and from our release script;
• And we added notices for the deprecated V1 API (endpoints and files).

Props imath & I. ;)

Fixes #8200
See #9145
Closes ​https://github.com/buddypress/buddypress/pull/337

File:

• trunk/docs/contributor/code/README.md (modified) (5 diffs)

trunk/docs/contributor/code/README.md

@@ -111 +111 @@
 ```
 
-You should see that your `~/Plugins/buddypress` directory now contains 1 or 2 more sub directories: `/node_modules` and `/vendor` if you installed the composer packages.
+You should see that your `~/Plugins/buddypress` directory now contains 1 or 2 more subdirectories: `/node_modules` and `/vendor` if you installed the composer packages.
 
 ![Check installs](../assets/code-003-install-tools.png)
@@ -121 +121 @@
 ```
 
-The first time you’ll execute this command it will take some time to run and you’ll see that 2 downloads will start:
-
-- [BP REST](https://github.com/buddypress/BP-REST): it’s the plugin we use to develop the BP REST API.
+The first time you’ll execute this command it will take some time to run, and you’ll see that the following download will start:
+
 - [WordPress](https://core.trac.wordpress.org/browser/trunk): it’s the WordPress development version.
 
@@ -176 +175 @@
 ### Customizing your BuddyPress local development environment
 
-To develop BuddyPress we use the development version of [WordPress](https://core.trac.wordpress.org/browser/trunk), the development version of the [BP REST API](https://github.com/buddypress/BP-REST) and we set two debugging constants:
+To develop BuddyPress we use the development version of [WordPress](https://core.trac.wordpress.org/browser/trunk), and we set two debugging constants:
 
 ```php
@@ -190 +189 @@
 {
     "core": "WordPress/WordPress#master",
-    "plugins": [ ".", "buddypress/BP-REST#master", "buddypress/bp-classic#trunk" ],
+    "plugins": [ ".", "buddypress/bp-classic#trunk" ],
     "config": {
         "WP_DEBUG": true,
@@ -206 +205 @@
 ## Patching BuddyPress
 
-Let’s work with a real bug example (It might has been fixed when you’ll read this page!) to understand how to suggest a fix to the BuddyPress development team. First, open the `~/Plugins/buddypress` directory into your favorite code editor.
+Let’s work with a real bug example (It might have been fixed when you’ll read this page!) to understand how to suggest a fix to the BuddyPress development team. First, open the `~/Plugins/buddypress` directory into your favorite code editor.
 
 ![BP in VSCode](../assets/code-004-vscode-bp.png)