Skip to Content
חוברת ה-APIיומן שינויים

יומן שינויים

CRUD מלא על רשומות יומן השינויים של הפרויקט שלכם.

GET/v1/changelog

ParameterTypeDescription
localestringהחזרת רשומות בשפה הזו כשקיים תרגום.
limitintegerגודל עמוד. ברירת המחדל היא 20.
offsetintegerמספר הפריטים לדילוג. ברירת המחדל היא 0.

הרשימה מחזירה רשומות שפורסמו בלבד — אותה קבוצה שמבקר בפורטל רואה.

GET/v1/changelog/:id

ParameterTypeDescription
localestringהחזרת הרשומה בשפה הזו כשקיים תרגום.

POST/v1/changelog

ParameterTypeDescription
titlerequiredstringכותרת הרשומה.
bodystringגוף הרשומה (Markdown).
labelsstring[]תוויות כמו New, Improved, Fixed.
versionstringגרסת semver. ברירת המחדל היא 1.0.0.
statusstringdraft, scheduled או published. ברירת המחדל היא draft.
localestringשפת התוכן. ברירת המחדל היא en.

PATCH/v1/changelog/:id

ParameterTypeDescription
titlestringכותרת הרשומה.
bodystringגוף הרשומה (Markdown).
labelsstring[]תוויות כמו New, Improved, Fixed.
versionstringגרסת semver. ברירת המחדל היא 1.0.0.
statusstringdraft, scheduled או published. ברירת המחדל היא draft.
localestringשפת התוכן. ברירת המחדל היא en.

DELETE/v1/changelog/:id

פעולות כתיבה דורשות גישת API בתוכנית בתשלום Pro. DELETE מחזיר 204 עם גוף ריק.

רשימת רשומות ביומן השינויים

curl "https://api.supdesk.app/v1/changelog?locale=en&limit=20" \ -H "Authorization: Bearer sd_live_..."
{ "data": [ { "id": "ch_abc123", "title": "Version 1.4.0", "body": "### New Features\n\n- Added dark mode support\n- New export options\n\n### Fixes\n\n- Fixed Safari export button issue", "labels": ["new", "fixed"], "published_at": "2026-07-01T12:00:00Z", "locale": "en", "version": "1.4.0" } ], "pagination": { "limit": 20, "offset": 0, "has_more": false } }

קבלת רשומה מיומן השינויים

curl "https://api.supdesk.app/v1/changelog/ch_abc123?locale=en" \ -H "Authorization: Bearer sd_live_..."
{ "data": { "id": "ch_abc123", "title": "Version 1.4.0", "body": "### New Features\n\n- Added dark mode support\n- New export options\n\n### Fixes\n\n- Fixed Safari export button issue", "labels": ["new", "fixed"], "published_at": "2026-07-01T12:00:00Z", "locale": "en", "version": "1.4.0" } }

יצירת רשומה ביומן השינויים

curl -X POST https://api.supdesk.app/v1/changelog \ -H "Authorization: Bearer sd_live_..." \ -H "Content-Type: application/json" \ -d '{ "title": "Version 1.4.0", "body": "### New Features\n\n- Added dark mode support\n- New export options\n\n### Fixes\n\n- Fixed Safari export button issue", "labels": ["new", "fixed"], "version": "1.4.0", "status": "published", "locale": "en" }'
{ "data": { "id": "ch_abc123", "title": "Version 1.4.0", "body": "### New Features\n\n- Added dark mode support\n- New export options\n\n### Fixes\n\n- Fixed Safari export button issue", "labels": ["new", "fixed"], "published_at": "2026-07-01T12:00:00Z", "locale": "en", "version": "1.4.0" } }

עדכון רשומה ביומן השינויים

curl -X PATCH https://api.supdesk.app/v1/changelog/ch_abc123 \ -H "Authorization: Bearer sd_live_..." \ -H "Content-Type: application/json" \ -d '{ "title": "Version 1.4.0 - Enhanced", "status": "draft" }'
{ "data": { "id": "ch_abc123", "title": "Version 1.4.0 - Enhanced", "body": "### New Features\n\n- Added dark mode support\n- New export options\n\n### Fixes\n\n- Fixed Safari export button issue", "labels": ["new", "fixed"], "published_at": null, "locale": "en", "version": "1.4.0" } }

מחיקת רשומה מיומן השינויים

curl -X DELETE https://api.supdesk.app/v1/changelog/ch_abc123 \ -H "Authorization: Bearer sd_live_..."

מחזיר 204 No Content בהצלחה.

Last updated on