From 97c94f8fcca45f905227e44c9c305c9c2f3acf9e Mon Sep 17 00:00:00 2001
From: Alejandro Celaya <alejandrocelaya@gmail.com>
Date: Tue, 5 Mar 2024 11:14:07 +0100
Subject: [PATCH] Document color and bgColor QR code query params

---
 CHANGELOG.md                                | 18 +++++++++++++++++-
 docs/swagger/paths/{shortCode}_qr-code.json | 20 ++++++++++++++++++++
 2 files changed, 37 insertions(+), 1 deletion(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index c59a0a53..2c2caa10 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,23 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com), and this project adheres to [Semantic Versioning](https://semver.org).
 
+## [Unreleased]
+### Added
+* [#2041](https://github.com/shlinkio/shlink/issues/2041) Document `color` and `bgColor` params for the QR code route in the OAS docs.
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* *Nothing*
+
+
 ## [4.0.0] - 2024-03-03
 ### Added
 * [#1914](https://github.com/shlinkio/shlink/issues/1914) Add new dynamic redirects engine based on rules. Rules are conditions checked against the visitor's request, and when matching, they can result in a redirect to a different long URL.
@@ -56,7 +73,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com), and this
 
 ### Changed
 * [#1968](https://github.com/shlinkio/shlink/issues/1968) Move migrations from `data` to `module/Core`.
-* *Nothing*
 
 ### Deprecated
 * *Nothing*
diff --git a/docs/swagger/paths/{shortCode}_qr-code.json b/docs/swagger/paths/{shortCode}_qr-code.json
index ca66a079..39be2dc9 100644
--- a/docs/swagger/paths/{shortCode}_qr-code.json
+++ b/docs/swagger/paths/{shortCode}_qr-code.json
@@ -65,6 +65,26 @@
                     "enum": ["true", "false"],
                     "default": "false"
                 }
+            },
+            {
+                "name": "color",
+                "in": "query",
+                "description": "The QR code foreground color. It should be an hex representation of a color, in 3 or 6 characters, optionally preceded by the \"#\" character.",
+                "required": false,
+                "schema": {
+                    "type": "string",
+                    "default": "#000000"
+                }
+            },
+            {
+                "name": "bgColor",
+                "in": "query",
+                "description": "The QR code background color. It should be an hex representation of a color, in 3 or 6 characters, optionally preceded by the \"#\" character.",
+                "required": false,
+                "schema": {
+                    "type": "string",
+                    "default": "#ffffff"
+                }
             }
         ],
         "responses": {