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

ایجاد قالب پیش‌نویس

POST /api/v1/draft-templates/ مشاهده در Swagger

ATP - ایجاد قالب پیش‌نویس (POST /api/v1/draft-templates/)

Endpoint

POST /api/v1/draft-templates/

هدف آزمون

ایجاد قالب جدید (system اگر workspace_id نباشد).

شرایط آزمون

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

فرآیند آزمون

  1. ارسال درخواست POST به /api/v1/draft-templates/
  2. دریافت پاسخ HTTP
  3. بررسی کد وضعیت و بدنه JSON

معرفی ویژگی

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

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

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

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

  1. ارسال POST /api/v1/draft-templates/
  2. دریافت پاسخ موفق
  3. بررسی ساختار پاسخ

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

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

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

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

سناریو 4: خطا — توکن منقضی

  1. استفاده از access token منقضی‌شده
  2. دریافت کد 401
  3. تازه‌سازی توکن با endpoint refresh

قالب API

مولفه نوع نوع داده اجباری توضیحات
key Body string بله کلید یکتا قالب
name Body string بله نام نمایشی
description Body string خیر توضیح
workspace_id Body uuid خیر محدود به workspace

Swagger

post:
  summary: ایجاد قالب پیش‌نویس
  responses:
    201:
      description: منبع ایجاد شد
    400:
      description: داده ورودی نامعتبر
    401:
      description: احراز هویت نامعتبر

نمونه ورودی

curl -X POST "http://localhost:8000/api/v1/draft-templates/" \
  -H "Authorization: Bearer <access>" \
  -H "Content-Type: application/json"

نمونه خروجی

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

Status Codes

  • 201: قالب ایجاد شد
  • 400: validation
  • 403: عدم دسترسی

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

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

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

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

توضیحات

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