Skip to content

Commit fdfa873

Browse files
committed
chore: bump revision to 0.1.25.37 + document include=evidence
Addresses review: - pom.xml <revision> 0.1.25.36 -> 0.1.25.37 so the release workflow ships the evidence-linking behavior under the version the AUDIT documents (it read the old .36 from the POM otherwise). - service README: document the include=evidence list projection on GET /v1/reservations (the table omitted include entirely), and add the evidence (+ committed_metadata) fields to the single-get response field list.
1 parent 9f5454b commit fdfa873

2 files changed

Lines changed: 4 additions & 1 deletion

File tree

cycles-protocol-service/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -465,6 +465,7 @@ List reservations for the effective tenant. Optional recovery/debug endpoint. Re
465465
| `expires_to` | ISO 8601 date-time (v0.1.25.21+). Inclusive upper bound on `expires_at_ms`. Same blank-as-unset rule. `expires_from > expires_to` returns `400 INVALID_REQUEST`. |
466466
| `finalized_from` | ISO 8601 date-time (v0.1.25.21+). Inclusive lower bound on `finalized_at_ms`. Populated only on COMMITTED and RELEASED rows — ACTIVE and EXPIRED rows are normatively excluded when this is set. May be supplied alone or with `finalized_to`. Blank string treated as unset. |
467467
| `finalized_to` | ISO 8601 date-time (v0.1.25.21+). Inclusive upper bound on `finalized_at_ms`. Same blank-as-unset rule and ACTIVE/EXPIRED exclusion. `finalized_from > finalized_to` returns `400 INVALID_REQUEST`. |
468+
| `include` | Comma-separated field projection (v0.1.25.36+). Optional heavy fields omitted from list rows by default: `metadata` (reserve-time), `committed_metadata` (commit-time), `evidence` (CyclesEvidence refs for the row's reserve/commit/release ops, keyed by artifact type — v0.1.25.37+). E.g. `?include=evidence` adds the evidence map so a consumer can link a reservation to its signed envelope without having captured the `evidence_id` off the original response. Projection-only: unrecognized/empty tokens are ignored, and it does **not** participate in cursor / filter-hash binding (changing it mid-pagination never invalidates a cursor). |
468469

469470
When `sort_by` or `sort_dir` is provided, the cursor encodes the
470471
`(sort_by, sort_dir, filters)` tuple — reusing a sorted cursor after
@@ -513,6 +514,8 @@ Includes all fields from the list entry above, plus:
513514
| `committed` | Amount actually charged (present when COMMITTED) |
514515
| `finalized_at_ms` | Timestamp of commit or release |
515516
| `metadata` | Metadata supplied at reservation time |
517+
| `committed_metadata` | Metadata supplied on the commit request (present on COMMITTED rows whose commit carried metadata) |
518+
| `evidence` | CyclesEvidence refs keyed by artifact type (`reserve` / `commit` / `release`), each `{ evidence_id, cycles_evidence_url }` — resolve via `GET /v1/evidence/{id}` (v0.1.25.37+). Always present on the single-get when recorded; absent when evidence emission is disabled. On the list endpoint it is opt-in via `include=evidence`. |
516519

517520
---
518521

cycles-protocol-service/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
<module>cycles-protocol-service-api</module>
1919
</modules>
2020
<properties>
21-
<revision>0.1.25.36</revision>
21+
<revision>0.1.25.37</revision>
2222
<java.version>21</java.version>
2323
<maven.compiler.source>21</maven.compiler.source>
2424
<maven.compiler.target>21</maven.compiler.target>

0 commit comments

Comments
 (0)