OpenBankProject / OpenBankProject/OBP-API
404 response codes are being returned but not defined in the spec
オープン
まだ誰も着手していません。
- 主要言語
- Scala
- スター
- 1.7k
- フォーク
- 482
- 平均マージ
- 1日 12時間
- マージ済み PR（30日）
- 15
説明
Spec definition issue
All expected response codes should be defined in the OAS as follows:
'The documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known in advance. However, documentation is expected to cover a successful operation response and any known errors.'
Example:
404 response codes are being returned but not defined in the spec
{
"httpMethod": "POST",
"url": "http://apisandbox.openbankproject.com/obp/v3.0.0/banks/nordea/accounts/nordea-test-160273",
"apiRequestParameters": [{
"paramIn": "body",
"parameterName": "body",
"parameterValue": "Enter_value_here",
"required": true
}, {
"paramIn": "path",
"parameterName": "ACCOUNT_ID",
"parameterValue": "nordea-test-160273",
"required": true
}, {
"paramIn": "path",
"parameterName": "BANK_ID",
"parameterValue": "nordea",
"required": true
}
],
"apiRequestResponses": [{
"responseCode": "400"
}
],
"authorization": {
"locatedIn": "Header",
"authKey": "Authorization",
"authValue": "DirectLogin token=\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyIiOiIifQ.tQDG3T1wOpEtQYultU8U6iyPWx2mBV2UM3SAOHpaRjo\""
},
"apiRequestResult": {
"statusCode": "404",
"body": "<!DOCTYPE html>\n<html> <body>The Requested URL /obp/v3.0.0/banks/nordea/accounts/nordea-test-160273 was not found on this server</body> </html> \n ",
"assertedResult": 5
}
}
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、例に示されている POST エンドポイントの OpenAPI 定義を特定し、宣言されているレスポンスと観測された 404 レスポンスを比較します。仕様を更新して、成功時のレスポンスと既知のエラーレスポンスを記載し、その後、記載したコードがエンドポイントの動作と一致することを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- openapi, scala
- 領域
- api, documentation
- issue の種類
- ドキュメント
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 42/100