biocore / biocore/microsetta-private-api

Bulk Request Error Handling with ApiRequest

Open
#160 1 comment 0 reactions 0 assignees View on GitHub
minimalInterface
Dominant language
Python
Stars
6
Forks
18
PR merge metrics
No merged PRs in 30d

Description

Reached a point in the minimal interface where I needed to claim multiple samples at once. Each operation could fail independently, but I have no way to agglomerate error messages back to the user due to the way ApiRequest is dumping us to error pages.

I suspect we need a slightly more general mechanism for request errors and to take more care what routes return a json response and what routes return html pages, as any routes that can return both under different circumstances make javascript and python parsing of errors very difficult.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by tracing ApiRequest and the minimal interface's bulk sample-claim path. Map which routes currently return JSON versus HTML, including independently failing operations, and identify how JavaScript and Python callers receive errors. Done means the request-error mechanism and route response behavior are defined well enough to aggregate failures without forcing clients to parse error pages.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, python
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.