swagger-api/swagger-codegen

[HTML2] Not making use of method examples

オープン

#3,660 opened on 2016/08/29

GitHub で見るコントリビューターガイド
 (4 件のコメント) (0 件のリアクション) (0 人の担当者)HTML (5,474 件のフォーク)batch import
Client: HTMLEnhancement: Generalhelp wanted

Repository metrics

Stars
 (12,701 個のスター)
PR merge metrics
 (PR metrics pending)

説明

Description

Examples for parameters or return values are nowhere to be found in the resulting document.

Swagger-codegen version

2.2.1

Swagger declaration file content or url
swagger: '2.0'
info:
  version: 0.0.0
  title: Simple API
paths:
  /:
    get:
      parameters:
      - name: body
        in: body
        schema:
          type: string
          example: |
              foo
              bar
      responses:
        200:
          description: OK
          schema:
            type: string
            example: |
              foo
              bar

コントリビューターガイド

調査方針
HTML2テンプレートファイル（例：mustacheテンプレート）を調査し、パラメータとレスポンスがレンダリングされる場所を見つけ、exampleフィールドが出力に含まれていることを確認してください。
技術スタック
htmljavascript
領域
backenddocumentation
Issue 種別
バグ
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Swagger/OpenAPIHTML templating
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70