In openapi-diff-cli add old and new filenames to the output

Open Beginner friendly
#506 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
java, openapi
Domain
api, cli

Research direction

Start at the openapi-diff-cli report output entry point and trace how the old and new input filenames are passed into report generation. Run the CLI with the issue's old and new JSON inputs, then verify the report includes both filenames in the shown section without changing the existing change log.

Written by the indexing model from the issue text.

Description

enhancement

When using openapi-diff-cli we need to give and filenames.
It will be cool to have those filenames in the report output.

Before:

==========================================================================
==                            API CHANGE LOG                            ==
==========================================================================
                           API Name API
--------------------------------------------------------------------------
--                            What's Changed                            --
--------------------------------------------------------------------------
...

After:

==========================================================================
==                            API CHANGE LOG                            ==
==========================================================================
                           API Name API
--------------------------------------------------------------------------
old file: xxx.json
new file: yyy.json
--------------------------------------------------------------------------
--                            What's Changed                            --
--------------------------------------------------------------------------
...
Dominant language
Java
Stars
1.1k
Forks
190
PR merge metrics
No merged PRs in 30d

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.

More from OpenAPITools/openapi-diff

All issues in OpenAPITools/openapi-diff

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.