Changeset 14042

Timestamp:

10/09/2024 04:36:10 AM (21 months ago)

Author:

imath

Message:

Documentation: start documenting v2 of the BP REST API

Add the following page to developer doc:

• Introduction about the BP REST API
• Reference: list of REST API Routes
• Components routes
• Members routes

NB: this commit also improves Components and Members REST controllers item schemas.

See ​https://buddypress.trac.wordpress.org/ticket/9145
Closes ​https://github.com/buddypress/buddypress/pull/382

Location:

trunk

Files:

• docs/developer/README.md (modified) (1 diff)
• docs/developer/execution-contexts/README.md (modified) (1 diff)
• docs/developer/execution-contexts/rest-api (added)
• docs/developer/execution-contexts/rest-api/README.md (added)
• docs/developer/execution-contexts/rest-api/components.md (added)
• docs/developer/execution-contexts/rest-api/members.md (added)
• docs/developer/execution-contexts/rest-api/reference.md (added)
• docs/developer/manifest.json (modified) (1 diff)
• src/bp-core/classes/class-bp-core-components-rest-controller.php (modified) (3 diffs)
• src/bp-members/classes/class-bp-members-rest-controller.php (modified) (1 diff)

trunk/docs/developer/README.md

@@ -13 +13 @@
 3. [BuddyPress Theme Compatibility](./theme-compat/README.md)
 4. [BuddyPress execution contexts](./execution-contexts/README.md)
+5. [BuddyPress REST API (v2)](./execution-contexts/rest-api/README.md)

trunk/docs/developer/execution-contexts/README.md

@@ -5 +5 @@
 1. Theme/front-end
 2. [Ajax](./ajax.md)
-3. REST API
+3. [REST API](./rest-api/README.md)
 4. Administration

trunk/docs/developer/manifest.json

@@ -73 +73 @@
         },
         {
+                "title": "BuddyPress REST API",
+                "slug": "bp-rest-api",
+                "markdown_source": "../developer/execution-contexts/rest-api/README.md",
+                "parent": null
+        },
+        {
+                "title": "BP REST API Reference",
+                "slug": "bp-rest-api-reference",
+                "markdown_source": "../developer/execution-contexts/rest-api/reference.md",
+                "parent": "bp-rest-api"
+        },
+        {
+                "title": "Components REST API routes",
+                "slug": "bp-rest-api-components",
+                "markdown_source": "../developer/execution-contexts/rest-api/components.md",
+                "parent": "bp-rest-api-reference"
+        },
+        {
+                "title": "Members REST API routes",
+                "slug": "bp-rest-api-members",
+                "markdown_source": "../developer/execution-contexts/rest-api/members.md",
+                "parent": "bp-rest-api-reference"
+        },
+        {
                 "title": "BuddyPress Functions",
                 "slug": "bp-functions",

trunk/src/bp-core/classes/class-bp-core-components-rest-controller.php

@@ -432 +432 @@
                         'title'       => $data['title'],
                         'description' => $data['description'],
-                        'features'    => array(),
+                        'features'    => null,
                 );
 
@@ -476 +476 @@
                                         break;
                                 default:
-                                        $features = array();
+                                        $features = null;
                                         break;
                         }
@@ -553 +553 @@
                                         ),
                                         'features'    => array(
+                                                'context'     => array( 'view', 'edit' ),
                                                 'description' => __( 'Information about active features for the component.', 'buddypress' ),
-                                                'type'        => 'array',
-                                                'context'     => array( 'view', 'edit' ),
-                                                'default'     => array(),
+                                                'type'        => array( 'object', 'null' ),
+                                                'properties'  => array(),
+                                                'default'     => null,
                                         ),
                                 ),

trunk/src/bp-members/classes/class-bp-members-rest-controller.php

@@ -1119 +1119 @@
                                                         ),
                                                 ),
-                                                'format'      => 'date-time',
                                                 'context'     => array( 'view', 'edit' ),
                                                 'readonly'    => true,