Redocly / Redocly/redocly-cli

Support x-tagGroups in lint command

Open
#600 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue governance 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.
We have too many useful specification extensions. But openapi-cli doesn't support all of these.

Describe the solution you'd like
I think we should start supporting this from the lint command.

Describe alternatives you've considered
No. Because we should be consistent and already supported all custom extensions which describe in the documentation.

For example x-tagGroups:

x-tagGroups:  
  - name: test name
    tags: test_tag
    x-displayName: Test

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 with the lint command and the specification extensions documentation linked in the issue. Determine how lint currently handles custom extensions and define the scope for supporting x-tagGroups. Done means the lint command consistently supports this extension and its behavior is covered by the project’s relevant checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, typescript
Domain
api, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.