SlotKeeper 設計と品質

Message catalog: reservations/get_reservation

API

項目 値
domain reservations
api get_reservation
routes GET /reservations/{reservationId} (getReservation)
router src/app/apis/reservations/get_reservation/router.py
messages 2
logger wrapper calls 2
levels WARNING:1, ERROR:1

生成・検証方針

  • WARNING以上のMessage catalogは router.py、functions.py または response_builders.py の ops_logger.warning/error(...) kwargsを一次情報にする。
  • api_error_response(...) のstatus/detailとlogger呼び出しのstatus/detailを照合する。
  • 実装中の app.core.logging ラッパー呼び出しを検出し、WARN以上はAPI operation内のemitとcatalog定義の一致を検証する。
  • logging.getLogger(...)、logger.info(...) などの直接呼び出しは許可しない。
  • WARNING以上は運用上の意味を持つ前提で、必要な確認手順・runbook・contextを検証対象にする。

メッセージ一覧

id message_id ログ概要
M001 getReservation.caller_cannot_view_reservation 呼び出し元が予約者本人でも管理者でもないため、予約詳細の参照を拒否した。
M002 getReservation.router_api_function_error Routerで捕捉したApiFunctionErrorにより予約詳細取得が失敗した。

ログ詳細

M001 getReservation.caller_cannot_view_reservation

項目 内容
id M001
message_id getReservation.caller_cannot_view_reservation
level WARNING
status 403
wrapper calls 1
ログ概要 呼び出し元が予約者本人でも管理者でもないため、予約詳細の参照を拒否した。
説明 呼び出し元が予約者本人でも管理者でもない場合。
対応すべきこと actorPrincipalIdとreservationIdの所有者を確認する。
runbook RUNBOOK-authorization-forbidden
実装参照 src/app/apis/reservations/get_reservation/functions.py
wrapper: src/app/apis/reservations/get_reservation/functions.py (ops_logger.warning)

出力項目

出力項目 型 説明
traceId string | null リクエストとログを横断して追跡する相関IDです。
actorPrincipalId string | null APIを呼び出した認証主体IDです。
api.statusCode integer | null API responseとして返したHTTP status codeです。
resource ErrorResource ログに出力するAPI固有のErrorResourceです。
resource.reservationId string | null 取得対象予約の存在確認、権限確認、問い合わせに使用する予約IDです。
error.code string | null エラー分類を表す機械処理向けコードです。
error.message string | null エラー内容を運用者が理解するための説明です。

M002 getReservation.router_api_function_error

項目 内容
id M002
message_id getReservation.router_api_function_error
level ERROR
status
wrapper calls 1
ログ概要 Routerで捕捉したApiFunctionErrorにより予約詳細取得が失敗した。
説明 ROUTER_HANDLED_EXCEPTIONSを捕捉した場合。
対応すべきこと 同一routeの5xx率、直近deploy、DB状態を確認する。
runbook RUNBOOK-unexpected-api-failure
実装参照 src/app/apis/reservations/get_reservation/functions.py
wrapper: src/app/apis/reservations/get_reservation/functions.py (ops_logger.error)

出力項目

出力項目 型 説明
traceId string | null リクエストとログを横断して追跡する相関IDです。
actorPrincipalId string | null APIを呼び出した認証主体IDです。
api.statusCode integer | null API responseとして返したHTTP status codeです。
resource ErrorResource ログに出力するAPI固有のErrorResourceです。
resource.reservationId string | null 取得対象予約の存在確認、権限確認、問い合わせに使用する予約IDです。
error.code string | null エラー分類を表す機械処理向けコードです。
error.message string | null エラー内容を運用者が理解するための説明です。
error.exceptionType string | null 捕捉された例外の型名です。

strict検証で要求する項目

Level 必須項目
WARNING why_production
ERROR check_procedure, context_model, runbook
CRITICAL remediation_procedure, context_model, runbook, escalation