Redocly/redoc

Add an option to disable default sample

Open

#1 490 ouverte le 30 déc. 2020

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)TypeScript (21 877 stars) (2 272 forks)batch import
Type: Enhancementhelp wanted

Description

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?

Guide contributeur

Stack technique
typescriptreactrest api
Domaine
documentationapi
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
half day
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Basic knowledge of React and TypeScriptFamiliarity with Redoc's configuration system
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40
Direction de recherche
Investigate the code responsible for generating default samples in the OpenAPI spec rendering, likely in the schema or example components. Look for existing global options and consider adding a new option like 'showDefaultSample' or similar. Check if there's an OpenAPI extension approach. Refer to similar configuration options in the Redoc source code.