OpenAPITools / OpenAPITools/openapi-diff
Show additions / changes to schema body
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 190
- PR merge metrics
- No merged PRs in 30d
Description
Is it possible to show non-breaking changes (i.e. added fields) to the schema body?
The current output simply states "changed body: 'application/json'"
If I reverse the comparison I get a message:
Changed body: 'application/json'
Missing property: [n].id (integer)
So a useful message would be:
Changed body: 'application/json'
Added property: [n].id (integer)
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 by reproducing the OpenAPI comparison described in the issue, including the reversed comparison, and trace where schema-body changes are formatted. Update the reporting path so added properties are distinguished from missing properties, then verify that the output includes an “Added property” entry such as [n].id (integer) alongside the changed body message.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100