Redocly/redoc

Add an option to disable default sample

Open

#1,490 opened on 2020年12月30日

GitHub で見る
 (2 comments) (0 reactions) (0 assignees)TypeScript (2,272 forks)batch import
Type: Enhancementhelp wanted

Repository metrics

Stars
 (21,877 stars)
PR merge metrics
 (30d に merged PR はありません)

説明

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?

コントリビューターガイド