دستهبندیها (Categories)
دستهبندیها (Categories) روشی برای گروهبندی و فیلتر کردن پستها درون هر بخش (Board) هستند. هر دستهبندی به یک بخش خاص تعلق دارد و میتواند شامل چندین پست باشد.
دستهبندیها در سطح هر بخش تعریف میشوند و بین بخشها مشترک نیستند.
نوعهای مشترک (Common Types)
| نام | توضیح |
|---|---|
Category | شیء اصلی دستهبندی |
فیلدهای Category:
| فیلد | نوع | توضیح |
|---|---|---|
id | string | شناسه یکتای دستهبندی (UUID) |
createdAt | string | تاریخ و زمان ایجاد (فرمت ISO 8601) |
boardId | string | شناسه بخش مربوطه (UUID) |
workspaceId | string | شناسه فضای کاری مربوطه (UUID) |
name | string | نام دستهبندی |
postsCount | number | تعداد کل پستهای ثبت شده در این دسته |
مدیریت دستهبندیها (Categories)
دریافت لیست دستهبندیها
GET https://api.fidegah.ir/v1/post-categories
curl -X GET https://api.fidegah.ir/v1/post-categories \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json"پارامترهای Query (Query Parameters):
| پارامتر | نوع | توضیح |
|---|---|---|
boardId | string | فیلتر دستهبندیها بر اساس بخش (UUID) |
خروجی درخواست: آرایهای از Category.
دریافت دستهبندی با شناسه
GET https://api.fidegah.ir/v1/post-categories/:id
curl -X GET https://api.fidegah.ir/v1/post-categories/{id} \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json"پارامترهای مسیر (Path Parameters):
| پارامتر | نوع | توضیح |
|---|---|---|
id | string | شناسه دستهبندی مورد نظر (UUID) |
خروجی درخواست: شیء Category درخواستی.
ایجاد دستهبندی جدید
POST https://api.fidegah.ir/v1/post-categories
curl -X POST https://api.fidegah.ir/v1/post-categories \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "دستهبندی من",
"boardId": "b3f1c9a0-..."
}'بدنه درخواست (Request Body):
| پارامتر | نوع | ضرورت | توضیح |
|---|---|---|---|
name | string | الزامی | نام دستهبندی (حداکثر ۱۰۰ کاراکتر) |
boardId | string | الزامی | شناسه بخشی که دستهبندی به آن تعلق دارد (UUID) |
خروجی درخواست: شیء Category ایجادشده.
ویرایش دستهبندی
PATCH https://api.fidegah.ir/v1/post-categories/:id
curl -X PATCH https://api.fidegah.ir/v1/post-categories/{id} \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "نام جدید"
}'پارامترهای مسیر (Path Parameters):
| پارامتر | نوع | توضیح |
|---|---|---|
id | string | شناسه دستهبندی مورد نظر (UUID) |
بدنه درخواست (Request Body - اختیاری):
| پارامتر | نوع | توضیح |
|---|---|---|
name | string | نام جدید دستهبندی |
خروجی درخواست: شیء Category پس از ویرایش.
حذف دستهبندی
DELETE https://api.fidegah.ir/v1/post-categories/:id
curl -X DELETE https://api.fidegah.ir/v1/post-categories/{id} \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json"پارامترهای مسیر (Path Parameters):
| پارامتر | نوع | توضیح |
|---|---|---|
id | string | شناسه دستهبندی مورد نظر (UUID) |
خروجی درخواست:
| فیلد | نوع | توضیح |
|---|---|---|
message | string | پیام نتیجه حذف |
بخشها (Boards)
بخشها (Boards) فضاهایی برای دستهبندی و مدیریت بازخوردها، ویژگیها یا باگها هستند. هر بخش میتواند شامل چندین تگ و دستهبندی مجزا باشد.
تگها (Tags)
تگها (Tags) برچسبهایی برای دستهبندی دقیقتر و فیلتر کردن پستها درون هر بخش (Board) هستند. هر تگ به یک بخش خاص تعلق دارد و برخلاف دستهبندیها، هر پست میتواند چندین تگ داشته باشد.