Public changelog feed (by project slug)

GET

/public/changelog/{project_slug}

What the hosted page shows: published entries with audience public that have not passed expires_at, pinned first, with labels, cover image and button. q searches title and text, label filters by a label slug. meta.labels are the labels in use (filter chips). No auth required.

Parameters

Path Parameters

project_slug

required

string

Query Parameters

q

string

<= 100 characters

label

string

Responses

200

Published entries

object

data

required

Array<object>

object

id

required

string

/^ce_[0-9A-HJKMNP-TV-Z]{26}$/

title

required

string

>= 1 characters <= 200 characters

body_markdown

required

string

version

required

Any of:

string

string

null

null

category

required

string

Allowed values: feature fix improvement security breaking

published_at

required

Any of:

string

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/

null

null

public_url

required

string format: uri

cover_image_url

required

Any of:

string

string

null

null

cta_label

required

Any of:

string

string

null

null

cta_url

required

Any of:

string

string

null

null

pinned

required

boolean

labels

required

Array<object>

object

slug

required

string

name

required

string

colour

required

string

Allowed values: gray red orange amber green teal blue indigo purple pink

error

required

null

meta

object

key

additional properties

404

Error envelope. See error.code for the discriminator.

object

data

required

null

error

required

object

code

required

string

message

required

string

remediation

required

string

doc_url

string format: uri

param

string

request_id

string

meta

object

key

additional properties