OilfieldToolsNet/shlink
4
0
Fork 0
mirror of https://github.com/shlinkio/shlink.git synced 2024-11-22 17:06:41 -06:00
Code Issues Packages Projects Releases Wiki Activity

Added response examples to swagger docs

Browse Source
This commit is contained in:
Alejandro Celaya 2017-04-16 10:45:52 +02:00
parent 10da57572f
commit 17be221920
4 changed files with 56 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/swagger/paths/v1_short-codes.json
View File

@ -74,7 +74,7 @@
"shortUrls": { "shortUrls": {
"data": [ "data": [
{ {
"shortCode": "", "shortCode": "12C18",
"originalUrl": "https://store.steampowered.com", "originalUrl": "https://store.steampowered.com",
"dateCreated": "2016-08-21T20:34:16+02:00", "dateCreated": "2016-08-21T20:34:16+02:00",
"visitsCount": 328, "visitsCount": 328,
@ -82,6 +82,22 @@
"games", "games",
"tech" "tech"
] ]
},
{
"shortCode": "12Kb3",
"originalUrl": "https://shlink.io",
"dateCreated": "2016-05-01T20:34:16+02:00",
"visitsCount": 1029,
"tags": [
"shlink"
]
},
{
"shortCode": "123bA",
"originalUrl": "https://www.google.com",
"dateCreated": "2015-10-01T20:34:16+02:00",
"visitsCount": 25,
"tags": []
} }
], ],
"pagination": { "pagination": {

5
docs/swagger/paths/v1_short-codes_{shortCode}.json
View File

@ -28,6 +28,11 @@
"description": "The original long URL behind the short code." "description": "The original long URL behind the short code."
} }
} }
},
"examples": {
"application/json": {
"longUrl": "https://shlink.io"
}
} }
}, },
"400": { "400": {

8
docs/swagger/paths/v1_short-codes_{shortCode}_tags.json
View File

@ -41,6 +41,14 @@
} }
} }
} }
},
"examples": {
"application/json": {
"tags": [
"games",
"tech"
]
}
} }
}, },
"400": { "400": {

26
docs/swagger/paths/v1_short-codes_{shortCode}_visits.json
View File

@ -36,6 +36,32 @@
} }
} }
} }
},
"examples": {
"application/json": {
"visits": {
"data": [
{
"referer": "https://twitter.com",
"date": "2015-08-20T05:05:03+04:00",
"remoteAddr": "10.20.30.40",
"userAgent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0 Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0"
},
{
"referer": "https://t.co",
"date": "2015-08-20T05:05:03+04:00",
"remoteAddr": "11.22.33.44",
"userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36"
},
{
"referer": null,
"date": "2015-08-20T05:05:03+04:00",
"remoteAddr": "110.220.5.6",
"userAgent": "some_web_crawler/1.4"
}
]
}
}
} }
}, },
"404": { "404": {