swagger-api/swagger-codegen

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

Aperta

#3240 aperta il 29 giu 2016

Vedi su GitHubGuida contributor
 (2 commenti) (0 reazioni) (0 assegnatari)HTML (5474 fork)batch import
Client: HTMLFeature: DocumentationIssue: Bughelp wanted

Metriche repository

Star
 (12.701 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Innanzitutto, individua il file del modello HTML dinamico nel repository swagger codegen, probabilmente sotto modules/swagger codegen/src/main/resources/htmlDocs/. Confrontalo con il modello HTML statico per identificare dove vengono visualizzate le informazioni 'obbligatorio' o 'opzionale'. Quindi, esamina il modello di dati per assicurarti che il campo 'required' sia disponibile nel contesto passato al modello (probabilmente nell'oggetto parametro). Infine, modifica il modello dinamico aggiungendo un blocco condizionale per visualizzare 'obbligatorio' o 'opzionale' in base all'attributo 'required' del parametro. Fai riferimento al modello HTML statico esistente per la sintassi esatta.
Tech stack
html
Dominio
apidocumentation
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
GitOpenAPI/Swagger basics
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70