Redocly/redoc

Add an option to disable default sample

Open

#1,490 创建于 2020年12月30日

在 GitHub 查看
 (2 评论) (0 反应) (0 负责人)TypeScript (21,877 star) (2,272 fork)batch import
Type: Enhancementhelp wanted

描述

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?

贡献者指南

技术栈
typescriptreactrest api
领域
documentationapi
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Basic knowledge of React and TypeScriptFamiliarity with Redoc's configuration system
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
40
研究方向
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.