Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updating endpoint to search categories throughout the entire tree of children of a given parent #28896

Closed
3 tasks
dsilvam opened this issue Jun 14, 2024 · 2 comments · Fixed by #29021, #29081, #29091, #29116 or #29251
Closed
3 tasks

Updating endpoint to search categories throughout the entire tree of children of a given parent #28896

dsilvam opened this issue Jun 14, 2024 · 2 comments · Fixed by #29021, #29081, #29091, #29116 or #29251
Assignees
@oidacra
Labels
QA : Approved QA : Passed Internal Release : 24.07.19 Bug Fixing Team : Falcon Type : Task

Comments

@dsilvam
Copy link
Contributor

dsilvam commented Jun 14, 2024 •
edited by freddyDOTCMS
Loading

Parent Issue

#28493

Task

Update the 'categories/children' endpoint to allow searching through the entire category tree starting from a specified inode. This means the search will begin from the specified inode category and then proceed recursively through its children.

It needs to accept partial searches, ala search_term.

Each returned categories need to include an array of its parents.

Proposed Objective

Core Features

Proposed Priority

Priority 2 - Important

Acceptance Criteria

  • * Ability to search by partial words
  • * Array of parents included for each returned/matched category.
  • * Postman test included

External Links... Slack Conversations, Support Tickets, Figma Designs, etc.

No response

Assumptions & Initiation Needs

No response

Quality Assurance Notes & Workarounds

No response

Sub-Tasks & Estimates

No response
@dsilvam dsilvam moved this from New to Next 1-3 Sprints in dotCMS - Product Planning Jun 14, 2024
@john-thomas-dotcms john-thomas-dotcms moved this from Next 1-3 Sprints to Current Sprint Backlog in dotCMS - Product Planning Jun 20, 2024
@freddyDOTCMS freddyDOTCMS moved this from Current Sprint Backlog to In Progress in dotCMS - Product Planning Jun 21, 2024
@freddyDOTCMS freddyDOTCMS self-assigned this Jun 21, 2024
@freddyDOTCMS freddyDOTCMS moved this from In Progress to In Review in dotCMS - Product Planning Jun 26, 2024
freddyDOTCMS added a commit that referenced this issue Jun 26, 2024
@freddyDOTCMS
#28896 Create Factory method to find categories in all levels
6c956f3
@freddyDOTCMS freddyDOTCMS mentioned this issue Jun 26, 2024
Merged
3 tasks
freddyDOTCMS added a commit that referenced this issue Jun 26, 2024
@freddyDOTCMS
#28896 Create API Method to find category in all levels
25f7d38
@freddyDOTCMS freddyDOTCMS mentioned this issue Jun 26, 2024
Closed
freddyDOTCMS added a commit that referenced this issue Jun 26, 2024
@freddyDOTCMS
#28896 Create Endpoint to find category in all levels
0ca3b06
freddyDOTCMS added a commit that referenced this issue Jun 26, 2024
@freddyDOTCMS
#28896 Feedback
3ceb562
freddyDOTCMS added a commit that referenced this issue Jun 26, 2024
@freddyDOTCMS
#28896 Feedback
44112c4
@freddyDOTCMS freddyDOTCMS moved this from In Review to In Progress in dotCMS - Product Planning Jun 27, 2024
@freddyDOTCMS freddyDOTCMS changed the title Create endpoint to search categories throughout the entire tree Update endpoint to search categories throughout the entire tree Jun 27, 2024
@dsilvam dsilvam changed the title Update endpoint to search categories throughout the entire tree Updating endpoint to search categories throughout the entire tree of children of a given parent Jun 27, 2024
github-merge-queue bot pushed a commit that referenced this issue Jul 2, 2024
@freddyDOTCMS
#28896 Create Factory method to find categories in all levels (#29021)
7e09771 
This is the first PR for #28896

Later I am going to use this Factory to create a API Method

### Proposed Changes
* Create Method to find categories in all levels and apply a filter


https://github.com/dotCMS/core/pull/29021/files#diff-bf828c747c99cefe73af7cec527db7f7e64bd4a66ba54a55eb1170f6a2996333R844

* Update the Cache with the result


https://github.com/dotCMS/core/pull/29021/files#diff-bf828c747c99cefe73af7cec527db7f7e64bd4a66ba54a55eb1170f6a2996333R863

We already have a method to find the ALL the categories and it update
the cache after execute the query, so I created a Util method to share
the code.


https://github.com/dotCMS/core/pull/29021/files#diff-bf828c747c99cefe73af7cec527db7f7e64bd4a66ba54a55eb1170f6a2996333R168

### Checklist
- [ ] Tests
- [ ] Translations
- [ ] Security Implications Contemplated (add notes if applicable)

### Additional Info
** any additional useful context or info **

### Screenshots
Original             |  Updated
:-------------------------:|:-------------------------:
** original screenshot **  |  ** updated screenshot **
freddyDOTCMS added a commit that referenced this issue Jul 2, 2024
@freddyDOTCMS
#28896 Creating API Level class to search Categories on the entire tree
476f287
@freddyDOTCMS freddyDOTCMS mentioned this issue Jul 2, 2024
Merged
freddyDOTCMS added a commit that referenced this issue Jul 2, 2024
@freddyDOTCMS
#28896 Updating ENdpoint to to search Categories on the entire tree
a50b48d
github-merge-queue bot pushed a commit that referenced this issue Jul 2, 2024
@freddyDOTCMS
#28896 Creating API Level class to search Categories on the entire tr…
884e181 
…ee (#29081)

This is the first PR for #28896

Later I am going to use this API on an Endpoint

### Proposed Changes
* Create API Method to search categories on the entire tree


https://github.com/dotCMS/core/pull/29081/files#diff-cc8d6686856cf74ed3cfdbbf782839a205ade11ffa80218a0a1365fe47ac7c17R497
github-merge-queue bot pushed a commit that referenced this issue Jul 2, 2024
@freddyDOTCMS
#28896 Updating ENdpoint to to search Categories on the entire tree (#…
6704bda 
…29091)

### Proposed Changes
* Include a new parameter on the category/children Endpoint, to look
through the Entire tree


https://github.com/dotCMS/core/pull/29091/files#diff-1677f12a3b6c8909f3436afc7817819af2f46ac5ae6a37bdfab43690ffa24780R242

*Include this parameter on the paginator also


https://github.com/dotCMS/core/pull/29091/files#diff-693f0b4479466ce339fe60e74bc320dc80aa8ce835d8e6fd661b32bdba348419R67
@github-actions github-actions bot mentioned this issue Jul 2, 2024
Merged
freddyDOTCMS added a commit that referenced this issue Jul 3, 2024
@freddyDOTCMS
#28896 Including listParents as attribute on the response of the chil…
bb8cd6c 
…dren Categories Endpoint
@freddyDOTCMS freddyDOTCMS mentioned this issue Jul 3, 2024
Merged
@freddyDOTCMS freddyDOTCMS moved this from In Progress to In Review in dotCMS - Product Planning Jul 3, 2024
github-merge-queue bot pushed a commit that referenced this issue Jul 4, 2024
@freddyDOTCMS
#28896 Including listParents as attribute on the response of the chil… (
a33cb02 
#29116)

Last PR for #28896

### Proposed Changes
* Create a new class to represent the Category plus the Hierarchy list


https://github.com/dotCMS/core/pull/29116/files#diff-89fd51608ec8ccbe6e79cf1e53ff4bf88fc7e79a82458f8d7aceda8555ce6cd7R18

* return this new class on the findAll CategoryFactory method


https://github.com/dotCMS/core/pull/29116/files#diff-88379e3d0d9b5a5c54cb2207518bb686c3a9243cf6419ff11377616a7cd88dd2R293

* Convert the Database result to HierarchedCategory instead of category


https://github.com/dotCMS/core/pull/29116/files#diff-bf828c747c99cefe73af7cec527db7f7e64bd4a66ba54a55eb1170f6a2996333R625
@dsilvam dsilvam moved this from In Review to Internal QA in dotCMS - Product Planning Jul 4, 2024
@oidacra oidacra self-assigned this Jul 8, 2024
@oidacra
Copy link
Member

oidacra commented Jul 11, 2024

Passed IQA, I can now get all the parents of a searched item and search all the children.

@oidacra oidacra closed this as completed Jul 11, 2024
@dsilvam dsilvam moved this from Internal QA to QA - Backlog in dotCMS - Product Planning Jul 11, 2024
@bryanboza bryanboza moved this from QA - Backlog to QA - In Progress in dotCMS - Product Planning Jul 11, 2024
@josemejias11
Copy link
Contributor

Approved: Tested on master_d501a60, Docker, macOS 14.5, FF v126.0.1

@josemejias11 josemejias11 moved this from QA - In Progress to Done in dotCMS - Product Planning Jul 16, 2024
freddyDOTCMS added a commit that referenced this issue Jul 17, 2024
@freddyDOTCMS
#28896 including countChildren atribute on the Endpoint response
32c2ad8
@github-actions github-actions bot mentioned this issue Jul 18, 2024
Merged
nicobytes pushed a commit that referenced this issue Jul 18, 2024
@freddyDOTCMS
#28896 including countChildren atribute on the Endpoint response (#29251
694202e 
)

### Proposed Changes
* Create new attribute


https://github.com/dotCMS/core/pull/29251/files#diff-89fd51608ec8ccbe6e79cf1e53ff4bf88fc7e79a82458f8d7aceda8555ce6cd7R22

* Calculate this new attribute in the SQL Query


https://github.com/dotCMS/core/pull/29251/files#diff-bf828c747c99cefe73af7cec527db7f7e64bd4a66ba54a55eb1170f6a2996333R955
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@oidacra oidacra

Labels
QA : Approved QA : Passed Internal Release : 24.07.19 Bug Fixing Team : Falcon Type : Task
Projects
dotCMS - Product Planning
Archived in project
Milestone
No milestone
4 participants
@dsilvam @oidacra @josemejias11 @freddyDOTCMS