Skip to content

docs: add hackathons list API documentation#5313

Open
git-Rag wants to merge 1 commit into
SandeepVashishtha:masterfrom
git-Rag:docs/hackathons-list-api
Open

docs: add hackathons list API documentation#5313
git-Rag wants to merge 1 commit into
SandeepVashishtha:masterfrom
git-Rag:docs/hackathons-list-api

Conversation

@git-Rag
Copy link
Copy Markdown
Contributor

@git-Rag git-Rag commented Jun 1, 2026

Related Backend Implementation

SandeepVashishtha/Eventra-Backend#48

Description

This PR updates the API documentation to include the newly added hackathons list endpoint.

The documented endpoint allows clients to fetch available hackathons using GET /api/hackathons. This docs update reflects the current backend behavior for the public hackathons list API.

Changes Made

  • Documented GET /api/hackathons
  • Added public authentication details
  • Added sample request using curl
  • Added sample JSON response
  • Clarified that the endpoint returns a JSON array
  • Mentioned that pagination, filters, detail, create, update, delete, and registration endpoints are not included in this API yet

Notes

This PR only updates the frontend/docs repository API documentation.
No frontend components, package files, or application logic were modified.

@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 1, 2026

@git-Rag is attempting to deploy a commit to the sandeepvashishtha's projects Team on Vercel.

A member of the Team first needs to authorize it.

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.

1 participant