گزارش تغییرات (Changelog)

گزارش تغییرات (Changelog) فضایی برای انتشار تغییرات و به‌روزرسانی‌های محصول است. هر آیتم می‌تواند شامل محتوای JSON و چندین تگ باشد.

نوع‌های مشترک (Common Types)

نام	توضیح
`Changelog`	شیء اصلی گزارش تغییرات

فیلدهای Changelog:

فیلد	نوع	توضیح
`id`	`string`	شناسه یکتای گزارش تغییرات (UUID)
`createdAt`	`string`	تاریخ و زمان ایجاد (فرمت ISO 8601)
`workspaceId`	`string`	شناسه فضای کاری مربوطه (UUID)
`userId`	`string`	شناسه کاربر ایجادکننده (UUID)
`title`	`string`	عنوان گزارش تغییرات
`content`	`string`	محتوای گزارش تغییرات
`tagIds`	`[]string`	آرایه شناسه تگ‌های مرتبط (UUID)
`likesCount`	`number`	تعداد لایک‌ها
`viewsCount`	`number`	تعداد بازدیدها
`isLiked`	`boolean`	آیا کاربر جاری لایک کرده است؟ (فقط در دریافت لیست/تکی)
`creator`	`Creator`	اطلاعات کاربر سازنده

فیلدهای Creator:

فیلد	نوع	توضیح
`id`	`string`	شناسه یکتای کاربر (UUID)
`fullName`	`string`	نام کامل
`avatarUrl`	`string \| null`	آدرس آواتار

فیلد isLiked فقط در پاسخ دریافت لیست و دریافت با شناسه وجود دارد؛ در پاسخ ایجاد و ویرایش برگردانده نمی‌شود.

مدیریت گزارش تغییرات (Changelog)

دریافت لیست تگ‌های گزارش تغییرات

GET https://api.fidegah.ir/v1/changelogs/tags

curl -X GET https://api.fidegah.ir/v1/changelogs/tags \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

خروجی درخواست: آرایه‌ای از تگ‌های قابل استفاده برای گزارش تغییرات.

دریافت لیست گزارش تغییرات

GET https://api.fidegah.ir/v1/changelogs

curl -X GET https://api.fidegah.ir/v1/changelogs \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

پارامترهای Query (Query Parameters):

پارامتر	نوع	توضیح
`search`	`string`	جستجو براساس عنوان یا محتوا
`tagId`	`string`	فیلتر بر اساس شناسه تگ (UUID) — با کاما جدا کنید

نتایج بر اساس جدیدترین تاریخ ایجاد مرتب می‌شوند. صفحه‌بندی نتایج طبق ساختار عمومی صفحه‌بندی API پشتیبانی می‌شود (مشاهده جزئیات).

خروجی درخواست:

فیلد	نوع	توضیح
`data`	`[]Changelog`	آرایه شامل لیست گزارش تغییرات
`pagination`	`Pagination`	اطلاعات صفحه‌بندی

دریافت گزارش تغییرات با شناسه

GET https://api.fidegah.ir/v1/changelogs/:id

curl -X GET https://api.fidegah.ir/v1/changelogs/{id} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

پارامترهای مسیر (Path Parameters):

پارامتر	نوع	توضیح
`id`	`string`	شناسه گزارش تغییرات مورد نظر (UUID)

با هر بار دریافت، تعداد بازدید (viewsCount) این گزارش تغییرات یک واحد افزایش می‌یابد.

خروجی درخواست: شیء Changelog درخواستی.

ایجاد گزارش تغییرات جدید

POST https://api.fidegah.ir/v1/changelogs

curl -X POST https://api.fidegah.ir/v1/changelogs \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "به‌روزرسانی جدید",
    "content": "متن گزارش تغییرات"
  }'

بدنه درخواست (Request Body):

پارامتر	نوع	ضرورت	توضیح
`title`	`string`	الزامی	عنوان گزارش تغییرات (حداکثر ۲۰۰ کاراکتر)
`content`	`string`	الزامی	محتوای گزارش تغییرات
`tagIds`	`[]string`	اختیاری	آرایه شناسه تگ‌های مرتبط (UUID)

خروجی درخواست: شیء Changelog ایجادشده.

ویرایش گزارش تغییرات

PATCH https://api.fidegah.ir/v1/changelogs/:id

curl -X PATCH https://api.fidegah.ir/v1/changelogs/{id} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "عنوان جدید"
  }'

پارامترهای مسیر (Path Parameters):

پارامتر	نوع	توضیح
`id`	`string`	شناسه گزارش تغییرات مورد نظر (UUID)

بدنه درخواست (Request Body - همگی اختیاری):

پارامتر	نوع	توضیح
`title`	`string`	عنوان جدید
`content`	`string`	محتوای جدید
`tagIds`	`[]string`	آرایه جدید شناسه تگ‌ها (UUID)

خروجی درخواست: شیء Changelog پس از ویرایش.

حذف گزارش تغییرات

DELETE https://api.fidegah.ir/v1/changelogs/:id

curl -X DELETE https://api.fidegah.ir/v1/changelogs/{id} \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

پارامترهای مسیر (Path Parameters):

پارامتر	نوع	توضیح
`id`	`string`	شناسه گزارش تغییرات مورد نظر (UUID)

خروجی درخواست:

فیلد	نوع	توضیح
`message`	`string`	پیام نتیجه حذف

لایک / برداشتن لایک از گزارش تغییرات

POST https://api.fidegah.ir/v1/changelogs/:id/like

curl -X POST https://api.fidegah.ir/v1/changelogs/{id}/like \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

پارامترهای مسیر (Path Parameters):

پارامتر	نوع	توضیح
`id`	`string`	شناسه گزارش تغییرات مورد نظر (UUID)

این endpoint وضعیت لایک کاربر متصل به API Key روی گزارش تغییرات را toggle می‌کند: اگر قبلاً لایک نکرده، لایک ثبت می‌شود و اگر قبلاً لایک کرده، لایک برداشته می‌شود.

خروجی درخواست: وضعیت جدید لایک روی گزارش تغییرات.

گزارش تغییرات (Changelog)

On this page