Skip to content

docs(spec): classify scenarios as draft requirements or library policy - #75

Merged
mroderick merged 1 commit into
mainfrom
spec-classification
Nov 12, 2026
Merged

mroderick merged 1 commit into
mainfrom
spec-classification

Conversation

@mroderick

Copy link
Copy Markdown
Contributor

Summary

Classifies every scenario in docs/specs/idempotency.feature as a draft requirement or library policy, and says which on the published page.

  • Three @draft Rules name the draft section they implement: section 2.1 (1 scenario), 2.6 (5), 2.7 (7).
  • Six @library Rules hold the other 36 scenarios, grouped by theme.
  • docs/specs/index.md replaces the eight overview bullets, which all read as draft-mandated, with a split list and the count on each side.

13 of the 49 scenarios trace to draft-07. The other 36 cover policy this page used to present under draft headings: the 21 and 255 character limits, the comma rejection, the 409 for a same-body different-key request, and all response recording and replay, which the draft never mentions.

Review notes

The classification is the substance; scenario text is unchanged apart from position.

Worth a look: whether each library Rule reads as policy to you, and whether the section citations are the ones you want. Two were judgement calls. The concurrent 409 is cited to section 2.7, which states the status, although section 2.6 also mentions the conflict and the response body points there. The 422 for a reused key is cited to 2.7 for the same reason, while its body points at 2.2.

npm run format:check and npm run build pass.

Every scenario now sits in a Rule tagged @draft, with the draft section it
implements, or @library for behaviour the draft leaves open. Cucumber
inherits tags, so a scenario cannot hold a class of its own: the suite is
grouped into Rules of one class each rather than tagged per scenario.

Thirteen of the 49 scenarios trace to draft-07. The rest cover policy the
page used to present under draft section headings, such as the 21 and 255
character limits, the comma rejection, the 409 for a same-body
different-key request, and all response recording and replay.
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying website with  Cloudflare Pages  Cloudflare Pages

Latest commit: 233f612
Status: ✅  Deploy successful!
Preview URL: https://60ce4234.website-33l.pages.dev
Branch Preview URL: https://spec-classification.website-33l.pages.dev

View logs

@mroderick
mroderick marked this pull request as ready for review November 12, 2026 14:04
@mroderick
mroderick merged commit 17be049 into main Nov 12, 2026
3 checks passed
@mroderick
mroderick deleted the spec-classification branch November 12, 2026 14:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant