ATP - پیشنمایش migration قالب (POST /api/v1/invention-cases/{invention_case_id}/draft-documents/{document_id}/template-migration-preview/)
Endpoint
POST /api/v1/invention-cases/{invention_case_id}/draft-documents/{document_id}/template-migration-preview/
هدف آزمون
محاسبه تفاوتها قبل از اعمال نسخه جدید قالب روی draft.
شرایط آزمون
- سرویس core-api در حال اجرا باشد
- هدر Authorization با access token معتبر
فرآیند آزمون
- انتخاب target_template_version_id
- POST preview
- دریافت preview_token و diff sections
- بررسی decisions مورد نیاز
معرفی ویژگی
این endpoint عملیات «پیشنمایش migration قالب» را در API Patent Genie انجام میدهد.
- ورودی معتبر: اعتبارسنجی در مرز API
- پاسخ استاندارد: قالب JSON یکسان با سایر endpointها
- کنترل دسترسی: مطابق policy ماژول مربوطه
سناریوی آزمون
سناریو 1: مسیر موفق
- ارسال
POST /api/v1/invention-cases/{invention_case_id}/draft-documents/{document_id}/template-migration-preview/ - دریافت پاسخ موفق
- بررسی ساختار پاسخ
سناریو 2: خطا - درخواست نامعتبر
- ارسال درخواست با داده یا شناسه نامعتبر
- دریافت کد خطای 4xx
- بررسی پیام خطای استاندارد API
سناریو 3: خطا — بدون احراز هویت
- ارسال درخواست بدون هدر Authorization
- دریافت کد 401
- بررسی عدم برگرداندن داده محافظتشده
سناریو 4: خطا — منبع یافت نشد
- استفاده از UUID نامعتبر یا متعلق به کاربر دیگر
- دریافت کد 404
- بررسی پیام خطای استاندارد API
قالب API
| مولفه | نوع | نوع داده | اجباری | توضیحات |
|---|---|---|---|---|
| target_template_version_id | Body | uuid | بله | نسخه مقصد قالب |
| invention_case_id | Path | uuid | بله | شناسه پرونده اختراع |
| document_id | Path | uuid | بله | شناسه سند |
Swagger
post:
summary: پیشنمایش migration قالب
responses:
201:
description: منبع ایجاد شد
400:
description: داده ورودی نامعتبر
401:
description: احراز هویت نامعتبر
نمونه ورودی
curl -X POST "http://localhost:8000/api/v1/invention-cases/{invention_case_id}/draft-documents/{document_id}/template-migration-preview/" \
-H "Authorization: Bearer <access>" \
-H "Content-Type: application/json"
نمونه خروجی
{
"success": true,
"data": {}
}
Status Codes
- 201: منبع ایجاد شد
- 400: داده ورودی نامعتبر
- 401: احراز هویت نامعتبر
نتیجه مورد انتظار
در صورت موفقیت، پاسخ JSON استاندارد با کد وضعیت مناسب برای POST برگردانده میشود.
روال صحتسنجی
- بررسی کد وضعیت HTTP
- بررسی فیلد success در بدنه
- بررسی عدم افشای داده حساس
توضیحات
- ADR-0009
- preview_token برای apply الزامی است