CenterForDigitalHumanities/rerum_server_nodejs

Order Keys in GETs

Open

#67 opened on Mar 29, 2022

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)JavaScript (4 forks)auto 404
OSSenhancementgood first issue

Repository metrics

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

Description

Investigate whether or not it is worth having middleware to order/preference keys in the JSON Object(s) that are part of the return. Think about how this would act differently for getByID and getByProps, for example.

Contributor guide

Research direction
Analyze the current behavior of GET endpoints (getByID vs getByProps) regarding JSON key ordering. Determine if middleware to enforce consistent key ordering would improve API consistency and client experience.
Tech stack
javascript
Domain
backend
Issue type
Research
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
JavaScriptJSONAPI design
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60