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

جزئیات نسخه بخش

GET /api/v1/invention-cases/{invention_case_id}/draft-documents/{document_id}/sections/{section_id}/versions/{version_id}/ مشاهده در Swagger

ATP - جزئیات نسخه بخش (GET /api/v1/invention-cases/{invention_case_id}/draft-documents/{document_id}/sections/{section_id}/versions/{version_id}/)

Endpoint

GET /api/v1/invention-cases/{invention_case_id}/draft-documents/{document_id}/sections/{section_id}/versions/{version_id}/

هدف آزمون

مشاهده section version.

شرایط آزمون

  • سرویس core-api در حال اجرا باشد
  • هدر Authorization با access token معتبر

فرآیند آزمون

  1. ارسال درخواست GET به /api/v1/invention-cases/{invention_case_id}/draft-documents/{document_id}/sections/{section_id}/versions/{version_id}/
  2. دریافت پاسخ HTTP
  3. بررسی کد وضعیت و بدنه JSON

معرفی ویژگی

این endpoint عملیات «جزئیات نسخه بخش» را در API Patent Genie انجام می‌دهد.

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

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

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

  1. ارسال GET /api/v1/invention-cases/{invention_case_id}/draft-documents/{document_id}/sections/{section_id}/versions/{version_id}/
  2. دریافت پاسخ موفق
  3. بررسی ساختار پاسخ

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

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

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

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

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

  1. استفاده از UUID نامعتبر یا متعلق به کاربر دیگر
  2. دریافت کد 404
  3. بررسی پیام خطای استاندارد API

قالب API

مولفه نوع نوع داده اجباری توضیحات
invention_case_id Path uuid بله شناسه پرونده اختراع
document_id Path uuid بله شناسه سند
section_id Path uuid بله شناسه بخش پیش‌نویس
version_id Path uuid بله شناسه نسخه

Swagger

get:
  summary: جزئیات نسخه بخش
  responses:
    200:
      description: عملیات موفق
    401:
      description: احراز هویت نامعتبر یا ناقص

نمونه ورودی

curl -X GET "http://localhost:8000/api/v1/invention-cases/{invention_case_id}/draft-documents/{document_id}/sections/{section_id}/versions/{version_id}/" \
  -H "Authorization: Bearer <access>" \
  -H "Content-Type: application/json"

نمونه خروجی

{
  "success": true,
  "data": {}
}

Status Codes

  • 200: عملیات موفق
  • 401: احراز هویت نامعتبر یا ناقص

نتیجه مورد انتظار

در صورت موفقیت، پاسخ JSON استاندارد با کد وضعیت مناسب برای GET برگردانده می‌شود.

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

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

توضیحات

  • مسیر باید با پیاده‌سازی فعلی urls.py هم‌خوان باشد