ATP - لغو اجرا (POST /api/v1/workflow-runs/{workflow_run_id}/cancel/)
Endpoint
POST /api/v1/workflow-runs/{workflow_run_id}/cancel/
هدف آزمون
لغو run در وضعیت running.
شرایط آزمون
- سرویس core-api در حال اجرا باشد
- هدر Authorization با access token معتبر
فرآیند آزمون
- GET detail و تأیید status=running
- POST cancel
- بررسی status=cancelled
- بررسی stepهای ناتمام failed/cancelled
معرفی ویژگی
این endpoint عملیات «لغو اجرا» را در API Patent Genie انجام میدهد.
- ورودی معتبر: اعتبارسنجی در مرز API
- پاسخ استاندارد: قالب JSON یکسان با سایر endpointها
- کنترل دسترسی: مطابق policy ماژول مربوطه
سناریوی آزمون
سناریو 1: مسیر موفق
- ارسال
POST /api/v1/workflow-runs/{workflow_run_id}/cancel/ - دریافت پاسخ موفق
- بررسی ساختار پاسخ
سناریو 2: خطا - درخواست نامعتبر
- ارسال درخواست با داده یا شناسه نامعتبر
- دریافت کد خطای 4xx
- بررسی پیام خطای استاندارد API
سناریو 3: لغو موفق
- run running
- POST cancel
- 200
- status=cancelled
سناریو 4: لغو run تمامشده
- run completed
- POST cancel
- 400
قالب API
| مولفه | نوع | نوع داده | اجباری | توضیحات |
|---|---|---|---|---|
| workflow_run_id | Path | uuid | بله | شناسه اجرای گردشکار |
Swagger
post:
summary: لغو اجرا
responses:
201:
description: منبع ایجاد شد
400:
description: داده ورودی نامعتبر
401:
description: احراز هویت نامعتبر
نمونه ورودی
curl -X POST "http://localhost:8000/api/v1/workflow-runs/{workflow_run_id}/cancel/" \
-H "Authorization: Bearer <access>" \
-H "Content-Type: application/json"
نمونه خروجی
{
"success": true,
"data": {}
}
Status Codes
- 201: منبع ایجاد شد
- 400: داده ورودی نامعتبر
- 401: احراز هویت نامعتبر
نتیجه مورد انتظار
در صورت موفقیت، پاسخ JSON استاندارد با کد وضعیت مناسب برای POST برگردانده میشود.
روال صحتسنجی
- بررسی کد وضعیت HTTP
- بررسی فیلد success در بدنه
- بررسی عدم افشای داده حساس
توضیحات
- مسیر باید با پیادهسازی فعلی urls.py همخوان باشد