OpenFn / OpenFn/lightning

Support nested objects in credentials with a JSON field type

Open
#3,390 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Elixir
Stars
296
Forks
86
Avg merge
1d 13h
Merged PRs (30d)
50

Description

We have a use-case where the http adaptor wants to send a nested JSON obejct as part of a credential.

Usually credentials are flat, like this:

{
  user: 'admin',
  password: 'password'
}

But in HTTP we want to use a JSON object as the value for a complex field. Like this:

{
  user: 'admin',
  password: 'password',
 tls: {
     ca: '--CERT--'
  }
}

The lightning UI can't really handle this as it stands - it assumes that credentials are simple primitive values in the JSON schema.

What I suggest is that we allow any complex fields to accept raw JSON as a value. Then users can specify objects of arbitrary complexity as plain JSON

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 by tracing how the Lightning UI represents credential fields from the JSON schema, then follow the HTTP adaptor path that consumes those credentials. Check how primitive and complex fields are currently handled, and define completion as accepting nested JSON objects of arbitrary complexity while preserving the existing flat credential behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
elixir, json
Domain
api, frontend
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.