Redocly/redoc

Add an option to disable default sample

Open

#1490 opened on Dec 30, 2020

View on GitHub
 (2 comments) (0 reactions) (0 assignees)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?

Contributor guide

Tech stack
typescriptreactrest api
Domain
documentationapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of React and TypeScriptFamiliarity with Redoc's configuration system
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
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.