[OpenAPI 3.1] Stage 2: full JSON Schema 2020-12 diff

Open
#953 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 5 days

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
15/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Active
Tech stack
java, openapi
Domain
api, tooling

Research direction

This is a tracking issue, not a scoped task: read the parent plan #942 and the Stage 1 keyword-diff implementation to see which JSON Schema 2020-12 keywords are already compared. Then split the listed candidates (unevaluatedProperties, patternProperties, $defs/$dynamicRef, etc.) into sub-issues and check whether Apitomy's compatibility fixtures can be reused. Done for Stage 2 means every listed keyword has a tracked comparison task and a fixture/test plan, not a single patch.

Written by the indexing model from the issue text.

Description

OpenAPI 3.1.0 Support

Tracking issue for Stage 2 of the OpenAPI 3.1 plan: #942

Goal

Compare every JSON Schema 2020-12 keyword, not only the ones covered in Stage 1.

Scope

Sub-issues will be added. Candidates:

  • unevaluatedProperties, unevaluatedItems
  • patternProperties, propertyNames, contains, minContains/maxContains
  • dependentRequired, dependentSchemas
  • $defs, $anchor, $id, $dynamicRef (reference resolution)

We'll also evaluate reusing Apitomy's JSON Schema compatibility test data as fixtures (see #942).

Starts after Stage 1.

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.