From 6d7c6f71fd0d880e6dfb39de7ae20da310583eba Mon Sep 17 00:00:00 2001
From: Matt Blenkinsop <matt.blenkinsop@ptfs-europe.com>
Date: Tue, 13 Aug 2024 14:18:49 +0000
Subject: [PATCH] Bug 10190: Let the circulation_rules endpoint accept query
 parameters

Sponsored-by: Glasgow Colleges Library Group
---
 api/v1/swagger/paths/circulation_rules.yaml | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)

diff --git a/api/v1/swagger/paths/circulation_rules.yaml b/api/v1/swagger/paths/circulation_rules.yaml
index 4b7e5e1cd65..cc4b6ac7c5c 100644
--- a/api/v1/swagger/paths/circulation_rules.yaml
+++ b/api/v1/swagger/paths/circulation_rules.yaml
@@ -9,6 +9,13 @@
     produces:
       - application/json
     parameters:
+      - $ref: "../swagger.yaml#/parameters/match"
+      - $ref: "../swagger.yaml#/parameters/order_by"
+      - $ref: "../swagger.yaml#/parameters/page"
+      - $ref: "../swagger.yaml#/parameters/per_page"
+      - $ref: "../swagger.yaml#/parameters/q_param"
+      - $ref: "../swagger.yaml#/parameters/q_body"
+      - $ref: "../swagger.yaml#/parameters/request_id_header"
       - name: effective
         in: query
         description: Boolean indicating whether to return effective rules or all rules. Defaults to true.
@@ -42,7 +49,10 @@
           items:
             $ref: "../swagger.yaml#/definitions/circulation_rules"
       "400":
-        description: Bad request
+        description: |
+          Bad request. Possible `error_code` attribute values:
+
+            * `invalid_query`
         schema:
           $ref: "../swagger.yaml#/definitions/error"
       "401":
@@ -91,8 +101,7 @@
           items:
             $ref: "../swagger.yaml#/definitions/circulation_rules"
       "400":
-        description: |
-          Bad request.
+        description: Bad request
         schema:
           $ref: "../swagger.yaml#/definitions/error"
       "403":
-- 
2.46.0