Redocly/redocly-cli

Support x-tagGroups in lint command

Open

#600 opened on Mar 21, 2022

View on GitHubContributor guide
 (1 comment) (2 reactions) (0 assignees)TypeScript (222 forks)auto 404
Type: Enhancementgood first issuegovernancep3

Repository metrics

Stars
 (1,481 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Examine how other Redocly spec extensions are handled in the lint command, and implement similar support for x tagGroups by adding it to the list of recognized extensions.
Tech stack
typescript
Domain
apibackend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitTypeScriptOpenAPI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65