رأیها (Votes)
رأیها (Votes) امکان ابراز نظر کاربران نسبت به پستها را فراهم میکنند. هر کاربر میتواند به هر پست فقط یک رأی بدهد.
نوعهای مشترک (Common Types)
| نام | توضیح |
|---|---|
Vote | شیء اصلی رأی |
فیلدهای Vote:
| فیلد | نوع | توضیح |
|---|---|---|
id | number | شناسه یکتای رأی |
created_at | string | تاریخ و زمان ایجاد (فرمت ISO 8601) |
post_id | number | شناسه پست مربوطه |
workspace_id | number | شناسه فضای کاری مربوطه |
external_author | ExternalAuthor | اطلاعات کاربر رأیدهنده |
فیلدهای ExternalAuthor:
| فیلد | نوع | توضیح |
|---|---|---|
id | string | شناسه یکتای کاربر (UUID) |
created_at | string | تاریخ و زمان ایجاد (فرمت ISO 8601) |
email | string | ایمیل |
full_name | string | نام کامل |
avatar_url | string | null | آدرس آواتار |
مدیریت رأیها (Votes)
دریافت لیست رأیهای یک پست
GET https://api.fidegah.ir/v1/posts/:postId/votes
curl -X GET https://api.fidegah.ir/v1/posts/{postId}/votes \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json"پارامترهای Query (Query Parameters):
| پارامتر | نوع | توضیح |
|---|---|---|
externalUserId | string | فیلتربراساس شناسه رأی دهنده — با کاما جدا کنید |
sortBy | string | فیلد مرتبسازی (پیشفرض created_at) |
sortOrder | 'asc' | 'desc' | جهت مرتبسازی (پیشفرض desc) |
پارامترهای مسیر (Path Parameters):
| پارامتر | نوع | توضیح |
|---|---|---|
postId | number | شناسه پست مورد نظر |
خروجی درخواست:
| فیلد | نوع | توضیح |
|---|---|---|
success | boolean | وضعیت موفقیتآمیز بودن درخواست |
data | []Vote | آرایه شامل لیست رأیها |
pagination | Pagination | اطلاعات صفحهبندی (مشاهده جزئیات) |
ثبت رأی
POST https://api.fidegah.ir/v1/posts/:postId/votes
curl -X POST https://api.fidegah.ir/v1/posts/{postId}/votes \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"user": {
"id": "uuid-here",
"email": "user@example.com",
"full_name": "نام کاربر"
}
}'پارامترهای مسیر (Path Parameters):
| پارامتر | نوع | توضیح |
|---|---|---|
postId | number | شناسه پست مورد نظر |
بدنه درخواست (Request Body):
| پارامتر | نوع | ضرورت | توضیح |
|---|---|---|---|
user | User | الزامی | اطلاعات کاربر رأیدهنده |
فیلدهای User:
| فیلد | نوع | ضرورت | توضیح |
|---|---|---|---|
id | string | الزامی | شناسه یکتای کاربر (UUID) |
email | string | الزامی | ایمیل کاربر |
full_name | string | الزامی | نام کامل کاربر |
avatar_url | string | اختیاری | آدرس آواتار کاربر |
خروجی درخواست:
| فیلد | نوع | توضیح |
|---|---|---|
success | boolean | وضعیت موفقیتآمیز بودن درخواست |
data | Vote | شیء رأی ثبت شده |
حذف رأی
DELETE https://api.fidegah.ir/v1/posts/:postId/votes
curl -X DELETE https://api.fidegah.ir/v1/posts/{postId}/votes \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json"پارامترهای مسیر (Path Parameters):
| پارامتر | نوع | توضیح |
|---|---|---|
postId | number | شناسه پست مورد نظر |
خروجی درخواست:
| فیلد | نوع | توضیح |
|---|---|---|
success | boolean | وضعیت موفقیتآمیز بودن درخواست |
message | string | پیام نتیجه حذف |
دیدگاهها (Comments)
دیدگاهها (Comments) امکان تعامل کاربران با پستها را فراهم میکنند. هر دیدگاه میتواند شامل پاسخهای تودرتو باشد و توسط ادمین فضای کاری پین یا اسپم شود.
گزارش تغییرات (Changelog)
گزارش تغییرات (Changelog) فضایی برای انتشار تغییرات و بهروزرسانیهای محصول است. هر آیتم میتواند شامل محتوای JSON و چندین تگ باشد.