OpenFn / OpenFn/apollo

Validating incoming payloads and return a clear error

Open
#444 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

monitoring
Dominant language
Jupyter Notebook
Stars
5
Forks
10
Avg merge
2d 20h
Merged PRs (30d)
17

Description

At the moment, if an endpoint is called with invalid arguments, the server will at some stage throw an error. Ie, if the API key is missing, or the prompt keyword is missing. Whatever.

Apollo should be better at handling this and failing quickly, without raising sentry errors

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 by locating the endpoint handling for incoming payloads, especially where the API key and prompt arguments are processed. Trace how invalid arguments currently reach the server error path and Sentry. Done means invalid requests fail quickly with a clear error instead of raising a Sentry error.

Written by the indexing model from the issue text.

Assessment

Domain
api, backend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.