OpenFn / OpenFn/apollo

Adaptor caret range not parsed correctly in adaptor-apis

Open
#480 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

We may be missing some function signatures as the adaptor is not found if the specified version is a range.

Error logs:

Using cached files for @openfn/language-http 6.0.0
✅ adaptor ready
 Preparing common adaptor docs
 Fetching files...
WARNING: error 404 fetching https://api.github.com/repos/openfn/adaptors/contents/packages/common?ref=@openfn/language-common@^1.12.0
❌ error loading common
227 |   }
228 |   const res = await fetch(url, { headers });
229 |   if (res.status !== 200) {
230 |     console.warn(`WARNING: error ${res.status} fetching ${url}`);
231 |     const err = await res.json();
232 |     throw new Error("Adaptor not found: " + err.message);
                    ^
error: Adaptor not found: No commit found for the ref @openfn/language-common@^1.12.0
      at <anonymous> (/Users/hanna/openfn/apollo/node_modules/@openfn/adaptor-apis/dist/index.js:232:15)
      at async <anonymous> (/Users/hanna/openfn/apollo/node_modules/@openfn/adaptor-apis/dist/index.js:272:25)
      at async <anonymous> (/Users/hanna/openfn/apollo/node_modules/@openfn/adaptor-apis/dist/index.js:129:34)
      at async <anonymous> (/Users/hanna/openfn/apollo/services/adaptor_apis/adaptor_apis.ts:6:28)

WARNING: failed to load common docs. This may result in incorrect documentation
http: POST /services/adaptor_apis → 200 in 10981ms

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 in services/adaptor_apis/adaptor_apis.ts and reproduce the POST request that loads common adaptor documentation. Trace how the adaptor version reference is passed to the GitHub contents request, then verify that a range such as @openfn/language-common@^1.12.0 loads successfully and the common documentation includes the expected function signatures.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, typescript
Domain
api, documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.