Skip to content

docs: expand API endpoints documentation - #1732

Merged
mohityadav8 merged 1 commit into
AnthropicBots:mainfrom
ankitasahu83964:docs/api-endpoints-1731
Sep 5, 2026
Merged

docs: expand API endpoints documentation#1732
mohityadav8 merged 1 commit into
AnthropicBots:mainfrom
ankitasahu83964:docs/api-endpoints-1731

Conversation

@ankitasahu83964

Copy link
Copy Markdown
Contributor

Summary

  • Added detailed API endpoint documentation in docs/API.md
  • Documented HTTP methods, authentication requirements, request examples, success responses, and common errors
  • Added documentation for authentication, products, cart, checkout, orders, wishlist, addresses, and promotions
  • Linked the detailed API documentation from README.md

Testing

  • npm run check:syntax

Related Issue

Closes #1731

@hydra-maintainer

Copy link
Copy Markdown

🔍 Quality Gate Report

✅ All quality gates passed!

Status Check Details
Linked Issue PR description references a closing issue ✅

@vercel

vercel Bot commented Aug 31, 2026

Copy link
Copy Markdown

@ankitasahu83964 is attempting to deploy a commit to the Bhuvansh's projects Team on Vercel.

A member of the Team first needs to authorize it.

@hydra-maintainer

Copy link
Copy Markdown

🤖 AI Code Review

🔴 Score: 50/100 | comment

AI review unavailable at this time.


Automated AI review — a human maintainer will also review.

@hydra-maintainer

Copy link
Copy Markdown

🔴 PR Health Score: 30/100

This PR's health score is below the 75/100 threshold for a healthy label.

Status Signal
Test coverage
Linked issue
PR description (≥50 chars)
DCO sign-off
⬜ 0 approval(s) Approvals
Diff size < 400 lines

Improving these signals will help reviewers engage faster and raise your score. 💪

Signed-off-by: Ankita Sahu <ankitasahu83964@gmail.com>
@ankitasahu83964
ankitasahu83964 force-pushed the docs/api-endpoints-1731 branch from 13d90bf to b49bb8c Compare August 31, 2026 18:36
@hydra-maintainer

Copy link
Copy Markdown

🔍 Quality Gate Report

✅ All quality gates passed!

Status Check Details
Linked Issue PR description references a closing issue ✅

@hydra-maintainer

Copy link
Copy Markdown

🤖 AI Code Review

🔴 Score: 50/100 | comment

AI review unavailable at this time.


Automated AI review — a human maintainer will also review.

@hydra-maintainer

Copy link
Copy Markdown

🔴 PR Health Score: 30/100

This PR's health score is below the 75/100 threshold for a healthy label.

Status Signal
Test coverage
Linked issue
PR description (≥50 chars)
DCO sign-off
⬜ 0 approval(s) Approvals
Diff size < 400 lines

Improving these signals will help reviewers engage faster and raise your score. 💪

@ankitasahu83964

Copy link
Copy Markdown
Contributor Author

Hi maintainers, I ran the backend test suite locally after completing the documentation changes.

The backend suite currently reports pre-existing failures unrelated to this documentation PR:

  • mergeScarRegression.test.js
  • cartBulkSelection.test.js
  • wishlistReads.test.js

The failures are in existing application/test expectations around product stock bindings, global cart handlers, and wishlist product filters. The PR itself only changes docs/API.md and README.md.

The syntax check passes successfully with npm run check:syntax.

@mohityadav8
mohityadav8 merged commit e6f8742 into AnthropicBots:main Sep 5, 2026
2 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: 📚 Improve and Expand API Endpoints Documentation

2 participants