RealDevSquad / RealDevSquad/website-backend

Separate APIs for Filtered Search Results and Details Retrieval

Open
#1,229 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
74
Forks
276
Avg merge
1d 26m
Merged PRs (30d)
14

Description

Currently, our existing API provides filtered search results for tasks, users, skills, goals, and other entities directly in a single response. However, this approach poses limitations in terms of flexibility, performance, and data retrieval efficiency. To address these challenges, we propose the implementation of two separate APIs. The first API will be responsible for providing filtered search results, returning only the relevant entity IDs. The second API will utilize the provided IDs to retrieve detailed information about the entities.

By implementing separate APIs for filtered search results and details retrieval, we aim to enhance the flexibility, performance, and efficiency of our system, enabling better data management and retrieval capabilities for our users and client applications.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue does not name files, tests, endpoints, or entry points. Start by mapping the existing filtered-search responses for tasks, users, skills, goals, and other entities, then determine the API boundaries and ID-to-details flow. Done means the proposed separation is implemented with clear behavior for both search and detail retrieval.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, nodejs
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.