diff --git a/docs/swagger/paths/{shortCode}_qr-code.json b/docs/swagger/paths/{shortCode}_qr-code.json index a3fdaffb..3714f802 100644 --- a/docs/swagger/paths/{shortCode}_qr-code.json +++ b/docs/swagger/paths/{shortCode}_qr-code.json @@ -18,7 +18,7 @@ }, { "name": "size", - "in": "path", + "in": "query", "description": "The size of the image to be returned.", "required": false, "schema": { diff --git a/docs/swagger/paths/{shortCode}_qr-code_{size}.json b/docs/swagger/paths/{shortCode}_qr-code_{size}.json new file mode 100644 index 00000000..fb5dd33e --- /dev/null +++ b/docs/swagger/paths/{shortCode}_qr-code_{size}.json @@ -0,0 +1,66 @@ +{ + "get": { + "operationId": "shortUrlQrCodeSize", + "deprecated": true, + "tags": [ + "URL Shortener" + ], + "summary": "Short URL QR code", + "description": "Generates a QR code image pointing to a short URL", + "parameters": [ + { + "name": "shortCode", + "in": "path", + "description": "The short code to resolve.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "size", + "in": "path", + "description": "The size of the image to be returned.", + "required": false, + "schema": { + "type": "integer", + "minimum": 50, + "maximum": 1000, + "default": 300 + } + }, + { + "name": "format", + "in": "query", + "description": "The format for the QR code image, being valid values png and svg. Not providing the param or providing any other value will fall back to png.", + "required": false, + "schema": { + "type": "string", + "enum": [ + "png", + "svg" + ] + } + } + ], + "responses": { + "200": { + "description": "QR code in PNG format", + "content": { + "image/png": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "image/svg+xml": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + } + } + } +} diff --git a/docs/swagger/swagger.json b/docs/swagger/swagger.json index 8dc04412..dc834905 100644 --- a/docs/swagger/swagger.json +++ b/docs/swagger/swagger.json @@ -116,6 +116,9 @@ }, "/{shortCode}/qr-code": { "$ref": "paths/{shortCode}_qr-code.json" + }, + "/{shortCode}/qr-code/{size}": { + "$ref": "paths/{shortCode}_qr-code_{size}.json" } } }