| Field | Value |
|---|
| Source spec | sbom-service/openapi/version-stream.v1.json |
| OpenAPI version | 3.1.1 |
| API version | 1.0.0 |
| Operations | 4 |
| Path filter | All paths |
Registers/resets a cross-database consumer of sbom.versions, or reports its validated durable epoch/sequence position so it participates in the producer retention floor.
| Property | Value |
|---|
| Operation ID | RegisterSbomVersionStreamConsumer |
| Tags | StellaOps.SbomService |
| Auth | Required |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|
consumerId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | application/json |
400 | Bad Request | application/json |
401 | Unauthorized | - |
403 | Forbidden | - |
409 | Conflict | application/json |
Removes a cross-database consumer from the sbom.versions retention floor.
| Property | Value |
|---|
| Operation ID | UnregisterSbomVersionStreamConsumer |
| Tags | StellaOps.SbomService |
| Auth | Required |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
consumerId | path | yes | |
Responses:
| Status | Description | Content types |
|---|
204 | No Content | - |
400 | Bad Request | application/json |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | application/json |
Returns ordered P6 sbom.versions envelopes after afterSeq with the current epoch, head, retention horizon, and an explicit bootstrap signal for epoch or retention gaps.
| Property | Value |
|---|
| Operation ID | ReadSbomVersionStream |
| Tags | StellaOps.SbomService |
| Auth | Required |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
afterSeq | query | no | |
limit | query | no | |
streamEpoch | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | application/json |
400 | Bad Request | application/json |
401 | Unauthorized | - |
403 | Forbidden | - |
Returns a bounded UUID-keyset page of live ledger versions at a fixed P6 epoch/head fence. Continue with nextAfterVersionId plus the same streamEpoch/headSeq; rows missing an exact document digest, carrying null/empty/untrimmed closed-wire text, using an empty version/chain UUID, or carrying a nonpositive sequence are counted and withheld.
| Property | Value |
|---|
| Operation ID | ReadSbomVersionSnapshot |
| Tags | StellaOps.SbomService |
| Auth | Required |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|
afterVersionId | query | no | |
headSeq | query | no | |
limit | query | no | |
streamEpoch | query | no | |
Responses:
| Status | Description | Content types |
|---|
200 | OK | application/json |
400 | Bad Request | application/json |
401 | Unauthorized | - |
403 | Forbidden | - |
409 | Conflict | application/json |
