Add Use Cases Document Validation Against Current API

[maugauwi-hash]

Labels: documentation
Priority: Low
Estimated Time: 1 hour

Description:
docs/use-cases.md walks through example flows, but example request/response payloads should be validated against the current docs/openapi.yaml schema to avoid misleading new integrators.

Tasks:

• Validate every example payload in use-cases.md against the OpenAPI schema
• Fix any drifted examples
• Add a CI check that extracts and validates code fences in use-cases.md against the schema
• Document the validation process for future doc updates

---

Infrastructure, DevOps & Deployment

[bobo-24]

Hi! I came across this issue and would love to work on it. I have experience with similar tasks and I'm confident I can investigate, implement a clean solution, and thoroughly test it before submitting a PR. If the issue is still open, I would appreciate it if you could assign it to me. I’ll prioritize this immediately and ensure a reliable solution is delivered as soon as possible. Thank you!

[codewithzubair07]

@codewithzubair07 has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

i would like to work on this issue

ℹ️ Repo Maintainers: To accept this application, review their application or assign @codewithzubair07 to this issue.

[dami-005]

@dami-005 has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

hi maintainer, i would like to take this issue

ℹ️ Repo Maintainers: To accept this application, review their application or assign @dami-005 to this issue.

[drips-wave]

Congratulations, @dami-005! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on August 31, 2026.

🧑‍💻 @dami-005: Please resolve the issue such that the repo's maintainers have enough time to review your contribution before the due date. You'll earn Points for completing the issue on-time, which will make you eligible for a share of the Stellar Wave Program's reward pool.

Warning

When opening a PR, please link it to this issue to ensure it gets tracked accurately. Points are awarded when this issue is marked as completed by the maintainer.

🤠 Repo maintainers: Please keep an eye on the contributor's progress and review their work before the due date. You can manage this issue, including adjusting its complexity and points, here.

🌊 Happy Wave 🌊

[grantfox-oss]

🎉 This issue has been marked as completed on GrantFox!

@dami-005's PR #451 was approved and merged by @maugauwi-hash.

🏆 @dami-005: You earned 35 FoxPoints for this contribution! Your current tier: Explorer (990 total points). Track your full progress on GrantFox.

👏 Great work, @dami-005! Keep contributing to ethos-protocol.