Changeset 14047

Timestamp:

10/18/2024 02:24:44 AM (8 months ago)

Author:

imath

Message:

Document the BuddyPress Groups REST API routes

Props espellcaste

See #9145
See ​https://github.com/buddypress/bp-documentation/issues/298
Closes ​https://github.com/buddypress/buddypress/pull/387

Location:

trunk

Files:

• docs/developer/execution-contexts/rest-api/activity.md (modified) (1 diff)
• docs/developer/execution-contexts/rest-api/groups.md (added)
• docs/developer/execution-contexts/rest-api/reference.md (modified) (1 diff)
• docs/developer/manifest.json (modified) (1 diff)
• src/bp-groups/classes/class-bp-groups-rest-controller.php (modified) (1 diff)

trunk/docs/developer/execution-contexts/rest-api/activity.md

@@ -89 +89 @@
 | --- | --- |
 | `primary_item_id` | The ID of some other object primarily associated with this one. <br />JSON data type: _integer_. |
-| `primary_item_id` | The ID of some other object also associated with this one. <br />JSON data type: _integer_. |
+| `secondary_item_id` | The ID of some other object also associated with this one. <br />JSON data type: _integer_. |
 | `link` | The permalink to this activity item on the site. <br />JSON data type: _string_, format: _URI_. |
 | `component` | The active BuddyPress component the activity relates to. <br />JSON data type: _string_. <br />One of: the active BuddyPress component names. <br />Default: `activity`. |

trunk/docs/developer/execution-contexts/rest-api/reference.md

@@ -23 +23 @@
 | Extended Profile Data | `/buddypress/v2/xprofile/<field_id>/data/<user_id>` |
 | Friends | `/buddypress/v2/friends` |
-| User Groups | `/buddypress/v2/groups` |
+| [User Groups](./groups.md) | `/buddypress/v2/groups` |
 | Group Profile Photo | `/buddypress/v2/groups/<group_id>/avatar` |
 | Group Profile Cover | `/buddypress/v2/groups/<group_id>/cover` |

trunk/docs/developer/manifest.json

@@ -187 +187 @@
     },
     {
+        "title": "User Groups REST API routes",
+        "slug": "bp-rest-api-groups",
+        "markdown_source": "../developer/execution-contexts/rest-api/groups.md",
+        "parent": "bp-rest-api-reference"
+    },
+    {
         "title": "BuddyPress Functions",
         "slug": "bp-functions",

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

@@ -1127 +1127 @@
             $key                         = 'create_item';
             $args['description']['type'] = 'string';
+            unset( $args['description']['properties'] );
 
             // Add group types.