Changelog API

Create and manage changelog posts via the API.

List Posts

GET /api/v1/changelog/posts

Query Parameters

Parameter Type Description
type string Filter by type (new, improvement, fix)
published boolean Filter by published status
limit integer Number of posts to return

Response

{
  "success": true,
  "data": [
    {
      "id": 1,
      "title": "New Dashboard Design",
      "slug": "new-dashboard-design",
      "type": "new",
      "version": "2.0.0",
      "content": "We've completely redesigned...",
      "is_published": true,
      "published_at": "2024-01-20T14:00:00Z",
      "reactions": {
        "thumbs_up": 45,
        "heart": 23,
        "rocket": 12
      }
    }
  ]
}

Create Post

POST /api/v1/changelog/posts

Request Body

{
  "title": "Performance Improvements",
  "type": "improvement",
  "version": "2.1.0",
  "content": "We've optimized database queries...",
  "is_published": true
}

Update Post

PUT /api/v1/changelog/posts/{id}

Delete Post

DELETE /api/v1/changelog/posts/{id}

Get Reactions

GET /api/v1/changelog/posts/{id}/reactions

Response

{
  "success": true,
  "data": {
    "thumbs_up": 45,
    "heart": 23,
    "rocket": 12,
    "party": 8,
    "eyes": 5
  }
}

Was this page helpful?

Your feedback helps us improve our documentation

Thank you for your feedback!

Your input helps us create better documentation for everyone