DOCUMENTATIONv2

PATCH

Evidence streams

Update stream

/api/v2/evidence-streams/{stream_uuid}

AUTHENTICATIONBearer token · evidence:writeAUTHORITATIVE OWNERevidence-stream-serviceCONTRACT AUTHORITYCapability registry · plannedSTATUSPlanned · not executable

PLANNING CONTRACT · NOT CALLABLE

This page describes intended capability and integration boundaries so people and agents can prepare safely. Do not send this request or register it as an executable tool. Wait until the capability registry marks it implemented-contract, then re-fetch the deployed OpenAPI document and build the request from that machine contract.

PURPOSE + BUSINESS CONTEXT

Planned capability: pause, resume, or archive an evidence stream.

WHEN THIS CALL IS USEFUL

Do not call or register this operation as an executable agent tool yet. Use this page to plan the future stream workflow; enable it only after the status becomes implemented-contract and the exact operation appears in deployed OpenAPI.

OUTCOME · Planned · Revise and reconcile

What changes

None today: this route is not executable. Its intended behavior is: updates only the allowlisted stream fields and version accepted by the authoritative owner; it grants no adjacent authority.

WHY IT MATTERS

Lets people and agents prepare for stream without falsely presenting roadmap scope as a live capability.
Gives people and agents a contract-backed way to advance stream.
Lets integrations follow evidence from schema and source enrollment through ordered commitments, validation posture, operational alerts, and exception review.

ISOLATION + AUTHORITY

Schema, source, signer, stream, event, payload, sequence, validation, quarantine, alert, acknowledgement, retention, and business-outcome authorities remain distinct. Evidence visibility or cryptographic validity does not by itself prove semantic truth, regulatory acceptance, settlement, or authorization for an external action. This planning record grants no runtime authority, and only deployed OpenAPI can define an executable public contract.

BEFORE YOU CALL

First confirm that this operation is marked implemented-contract and exists in the currently deployed OpenAPI document; until then, no production request is valid.
Its capability-registry profile is provisional integration guidance, not an executable request schema.
Authenticate at the documented boundary: bearer+scope.
Treat the proposed stream_uuid (path), expected_version (body), action (body), reason (body) as planning input only; re-generate the request from deployed OpenAPI before making a call.
Use one Idempotency-Key only for retries of the same byte-equivalent logical mutation.
Resolve the owner scope, schema, source, stream, sequence or time window, validation posture, and minimum payload disclosure required by the decision.

WHAT TO DO NEXT

Keep this operation disabled in clients, agents, SDKs, and workflow automation while it remains planned-contract.
Use the stated owner, lifecycle, authority boundary, and provisional stream profile to prepare requirements and conformance tests without sending a request.
Monitor the capability registry for implemented-contract, then re-fetch deployed OpenAPI and validate its exact security, parameters, schemas, responses, and agent metadata before enabling the integration.

AGENT GUIDANCE

Never call this planned contract, include it in an executable tool registry, or infer runtime availability from this readable page.
Its capability-registry profile is provisional integration guidance, not an executable request schema.
Use stream only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Treat the proposed stream_uuid (path), expected_version (body), action (body), reason (body) as planning input only; re-generate the request from deployed OpenAPI before making a call.
Distinguish schema validity, source authenticity, signature validity, sequence continuity, payload availability, quarantine status, alert acknowledgement, operational health, and business acceptance.
After a timeout or conflict, read authoritative state before deciding whether an equivalent retry is safe.
When implementation lands, discard generated requests based on this planning record and rebuild them from the deployed OpenAPI operation.

MACHINE CONTRACT

This operation is a non-executable planning contract. Its capability-registry record defines the intended owner, parameters, responses, and integration boundary until an implemented Rust OpenAPI operation replaces it.

EXTENDED INTEGRATION GUIDANCE

Readable request and response reference

Examples describe the reviewed planning contract and remain non-executable until promoted into OpenAPI.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE

AuthorizationheaderRequired

Bearer tokenCredential containing evidence:write authority.EXAMPLEBearer hc_live_…

Idempotency-KeyheaderRequired

ASCII string · 1–128Caller-generated stable key reused for retries of the same logical mutation.EXAMPLEpatch-api-v2-evidence-streams-stream-uuid-request-001

stream_uuidpathRequired

identifierCanonical stream uuid.EXAMPLEstream-uuid-01

expected_versionbodyRequired

integer · ≥1Current stream version for optimistic concurrency.EXAMPLE1

actionbodyRequired

PAUSE | RESUME | ARCHIVEGoverned lifecycle transition.EXAMPLEaction-01

reasonbodyRequired

string · 8–500Attributed rationale retained with private audit evidence.EXAMPLEreason-01

REQUEST

JSON body example

{
  "expected_version": 1,
  "action": "action-01",
  "reason": "reason-01"
}

RESPONSES

Status and payload examples

200Mutation accepted and canonical state returned.Not executable · JSON RESPONSE+

{
  "result": "See the operation's authoritative OpenAPI response schema."
}

INTEGRATION DECISION

CALLER ACTION: Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY: Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION: No runtime state exists to reconcile for this planning contract. Continue from owner-scoped stream metadata, events, checkpoints, commitments, retention windows, and consumer positions through an implemented operation.
ESCALATE WHEN: Escalate when sequence continuity, checkpoint commitment, retention, ownership, or consumer position cannot be proven.

401Bearer credential is missing, expired, or invalid.Not executable · JSON RESPONSE+

{
  "code": "request_failed",
  "message": "Bearer credential is missing, expired, or invalid."
}

INTEGRATION DECISIONrequest_failed

CALLER ACTION: Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY: Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION: No runtime state exists to reconcile for this planning contract. Continue from owner-scoped stream metadata, events, checkpoints, commitments, retention windows, and consumer positions through an implemented operation.
ESCALATE WHEN: Escalate when sequence continuity, checkpoint commitment, retention, ownership, or consumer position cannot be proven.

403The principal lacks the required scope, role, tenant, or step-up authority.Not executable · JSON RESPONSE+

{
  "code": "request_failed",
  "message": "The principal lacks the required scope, role, tenant, or step-up authority."
}

INTEGRATION DECISIONrequest_failed

CALLER ACTION: Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY: Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION: No runtime state exists to reconcile for this planning contract. Continue from owner-scoped stream metadata, events, checkpoints, commitments, retention windows, and consumer positions through an implemented operation.
ESCALATE WHEN: Escalate when sequence continuity, checkpoint commitment, retention, ownership, or consumer position cannot be proven.

422Path, query, or body validation failed.Not executable · JSON RESPONSE+

{
  "code": "request_failed",
  "message": "Path, query, or body validation failed."
}

INTEGRATION DECISIONrequest_failed

CALLER ACTION: Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY: Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION: No runtime state exists to reconcile for this planning contract. Continue from owner-scoped stream metadata, events, checkpoints, commitments, retention windows, and consumer positions through an implemented operation.
ESCALATE WHEN: Escalate when sequence continuity, checkpoint commitment, retention, ownership, or consumer position cannot be proven.

503The authoritative service or read model is unavailable.Not executable · JSON RESPONSE+

{
  "code": "request_failed",
  "message": "The authoritative service or read model is unavailable."
}

INTEGRATION DECISIONrequest_failed

CALLER ACTION: Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY: Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION: No runtime state exists to reconcile for this planning contract. Continue from owner-scoped stream metadata, events, checkpoints, commitments, retention windows, and consumer positions through an implemented operation.
ESCALATE WHEN: Escalate when sequence continuity, checkpoint commitment, retention, ownership, or consumer position cannot be proven.

OPERATIONAL NOTES

Security and lifecycle guarantees

The Rust gateway validates the public contract and routes only to the authoritative owner; clients never address internal services directly.
Mutations are retry-safe only when the same Idempotency-Key and canonical request body are reused.

DOCUMENTATION STATUS

This planned contract now defines its public parameters, authorization boundary, replay behavior, responses, and authoritative owner. It remains non-executable until its owner adapter and conformance tests are promoted into the Rust gateway.

Return to the V2 directory ↗