fix(api-docs): fix YieldGenReportResponse format#1836
Open
theborakompanioni wants to merge 1 commit intoJoinMarket-Org:masterfrom
Open
fix(api-docs): fix YieldGenReportResponse format#1836theborakompanioni wants to merge 1 commit intoJoinMarket-Org:masterfrom
theborakompanioni wants to merge 1 commit intoJoinMarket-Org:masterfrom
Conversation
There was a problem hiding this comment.
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
YieldGenReportResponsefromarray[string]to anobjectwith ayigen_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 |
There was a problem hiding this comment.
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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