buddyboss-platform icon indicating copy to clipboard operation
buddyboss-platform copied to clipboard

PROD-1439 #311 - Fix include param for platform document API

Open surajkrsingh opened this issue 3 years ago • 4 comments

All Submissions:

Changes proposed in this Pull Request:

Fixes https://github.com/buddyboss/buddyboss-platform-api/issues/311.

How to test the changes in this Pull Request:

  1. Pull the changes
  2. Check endpoint - site-url/wp-json/buddyboss/v1/document?include=10 ( e.g- document id as 10 )
  3. See the response

Proof Screenshots or Video

https://www.awesomescreenshot.com/video/5920582?key=aca06b75b795e13ec5bb84f5f86e5423

Other information:

  • [x] Have you added an explanation of what your changes do and why you'd like us to include them?
  • [ ] Have you written new tests for your changes, as applicable?
  • [x] Have you successfully run tests with your changes locally?

Changelog entry

Fixed the include param for platform document API

surajkrsingh avatar Nov 07 '21 16:11 surajkrsingh

@chetansatasiya As per the API document, it should have the include param - https://www.buddyboss.com/resources/api/#api-Document-GetBBDocuments

And also if we check the consistency with another API endpoint like groups, videos and media, has include param.

I didn't find the in param working for the document endpoints and the customer has created an issue because they follow the documentation.

Please let me know, your thought on this.

surajkrsingh avatar Nov 08 '21 03:11 surajkrsingh

@KartikSuthar @chetansatasiya Changes updated on the PR

We already making changes here - https://github.com/buddyboss/buddyboss-platform/pull/3141#discussion_r744421185

Tested the API result demo image

surajkrsingh avatar Nov 08 '21 07:11 surajkrsingh

@surajkrsingh Approved. can you prepare this for QA.

dipskakadiya avatar Dec 01 '21 05:12 dipskakadiya

Merged into dev and qa-ongoing

surajkrsingh avatar Dec 01 '21 05:12 surajkrsingh