SlotKeeper 設計と品質

list_resources detail design

  • Operation: listResources
  • Endpoint: GET /resources

1. 正常系入力

Location Name Type 説明

Request body はありません。

2. 正常系前提

  • 例外処理: ROUTER_HANDLED_EXCEPTIONS: 発生しない

3. 正常系リソース変更

正常系で作成/更新/削除するリソースはありません。

4. 正常系レスポンス

  • Response model: ListResourcesResponse
項目 説明 値の取得元
items 一覧レスポンスに含まれるリソース配列です。
items.resourceId 予約対象の資源を一意に識別するIDです。 row.resource_id
items.name 利用者に表示する資源名です。 row.name
items.description 資源の設備や用途を説明する文章です。 row.description
items.kind 会議室または備品を表す資源種別です。 ResourceKind(row.kind)
items.active 新規予約を受け付けるかどうかです。 row.active
items.version 資源編集の楽観ロックに使う公開版です。 row.row_version
nextToken 次ページを取得するために前回レスポンスから受け取る継続tokenです。 page.next_token