docs: make CyclesEvidence discoverable in the spec repo#111
Merged
Conversation
Evidence was invisible in the spec-repo docs (README, CONFORMANCE, spec-index) even though the runtime base ships the cycles_evidence ref + getEvidence and a draft envelope spec exists. - README: add a CyclesEvidence note to the companion-specs section (the cycles_evidence ref + getEvidence on the runtime base, the draft envelope companion, additive/optional). - cycles-spec-index.yaml: register drafts/cycles-evidence-v0.1.yaml as a document (id evidence_envelope, role companion, conformance: draft) with owns/integration_points/readers. - CONFORMANCE.md: a MAY bullet for emitting cycles_evidence + getEvidence, noting the envelope draft is not yet part of the conformance target. - drafts/README.md: new index of the drafts (evidence + aps-denial-mapping) with where the producing/signing code lives. Docs/metadata only; no spec wire change, no merged drift, changelog valid.
…ence draft Review nit (3): the evidence_envelope document entry used a non-standard conformance: draft token. Switch to conformance: reference (the established non-normative value per the normative|reference vocabulary); conformance_status: draft + the note already convey it is pre-normative.
Review findings (Low #3 + Medium #1, draft side): - drafts/README.md: the spec-index now registers drafts as conformance: reference + conformance_status: draft (not conformance: draft) — fix the README sentence to match. - cycles-evidence-v0.1.yaml: add a DOMAIN vs EMISSION POLICY note to the error artifact_type — the artifact DOMAIN is any 4xx/5xx (so the mirror enum includes FORBIDDEN etc., which a verifier must accept), but WHICH codes a given server emits is policy: the reference server emits only for budget/lifecycle denials and omits pre-evaluation validation/auth. Resolves the apparent inconsistency between the envelope domain and the server's scoped emission.
…DOMAIN, not server emission Review (Low): the v0.1.25.4 changelog line 'forbidden/validation failures on /v1/decide remain error-artifact territory (e.g. 12-decide-live-forbidden)' read as a reference-server emission promise. Reword to match the draft's domain-vs-emission note: those are the error-artifact DOMAIN (verifier-domain fixture illustrates the shape), and the reference server omits cycles_evidence for pre-evaluation auth/validation failures.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Evidence was invisible in the spec-repo docs. Adds: a CyclesEvidence note in the README companion-specs section; registers
drafts/cycles-evidence-v0.1.yamlas a document incycles-spec-index.yaml(conformance: draft); a MAY bullet in CONFORMANCE.md forcycles_evidence/getEvidence(noting the envelope draft isn't yet a conformance target); and a newdrafts/README.mdindexing the drafts + where the producer/signer code lives. Docs/metadata only — no spec wire change, no merged drift, changelog valid.