Redocly / Redocly/redocly-cli

Add warning if oneOf, allOf or anyOf has a only one element in recommended configuration

Open
#683 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

c0 p3 Type: Enhancement
Dominant language
TypeScript
Stars
1.5k
Forks
228
Avg merge
1d 14h
Merged PRs (30d)
48

Description

Is your feature request related to a problem? Please describe.
Add warning if oneOf, allOf or anyOf has a only one element in recommended configuration

In this case are not sense to mantain this keywords in the spec

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 locating the OpenAPI lint rules and tests that handle oneOf, allOf, and anyOf, then review how the recommended configuration reports warnings. Add coverage for schemas containing only one element and verify that the linter warns that the keyword is unnecessary.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.