Revision history for a named component across versions

GET

/components/history

Traces the version history of a component by name within a project. Returns an ordered array alternating between milestone entries (marking a version point) and diff entries (showing rule-level changes between consecutive releases). Used by the DiffViewer feature. Requires project membership. Component objects use ComponentBlueprint default view (9 fields).

Authorizations

tokenAuth

Personal access token authentication. Send via Authorization header: Authorization: Token vulcan_xxx. Tokens are SHA-256 hashed server-side (never stored in plaintext). Scopes: read (GET), write (mutations), admin (everything). Create tokens via Settings → API Tokens in the web UI.

Type

HTTP (token)

Parameters

Query Parameters

project_id*

ID of the project containing the component versions.

Type

integer

Required

Example1

name*

Component name to trace across versions.

Type

string

Required

Example"Photon OS 3"

Responses

Ordered revision history. The array alternates between two entry types: 1. Milestone entries: { component: ComponentSummary } — marks a version point 2. Diff entries: { base_component: ComponentSummary, diff_component: ComponentSummary, changes: { rule_id: HistoryChangeEntry } }

Content-Type

application/json

[

  

{

  

  

"component": {

  

  

  

"id": 1,

  

  

  

"name": "Photon OS 3",

  

  

  

"prefix": "PHOS-03",

  

  

  

"version": 1,

  

  

  

"release": 1

  

  

}

  

},

  

{

  

  

"base_component": {

  

  

  

"id": 1,

  

  

  

"name": "Photon OS 3",

  

  

  

"prefix": "PHOS-03",

  

  

  

"version": 1,

  

  

  

"release": 1

  

  

},

  

  

"diff_component": {

  

  

  

"id": 2,

  

  

  

"name": "Photon OS 3",

  

  

  

"prefix": "PHOS-03",

  

  

  

"version": 1,

  

  

  

"release": 2

  

  

},

  

  

"changes": {

  

  

  

"000050": {

  

  

  

  

"change": "updated",

  

  

  

  

"base": {

  

  

  

  

  

"rule_id": "000050",

  

  

  

  

  

"title": "Original title",

  

  

  

  

  

"fix": "Original fix text"

  

  

  

  

},

  

  

  

  

"diff": {

  

  

  

  

  

"rule_id": "000050",

  

  

  

  

  

"title": "Updated title",

  

  

  

  

  

"fix": "Updated fix text"

  

  

  

  

}

  

  

  

}

  

  

}

  

},

  

{

  

  

"component": {

  

  

  

"id": 2,

  

  

  

"name": "Photon OS 3",

  

  

  

"prefix": "PHOS-03",

  

  

  

"version": 1,

  

  

  

"release": 2

  

  

}

  

}

]

GET

/components/history

Playground

Server

Authorization

tokenAuth

Variables

Key

Value

project_id*

name*

Samples

Powered by VitePress OpenAPI