enhancemnt to "add_root" feature
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 35/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- ruby
- 領域
- api, documentation
調査の方向性
Start at the add_root feature entry point and inspect how it derives the root from the response model class; then check whether the response model exposes root_element(root_type) for collection_root and root. Done when generated Swagger output uses the entity-configured singular and plural roots while preserving existing behavior.
索引モデルが issue の本文から書いたものです。
説明
The new add_root feature is extremely nice and something I've been waiting for in this gem for a while.
One small issue with it is that the way it handles dynamically building the 'root' name is solely based on the response model class name. Where as, ideally what would be nice is to "detect" if said response model is a grape-entity class and query the "Root" configuration from that class.
I have several GrapeEntity classes that change the "root" to be someone slightly different than the internal class name (e.g. OrganizationMember -> 'members'/'member') so having the swagger gem consult the entity class. (e.g. simply calling OrganizationMember.root_element(root_type) where root_type is :collection_root or :root ).
- 主要言語
- Ruby
- スター
- 1.1k
- フォーク
- 477
- 平均マージ
- 1日 18時間
- マージ済み PR（30日）
- 5
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
ruby-grape/grape-swagger のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
ruby-grape/grape-swagger#1014 ·
メンテナーはふだん 1 日以内に返信
-
Support default_response and default in 2.3; stop reading route.desc対応中かも @numbata が 62 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
ruby-grape/grape-swagger#989 ·
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
ruby-grape/grape-swagger#987 · コメント 3 件 ·
メンテナーはふだん 1 日以内に返信
-
Bug report: omitted array parameters with `array_use_braces: true`対応中かも @olivier-thatch が 536 日前に担当しました。 オープン
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
ruby-grape/grape-swagger#952 · コメント 2 件 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
Bug Report: `default` for array params (`type: [String]`) is incorrectly placed inside `items`対応中かも @numbata が 4 日前に担当しました。 オープン
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
ruby-grape/grape-swagger#950 · コメント 2 件 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
ruby-grape/grape-swagger の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
swombat/souls-house#825 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
openhab/openhab-jruby#571 ·
-
Bug
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
chatwoot/chatwoot#16591 · コメント 1 件 ·
メンテナーはふだん 2 日以内に返信
-
good first issue User Interface
難易度 2/5 1〜3時間 初心者へのやさしさ 64/100
rubyforgood/skillrx#740 ·