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