apiblueprint - リソースに対して複数の GET アクションを指定する方法

Question

通常、リソースには複数の get メソッドがあります。単数形を取得するか、クエリ パラメータで多数を取得します。これは設計図でどのように表されますか? 2 つのリソースを使用してそれを行うことができますが、同じリソースであるため、私の意見では正しくありません。

この質問に関連して、URIがリソースレベルで定義されている場合、PUTをリソースに追加するにはどうすればよいですか。

理想的には、これは物事が書かれるべきだと私が思う方法ですが、編集者はそれを好きではありません. HTTP_ACTION と URI を組み合わせることができるドキュメントを見つけましたが、エディターはリソース レベルで URI を必要としているようです。

# Storefronts

## Read [GET /v1/storefronts{?query_params...}]

+ Parameter
    query_params ...

+ Request Matching Storefronts (application/json)
+ Response 200 (application/json)

## Read [GET /v1/storefronts/{id}]

+ Parameter
    + id (string) ... id for record to return
+ Request (application/json)
+ Response 200 (application/json)

## UPDATE [PUT /v1/storefronts/{id}]

+ Parameter
    + id (string) ... id for record to update
+ Request (application/json)
+ Response 200 (application/json)