OpenSourceFellows / OpenSourceFellows/map_dashboard_hackathon

Endpoint to update datasets

Open
#46 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

🛠️ Update Dataset


📋 Endpoints Required

  • PUT /api/v1/data_sources/:id/datasets/:id — Update resource

🗂️ Data Schema

Describe or paste the expected request/response shape below.

{
  name: string,
  rows: Array of data to insert, must have all the req. columns from table definition,
}

Note: See dataset.test.ts for examples of how to use the Dataset API.

✅ Acceptance Criteria

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

🔒 Auth & Permissions

N/A

🔗 Related


💬 Additional Context

Once the schema is in place, we won't have a good way to update it and will have to build that functionality out later. For now, this endpoint can just be used to insert data.

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 with src/db/models/tests/integration/dataset.test.ts and trace the Dataset API implementation behind the PUT /api/v1/data_sources/:id/datasets/:id endpoint. Confirm the request shape for name and rows, then verify validation, error responses, and integration coverage; the remaining acceptance items also mention authorization and OpenAPI documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, databases
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.