Skip to content

docs(swagger): #95 — move annotation examples to §3.7, add val-bound route example#96

Merged
michael-conrad merged 1 commit into
devfrom
feature/95-move-annotation-examples
May 23, 2026
Merged

docs(swagger): #95 — move annotation examples to §3.7, add val-bound route example#96
michael-conrad merged 1 commit into
devfrom
feature/95-move-annotation-examples

Conversation

@michael-conrad
Copy link
Copy Markdown
Owner

Summary

Move annotation examples from §11 into §3 (Annotation Rules), add a fourth example for the val-bound route pattern from ApiRepositoryStatusControllerBase.scala, and update §3.1 and §4 to distinguish the permitted route-level val binding from the prohibited operation(op) extraction pattern.

Outcome

  • ✅ SC-1: §11 deleted from doc/swagger/swagger.md
  • ✅ SC-2: §3.7 exists with four subsections (3.7.1, 3.7.2, 3.7.3, 3.7.4)
  • ✅ SC-3: All three original before/after examples preserved
  • ✅ SC-4: §3.7.4 contains listStatusesRoute and listStatusesRoute.action()
  • ✅ SC-5: §3.7.4 references source file ApiRepositoryStatusControllerBase.scala
  • ✅ SC-6: §3.7.4 after example has apiOperation on val declaration
  • ✅ SC-7: §3.7.4 explains .action() inheritance
  • ✅ SC-8: Route paths, authenticators, and parameter names verified against source
  • ✅ SC-9: §3.1 updated with route-level val binding pattern and cross-reference to §3.7.4
  • ✅ SC-10: §4 anti-pattern updated with operation(op) vs route-level val binding distinction

Fixes #95

🤖 Co-authored with AI: OpenCode (ollama-cloud/glm-5.1)

…route example

- Move three before/after examples from old §11 into §3.7 (3.7.1-3.7.3)
- Add §3.7.4: val-bound route with legacy alias (listStatusesRoute)
  sourced from ApiRepositoryStatusControllerBase.scala
- Update §3.1: replace hypothetical val-bound example with concrete
  route-level val binding pattern, cross-reference §3.7.4, add explicit
  prohibited operation(op) extraction pattern
- Update §4 anti-pattern: distinguish prohibited operation(op) extraction
  from permitted route-level val binding, cross-reference §3.7.4
- Delete §11 (examples now in §3.7)

🤖 Co-authored with AI: OpenCode (ollama-cloud/glm-5.1)
@michael-conrad michael-conrad merged commit 7990411 into dev May 23, 2026
4 checks passed
@michael-conrad michael-conrad deleted the feature/95-move-annotation-examples branch May 23, 2026 05:55
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