PUT new attribute backwards compatibility optional
Maintainers usually reply within 5 days
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 30/100
Research direction
Start by tracing how changedOperation.isIncompatible() handles added fields in PUT requests and how that result reaches the completed diff. Compare the proposed approaches: exposing granular incompatibility information, adding a command-line flag, or traversing the object graph after diffing. Done means one chosen design is specified and its behavior for insert-only and update-style PUTs is covered.
Written by the indexing model from the issue text.
Description
https://github.com/OpenAPITools/openapi-diff/issues/136 made the PUT request incompatibility check stricter, considering an additional field as a breaking change. This makes sense for a scenario where updates are taking place, but is too strict if PUTs represent only inserts.
What would be the best way of optionally removing the strict handling of PUTs? Options could include:
- Surfacing more information about how the
changedOperation.isIncompatible()decision was made, allowing the user of the OpenApiDiff to use more granular information to decide whether it should be considered as a breaking change. - Adding a command-line flag to remove the PUT strictness for all cases in a run.
- Writing some code to traverse the object graph for PUTs when the diff has completed and decide whether the strict PUT handling is what caused the incompatibility, and then ignore it.
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 191
- Avg merge
- 4d 23h
- Merged PRs (30d)
- 1
Getting set up
- Ships a Dockerfile or Docker Compose file
- No pull request template
- Read the contributing 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.
More from OpenAPITools/openapi-diff
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
OpenAPITools/openapi-diff#506 ·
Maintainers usually reply within 5 days
-
HtmlRender: Notes of Parameters shows always the new descriptionPossibly taken @Inf1mum claimed this 6 days ago. Opengood first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
OpenAPITools/openapi-diff#364 ·
Maintainers usually reply within 5 days
-
Render capabilities
Difficulty 5/5 Over a week Newbie friendliness 20/100
OpenAPITools/openapi-diff#959 ·
Maintainers usually reply within 5 days
-
Render capabilities
Difficulty 5/5 Over a week Newbie friendliness 18/100
OpenAPITools/openapi-diff#958 ·
Maintainers usually reply within 5 days
-
Render capabilities
Difficulty 3/5 1-2 days Newbie friendliness 55/100
OpenAPITools/openapi-diff#957 ·
Maintainers usually reply within 5 days
All issues in OpenAPITools/openapi-diff
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
eclipse-tradista/tradista#371 ·
Maintainers usually reply within 1 day
-
critical
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
mars-sim/mars-sim#2199 · 2 comments ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
projeto-ong-amar/projeto-ong-amar-backend#26 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
primefaces/primefaces#15568 ·
Maintainers usually reply within 1 day
-
崩溃日志只按 CRLF 分行Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
PCL-Community/PCL-CE#3872 ·
Maintainers usually reply within 1 day