OpenAPITools / OpenAPITools/openapi-diff

Report totals

Open
#627 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

I'm using this tool to report API coverage in the OpenSearch API spec project. The workflow reports something like "API specs implemented for 232/649 (35%) APIs". The way it works is that we have a way to dump the number of APIs, then compare the spec.

I propose openapi-diff reports some counters into the output to make this process easier, such as totals and % of differences, possibly at multiple levels in attributes.

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

No source file, test, or entry point is named. Review how openapi-diff currently produces comparison output, then clarify which total and percentage counters are required and at which attribute levels. Done means the requested counters appear in the output and are covered by appropriate tests.

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.