OpenAPITools / OpenAPITools/openapi-diff
In openapi-diff-cli add old and new filenames to the output
Open
Beginner friendly
Nobody has claimed this yet.
enhancement
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 190
- PR merge metrics
- No merged PRs in 30d
Description
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 --
--------------------------------------------------------------------------
...
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
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.
Assessment
- Tech stack
- java, openapi
- Domain
- api, cli
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100