From 01e06f0503b26e11096535dbac2eb49bf8cb241b Mon Sep 17 00:00:00 2001 From: Alejandro Celaya Date: Tue, 13 Jul 2021 13:53:10 +0200 Subject: [PATCH] Improved swagger docs for QR code endpoint --- docs/swagger/paths/{shortCode}_qr-code.json | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/swagger/paths/{shortCode}_qr-code.json b/docs/swagger/paths/{shortCode}_qr-code.json index 43c1d38a..04a88fd7 100644 --- a/docs/swagger/paths/{shortCode}_qr-code.json +++ b/docs/swagger/paths/{shortCode}_qr-code.json @@ -5,7 +5,7 @@ "URL Shortener" ], "summary": "Short URL QR code", - "description": "Generates a QR code image pointing to a short URL", + "description": "Generates a QR code image pointing to a short URL.
Since this is not an API endpoint but an image one, when an invalid value is provided for any of the query params, they will fall to their default values instead of throwing an error.", "parameters": [ { "name": "shortCode", @@ -35,7 +35,8 @@ "required": false, "schema": { "type": "string", - "enum": ["png", "svg"] + "enum": ["png", "svg"], + "default": "png" } }, { @@ -56,7 +57,8 @@ "required": false, "schema": { "type": "string", - "enum": ["L", "M", "Q", "H"] + "enum": ["L", "M", "Q", "H"], + "default": "L" } } ],