OpenFn / OpenFn/docs

Add docs for http error maps

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

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
23
Forks
20
Avg merge
3d 1h
Merged PRs (30d)
6

Description

A pattern emerging in the new http namespaces is the error map:

http.get($.url,  { errors: false })

You can use the error map for 3 different things:

  • You can pass errors: false to disable all error handling
  • You can pass errors: { 404: 'message' } to set a custom error message (or throw for a code <400)
  • You can pass errors: { 404: false } to not throw for a particular code

Adaptor docs right now have a really hard time documenting this behaviour in-line in a single sentence. It's just too complex for the API reference.

We should add a section in the docsite for this, probably in the job writing guide, and link to it from all adaptors

Contributor guide

No contributing guide indexed for this repository

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 in the docsite's job writing guide and inspect the existing adaptor documentation. Add a dedicated section explaining the three http error-map behaviors, then link to it from all adaptors as requested. Done means the shared guidance is available and each relevant adaptor points readers to it.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.