swagger-api/swagger-codegen

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

Offen

#3.240 geöffnet am 29.06.2016

Auf GitHub ansehenContributor Guide
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)HTML (5.474 Forks)batch import
Client: HTMLFeature: DocumentationIssue: Bughelp wanted

Repository-Metriken

Stars
 (12.701 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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

Contributor Guide

Research-Richtung
Suchen Sie zunächst die dynamische HTML Vorlagendatei im swagger codegen Repository, wahrscheinlich unter modules/swagger codegen/src/main/resources/htmlDocs/. Vergleichen Sie sie mit der statischen HTML Vorlage, um zu identifizieren, wo die Informationen 'erforderlich' oder 'optional' angezeigt werden. Untersuchen Sie dann das Datenmodell, um sicherzustellen, dass das Feld 'required' im an die Vorlage übergebenen Kontext verfügbar ist (wahrscheinlich im Parameterobjekt). Ändern Sie schließlich die dynamische Vorlage, indem Sie einen bedingten Block hinzufügen, der basierend auf dem 'required' Attribut des Parameters 'erforderlich' oder 'optional' anzeigt. Beziehen Sie sich für die genaue Syntax auf die vorhandene statische HTML Vorlage.
Tech Stack
html
Domain
apidocumentation
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
GitOpenAPI/Swagger basics
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70