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 (2.272 Forks)batch import
Type: Enhancementhelp wanted

Repository-Metriken

Stars
 (21.877 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

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

Research-Richtung
Untersuche, wie Redoc Standardsamples aus Schema Eigenschaften generiert. Suche die Komponente, die Samples rendert (vermutlich Sample oder PropertySample). Füge eine globale Option `showDefaultSample` hinzu, die standardmäßig true ist, und rendere das Sample basierend auf dieser Option bedingt.
Tech Stack
typescriptreact
Domain
documentationapi
Issue Type
Funktion
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.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
TypeScriptReactOpenAPI
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60