Acceptance Test Protocol

فهرست ATPهای API

هر endpoint یک ATP اختصاصی دارد. روی هر مورد کلیک کنید تا سناریوهای آزمون، نمونه درخواست/پاسخ و روال صحت‌سنجی را ببینید.

سلامت سرویس

بررسی زنده بودن سرویس GET /api/health/
بررسی آمادگی سرویس GET /api/ready/

احراز هویت

ثبت‌نام کاربر POST /api/v1/auth/register/
ورود کاربر POST /api/v1/auth/login/
خروج کاربر POST /api/v1/auth/logout/
تازه‌سازی توکن POST /api/v1/auth/refresh/
پروفایل کاربر جاری GET /api/v1/auth/me/
فهرست نشست‌ها GET /api/v1/auth/sessions/
لغو نشست DELETE /api/v1/auth/sessions/{session_id}/

فضاهای کاری

لیست فضاهای کاری GET /api/v1/workspaces/
ایجاد فضای کاری POST /api/v1/workspaces/
جزئیات فضای کاری GET /api/v1/workspaces/{workspace_id}/
به‌روزرسانی فضای کاری PATCH /api/v1/workspaces/{workspace_id}/
لیست اعضای workspace GET /api/v1/workspaces/{workspace_id}/members/
افزودن عضو workspace POST /api/v1/workspaces/{workspace_id}/members/
به‌روزرسانی عضو workspace PATCH /api/v1/workspaces/{workspace_id}/members/{member_id}/
حذف عضو workspace DELETE /api/v1/workspaces/{workspace_id}/members/{member_id}/

اسناد فضای کاری

لیست اسناد workspace GET /api/v1/workspaces/{workspace_id}/documents/
آپلود سند workspace POST /api/v1/workspaces/{workspace_id}/documents/
جزئیات سند workspace GET /api/v1/workspaces/{workspace_id}/documents/{document_id}/
به‌روزرسانی سند workspace PATCH /api/v1/workspaces/{workspace_id}/documents/{document_id}/
حذف سند workspace DELETE /api/v1/workspaces/{workspace_id}/documents/{document_id}/

پرونده‌های اختراع

لیست پرونده‌های اختراع GET /api/v1/invention-cases/
ایجاد پرونده اختراع POST /api/v1/invention-cases/
جزئیات پرونده اختراع GET /api/v1/invention-cases/{invention_case_id}/
به‌روزرسانی پرونده اختراع PATCH /api/v1/invention-cases/{invention_case_id}/
انتقال stage پرونده POST /api/v1/invention-cases/{invention_case_id}/transition-stage/
پیشرفت پرونده GET /api/v1/invention-cases/{invention_case_id}/progress/

اسناد پرونده

لیست لینک اسناد پرونده GET /api/v1/invention-cases/{invention_case_id}/documents/
ایجاد لینک سند پرونده POST /api/v1/invention-cases/{invention_case_id}/documents/
حذف لینک سند پرونده DELETE /api/v1/invention-cases/{invention_case_id}/documents/{link_id}/
لیست اسناد مبدأ GET /api/v1/invention-cases/{invention_case_id}/source-documents/
ایجاد سند مبدأ POST /api/v1/invention-cases/{invention_case_id}/source-documents/

زمینه و intake

آمادگی intake GET /api/v1/invention-cases/{invention_case_id}/intake-readiness/
شروع استخراج context POST /api/v1/invention-cases/{invention_case_id}/start-context-extraction/
آمادگی context GET /api/v1/invention-cases/{invention_case_id}/context-readiness/
سوالات context GET /api/v1/invention-cases/{invention_case_id}/context-questions/
ثبت پاسخ‌های context POST /api/v1/invention-cases/{invention_case_id}/context-answers/

اسناد پیش‌نویس

لیست پیش‌نویس‌ها GET /api/v1/invention-cases/{invention_case_id}/draft-documents/
ایجاد پیش‌نویس POST /api/v1/invention-cases/{invention_case_id}/draft-documents/
جزئیات پیش‌نویس GET /api/v1/invention-cases/{invention_case_id}/draft-documents/{document_id}/
به‌روزرسانی پیش‌نویس PATCH /api/v1/invention-cases/{invention_case_id}/draft-documents/{document_id}/
لیست نسخه‌های پیش‌نویس GET /api/v1/invention-cases/{invention_case_id}/draft-documents/{document_id}/versions/
ایجاد نسخه پیش‌نویس POST /api/v1/invention-cases/{invention_case_id}/draft-documents/{document_id}/versions/
جزئیات نسخه پیش‌نویس GET /api/v1/invention-cases/{invention_case_id}/draft-documents/{document_id}/versions/{version_id}/
لیست بخش‌های پیش‌نویس GET /api/v1/invention-cases/{invention_case_id}/draft-documents/{document_id}/sections/
ایجاد بخش پیش‌نویس POST /api/v1/invention-cases/{invention_case_id}/draft-documents/{document_id}/sections/
جزئیات بخش پیش‌نویس GET /api/v1/invention-cases/{invention_case_id}/draft-documents/{document_id}/sections/{section_id}/
لیست نسخه‌های بخش GET /api/v1/invention-cases/{invention_case_id}/draft-documents/{document_id}/sections/{section_id}/versions/
ایجاد نسخه بخش POST /api/v1/invention-cases/{invention_case_id}/draft-documents/{document_id}/sections/{section_id}/versions/
جزئیات نسخه بخش GET /api/v1/invention-cases/{invention_case_id}/draft-documents/{document_id}/sections/{section_id}/versions/{version_id}/

پروژه‌ها

لیست اسناد پروژه GET /api/v1/projects/{project_id}/documents/
ایجاد لینک سند پروژه POST /api/v1/projects/{project_id}/documents/
حذف لینک سند پروژه DELETE /api/v1/projects/{project_id}/documents/{link_id}/

استخراج سند

جزئیات درخواست استخراج GET /api/v1/document-extraction-requests/{request_id}/
جزئیات job استخراج (alias) GET /api/v1/document-extraction-jobs/{request_id}/