From 9e19d79337cb0f2f95fc3f1e7e4475e568f85987 Mon Sep 17 00:00:00 2001 From: Steve Roberts Date: Wed, 10 Jun 2020 17:05:25 +1000 Subject: [PATCH] Add more detail on the ransack based queries in the description --- swagger.yaml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/swagger.yaml b/swagger.yaml index 0aed7ded9e..9f4accc980 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -342,7 +342,10 @@ paths: /orders: get: - description: Gets all Orders. Use combinations of parameters to filter your query. For example /api/orders?q[completed_at_gt]=2020_02_02&q[completed_at_lt]=2020_02_10 returns orders between 2nd and 10th February 2020. + description: > + Gets all Orders. Use combinations of parameters to filter your query. + For example /api/orders?q[completed_at_gt]=2020_02_02&q[completed_at_lt]=2020_02_10 returns orders between 2nd and 10th February 2020. + Query parameters are generated for the '#/components/schemas/Order_Concise' model with [Ransack](https://github.com/activerecord-hackery/ransack#search-matchers) search matchers tags: - orders parameters: