swagger-api/swagger-codegen

[HTML2] Not making use of method examples

Open

#3660 aperta il 29 ago 2016

Vedi su GitHub
 (4 commenti) (0 reazioni) (0 assegnatari)HTML (5474 fork)batch import
Client: HTMLEnhancement: Generalhelp wanted

Metriche repository

Star
 (12.701 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Esamina i file modello HTML2 (ad esempio, i modelli mustache) per trovare dove vengono renderizzati i parametri e le risposte e assicurati che il campo example sia incluso nell'output.
Tech stack
htmljavascript
Dominio
backenddocumentation
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Swagger/OpenAPIHTML templating
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70