بازگشت به فهرست ATP →
اسناد پیش‌نویس

پیش‌نمایش migration قالب

POST /api/v1/invention-cases/{invention_case_id}/draft-documents/{document_id}/template-migration-preview/ مشاهده در Swagger

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 معتبر

فرآیند آزمون

  1. انتخاب target_template_version_id
  2. POST preview
  3. دریافت preview_token و diff sections
  4. بررسی decisions مورد نیاز

معرفی ویژگی

این endpoint عملیات «پیش‌نمایش migration قالب» را در API Patent Genie انجام می‌دهد.

  • ورودی معتبر: اعتبارسنجی در مرز API
  • پاسخ استاندارد: قالب JSON یکسان با سایر endpointها
  • کنترل دسترسی: مطابق policy ماژول مربوطه

سناریوی آزمون

سناریو 1: مسیر موفق

  1. ارسال POST /api/v1/invention-cases/{invention_case_id}/draft-documents/{document_id}/template-migration-preview/
  2. دریافت پاسخ موفق
  3. بررسی ساختار پاسخ

سناریو 2: خطا - درخواست نامعتبر

  1. ارسال درخواست با داده یا شناسه نامعتبر
  2. دریافت کد خطای 4xx
  3. بررسی پیام خطای استاندارد API

سناریو 3: خطا — بدون احراز هویت

  1. ارسال درخواست بدون هدر Authorization
  2. دریافت کد 401
  3. بررسی عدم برگرداندن داده محافظت‌شده

سناریو 4: خطا — منبع یافت نشد

  1. استفاده از UUID نامعتبر یا متعلق به کاربر دیگر
  2. دریافت کد 404
  3. بررسی پیام خطای استاندارد 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 برگردانده می‌شود.

روال صحت‌سنجی

  1. بررسی کد وضعیت HTTP
  2. بررسی فیلد success در بدنه
  3. بررسی عدم افشای داده حساس

توضیحات

  • ADR-0009
  • preview_token برای apply الزامی است