Skip to content

feat: document yield API endpoints in OpenAPI spec (#386)#429

Merged
ONEONUORA merged 1 commit into
Fracverse:masterfrom
tech-adrian:feat/386-yield-openapi-docs
Jun 27, 2026
Merged

feat: document yield API endpoints in OpenAPI spec (#386)#429
ONEONUORA merged 1 commit into
Fracverse:masterfrom
tech-adrian:feat/386-yield-openapi-docs

Conversation

@tech-adrian

@tech-adrian tech-adrian commented Jun 27, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add Yield tag and 9 new schemas to backend/docs/openapi.yaml covering balance, history, deposit, withdraw, and auto-earn toggle
  • Document all 5 yield endpoints (GET /api/yield/balance, GET /api/yield/history, POST /api/yield/deposit, POST /api/yield/withdraw, POST /api/yield/toggle-auto) with request bodies, query params, response schemas, and error cases
  • All endpoints are secured with BearerAuth

Test plan

  • YAML parses without errors (python3 -c "import yaml; yaml.safe_load(open('backend/docs/openapi.yaml'))")
  • Import into Swagger UI / Redoc and confirm all 5 yield paths render correctly
  • Verify request/response field names match the Rust structs in backend/src/api/yield.rs
  • CI backend job passes (only Rust checks; no YAML linter in pipeline)

Closes #386

Add Yield tag, schemas, and paths for /api/yield/balance, /api/yield/history,
/api/yield/deposit, /api/yield/withdraw, and /api/yield/toggle-auto to backend/docs/openapi.yaml.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@drips-wave

drips-wave Bot commented Jun 27, 2026

Copy link
Copy Markdown

@tech-adrian Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@ONEONUORA ONEONUORA left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job @tech-adrian
Thank you for your contribution

@ONEONUORA ONEONUORA merged commit da68e68 into Fracverse:master Jun 27, 2026
7 of 11 checks passed
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.

[BE-038] Document yield API endpoints in Swagger/OpenAPI spec

2 participants