swagger-api/swagger-codegen

Dynamic html doesn't show parameter's "optional or required" info

Open

#3.240 aberto em 29 de jun. de 2016

Ver no GitHub
 (2 comments) (0 reactions) (0 assignees)HTML (5.474 forks)batch import
Client: HTMLFeature: DocumentationIssue: Bughelp wanted

Métricas do repositório

Stars
 (12.701 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

Description

Dynamic HTML generated from swagger doesn't contain parameter's 'optional or required' information. This is present in static html.

Swagger-codegen version

Swagger 2.0

Swagger declaration file content or url
Command line used for generation
Steps to reproduce

Generate dynamic html from any template. required flag for parameters not coming.

Related issues

Static html file doesn't have tags information in it.

Suggest a Fix

Guia do colaborador

Direção de pesquisa
Primeiro, localize o arquivo de modelo HTML dinâmico no repositório swagger codegen, provavelmente em modules/swagger codegen/src/main/resources/htmlDocs/. Compare o com o modelo HTML estático para identificar onde as informações 'obrigatório' ou 'opcional' são exibidas. Em seguida, examine o modelo de dados para garantir que o campo 'required' esteja disponível no contexto passado para o modelo (provavelmente no objeto de parâmetro). Por fim, modifique o modelo dinâmico adicionando um bloco condicional para exibir 'obrigatório' ou 'opcional' com base no atributo 'required' do parâmetro. Consulte o modelo HTML estático existente para a sintaxe exata.
Pilha de tecnologia
html
Domain
apidocumentation
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitOpenAPI/Swagger basics
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70