shift-org/shift-docs

Change API response when requesting an invalid event ID

Open

#566 opened on Jan 24, 2024

View on GitHub
 (1 comment) (0 reactions) (1 assignee)JavaScript (24 forks)auto 404
APIbackendgood first issue

Repository metrics

Stars
 (28 stars)
PR merge metrics
 (PR metrics pending)

Description

Currently, if you request a single event by ID (e.g. /events.php?id=99999) and the ID is non-existent or the event was deleted, we return a 200 OK response with an empty array. This is essentially a "not found" response, but in a roundabout way. We should just return a proper 404 response.

(But we should continue to return an empty array for day range requests that don't have any events scheduled. An empty array is meaningful in that scenario.)

Contributor guide

Research direction
Locate the handler for /events.php?id=... and modify the response to return a 404 status when the event ID is not found, while keeping the empty array for date range queries.
Tech stack
phpjavascript
Domain
backendapi
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPHP
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75