swagger-api/swagger-codegen

[HTML2] Not making use of method examples

Open

#3.660 geöffnet am 29. Aug. 2016

Auf GitHub ansehen
 (4 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)HTML (5.474 Forks)batch import
Client: HTMLEnhancement: Generalhelp wanted

Repository-Metriken

Stars
 (12.701 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Untersuchen Sie die HTML2 Vorlagendateien (z. B. Mustache Vorlagen), um herauszufinden, wo Parameter und Antworten gerendert werden, und stellen Sie sicher, dass das Beispiel Feld in der Ausgabe enthalten ist.
Tech Stack
htmljavascript
Domain
backenddocumentation
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Swagger/OpenAPIHTML templating
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70