Releases Index
Digest by week
View .md

One collection's weekly digest, with resolved release links

GET
/collections/{slug}/digests/{weekStart}

The digest for one ET week. :weekStart must be the Monday (YYYY-MM-DD, ET) starting the week. Full digest row (title, intro, markdown body, cited release ids) plus server-resolved minimal release info (title, org, upstream url, product, canonical /release/* fallback path) for every cited release, and the body's parsed ### sections (heading, anchor, lede, cited release ids, and those releases resolved) — resolved server-side so the web page never N+1s. releases[].url is the primary link when present; path is the fallback. Release ids that no longer resolve (deleted/suppressed since generation) are silently dropped from releases and sections[].releases.

Authorization

bearerAuth
headerAuthorizationBearer <relk_… | relu_… | OAuth JWT>

Machine/operator tokens use the relk_ prefix; self-serve read-only user keys use relu_; Sign in with Releases supplies an OAuth access token. Required scope depends on the endpoint.

Path Parameters

slug*string

Collection slug.

weekStart*string

ET Monday starting the week, YYYY-MM-DD.

Response Body

Full digest row with resolved release links.

application/json
  1. response
id*string
weekStart*string
title*string
intro*string
body*string
releaseIds*array<string>
releaseCount*integer
Range0 <= value <= 9007199254740991
generatedAt*string
releases*array<>
sections?array<>
Example Request
curl -X GET 'https://api.releases.sh/v1/collections/string/digests/string'
Example Response
{  "id": "string",  "weekStart": "string",  "title": "string",  "intro": "string",  "body": "string",  "releaseIds": [    "string"  ],  "releaseCount": 0,  "generatedAt": "string",  "releases": [    {      "id": "string",      "title": "string",      "path": "string",      "url": "string",      "org": {        "slug": "string",        "name": "string",        "avatarUrl": "string",        "githubHandle": "string"      },      "product": {        "slug": "string",        "name": "string"      },      "importance": 1,      "composition": {        "bugs": 0,        "features": 0,        "enhancements": 0      },      "publishedAt": "string"    }  ],  "sections": [    {      "heading": "string",      "anchor": "string",      "lede": "string",      "releaseIds": [        "string"      ],      "releases": [        {          "id": "string",          "title": "string",          "path": "string",          "url": "string",          "org": {            "slug": "string",            "name": "string",            "avatarUrl": "string",            "githubHandle": "string"          },          "product": {            "slug": "string",            "name": "string"          },          "importance": 1,          "composition": {            "bugs": 0,            "features": 0,            "enhancements": 0          },          "publishedAt": "string"        }      ]    }  ]}