← بازگشت به فهرست ATP
اسناد فضای کاری

حذف سند workspace

DELETE /api/v1/workspaces/{workspace_id}/documents/{document_id}/ مشاهده در Swagger

ATP - حذف سند workspace (DELETE /api/v1/workspaces/{workspace_id}/documents/{document_id}/)

Endpoint

DELETE /api/v1/workspaces/{workspace_id}/documents/{document_id}/

هدف آزمون

حذف سند و metadata.

شرایط آزمون

فرآیند آزمون

  1. ارسال درخواست DELETE به /api/v1/workspaces/{workspace_id}/documents/{document_id}/
  2. دریافت پاسخ HTTP
  3. بررسی کد وضعیت و بدنه JSON

معرفی ویژگی

این endpoint عملیات «حذف سند workspace» را در API Patent Genie انجام می‌دهد.

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

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

  1. ارسال DELETE /api/v1/workspaces/{workspace_id}/documents/{document_id}/
  2. دریافت پاسخ موفق
  3. بررسی ساختار پاسخ

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

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

قالب API

مولفه نوع نوع داده اجباری توضیحات
بدون پارامتر ورودی

Swagger

delete:
  summary: حذف سند workspace
  responses:
    204:
      description: حذف موفق
    404:
      description: منبع یافت نشد
    401:
      description: احراز هویت نامعتبر

نمونه ورودی

curl -X DELETE "http://localhost:8000/api/v1/workspaces/{workspace_id}/documents/{document_id}/" \
  -H "Authorization: Bearer <access>" \
  -H "Content-Type: application/json"

نمونه خروجی

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

Status Codes

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

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

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

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

توضیحات