Redocly/redocly-cli

Make it clearer that Redocly CLI is API description format agnostic

Aperta

#1263 aperta il 15 set 2023

Vedi su GitHubGuida contributor
 (3 commenti) (0 reazioni) (0 assegnatari)TypeScript (222 fork)auto 404
Type: DocsType: Enhancementgood first issue

Metriche repository

Star
 (1481 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Rivedi l'output del comando di linting per sostituire 'OpenAPI' con termini generici o rilevamento dinamico del formato, quindi aggiorna di conseguenza tutta la documentazione.
Tech stack
typescript
Dominio
apideveloper experiencedocumentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitNode.js
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65