mirror of
https://github.com/GoodOlClint/PSProxmoxVE.git
synced 2026-09-04 03:05:32 +00:00
docs: a PVE-behaviour claim documented against the published spec is verified, not deferred (ADR 0026) (#170)
* docs: a PVE-behaviour claim the PR documents against the spec is verified, not deferred The reviewer fetches the cited proxmox_api permalink with gh api, names it in the review, and approves when the spec supports the claim. Only inferred claims still go to the operator. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> * docs: record ADR 0026 and tighten the spec-verified rule per review Commit-anchored permalinks only, the gh api invocation spelled out, and the trade-off against the server-behaviour caveat stated in the prompt and in the ADR. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> * docs: cite the per-version OpenAPI file, and attribute the reserved list to the prompt Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> --------- Co-authored-by: goodolclint-claude[bot] <323206664+goodolclint-claude[bot]@users.noreply.github.com> Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
This commit is contained in:
committed by
GitHub
parent
147c2c6007
commit
8ec09c2b84
@@ -46,7 +46,23 @@ PR's checkout.
|
||||
OpenAPI spec — see `tests/PSProxmoxVE.Core.Tests/Fixtures/pve-api-enums.pve*.json`
|
||||
for valid values per PVE version. A value the schema accepts is not
|
||||
necessarily a value PVE acts on; where a PR claims server behaviour, ask
|
||||
whether it was observed or inferred.
|
||||
whether it was observed, documented, or inferred. Documented means the PR
|
||||
cites a commit-anchored permalink into https://github.com/GoodOlClint/Proxmox_API
|
||||
(`.../blob/<sha>/pve/...`, never a branch reference) to the OpenAPI spec file
|
||||
for the PVE version (`pve/openapi/pve-openapi.pve<N>.json`, one file per
|
||||
version; a `#L` range points at the endpoint), or to the `pve/CHANGELOG.md`
|
||||
entry for return-field history. Fetch it with
|
||||
|
||||
gh api -H "Accept: application/vnd.github.raw+json" \
|
||||
"repos/GoodOlClint/Proxmox_API/contents/<path>?ref=<sha>"
|
||||
|
||||
and read it. A claim the spec supports counts as verified; name the permalink
|
||||
you checked in the review. The spec is the published contract, not the
|
||||
server: it can lag or differ, and the wave-end integration run is what
|
||||
catches that. Naming the permalink is what lets a later live failure be
|
||||
traced to the spec and the server disagreeing, rather than to a guess. A
|
||||
cited link that is not commit-anchored, does not support the claim, or
|
||||
cannot be fetched leaves the claim inferred. See ADR 0026.
|
||||
|
||||
4. **Tests.** New cmdlets should have xUnit service tests and Pester
|
||||
parameter-validation tests. When you criticise a test, say what behaviour it
|
||||
@@ -101,7 +117,10 @@ sign-off.
|
||||
values — a PR that edits them can make a wrong value look spec-compliant to
|
||||
you;
|
||||
- changes branch protection, publishing, or release tagging;
|
||||
- claims live PVE behaviour that CI does not exercise.
|
||||
- claims live PVE behaviour that CI does not exercise and the PR does not
|
||||
document against the spec (see API correctness above). A spec-verified claim
|
||||
does not need the operator; an inferred one does. This is the trade-off
|
||||
ADR 0026 records.
|
||||
|
||||
## Verdict
|
||||
|
||||
|
||||
Reference in New Issue
Block a user