ATP - رویدادهای اجرا (GET /api/v1/workflow-runs/{workflow_run_id}/events/)
Endpoint
GET /api/v1/workflow-runs/{workflow_run_id}/events/
هدف آزمون
استریم SSE رویدادهای workflow run.
شرایط آزمون
- سرویس core-api در حال اجرا باشد
- هدر Authorization با access token معتبر
فرآیند آزمون
- ارسال درخواست GET به
/api/v1/workflow-runs/{workflow_run_id}/events/ - دریافت پاسخ HTTP
- بررسی کد وضعیت و بدنه JSON
معرفی ویژگی
این endpoint عملیات «رویدادهای اجرا» را در API Patent Genie انجام میدهد.
- ورودی معتبر: اعتبارسنجی در مرز API
- پاسخ استاندارد: قالب JSON یکسان با سایر endpointها
- کنترل دسترسی: مطابق policy ماژول مربوطه
سناریوی آزمون
سناریو 1: مسیر موفق
- ارسال
GET /api/v1/workflow-runs/{workflow_run_id}/events/ - دریافت پاسخ موفق
- بررسی ساختار پاسخ
سناریو 2: خطا - درخواست نامعتبر
- ارسال درخواست با داده یا شناسه نامعتبر
- دریافت کد خطای 4xx
- بررسی پیام خطای استاندارد API
سناریو 3: استریم تا done
- create run
- SSE events
- دریافت done
سناریو 4: resume
- قطع پس از id=3
- اتصال با last_event_id=3
- ادامه از id=4
قالب API
| مولفه | نوع | نوع داده | اجباری | توضیحات |
|---|---|---|---|---|
| last_event_id | Query | integer | خیر | sequence آخرین رویداد دریافتشده |
| workflow_run_id | Path | uuid | بله | شناسه اجرای گردشکار |
Swagger
get:
summary: رویدادهای اجرا
responses:
200:
description: عملیات موفق
401:
description: احراز هویت نامعتبر یا ناقص
نمونه ورودی
curl -X GET "http://localhost:8000/api/v1/workflow-runs/{workflow_run_id}/events/" \
-H "Authorization: Bearer <access>" \
-H "Content-Type: application/json"
نمونه خروجی
id: 1
data: {"type":"step_started","data":{"step_key":"search"}}
id: done
data: {"type":"done","data":{}}
Status Codes
- 200: عملیات موفق
- 401: احراز هویت نامعتبر یا ناقص
نتیجه مورد انتظار
در صورت موفقیت، پاسخ JSON استاندارد با کد وضعیت مناسب برای GET برگردانده میشود.
روال صحتسنجی
- بررسی کد وضعیت HTTP
- بررسی فیلد success در بدنه
- بررسی عدم افشای داده حساس
توضیحات
- رویداد نهایی done همیشه ارسال میشود