docs(arcgis-rest-portal): fix incorrect documentation for searchGroupContent #1208
Conversation
gavinr-maps
changed the title
There was a problem hiding this comment.
Thanks for the contribution! I have a few comments below. Also, the changes to CHANGELOG.md do not look related to this PR .. where did those come from? I think you can probably remove those changes from this PR.
Same for the changes to package.json and package-lock.json ... I do not think you should make version changes in the PR - our automatic release system will change those.
| * searchGroupContent({ | ||
| * q: 'water', | ||
| * groupId: 'abc123' | ||
| * }) | ||
| * .then(response => { | ||
| * console.log(response.total); // response.total => 355 | ||
| * }); |
There was a problem hiding this comment.
This section looks good. I think you can remove the // response.total => 355 line since this is just a fake example the number 355 does not really make sense.
| * @param options.q - The search query (required). | ||
| * @param options.groupId - The ID of the group to search within (required). | ||
| * @param options.params - Additional search parameters (optional). |
There was a problem hiding this comment.
I do not think you need to add these lines ... the automatic doc generator will link to ISearchGroupContentOptions properly as it does currently on https://developers.arcgis.com/arcgis-rest-js/api-reference/arcgis-rest-portal/searchGroupContent/ :
Deleted requested commented code.
Updated version to previous one
Updated version to previous one
Done
Reverted back to previous changes
Deleted the requested ,reverted back to correct one
There was a problem hiding this comment.
Looks good to me. @patrickarlt is this what you were envisioning for #1205?
What
This PR fixes the incorrect documentation for the
searchGroupContentmethod in thearcgis-rest-portalmodule. The previous documentation incorrectly suggested passing a string as a parameter, but the method actually requires anoptionsobject containingqandgroupId.Why
The current documentation is misleading, causing confusion for developers trying to use this method correctly. This fix ensures the documentation aligns with the method's expected behavior.
How
searchGroupContentfunction inpackages/arcgis-rest-portal/src/search.ts.optionsobject.Context
Fixes #1205
Reference: searchGroupContent REST Documentation
Checklist
searchGroupContent.npm testto ensure no existing functionality is broken.