Redocly/redoc

Add an option to disable default sample

Open

#1.490 aberto em 30 de dez. de 2020

Ver no GitHub
 (2 comments) (0 reactions) (0 assignees)TypeScript (2.272 forks)batch import
Type: Enhancementhelp wanted

Métricas do repositório

Stars
 (21.877 stars)
Métricas de merge de PR
 (Mesclagem média 3h 40m) (11 fundiu PRs em 30d)

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?

Guia do colaborador

Direção de pesquisa
Investigue o código responsável por gerar amostras padrão na renderização da especificação OpenAPI, provavelmente nos componentes de esquema ou de exemplo. Procure por opções globais existentes e considere adicionar uma nova opção como 'showDefaultSample' ou similar. Verifique se há uma abordagem de extensão OpenAPI. Consulte opções de configuração semelhantes no código fonte do Redoc.
Pilha de tecnologia
typescriptreactrest api
Domain
documentationapi
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Basic knowledge of React and TypeScriptFamiliarity with Redoc's configuration system
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
40