背景
prices は retrieve / list / update を持つが、products は list / update のみで retrieve が無い。単一の Product を ID で取得する手段が契約に存在しない。
問題
リソース間で単一取得の有無が揃っておらず、契約の一貫性を欠く。クライアントが単一の Product を取得したい場合、list を取得してクライアント側で ID 一致を絞り込むしかない。これが意図的な省略なのか、単に未追加なのかが契約からは判断できない。
やること
受け入れ条件
- リソース間で単一取得の方針が一貫していること
- その判断が根拠とともに残っていること
関連
本 issue は現在の API 契約実装のスコープ外として切り出したもの。リソース間の契約の一貫性に関わる。
背景
pricesはretrieve/list/updateを持つが、productsはlist/updateのみでretrieveが無い。単一の Product を ID で取得する手段が契約に存在しない。問題
リソース間で単一取得の有無が揃っておらず、契約の一貫性を欠く。クライアントが単一の Product を取得したい場合、
listを取得してクライアント側で ID 一致を絞り込むしかない。これが意図的な省略なのか、単に未追加なのかが契約からは判断できない。やること
products.retrieveを追加するか、あるいは「単一取得は当面提供しない」と明示的に決める(その場合はprices.retrieveの位置づけも合わせて整理する)受け入れ条件
関連
本 issue は現在の API 契約実装のスコープ外として切り出したもの。リソース間の契約の一貫性に関わる。