OpenSourceFellows / OpenSourceFellows/map_dashboard_hackathon

Endpoint to Fetch Users

Open
#50 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Advanced California Tribal GIS Hackathon
Dominant language
HTML
Stars
2
Forks
11
PR merge metrics
No merged PRs in 30d

Description

๐Ÿ› ๏ธ Fetching Users


๐Ÿ“‹ Endpoints Required

  • GET /api/v1/users โ€” List all resources (paginated)
  • GET /api/v1/users/:id โ€” Get a single resource by ID

๐Ÿ—‚๏ธ Data Schema

Describe or paste the expected request/response shape below.

NA - GET requests


---

## โœ… Acceptance Criteria
- [X] All endpoints return correct HTTP status codes
- [ ] Input validation is applied to request bodies and query params
- [X] Errors return consistent, descriptive JSON responses
- [ ] Endpoints are protected by appropriate auth/authorization middleware
- [X] Pagination supported on the list endpoint
- [X] Unit tests cover each endpoint (happy path + error cases)
- [X] Integration tests pass in CI
- [ ] OpenAPI / Swagger docs updated

---

## ๐Ÿ”’ Auth & Permissions
<!-- Describe which roles can access endpoints -->

---

## ๐Ÿ”— Related

<!-- Any related links -->
---

## ๐Ÿ’ฌ Additional Context
<!-- Any edge cases, business rules, soft deletes, cascades, rate limits, or other notes -->

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 locating the API entry points that serve GET /api/v1/users and GET /api/v1/users/:id. Review the existing endpoint tests and authentication, validation, and OpenAPI conventions before determining which unchecked acceptance criteria remain. Done means the listed validation, authorization, and documentation requirements are addressed without regressing the checked criteria.

Written by the indexing model from the issue text.

Assessment

Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.