[OpenAPI 3.1] Phase 3: wire the converter in

Open
#951 0 comments 0 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
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
java, openapi
Domain
api, tooling

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

OpenAPI 3.1.0 Support

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(); fromSpecifications works 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, --json shape, removed or changed APIs
Done when
  • 3.0→3.1 cross-version tests pass, including the specs from #755 and #858
  • fromSpecifications doesn'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

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.