OilfieldToolsNet/shlink
4
0
Fork 0
mirror of https://github.com/shlinkio/shlink.git synced 2025-02-25 18:45:27 -06:00
Code Issues Packages Projects Releases Wiki Activity

Documented pagination for tags endpoint

Browse Source
This commit is contained in:
Alejandro Celaya
2022-01-05 19:21:02 +01:00
parent 2f42b2d072
commit fd2a2530b1
1 changed files with 47 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
docs/swagger/paths/v1_tags.json
View File

@@ -17,7 +17,7 @@
},
{
"name": "withStats",
"description": "Whether you want to include also a list with general stats by tag or not.",
"description": "Whether you want to include also a list with general stats by tag or not. Defaults to false.",
"in": "query",
"required": false,
"schema": {
@@ -27,6 +27,33 @@
"false"
]
}
},
{
"name": "page",
"in": "query",
"description": "The page to display. Defaults to 1",
"required": false,
"schema": {
"type": "number"
}
},
{
"name": "itemsPerPage",
"in": "query",
"description": "The amount of items to return on every page. Defaults to all the items",
"required": false,
"schema": {
"type": "number"
}
},
{
"name": "searchTerm",
"in": "query",
"description": "A query used to filter results by searching for it on the tag name.",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
@@ -53,6 +80,9 @@
"items": {
"$ref": "../definitions/TagInfo.json"
}
},
"pagination": {
"$ref": "../definitions/Pagination.json"
}
}
}
@@ -67,7 +97,14 @@
"php",
"shlink",
"tech"
]
],
"pagination": {
"currentPage": 5,
"pagesCount": 10,
"itemsPerPage": 4,
"itemsInCurrentPage": 4,
"totalItems": 38
}
}
}
},
@@ -89,7 +126,14 @@
"shortUrlsCount": 7,
"visitsCount": 1087
}
]
],
"pagination": {
"currentPage": 5,
"pagesCount": 5,
"itemsPerPage": 10,
"itemsInCurrentPage": 2,
"totalItems": 42
}
}
}
}