Redocly/redoc

Add an option to disable default sample

Open

#1.490 geöffnet am 30. Dez. 2020

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (21.877 Stars) (2.272 Forks)batch import
Type: Enhancementhelp wanted

Beschreibung

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?

Contributor Guide

Tech Stack
typescriptreactrest api
Domain
documentationapi
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
half day
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Basic knowledge of React and TypeScriptFamiliarity with Redoc's configuration system
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40
Research-Richtung
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.