RealDevSquad / RealDevSquad/website-backend

The stocks api

Open
#1,019 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Details

  • The /stocks API response has two keys: message and stocks.
  • The message key returns a response such as success or failure.
  • The stocks key is an array of all the stocks.
  • The stocks key should be changed to data.
  • Changing the stocks key to data can improve clarity and consistency.
  • Rename the /stocks/users/self to /stocks/self
  • There is no API for buying and selling stocks.
  • You can only create stocks and get a list of all the stocks that have been created.
  • The lack of an API for buying and selling stocks can limit functionality and usefulness.
  • It is important to have APIs that support core features and actions.
  • Implementing APIs for buying and selling stocks can improve the user experience.
  • This provides more options for users.

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

Start by tracing the existing /stocks and /stocks/users/self API entry points. Clarify whether the response-key rename, endpoint rename, and buy/sell APIs are all required, then identify the relevant tests or add coverage for each behavior. Done means the requested endpoints and response shape are implemented and verified.

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.