ChangelogService
Get Changelog Post
Get one complete published post by slug.
Request
curl --request GET \ \ --url 'https://api.testnet.polyester.com/v1/changelog/posts/example' \ --header 'Accept: */*'
Responses
{
"post": {
"sections": [
{
"changes": [
{
"actionRequired": false,
"audiences": [
"ALL_USERS"
],
"category": "BREAKING_CHANGE",
"details": "value",
"id": "2",
"migrationGuidance": "value",
"summary": "value",
"surfaces": [
"TRADING"
],
"title": "My Trading Board"
}
],
"heading": "value",
"summary": "value",
"surface": "TRADING"
}
],
"summary": {
"actionRequiredCount": 1,
"breakingChangeCount": 1,
"bugFixCount": 1,
"changeCount": 1,
"coverageCutoff": "2025-01-01T00:00:00Z",
"improvementCount": 1,
"introduction": "value",
"newFeatureCount": 1,
"publishedAt": "2025-01-01T00:00:00Z",
"slug": "value",
"title": "My Trading Board"
}
}
}Post slug.
True when users or integrators must act.
falseAudiences addressed. Never empty.
["ALL_USERS"]Category.
BREAKING_CHANGELonger explanation; paragraphs separated by blank lines. Omitted when absent.
valueStable opaque change identifier (base58), identical across environments.
2What to do, when action is required. Omitted when absent.
valueOne-paragraph summary.
valueProduct areas affected. May be empty.
["TRADING"]Short title.
My Trading BoardSection heading.
valueSection summary. Omitted when absent.
valueProduct area of the section. Omitted for sections not tied to one area (for example changes that need your attention, or general).
TRADINGExact number of changes with action_required.
1Exact number of BREAKING_CHANGE changes.
1Exact number of BUG_FIX changes.
1Exact number of changes.
1Exclusive upper bound of the period covered. Omitted when unknown.
2025-01-01T00:00:00ZExact number of IMPROVEMENT changes.
1Introduction.
valueExact number of NEW_FEATURE changes.
1Publication time.
2025-01-01T00:00:00ZStable post identifier, unique within this environment.
valueTitle.
My Trading Board| 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. |