swagger-api/swagger-codegen

[HTML2] Not making use of method examples

Open

#3 660 ouverte le 29 août 2016

Voir sur GitHub
 (4 commentaires) (0 réactions) (0 assignés)HTML (5 474 forks)batch import
Client: HTMLEnhancement: Generalhelp wanted

Métriques du dépôt

Stars
 (12 701 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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

Guide contributeur

Direction de recherche
Examinez les fichiers de modèle HTML2 (par exemple, les modèles mustache) pour trouver où les paramètres et les réponses sont rendus et assurez vous que le champ exemple est inclus dans la sortie.
Stack technique
htmljavascript
Domaine
backenddocumentation
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Swagger/OpenAPIHTML templating
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70