having `operationId`, `outputs` present in the json report

[shah-jh]

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

No.

Describe the solution you'd like

I want to have to optionally see operationId, outputs associated with each step, present in the json output.

Describe alternatives you've considered

N/A

Additional context

N/A

[DmitryAnansky]

@shah-jh
Could you please clarify which command you’re referring to? My guess is that it’s respect, but could you update the request with a bit more detail so we can better understand the issue?

[shah-jh]

@shah-jh Could you please clarify which command you’re referring to? My guess is that it’s respect, but could you update the request with a bit more detail so we can better understand the issue?

sorry about that. yes respect. but let me take a step back and mention the underlying use case. let's say I have:

arazzo: "1.0.1"
info:
  title: GitHub Dynamic Branches Validation Journey
  version: "1.0.0"

sourceDescriptions:
  - name: githubApi
    url: https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.json
    type: openapi

workflows:
  - workflowId: fetch-repos-and-branches
    summary: Gets a user's repos, extracts one, and verifies it has a master branch

    inputs:
      type: object
      properties:
        username:
          type: string
      required:
        - username

    steps:
      # Step 1: Fetch the list of repositories for the supplied user
      - stepId: getRepos
        operationId: repos/list-for-user
        parameters:
          - name: username
            in: path
            value: $inputs.username
          - name: per_page
            in: query
            value: 5
        outputs:
          firstRepoName: $response.body#/0/name
        successCriteria:
          - condition: $statusCode == 200

      # Step 2: Fetch branches AND validate that 'master' is in the results
      - stepId: getBranches
        operationId: repos/list-branches
        parameters:
          - name: owner
            in: path
            value: $inputs.username
          - name: repo
            in: path
            value: $steps.getRepos.outputs.firstRepoName
        outputs:
          branchNames: $response.body[*].name
        successCriteria:
          - condition: $statusCode == 200
          - context: $response.body
            condition: '$[*][?(@.name=="master")]'
            type: jsonpath

If I run it with:

redocly respect github_journey.arazzo.yaml \
  --severity '{"SCHEMA_CHECK":"warn"}' \
  --json-output test-report.json \
  --input username=octocat

I get the following in the cli:

 ✓ GET /users/{username}/repos - step getRepos 
 ✓ GET /repos/{owner}/{repo}/branches - step getBranches 

I want to see username, owner populated. similar to how say https://github.com/postmanlabs/newman 's cli reports behave. It's only cause they don't show up here, that I'm trying to reconstruct it in the json output. Now I can do that for those, but I can't see the outputs for example. in this case: firstRepoName

I guess the two are independent feature requests in their own rights.

[DmitryAnansky]

@shah-jh
Could you please try running your command with the additional --verbose option enabled?
It should look like this:

redocly respect github_journey.arazzo.yaml \
  --severity '{"SCHEMA_CHECK":"warn"}' \
  --json-output test-report.json \
  --input username=octocat
  --verbose

Please let me know if the output is detailed enough for your needs.