OpenAPITools / OpenAPITools/openapi-diff

Feature Request: generate Overlay for the given 2 OpenAPI files

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

Nobody has claimed this yet.

Dominant language
Java
Stars
1.1k
Forks
190
PR merge metrics
No merged PRs in 30d

Description

Based of the calculated diff, it would be great if the tool is capable to generate an Overlay according to OAI Overlay Specification.

Contributor guide

Open the contributing guide

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.

Research direction

Start by reading the OAI Overlay Specification and tracing how the tool calculates diffs between two OpenAPI files. No source file or test is identified in the issue; done would require a defined way to generate a specification-compliant Overlay from the calculated diff, along with verification of the resulting document.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.