بخشها (Boards)
بخشها (Boards) فضاهایی برای دستهبندی و مدیریت بازخوردها، ویژگیها یا باگها هستند. هر بخش میتواند شامل چندین تگ و دستهبندی مجزا باشد.
نوعهای مشترک (Common Types)
| نام | توضیح |
|---|---|
Board | شیء اصلی بخش |
فیلدهای Board:
| فیلد | نوع | توضیح |
|---|---|---|
id | number | شناسه یکتای بخش |
created_at | string | تاریخ و زمان ایجاد (فرمت ISO 8601) |
workspace_id | number | شناسه فضای کاری مربوطه |
title | string | عنوان بخش |
description | string | null | توضیحات بخش |
url | string | آدرس یکتای بخش |
is_private | boolean | وضعیت خصوصی یا عمومی بودن بورد |
is_default | boolean | آیا بخش پیشفرض فضای کاری است؟ |
posts_count | number | تعداد کل پستهای ثبت شده در بخش |
author | User | اطلاعات کاربر سازنده |
فیلدهای User:
| فیلد | نوع | توضیح |
|---|---|---|
id | string | شناسه یکتای کاربر (UUID) |
created_at | string | تاریخ و زمان ایجاد (فرمت ISO 8601) |
email | string | ایمیل |
full_name | string | نام کامل |
avatar_url | string | null | آدرس آواتار |
مدیریت بخشها (Boards)
دریافت لیست تمام بخشها
GET https://api.fidegah.ir/v1/boards
curl -X GET https://api.fidegah.ir/v1/boards \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json"پارامترهای Query (Query Parameters):
| پارامتر | نوع | توضیح |
|---|---|---|
search | string | جستجو براساس عنوان |
isDefault | boolean | فیلتر بر اساس بخش پیشفرض |
isPrivate | boolean | فیلتر بر اساس خصوصی یا عمومی بودن |
sortBy | string | فیلد مرتبسازی (پیشفرض created_at) |
sortOrder | 'asc' | 'desc' | جهت مرتبسازی (پیشفرض desc) |
خروجی درخواست:
| فیلد | نوع | توضیح |
|---|---|---|
success | boolean | وضعیت موفقیتآمیز بودن درخواست |
data | []Board | آرایه شامل لیست بخشها |
pagination | Pagination | اطلاعات صفحهبندی (مشاهده جزئیات) |
دریافت بخش با شناسه
GET https://api.fidegah.ir/v1/boards/:id
curl -X GET https://api.fidegah.ir/v1/boards/{id} \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json"پارامترهای مسیر (Path Parameters):
| پارامتر | نوع | توضیح |
|---|---|---|
id | number | شناسه بخش مورد نظر |
خروجی درخواست:
| فیلد | نوع | توضیح |
|---|---|---|
success | boolean | وضعیت موفقیتآمیز بودن درخواست |
data | Board | شیء بخش درخواستی |
ایجاد بخش جدید
POST https://api.fidegah.ir/v1/boards
curl -X POST https://api.fidegah.ir/v1/boards \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"title": "بخش من",
"url": "myBoard",
"is_private": false
}'بدنه درخواست (Request Body):
| پارامتر | نوع | ضرورت | توضیح |
|---|---|---|---|
title | string | الزامی | عنوان بخش (حداقل ۳، حداکثر ۲۰ کاراکتر) |
url | string | الزامی | آدرس اختصاصی (حداقل ۳، حداکثر ۲۰ کاراکتر، شروع با حروف، بدون علائم خاص و خط تیره متوالی) |
is_private | boolean | الزامی | وضعیت خصوصی یا عمومی بودن بخش |
description | string | اختیاری | توضیحات بخش (پیشفرض null) |
is_default | boolean | اختیاری | بخش پیشفرض فضای کاری (پیشفرض false) |
خروجی درخواست:
| فیلد | نوع | توضیح |
|---|---|---|
success | boolean | وضعیت موفقیتآمیز بودن درخواست |
data | Board | شیء بخش ایجاد شده |
ویرایش بخش
PATCH https://api.fidegah.ir/v1/boards/:id
curl -X PATCH https://api.fidegah.ir/v1/boards/{id} \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"title": "عنوان جدید"
}'پارامترهای مسیر (Path Parameters):
| پارامتر | نوع | توضیح |
|---|---|---|
id | number | شناسه بخش |
بدنه درخواست (Request Body - همگی اختیاری):
| پارامتر | نوع | توضیح |
|---|---|---|
title | string | عنوان بخش (حداقل ۳، حداکثر ۲۰ کاراکتر) |
url | string | آدرس اختصاصی (حداقل ۳، حداکثر ۲۰ کاراکتر، شروع با حروف، بدون علائم خاص و خط تیره متوالی) |
is_private | boolean | وضعیت خصوصی یا عمومی بودن بخش |
description | string | توضیحات بخش |
is_default | boolean | بخش پیشفرض فضای کاری |
خروجی درخواست:
| فیلد | نوع | توضیح |
|---|---|---|
success | boolean | وضعیت موفقیتآمیز بودن درخواست |
data | Board | شیء بخش پس از ویرایش |
حذف بخش
DELETE https://api.fidegah.ir/v1/boards/:id
curl -X DELETE https://api.fidegah.ir/v1/boards/{id} \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json"پارامترهای مسیر (Path Parameters):
| پارامتر | نوع | توضیح |
|---|---|---|
id | number | شناسه بخش مورد نظر |
خروجی درخواست:
| فیلد | نوع | توضیح |
|---|---|---|
success | boolean | وضعیت موفقیتآمیز بودن درخواست |
message | string | پیام نتیجه حذف |
فضاهای کاری (Workspaces)
فضاهای کاری (Workspace) محیطی ایزوله برای سازماندهی تیمها، پروژهها و منابع هستند. هر کاربر میتواند عضو چندین فضای کاری باشد و در هر فضای کاری، نقشی متفاوت (مانند عضو، مدیر یا ادمین) ایفا کند. این قابلیت به شما امکان میدهد دسترسیها و سطح اختیارات را برای هر کاربر به صورت مجزا مدیریت کنید.
دستهبندیها (Categories)
دستهبندیها (Categories) روشی برای گروهبندی و فیلتر کردن پستها درون هر بخش (Board) هستند. هر دستهبندی به یک بخش خاص تعلق دارد و میتواند شامل چندین پست باشد.