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

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

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

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

فیلدهای Changelog:

فیلدهای User:

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`	جستجو براساس شناسه تگ — با کاما جدا کنید
`sortBy`	`string`	فیلد مرتب‌سازی (پیش‌فرض `created_at`)
`sortOrder`	`'asc' \| 'desc'`	جهت مرتب‌سازی (پیش‌فرض `desc`)

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

فیلد	نوع	توضیح
`success`	`boolean`	وضعیت موفقیت‌آمیز بودن درخواست
`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`	`number`	شناسه گزارش تغییرات مورد نظر

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

فیلد	نوع	توضیح
`success`	`boolean`	وضعیت موفقیت‌آمیز بودن درخواست
`data`	`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`	`number`	شناسه گزارش تغییرات مورد نظر

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

فیلد	نوع	توضیح
`success`	`boolean`	وضعیت موفقیت‌آمیز بودن درخواست
`message`	`string`	پیام نتیجه حذف