swagger-api/swagger-codegen

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

Ouverte

#3 240 ouverte le 29 juin 2016

Voir sur GitHubGuide contributeur
 (2 commentaires) (0 réaction) (0 personne assignée)HTML (5 474 forks)batch import
Client: HTMLFeature: DocumentationIssue: Bughelp wanted

Métriques du dépôt

Stars
 (12 701 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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

Guide contributeur

Direction de recherche
Tout d'abord, localisez le fichier de modèle HTML dynamique dans le dépôt swagger codegen, probablement sous modules/swagger codegen/src/main/resources/htmlDocs/. Comparez le avec le modèle HTML statique pour identifier où les informations 'obligatoire' ou 'facultatif' sont affichées. Ensuite, examinez le modèle de données pour vous assurer que le champ 'required' est disponible dans le contexte passé au modèle (probablement dans l'objet paramètre). Enfin, modifiez le modèle dynamique en ajoutant un bloc conditionnel pour afficher 'obligatoire' ou 'facultatif' en fonction de l'attribut 'required' du paramètre. Référez vous au modèle HTML statique existant pour la syntaxe exacte.
Stack technique
html
Domaine
apidocumentation
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
GitOpenAPI/Swagger basics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70