[OpenAPI 3.1] Phase 3: wire the converter in
Maintainers usually reply within 5 days
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
Research direction
Start from the plan in #942 and the converter landed in Phase 2, then trace every caller of OpenApiDiff.compare() and fromSpecifications to see where copies must be made before conversion. The 3.0-shape reads and the temporary both-shapes branches from Phase 2 need removing, and the renderers must be updated so a multi-type prints as string | null. Run the 3.0-to-3.1 cross-version tests, including the specs from #755 and #858, add a test proving fromSpecifications leaves its arguments untouched, and draft the 3.0.0 migration notes covering result schemas, the --json shape and removed APIs.
Written by the indexing model from the issue text.
Description
Part of the OpenAPI 3.1 plan: #942 (Stage 1, Phase 3)
Goal
Every spec is converted to 3.1 before comparing. Results contain the 3.1 form.
Scope
- Call the converter in
OpenApiDiff.compare();fromSpecificationsworks on copies - Remove the 3.0-shape reads and the temporary both-shapes code from Phase 2
- Renderers read 3.1 fields; multiple types print as
string | null - Write the 3.0.0 migration notes: result schemas are 3.1 objects,
--jsonshape, removed or changed APIs
Done when
- 3.0→3.1 cross-version tests pass, including the specs from #755 and #858
-
fromSpecificationsdoesn't modify the objects passed in (test) - Migration notes drafted
- 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