OpenFn / OpenFn/kit

Should workflow.yaml use the `configuration` or `credential` key?

Open
#1,217 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

DevX
Dominant language
TypeScript
Stars
21
Forks
23
Avg merge
1d 22h
Merged PRs (30d)
17

Description

At the moment a workflow.yaml defines a step like:

id: a
expression: step.js
configuration: <uuid>

But should configuration actually be credential?

  • credential is more in line with app language so it makes sense for that to be a UUID
  • configuration is part of a runtime workflow structure, an execution plan. The runtime doesn't know anything about credentials, per se
  • I think it makes sense for credential to be an optional UUID, resolved by the CLI, and configuration to be a plain object. And you can have both

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 workflow.yaml example and trace how the CLI and runtime interpret configuration and credential values. Resolve the schema decision, including whether credential is an optional UUID and configuration is an object, then document the accepted structure and ensure the workflow format is consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
cli
Domain
cli
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.