OpenFn / OpenFn/docs

Expose rest mappings in documentation

Open
#441 1 comment 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

Every datasource we interact with exposes a REST API. It's fair to expect that developers who know that datasource will be familar with that API.

And almost every adaptor function maps to one or more endpoints in that API.

It would likely be helpful for our docs to expose that mapping. So you want to write job code to to create a new sObject, you'll be expecting to post to salesforce.com/services/data/v60.0/sobjects/whatever. Maybe that URL - or part of it - should be listed in the docs.

Something like this:

image

We should support an @map jsdoc tag so that adaptor functions can declare the endpoints they map to.

/**
 * @map POST https://{domain}.my.salesforce.com/services/data/v60.0/sobjects/{object}
 */

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 with the adaptor functions and the current documentation generation path, then review how JSDoc comments are handled. Define how an @map POST endpoint is declared and displayed alongside each adaptor operation. Done means the relevant REST mappings appear in the generated docs and the declaration format is documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.