changelog.v1.ChangelogService
ListChanges
List changes across published posts, for example every breaking change since a given time.
Request
curl --request POST \ \
--url 'https://api.testnet.polyester.com/changelog.v1.ChangelogService/ListChanges' \
--header 'Content-Type: application/json' \
--header 'Connect-Protocol-Version: 1' \
--data '{
"actionRequired": false,
"audiences": [
"ALL_USERS"
],
"categories": [
"BREAKING_CHANGE"
],
"endTime": "2025-01-01T00:00:00Z",
"limit": 100,
"pageToken": "eyJvZmZzZXQiOjEwMH0",
"postSlug": "value",
"sort": "SORT_ASC",
"startTime": "2025-01-01T00:00:00Z",
"surfaces": [
"TRADING"
]
}'Responses
{
"changes": [
{
"change": {
"actionRequired": false,
"audiences": [
"ALL_USERS"
],
"category": "BREAKING_CHANGE",
"details": "value",
"id": "1",
"migrationGuidance": "value",
"summary": "value",
"surfaces": [
"TRADING"
],
"title": "My Trading Board"
},
"postSlug": "value",
"publishedAt": "2025-01-01T00:00:00Z",
"sectionHeading": "value"
}
],
"nextPageToken": "eyJvZmZzZXQiOjIwMH0"
}changelog.v1.ListChangesRequestchangelog.v1.ListChangesResponseCategories to include. Empty means all.
When set, only changes whose action_required equals this value.
Surfaces to include. Empty means all.
Audiences to include. Empty means all. Changes addressed to ALL_USERS always match.
Inclusive lower bound on post publication time. Optional.
Exclusive upper bound on post publication time. Optional; must be after start_time when both are set.
Restrict to one post. Optional.
Order of posts. Changes keep publication order inside each post.
Maximum changes to return. 0 means the default of 100; maximum 500.
Opaque, keyset-backed, exclusive cursor from a previous response. Reuse it only with the same filters, time bounds and sort.
Stable opaque 64-bit identifier, identical across environments.
Short title.
One-paragraph summary.
Longer explanation; paragraphs separated by blank lines. Omitted when absent.
Category.
True when users or integrators must act.
What to do, when action is required. Omitted when absent.
Audiences addressed. Never empty.
Product areas affected. May be empty.
Slug of the announcing post.
Publication time of the announcing post.
Heading of the section containing the change.
Cursor for the next page. Empty when no more results exist.
| Key | HTTP status | Connect code | Error | When |
|---|---|---|---|---|
| unauthenticated | 401 | unauthenticated | Unauthenticated | Authentication required. |
| permission-denied | 403 | permission_denied | Permission Denied | Permission denied. |
| invalid-argument | 400 | invalid_argument | Invalid Argument | Invalid argument. |
| not-found | 404 | not_found | Not Found | Not found. |
| unavailable | 503 | unavailable | Unavailable | Service unavailable. |