بازگشت به فهرست ATP →
قابلیت‌ها و تعاریف گردش‌کار

کاتالوگ capabilityها

GET /api/v1/capabilities/ مشاهده در Swagger

ATP - کاتالوگ capabilityها (GET /api/v1/capabilities/)

Endpoint

GET /api/v1/capabilities/

هدف آزمون

لیست تعاریف capability برای admin/internal tooling.

شرایط آزمون

  • کاربر احراز هویت‌شده با نقش admin (is_staff)

فرآیند آزمون

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

معرفی ویژگی

کاتالوگ read-only قابلیت‌های ماژولار؛ برای tooling و مستندسازی داخلی.

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

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

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

  1. ارسال GET /api/v1/capabilities/
  2. دریافت پاسخ موفق
  3. بررسی ساختار پاسخ

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

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

سناریو 3: مسیر موفق — admin

  1. ورود با کاربر is_staff
  2. GET /api/v1/capabilities/
  3. دریافت 200 با data.items
  4. بررسی فیلدهای key و module_key در هر item

سناریو 4: خطا — کاربر غیر admin

  1. ورود با کاربر عادی
  2. GET capabilities
  3. دریافت 403

قالب API

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

Swagger

get:
  summary: کاتالوگ capabilityها
  responses:
    200:
      description: عملیات موفق
    401:
      description: احراز هویت نامعتبر یا ناقص

نمونه ورودی

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

نمونه خروجی

{
  "success": true,
  "data": {
    "items": [
      { "key": "upload_source_documents", "module_key": "information_collection", "name": "..." }
    ]
  }
}

Status Codes

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

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

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

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

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

توضیحات

  • فقط IsAdminUser
  • ADR-0011