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

آپلود سند workspace

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

ATP - آپلود سند workspace (POST /api/v1/workspaces/{workspace_id}/documents/)

Endpoint

POST /api/v1/workspaces/{workspace_id}/documents/

هدف آزمون

ثبت metadata و آپلود فایل.

شرایط آزمون

فرآیند آزمون

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

معرفی ویژگی

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

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

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

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

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

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

قالب API

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

Swagger

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

نمونه ورودی

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

نمونه خروجی

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

Status Codes

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

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

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

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

توضیحات