Skip to content

docs: add proposals summarise API documentation - closes #476 - #522

Open
ChuyCode15 wants to merge 1 commit into
codebestia:mainfrom
ChuyCode15:feature/proposals-summarise-docs
Open

docs: add proposals summarise API documentation - closes #476#522
ChuyCode15 wants to merge 1 commit into
codebestia:mainfrom
ChuyCode15:feature/proposals-summarise-docs

Conversation

@ChuyCode15

@ChuyCode15 ChuyCode15 commented Jul 29, 2026

Copy link
Copy Markdown

Description

Adds comprehensive API documentation for POST /proposals/summarise endpoint.

Includes:

  • Request/response fields with types
  • All three risk levels: low, medium, high
  • 502 error case with exact response shape
  • Worked examples for each risk level

Closes #476

Type of change

  • Bug fix
  • New feature
  • Documentation update
  • Other

Checklist

  • I have read the contributing guidelines
  • I have tested my changes locally
  • My code follows the project's coding standards

@drips-wave

drips-wave Bot commented Jul 29, 2026

Copy link
Copy Markdown

@ChuyCode15 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

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.

API docs: /proposals/summarise endpoint

1 participant