swagger-api/swagger-codegen

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

Open

#3,240 建立於 2016年6月29日

在 GitHub 查看
 (2 留言) (0 反應) (0 負責人)HTML (5,474 fork)batch import
Client: HTMLFeature: DocumentationIssue: Bughelp wanted

倉庫指標

Star
 (12,701 star)
PR 合併指標
 (30 天內沒有已合併 PR)

描述

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

貢獻者指南

研究方向
首先，在 swagger codegen 儲存庫中找到動態 HTML 模板檔案，很可能位於 modules/swagger codegen/src/main/resources/htmlDocs/ 目錄下。將其與靜態 HTML 模板進行比較，以確定顯示「必填」或「可選」資訊的位置。然後，檢查資料模型，確保傳遞給模板的上下文（可能在參數物件中）包含 'required' 欄位。最後，修改動態模板，新增一個條件區塊，根據參數的 'required' 屬性顯示「必填」或「可選」。參考現有的靜態 HTML 模板以取得確切的語法。
技術棧
html
領域
apidocumentation
議題類型
錯誤
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
GitOpenAPI/Swagger basics
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70