[ING-30] feat: Document currency filter on list endpoints#534
Open
aquinofb wants to merge 1 commit into
Open
Conversation
## Context The lago-api backend exposes an optional `currency` query parameter on the subscriptions, wallets, and payment_requests list endpoints (PR #5249), but the OpenAPI spec did not document it. ## Description Add a shared `currency` query parameter (with `explode: true`, matching sibling query params such as payment_status) and reference it from the GET parameters of the three list endpoints. Regenerate the bundled openapi.yaml so the published spec stays in sync with the source.
aquinofb
requested review from
a team,
lovrocolic,
mariohd,
murparreira and
vincent-pochet
mariohd
approved these changes
Jun 3, 2026
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
2 participants
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.
Context
The lago-api backend exposes an optional
currencyquery parameter on the subscriptions, wallets, and payment_requests list endpoints (getlago/lago-api#5249), filtering respectively by plan amount currency, wallet balance currency, and payment request amount currency. The OpenAPI spec did not document it, so the published reference and downstream SDKs had no knowledge of the filter.Description
Adds a shared
currencyquery parameter and references it from theGETparameters of the three list endpoints. It follows the existing filter-param convention (a file undersrc/parameters/referenced by path and hoisted intocomponents.parametersat bundle time, likepayment_statusandsubscription_status), and setsexplode: trueto match sibling query params. The bundledopenapi.yamlis regenerated so the published spec stays in sync with the source.How to try locally
GET /subscriptions,GET /wallets, andGET /payment_requestsnow expose an optionalcurrencyquery parameter.