swagger-api/swagger-codegen

[HTML2] Not making use of method examples

Open

#3.660 aberto em 29 de ago. de 2016

Ver no GitHub
 (4 comments) (0 reactions) (0 assignees)HTML (5.474 forks)batch import
Client: HTMLEnhancement: Generalhelp wanted

Métricas do repositório

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

Description

Description

Examples for parameters or return values are nowhere to be found in the resulting document.

Swagger-codegen version

2.2.1

Swagger declaration file content or url
swagger: '2.0'
info:
  version: 0.0.0
  title: Simple API
paths:
  /:
    get:
      parameters:
      - name: body
        in: body
        schema:
          type: string
          example: |
              foo
              bar
      responses:
        200:
          description: OK
          schema:
            type: string
            example: |
              foo
              bar

Guia do colaborador

Direção de pesquisa
Investigue os arquivos de modelo HTML2 (por exemplo, modelos mustache) para encontrar onde os parâmetros e respostas são renderizados e garanta que o campo de exemplo esteja incluído na saída.
Pilha de tecnologia
htmljavascript
Domain
backenddocumentation
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
Swagger/OpenAPIHTML templating
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70