Skip to content

docs(swagger): #93 — add before/after annotation examples, remove .opencode references#94

Merged
michael-conrad merged 2 commits into
devfrom
feature/93-swagger-examples-and-references
May 23, 2026
Merged

docs(swagger): #93 — add before/after annotation examples, remove .opencode references#94
michael-conrad merged 2 commits into
devfrom
feature/93-swagger-examples-and-references

Conversation

@michael-conrad
Copy link
Copy Markdown
Owner

Summary

Add three before/after annotation pairs to Section 11 of doc/swagger/swagger.md covering GET with path params (getIssue), GET with query params (listIssues), and POST with body param (createIssue). Replace all .opencode-specific references (issue #836, critical-rules-060, verification-before-completion, #836 classification gate) with self-contained principles that explain the reasoning without external references.

Outcome

  • ✅ SC-1: Three before/after annotation pairs in Section 11
  • ✅ SC-2: Before examples show un-annotated routes (no apiOperation)
  • ✅ SC-3: After examples show same routes with apiOperation inline
  • ✅ SC-4: Zero #836 references in both swagger docs
  • ✅ SC-5: Zero critical-rules references in both swagger docs
  • ✅ SC-6: Zero verification-before-completion references in swagger.md
  • ✅ SC-7–SC-9: Self-contained evidence classification language (no external references)
  • ✅ SC-10: GET+query pair includes queryParam usage
  • ✅ SC-11: POST+body pair includes bodyParam usage
  • ✅ Adversarial audit: ALL 11 SCs PASS

Fixes #93

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

michael-conrad and others added 2 commits May 23, 2026 01:10
…ork initialization

Co-authored-by: OpenCode (ollama-cloud/glm-5.1) <ai@opencode.ai>
…encode references

- Add three before/after annotation pairs to Section 11: GET+path params
  (getIssue), GET+query params (listIssues), POST+body param (createIssue)
- Replace all issue gitbucket#836 references with self-contained substrate-determined
  behavioral evidence language
- Replace critical-rules-060 with plain FAIL rule language
- Replace verification-before-completion with final verification
- Replace gitbucket#836 classification gate in approach-validation.md with self-contained
  behavioral classification principle

Co-authored with AI: opencode (ollama-cloud/glm-5.1)
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