From 8c2824ce179cc306ae4d696c20d140610e64a380 Mon Sep 17 00:00:00 2001
From: Felipe Rodrigues <aquinofb@gmail.com>
Date: Wed, 27 May 2026 12:40:34 -0300
Subject: [PATCH] [ING-30] feat: Document currency filter on list endpoints

## 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.
---
 openapi.yaml                        | 12 ++++++++++++
 src/parameters/currency.yaml        |  8 ++++++++
 src/resources/payment_requests.yaml |  1 +
 src/resources/subscriptions.yaml    |  1 +
 src/resources/wallets.yaml          |  1 +
 5 files changed, 23 insertions(+)
 create mode 100644 src/parameters/currency.yaml

diff --git a/openapi.yaml b/openapi.yaml
index 696aba5e..359fb518 100644
--- a/openapi.yaml
+++ b/openapi.yaml
@@ -4255,6 +4255,7 @@ paths:
       parameters:
         - $ref: '#/components/parameters/page'
         - $ref: '#/components/parameters/per_page'
+        - $ref: '#/components/parameters/currency'
         - $ref: '#/components/parameters/external_customer_id'
         - $ref: '#/components/parameters/payment_status'
         - name: billing_entity_codes[]
@@ -5214,6 +5215,7 @@ paths:
       parameters:
         - $ref: '#/components/parameters/page'
         - $ref: '#/components/parameters/per_page'
+        - $ref: '#/components/parameters/currency'
         - name: external_customer_id
           in: query
           description: The customer external unique identifier (provided by your own application)
@@ -6242,6 +6244,7 @@ paths:
       parameters:
         - $ref: '#/components/parameters/page'
         - $ref: '#/components/parameters/per_page'
+        - $ref: '#/components/parameters/currency'
         - name: external_customer_id
           in: query
           description: The customer external unique identifier (provided by your own application).
@@ -9175,6 +9178,15 @@ components:
         type: string
         format: uuid
         example: 1a901a90-1a90-1a90-1a90-1a901a901a90
+    currency:
+      name: currency
+      in: query
+      description: Filter the results by currency, expressed as an ISO 4217 code.
+      required: false
+      explode: true
+      schema:
+        type: string
+        example: EUR
     plan_code:
       name: code
       in: path
diff --git a/src/parameters/currency.yaml b/src/parameters/currency.yaml
new file mode 100644
index 00000000..bd11cd21
--- /dev/null
+++ b/src/parameters/currency.yaml
@@ -0,0 +1,8 @@
+name: currency
+in: query
+description: Filter the results by currency, expressed as an ISO 4217 code.
+required: false
+explode: true
+schema:
+  type: string
+  example: EUR
diff --git a/src/resources/payment_requests.yaml b/src/resources/payment_requests.yaml
index 4f5287e0..cbcb6553 100644
--- a/src/resources/payment_requests.yaml
+++ b/src/resources/payment_requests.yaml
@@ -33,6 +33,7 @@ get:
   parameters:
     - $ref: '../parameters/page.yaml'
     - $ref: '../parameters/per_page.yaml'
+    - $ref: '../parameters/currency.yaml'
     - $ref: '../parameters/external_customer_id.yaml'
     - $ref: '../parameters/payment_status.yaml'
     - name: billing_entity_codes[]
diff --git a/src/resources/subscriptions.yaml b/src/resources/subscriptions.yaml
index 189e3d54..0a2873cb 100644
--- a/src/resources/subscriptions.yaml
+++ b/src/resources/subscriptions.yaml
@@ -35,6 +35,7 @@ get:
   parameters:
     - $ref: '../parameters/page.yaml'
     - $ref: '../parameters/per_page.yaml'
+    - $ref: '../parameters/currency.yaml'
     - name: external_customer_id
       in: query
       description: The customer external unique identifier (provided by your own application)
diff --git a/src/resources/wallets.yaml b/src/resources/wallets.yaml
index e573243a..e0b998c0 100644
--- a/src/resources/wallets.yaml
+++ b/src/resources/wallets.yaml
@@ -35,6 +35,7 @@ get:
   parameters:
     - $ref: "../parameters/page.yaml"
     - $ref: "../parameters/per_page.yaml"
+    - $ref: "../parameters/currency.yaml"
     - name: external_customer_id
       in: query
       description: The customer external unique identifier (provided by your own application).