Redocly/redoc

Add an option to disable default sample

Open

#1490 aperta il 30 dic 2020

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)TypeScript (2272 fork)batch import
Type: Enhancementhelp wanted

Metriche repository

Star
 (21.877 star)
Metriche merge PR
 (Merge medio 3h 40m) (11 PR mergiate in 30 g)

Descrizione

When the scheme doesn't come with example, Redoc will automatically generate a sample by properties default value. This default sample isn't useful in most case and it's confusing to reader.

I'd like to write examples which represent real use cases in the OpenAPI definition and leave unimportant responses/responses without sample. But I didn't find a way to disable the sample. It is possible to add global option in the tool, or add OpenAPI extension to disable default sample?

Guida contributor

Direzione di ricerca
Indaga il codice responsabile della generazione di campioni predefiniti nel rendering delle specifiche OpenAPI, probabilmente nei componenti dello schema o degli esempi. Cerca le opzioni globali esistenti e considera l'aggiunta di una nuova opzione come 'showDefaultSample' o simile. Verifica se esiste un approccio tramite estensione OpenAPI. Fai riferimento a opzioni di configurazione simili nel codice sorgente di Redoc.
Tech stack
typescriptreactrest api
Dominio
documentationapi
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Basic knowledge of React and TypeScriptFamiliarity with Redoc's configuration system
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
40