mirrors/shlink
1
0
Fork 0
mirror of https://github.com/shlinkio/shlink.git synced 2024-11-26 23:18:37 +03:00
Code Issues Projects Releases Packages Wiki Activity

#917 Documented QR endpoint with query size and path size

Browse source
This commit is contained in:
Alejandro Celaya 2020-11-27 17:47:52 +01:00
parent 4f1ab977a1
commit c13adb04ef
3 changed files with 70 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/swagger/paths/{shortCode}_qr-code.json
View file

@ -18,7 +18,7 @@
}, },
{ {
"name": "size", "name": "size",
"in": "path", "in": "query",
"description": "The size of the image to be returned.", "description": "The size of the image to be returned.",
"required": false, "required": false,
"schema": { "schema": {

66
docs/swagger/paths/{shortCode}_qr-code_{size}.json Normal file
View file

@ -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"
}
}
}
}
}
}
}

3
docs/swagger/swagger.json
View file

@ -116,6 +116,9 @@
}, },
"/{shortCode}/qr-code": { "/{shortCode}/qr-code": {
"$ref": "paths/{shortCode}_qr-code.json" "$ref": "paths/{shortCode}_qr-code.json"
},
"/{shortCode}/qr-code/{size}": {
"$ref": "paths/{shortCode}_qr-code_{size}.json"
} }
} }
} }