Redocly / Redocly/redocly-cli

Make it clearer that Redocly CLI is API description format agnostic

Open
#1,263 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue Type: Docs 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 support linting of a few different structures now, and especially since introducing AsyncAPI support in #1127, we should take care to make sure that the tool doesn't refer specifically to OpenAPI when it's actually any API description format.

Describe the solution you'd like

  • Change the output of the linting command to not refer to OpenAPI specifically, either to be generic or to pick up and state the file type that was valid
  • Review the language of the command parameters and help output to make sure that it is only specific about OpenAPI where we do only have support for thar format
  • Update the documentation for Redocly CLI (yes, all of it) to adjust the wording to be "API description" where it makes sense

Describe alternatives you've considered

Hope that nobody notices

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 Redocly CLI documentation and searching it for references that assume OpenAPI is the only supported format. Review each occurrence in context, changing wording to “API description” where appropriate while preserving format-specific guidance. The work is done when the documentation consistently reflects the supported formats and format-specific references remain accurate.

Written by the indexing model from the issue text.

Assessment

Domain
cli, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.