CenterForDigitalHumanities / CenterForDigitalHumanities/TPEN-services

Error Handling and Responding to Clients in Routes

Open
#480 0 comments 0 reactions 0 assignees View on GitHub
core-functionality enhancement
Dominant language
JavaScript
Stars
2
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Files in the following directories interact with the Express request and response stream. They explicitly determine response status codes and status messages. These responses should all be in accordance with RESTful best practices.

- /
- project/
- layer/
- page/
- line/
- utilities/

Review all error catching and handling scenarios as it pertains to what response is sent to clients. Ensure we are RESTful where we can be and as consistent as possible.

Understand how errors are received from databaseTiny and the Classes and make sure those errors make it out to the client appropriately.

Read #479 and #463 to know more about the errors routes will recieve.

Contributor guide

Open the contributing guide

Research direction

Start by reading issues #479 and #463 to understand the errors routes receive. Review error handling and response construction across the /, project/, layer/, page/, line/, and utilities/ directories, including errors from databaseTiny and the Classes. Done means client responses use consistent, RESTful status codes and messages wherever the existing behavior permits.

Written by the indexing model from the issue text.

Assessment

Tech stack
express, javascript
Domain
api, backend
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.