Redocly/redoc

Add an option to disable default sample

オープン

#1,490 opened on 2020/12/30

 (2 件のコメント) (0 件のリアクション) (0 人の担当者)TypeScript (2,272 件のフォーク)batch import
Type: Enhancementhelp wanted

Repository metrics

Stars
 (21,877 個のスター)
PR merge metrics
 (PR metrics pending)

説明

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?

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