Add an option to disable default sample · Redocly/redoc#1490

(2 comments) (0 reactions) (0 assignees)TypeScript (21,877 stars) (2,272 forks)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
Issue 種別: feature
難度: 3
推定時間: half day
活動状況: stale
明確さ: clear
前提条件: Basic knowledge of React and TypeScriptFamiliarity with Redoc's configuration system
初心者向け度: 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.