Wrong changelog generated when having objects with same field name

Open
#268 4 comments 2 reactions 0 assignees View on GitHub

Maintainers usually reply within 5 days

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
java, openapi
Domain
api

Research direction

Reproduce the comparison with old and new OpenAPI schemas containing Object1.myField1 and Object2.myField1, where only their descriptions differ. Trace the changelog diff generation entry point and verify why the fields are matched across objects. Done means unchanged fields no longer produce a false change, with a defined configuration behavior for suppressing non-breaking description changes.

Written by the indexing model from the issue text.

Description

Lets say that the old and the new OpenAPI schemas have classes Object1 and Object2, both of which have a field myField1 without changes in-between the openapi schemas. If Obejct1.myField1 has different description than Object2.myField1, that would be detected as a change and printed in the output diff file.

Also, can you add some kind of configuration that would prevent the library to print such non-breaking changes (i.e. changed description is not a breaking change) ?

Dominant language
Java
Stars
1.1k
Forks
191
Avg merge
4d 23h
Merged PRs (30d)
1

Getting set up

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.