swagger-api/swagger-codegen

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

Open

#3,240 opened on 2016年6月29日

GitHub で見る
 (2 comments) (0 reactions) (0 assignees)HTML (5,474 forks)batch import
Client: HTMLFeature: DocumentationIssue: Bughelp wanted

Repository metrics

Stars
 (12,701 stars)
PR merge metrics
 (30d に merged 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
Issue 種別
バグ
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
GitOpenAPI/Swagger basics
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70