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