Ability to set description to whole entity
まだ誰も着手していません。
評価
調査の方向性
Start by tracing how grape-swagger-entity handles entity definitions and how the desc entry point builds resource response descriptions. Confirm whether the entity-level description should populate the response description instead of the resource description, then add coverage for the shown User response shape.
索引モデルが issue の本文から書いたものです。
説明
It seems there is no way to set global description for the whole Entity. If use grape-swagger-entity, it takes entity definition outside from resource, which I think is incorrect.
{
"definitions":{
"User":{
"type":"object",
"properties":{
"username":{
"type":"string"
}
},
"required":[
"username"
],
"description":"Create a token from email/password pair"
}
}
}
This description seems being used nowhere, but it can be used as description on resource response section, when you set desc "Retrieve information about the signed user", entity: Entities::User
"responses":{"200":{"description":"User entity","schema":{"$ref":"#/definitions/User"}}
instead of
"responses":{"200":{"description":"Retrieve information about the signed user","schema":{"$ref":"#/definitions/User"}}
- 主要言語
- Ruby
- スター
- 730
- フォーク
- 154
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
ruby-grape/grape-entity のほかの issue
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
ruby-grape/grape-entity#386 · コメント 7 件 · リアクション 1 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
ruby-grape/grape-entity#382 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
ruby-grape/grape-entity#380 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
ruby-grape/grape-entity#373 · コメント 2 件 ·
-
Truncate Formatterオープン
難易度 1/5 1〜3時間 初心者へのやさしさ 45/100
ruby-grape/grape-entity#372 ·
ruby-grape/grape-entity の issue をすべて見る
似ている issue
-
🐞 bug pending triage
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
CircuitVerse/CircuitVerse#8031 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
riscv/riscv-unified-db#2740 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
GantMan/jail-monkey#380 ·