Skip to content

fix(api-docs): fix YieldGenReportResponse format#1836

Open
theborakompanioni wants to merge 1 commit intoJoinMarket-Org:masterfrom
theborakompanioni:tbk/fix-api-docs-yigen-report
Open

fix(api-docs): fix YieldGenReportResponse format#1836
theborakompanioni wants to merge 1 commit intoJoinMarket-Org:masterfrom
theborakompanioni:tbk/fix-api-docs-yigen-report

Conversation

@theborakompanioni
Copy link
Copy Markdown
Contributor

API docs state wrong return type for /wallet/yieldgen/report.

Instead of an array, the response contains an object with property yigen_data:

https://github.com/JoinMarket-Org/joinmarket-clientserver/blob/ce32bafbb5d716bde61830f71266410249d43dbc/src/jmclient/wallet_rpc.py#L974C53-L974C63

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR corrects the OpenAPI schema for /wallet/yieldgen/report so the documented response matches the actual RPC output (an object containing yigen_data, rather than a bare array).

Changes:

  • Update YieldGenReportResponse from array[string] to an object with a yigen_data: array[string] property.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +836 to +839
type: object
properties:
yigen_data:
type: array
Copy link

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

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

The /wallet/yieldgen/report endpoint description earlier in this spec still says the response is “Data returned as list of strings…”, but the schema was updated to an object wrapper with yigen_data. To keep the OpenAPI docs consistent, update that endpoint description to mention the yigen_data property (and that it contains the list of CSV-formatted strings).

Suggested change
type: object
properties:
yigen_data:
type: array
type: object
description: Object wrapper containing yield generator report data in the `yigen_data` property.
properties:
yigen_data:
type: array
description: List of CSV-formatted strings, each representing a yield generator report row.

Copilot uses AI. Check for mistakes.
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.

2 participants