Version changelog

Generated from apiome-rest/openapi.yaml (API version 1.204.1) — do not edit by hand. How to authenticate is on the REST API reference.

Tag: version-changelog · 2 operations

`GET /v1/versions/{tenant_slug}/{project_id}/changelogs`

List Project Version Changelogs

List changelog summaries for every published revision of a project.

Revisions without a stored classification row (pending or pre-backfill) are included with status: null so callers can render a pending state.

Operation id: list_project_version_changelogs_v1_versions__tenant_slug___project_id__changelogs_get

Parameters

Name	In	Type	Required	Description
`tenant_slug`	path	string	yes	URL-safe tenant slug that scopes the request.
`project_id`	path	string	yes	Project identifier that scopes the request.
`limit`	query	integer or null	no	Optional max rows, newest publish first.
`authorization`	header	string or null	no	JWT bearer token for authenticated access (`Authorization: Bearer <token>`).
`X-API-Key`	header	string or null	no	Tenant-scoped API key used as an alternative to JWT bearer authentication.

Responses

Status	Description	Body
200	Successful response for list project version changelogs.	`application/json` `ProjectVersionChangelogsResponse`
400	Malformed project id.	—
404	Project not found in tenant.	—
422	Validation Error	`application/json` `HTTPValidationError`

`GET /v1/versions/{tenant_slug}/{project_id}/{version_record_id}/changelog`

Get Version Changelog

Return the stored classified changelog for one published revision.

The changelog field is the raw ctg.changelog.v1 payload (entries in breaking → non-breaking → docs-only order, grouped by path), or the initial-publication marker when the revision had no published baseline.

Operation id: get_version_changelog_v1_versions__tenant_slug___project_id___version_record_id__changelog_get

Parameters

Name	In	Type	Required	Description
`tenant_slug`	path	string	yes	URL-safe tenant slug that scopes the request.
`project_id`	path	string	yes	Project identifier that scopes the request.
`version_record_id`	path	string	yes	Version row identifier (`versions.id` UUID).
`authorization`	header	string or null	no	JWT bearer token for authenticated access (`Authorization: Bearer <token>`).
`X-API-Key`	header	string or null	no	Tenant-scoped API key used as an alternative to JWT bearer authentication.

Responses

Status	Description	Body
200	Successful response for get version changelog.	`application/json` `VersionChangelogOut`
400	Revision is not published.	—
404	Version not found, or no changelog stored for this revision.	—
422	Validation Error	`application/json` `HTTPValidationError`

Schemas used

`HTTPValidationError`

Validation error response emitted when request data fails schema checks.

Property	Type	Required	Description
`detail`	array of `ValidationError`	no	Detail.

`ProjectVersionChangelogsResponse`

All published-revision changelog summaries for a project, newest publish first.

Property	Type	Required	Description
`projectId`	string	yes	Project ID.
`changelogs`	array of `VersionChangelogSummaryRow`	yes	Changelogs.
`filteredCount`	integer	yes	Number of filtered.