OpenBankProject / OpenBankProject/OBP-API
Provide JSON schemas for OBP ResourceDoc endpoint
まだ誰も着手していません。
- 主要言語
- Scala
- スター
- 1.7k
- フォーク
- 482
- 平均マージ
- 1日 12時間
- マージ済み PR(30日)
- 15
説明
Provide JSON schemas for your methods
In schema you need to declare:
- String types acceptable per method : string, ing, etc.
- Arrays (if applicable)
- Booleans
- Nulls
- Objects
Example of load:
{
"first_name": "George",
"last_name": "Washington",
"birthday": "1732-02-22",
"address": {
"street_address": "3200 Mount Vernon Memorial Highway",
"city": "Mount Vernon",
"state": "Virginia",
"country": "United States"
}
}
Corresponding schema:
{
"type": "object",
"properties": {
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"birthday": {
"type": "string",
"format": "date-time"
},
"address": {
"type": "object",
"properties": {
"street_address": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"country": {
"type": "string"
}
}
}
}
}
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
OBP ResourceDoc endpoint を特定し、その methods と responses が現在どのように定義されているかを確認してください。schemas が必要な methods の完全な集合を特定し、各 schema が issue に記載されたサポート対象の strings、arrays、booleans、nulls、objects を宣言していることを確認してください。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- json, scala
- 領域
- api, backend-api-design
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 25/100