Redocly / Redocly/redocly-cli

Respect should log inputs and outputs in JSON logs

Open
#2,977 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

p3 Type: Enhancement
Dominant language
TypeScript
Stars
1.5k
Forks
228
Avg merge
1d 14h
Merged PRs (30d)
48

Description

Is your feature request related to a problem? Please describe.

Sometimes workflow inputs in an API Arazzo workflow need to be calculated at runtime based on outputs of previous steps. As there are currently no built-in or specified data manipulation tools, the outputs should at least (and for completeness) be logged in the JSON log file.
This way the result of defined outputs is better traceable and could be processed by other tools in the CI/CD pipeline.

Describe the solution you'd like

The JSON log output by respect should contain the outputs and inputs for executed workflows/steps.

Describe alternatives you've considered

Creating a lightweight helper API Server that returns desired data based on runtime values

Additional context

  • maybe related to #2147 ?
  • option whether JSON and HAR logs should apply masking for sensitive data (inputs defined as password type) might make sense

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 by locating the JSON log generation and the execution paths for Arazzo workflows and steps. Trace where inputs and defined outputs are available, then add them to the JSON logs and verify the behavior with tests; also clarify whether sensitive password-type inputs must be masked.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, observability
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.