mirror of
https://github.com/shlinkio/shlink.git
synced 2024-11-24 09:50:17 -06:00
Fixed existing examples for API
This commit is contained in:
Alejandro Celaya
parent
ada8d18fa1
commit
808ae6a442
@ -13,16 +13,14 @@
|
|||||||
"application/json": {
|
"application/json": {
|
||||||
"schema": {
|
"schema": {
|
||||||
"$ref": "../definitions/Health.json"
|
"$ref": "../definitions/Health.json"
|
||||||
}
|
},
|
||||||
}
|
"example": {
|
||||||
},
|
"status": "pass",
|
||||||
"examples": {
|
"version": "2.10.0",
|
||||||
"application/json": {
|
"links": {
|
||||||
"status": "pass",
|
"about": "https://shlink.io",
|
||||||
"version": "1.16.0",
|
"project": "https://github.com/shlinkio/shlink"
|
||||||
"links": {
|
}
|
||||||
"about": "https://shlink.io",
|
|
||||||
"project": "https://github.com/shlinkio/shlink"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -33,16 +31,14 @@
|
|||||||
"application/json": {
|
"application/json": {
|
||||||
"schema": {
|
"schema": {
|
||||||
"$ref": "../definitions/Health.json"
|
"$ref": "../definitions/Health.json"
|
||||||
}
|
},
|
||||||
}
|
"example": {
|
||||||
},
|
"status": "fail",
|
||||||
"examples": {
|
"version": "2.10.0",
|
||||||
"application/json": {
|
"links": {
|
||||||
"status": "fail",
|
"about": "https://shlink.io",
|
||||||
"version": "1.16.0",
|
"project": "https://github.com/shlinkio/shlink"
|
||||||
"links": {
|
}
|
||||||
"about": "https://shlink.io",
|
|
||||||
"project": "https://github.com/shlinkio/shlink"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@ -117,73 +117,71 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
},
|
||||||
}
|
"example": {
|
||||||
},
|
"shortUrls": {
|
||||||
"examples": {
|
"data": [
|
||||||
"application/json": {
|
{
|
||||||
"shortUrls": {
|
"shortCode": "12C18",
|
||||||
"data": [
|
"shortUrl": "https://doma.in/12C18",
|
||||||
{
|
"longUrl": "https://store.steampowered.com",
|
||||||
"shortCode": "12C18",
|
"dateCreated": "2016-08-21T20:34:16+02:00",
|
||||||
"shortUrl": "https://doma.in/12C18",
|
"visitsCount": 328,
|
||||||
"longUrl": "https://store.steampowered.com",
|
"tags": [
|
||||||
"dateCreated": "2016-08-21T20:34:16+02:00",
|
"games",
|
||||||
"visitsCount": 328,
|
"tech"
|
||||||
"tags": [
|
],
|
||||||
"games",
|
"meta": {
|
||||||
"tech"
|
"validSince": "2017-01-21T00:00:00+02:00",
|
||||||
],
|
"validUntil": null,
|
||||||
"meta": {
|
"maxVisits": 100
|
||||||
"validSince": "2017-01-21T00:00:00+02:00",
|
},
|
||||||
"validUntil": null,
|
"domain": null,
|
||||||
"maxVisits": 100
|
"title": "Welcome to Steam",
|
||||||
|
"crawlable": false
|
||||||
},
|
},
|
||||||
"domain": null,
|
{
|
||||||
"title": "Welcome to Steam",
|
"shortCode": "12Kb3",
|
||||||
"crawlable": false
|
"shortUrl": "https://doma.in/12Kb3",
|
||||||
},
|
"longUrl": "https://shlink.io",
|
||||||
{
|
"dateCreated": "2016-05-01T20:34:16+02:00",
|
||||||
"shortCode": "12Kb3",
|
"visitsCount": 1029,
|
||||||
"shortUrl": "https://doma.in/12Kb3",
|
"tags": [
|
||||||
"longUrl": "https://shlink.io",
|
"shlink"
|
||||||
"dateCreated": "2016-05-01T20:34:16+02:00",
|
],
|
||||||
"visitsCount": 1029,
|
"meta": {
|
||||||
"tags": [
|
"validSince": null,
|
||||||
"shlink"
|
"validUntil": null,
|
||||||
],
|
"maxVisits": null
|
||||||
"meta": {
|
},
|
||||||
"validSince": null,
|
"domain": null,
|
||||||
"validUntil": null,
|
"title": null,
|
||||||
"maxVisits": null
|
"crawlable": false
|
||||||
},
|
},
|
||||||
"domain": null,
|
{
|
||||||
"title": null,
|
"shortCode": "123bA",
|
||||||
"crawlable": false
|
"shortUrl": "https://example.com/123bA",
|
||||||
},
|
"longUrl": "https://www.google.com",
|
||||||
{
|
"dateCreated": "2015-10-01T20:34:16+02:00",
|
||||||
"shortCode": "123bA",
|
"visitsCount": 25,
|
||||||
"shortUrl": "https://example.com/123bA",
|
"tags": [],
|
||||||
"longUrl": "https://www.google.com",
|
"meta": {
|
||||||
"dateCreated": "2015-10-01T20:34:16+02:00",
|
"validSince": "2017-01-21T00:00:00+02:00",
|
||||||
"visitsCount": 25,
|
"validUntil": null,
|
||||||
"tags": [],
|
"maxVisits": null
|
||||||
"meta": {
|
},
|
||||||
"validSince": "2017-01-21T00:00:00+02:00",
|
"domain": "example.com",
|
||||||
"validUntil": null,
|
"title": null,
|
||||||
"maxVisits": null
|
"crawlable": false
|
||||||
},
|
}
|
||||||
"domain": "example.com",
|
],
|
||||||
"title": null,
|
"pagination": {
|
||||||
"crawlable": false
|
"currentPage": 5,
|
||||||
|
"pagesCount": 12,
|
||||||
|
"itemsPerPage": 10,
|
||||||
|
"itemsInCurrentPage": 10,
|
||||||
|
"totalItems": 115
|
||||||
}
|
}
|
||||||
],
|
|
||||||
"pagination": {
|
|
||||||
"currentPage": 5,
|
|
||||||
"pagesCount": 12,
|
|
||||||
"itemsPerPage": 10,
|
|
||||||
"itemsInCurrentPage": 10,
|
|
||||||
"totalItems": 115
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -267,28 +265,26 @@
|
|||||||
"application/json": {
|
"application/json": {
|
||||||
"schema": {
|
"schema": {
|
||||||
"$ref": "../definitions/ShortUrl.json"
|
"$ref": "../definitions/ShortUrl.json"
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"examples": {
|
|
||||||
"application/json": {
|
|
||||||
"shortCode": "12C18",
|
|
||||||
"shortUrl": "https://doma.in/12C18",
|
|
||||||
"longUrl": "https://store.steampowered.com",
|
|
||||||
"dateCreated": "2016-08-21T20:34:16+02:00",
|
|
||||||
"visitsCount": 0,
|
|
||||||
"tags": [
|
|
||||||
"games",
|
|
||||||
"tech"
|
|
||||||
],
|
|
||||||
"meta": {
|
|
||||||
"validSince": "2017-01-21T00:00:00+02:00",
|
|
||||||
"validUntil": null,
|
|
||||||
"maxVisits": 500
|
|
||||||
},
|
},
|
||||||
"domain": null,
|
"example": {
|
||||||
"title": null,
|
"shortCode": "12C18",
|
||||||
"crawlable": false
|
"shortUrl": "https://doma.in/12C18",
|
||||||
|
"longUrl": "https://store.steampowered.com",
|
||||||
|
"dateCreated": "2016-08-21T20:34:16+02:00",
|
||||||
|
"visitsCount": 0,
|
||||||
|
"tags": [
|
||||||
|
"games",
|
||||||
|
"tech"
|
||||||
|
],
|
||||||
|
"meta": {
|
||||||
|
"validSince": "2017-01-21T00:00:00+02:00",
|
||||||
|
"validUntil": null,
|
||||||
|
"maxVisits": 500
|
||||||
|
},
|
||||||
|
"domain": null,
|
||||||
|
"title": null,
|
||||||
|
"crawlable": false
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
@ -330,6 +326,13 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
},
|
||||||
|
"example": {
|
||||||
|
"title": "Invalid URL",
|
||||||
|
"type": "INVALID_URL",
|
||||||
|
"detail": "Provided URL foo is invalid. Try with a different one.",
|
||||||
|
"status": 400,
|
||||||
|
"url": "https://invalid-url.com"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@ -49,35 +49,33 @@
|
|||||||
"application/json": {
|
"application/json": {
|
||||||
"schema": {
|
"schema": {
|
||||||
"$ref": "../definitions/ShortUrl.json"
|
"$ref": "../definitions/ShortUrl.json"
|
||||||
|
},
|
||||||
|
"example": {
|
||||||
|
"longUrl": "https://github.com/shlinkio/shlink",
|
||||||
|
"shortUrl": "https://doma.in/abc123",
|
||||||
|
"shortCode": "abc123",
|
||||||
|
"dateCreated": "2016-08-21T20:34:16+02:00",
|
||||||
|
"visitsCount": 0,
|
||||||
|
"tags": [
|
||||||
|
"games",
|
||||||
|
"tech"
|
||||||
|
],
|
||||||
|
"meta": {
|
||||||
|
"validSince": "2017-01-21T00:00:00+02:00",
|
||||||
|
"validUntil": null,
|
||||||
|
"maxVisits": 100
|
||||||
|
},
|
||||||
|
"domain": null,
|
||||||
|
"title": null,
|
||||||
|
"crawlable": false
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"text/plain": {
|
"text/plain": {
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"examples": {
|
|
||||||
"application/json": {
|
|
||||||
"longUrl": "https://github.com/shlinkio/shlink",
|
|
||||||
"shortUrl": "https://doma.in/abc123",
|
|
||||||
"shortCode": "abc123",
|
|
||||||
"dateCreated": "2016-08-21T20:34:16+02:00",
|
|
||||||
"visitsCount": 0,
|
|
||||||
"tags": [
|
|
||||||
"games",
|
|
||||||
"tech"
|
|
||||||
],
|
|
||||||
"meta": {
|
|
||||||
"validSince": "2017-01-21T00:00:00+02:00",
|
|
||||||
"validUntil": null,
|
|
||||||
"maxVisits": 100
|
|
||||||
},
|
},
|
||||||
"domain": null,
|
"example": "https://doma.in/abc123"
|
||||||
"title": null,
|
}
|
||||||
"crawlable": false
|
|
||||||
},
|
|
||||||
"text/plain": "https://doma.in/abc123"
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"400": {
|
"400": {
|
||||||
@ -86,23 +84,21 @@
|
|||||||
"application/problem+json": {
|
"application/problem+json": {
|
||||||
"schema": {
|
"schema": {
|
||||||
"$ref": "../definitions/Error.json"
|
"$ref": "../definitions/Error.json"
|
||||||
|
},
|
||||||
|
"example": {
|
||||||
|
"title": "Invalid URL",
|
||||||
|
"type": "INVALID_URL",
|
||||||
|
"detail": "Provided URL foo is invalid. Try with a different one.",
|
||||||
|
"status": 400,
|
||||||
|
"url": "https://invalid-url.com"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"text/plain": {
|
"text/plain": {
|
||||||
"schema": {
|
"schema": {
|
||||||
"type": "string"
|
"type": "string"
|
||||||
}
|
},
|
||||||
|
"example": "INVALID_URL"
|
||||||
}
|
}
|
||||||
},
|
|
||||||
"examples": {
|
|
||||||
"application/problem+json": {
|
|
||||||
"title": "Invalid URL",
|
|
||||||
"type": "INVALID_URL",
|
|
||||||
"detail": "Provided URL foo is invalid. Try with a different one.",
|
|
||||||
"status": 400,
|
|
||||||
"url": "https://invalid-url.com"
|
|
||||||
},
|
|
||||||
"text/plain": "INVALID_URL"
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"500": {
|
"500": {
|
||||||
@ -118,13 +114,6 @@
|
|||||||
"type": "string"
|
"type": "string"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
|
||||||
"examples": {
|
|
||||||
"application/problem+json": {
|
|
||||||
"error": "INTERNAL_SERVER_ERROR",
|
|
||||||
"message": "Unexpected error occurred"
|
|
||||||
},
|
|
||||||
"text/plain": "INTERNAL_SERVER_ERROR"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@ -35,27 +35,25 @@
|
|||||||
"application/json": {
|
"application/json": {
|
||||||
"schema": {
|
"schema": {
|
||||||
"$ref": "../definitions/ShortUrl.json"
|
"$ref": "../definitions/ShortUrl.json"
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"examples": {
|
|
||||||
"application/json": {
|
|
||||||
"shortCode": "12Kb3",
|
|
||||||
"shortUrl": "https://doma.in/12Kb3",
|
|
||||||
"longUrl": "https://shlink.io",
|
|
||||||
"dateCreated": "2016-05-01T20:34:16+02:00",
|
|
||||||
"visitsCount": 1029,
|
|
||||||
"tags": [
|
|
||||||
"shlink"
|
|
||||||
],
|
|
||||||
"meta": {
|
|
||||||
"validSince": "2017-01-21T00:00:00+02:00",
|
|
||||||
"validUntil": null,
|
|
||||||
"maxVisits": 100
|
|
||||||
},
|
},
|
||||||
"domain": null,
|
"example": {
|
||||||
"title": null,
|
"shortCode": "12Kb3",
|
||||||
"crawlable": false
|
"shortUrl": "https://doma.in/12Kb3",
|
||||||
|
"longUrl": "https://shlink.io",
|
||||||
|
"dateCreated": "2016-05-01T20:34:16+02:00",
|
||||||
|
"visitsCount": 1029,
|
||||||
|
"tags": [
|
||||||
|
"shlink"
|
||||||
|
],
|
||||||
|
"meta": {
|
||||||
|
"validSince": "2017-01-21T00:00:00+02:00",
|
||||||
|
"validUntil": null,
|
||||||
|
"maxVisits": 100
|
||||||
|
},
|
||||||
|
"domain": null,
|
||||||
|
"title": null,
|
||||||
|
"crawlable": false
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
@ -129,27 +127,25 @@
|
|||||||
"application/json": {
|
"application/json": {
|
||||||
"schema": {
|
"schema": {
|
||||||
"$ref": "../definitions/ShortUrl.json"
|
"$ref": "../definitions/ShortUrl.json"
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"examples": {
|
|
||||||
"application/json": {
|
|
||||||
"shortCode": "12Kb3",
|
|
||||||
"shortUrl": "https://doma.in/12Kb3",
|
|
||||||
"longUrl": "https://shlink.io",
|
|
||||||
"dateCreated": "2016-05-01T20:34:16+02:00",
|
|
||||||
"visitsCount": 1029,
|
|
||||||
"tags": [
|
|
||||||
"shlink"
|
|
||||||
],
|
|
||||||
"meta": {
|
|
||||||
"validSince": "2017-01-21T00:00:00+02:00",
|
|
||||||
"validUntil": null,
|
|
||||||
"maxVisits": 100
|
|
||||||
},
|
},
|
||||||
"domain": null,
|
"example": {
|
||||||
"title": "Shlink - The URL shortener",
|
"shortCode": "12Kb3",
|
||||||
"crawlable": false
|
"shortUrl": "https://doma.in/12Kb3",
|
||||||
|
"longUrl": "https://shlink.io",
|
||||||
|
"dateCreated": "2016-05-01T20:34:16+02:00",
|
||||||
|
"visitsCount": 1029,
|
||||||
|
"tags": [
|
||||||
|
"shlink"
|
||||||
|
],
|
||||||
|
"meta": {
|
||||||
|
"validSince": "2017-01-21T00:00:00+02:00",
|
||||||
|
"validUntil": null,
|
||||||
|
"maxVisits": 100
|
||||||
|
},
|
||||||
|
"domain": null,
|
||||||
|
"title": "Shlink - The URL shortener",
|
||||||
|
"crawlable": false
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
@ -247,17 +243,39 @@
|
|||||||
"content": {
|
"content": {
|
||||||
"application/problem+json": {
|
"application/problem+json": {
|
||||||
"schema": {
|
"schema": {
|
||||||
"$ref": "../definitions/Error.json"
|
"allOf": [
|
||||||
|
{
|
||||||
|
"$ref": "../definitions/Error.json"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "object",
|
||||||
|
"required": ["shortCode", "threshold"],
|
||||||
|
"properties": {
|
||||||
|
"shortCode": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "The short code with which we tried to find the short URL to delete"
|
||||||
|
},
|
||||||
|
"domain": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "The domain with which we tried to find the short URL to delete"
|
||||||
|
},
|
||||||
|
"threshold": {
|
||||||
|
"type": "number",
|
||||||
|
"description": "The amount of visits currently configured as threshold to allow deleting short UYRLs or not"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"example": {
|
||||||
|
"title": "Cannot delete short URL",
|
||||||
|
"type": "INVALID_SHORTCODE_DELETION",
|
||||||
|
"detail": "Impossible to delete short URL with short code \"abc123\", since it has more than \"15\" visits.",
|
||||||
|
"status": 422,
|
||||||
|
"shortCode": "abc123",
|
||||||
|
"threshold": 15
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
|
||||||
"examples": {
|
|
||||||
"application/problem+json": {
|
|
||||||
"title": "Cannot delete short URL",
|
|
||||||
"type": "INVALID_SHORTCODE_DELETION",
|
|
||||||
"detail": "It is not possible to delete URL with short code \"abc123\" because it has reached more than \"15\" visits.",
|
|
||||||
"status": 422
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"404": {
|
"404": {
|
||||||
|
|||||||
@ -69,14 +69,6 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
|
||||||
"examples": {
|
|
||||||
"application/json": {
|
|
||||||
"tags": [
|
|
||||||
"games",
|
|
||||||
"tech"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"400": {
|
"400": {
|
||||||
|
|||||||
@ -97,49 +97,47 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
},
|
||||||
}
|
"example": {
|
||||||
},
|
"visits": {
|
||||||
"examples": {
|
"data": [
|
||||||
"application/json": {
|
{
|
||||||
"visits": {
|
"referer": "https://twitter.com",
|
||||||
"data": [
|
"date": "2015-08-20T05:05:03+04:00",
|
||||||
{
|
"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://twitter.com",
|
"visitLocation": null,
|
||||||
"date": "2015-08-20T05:05:03+04:00",
|
"potentialBot": false
|
||||||
"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",
|
|
||||||
"visitLocation": null,
|
|
||||||
"potentialBot": false
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"referer": "https://t.co",
|
|
||||||
"date": "2015-08-20T05:05:03+04:00",
|
|
||||||
"userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36",
|
|
||||||
"visitLocation": {
|
|
||||||
"cityName": "Cupertino",
|
|
||||||
"countryCode": "US",
|
|
||||||
"countryName": "United States",
|
|
||||||
"latitude": 37.3042,
|
|
||||||
"longitude": -122.0946,
|
|
||||||
"regionName": "California",
|
|
||||||
"timezone": "America/Los_Angeles"
|
|
||||||
},
|
},
|
||||||
"potentialBot": false
|
{
|
||||||
},
|
"referer": "https://t.co",
|
||||||
{
|
"date": "2015-08-20T05:05:03+04:00",
|
||||||
"referer": null,
|
"userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36",
|
||||||
"date": "2015-08-20T05:05:03+04:00",
|
"visitLocation": {
|
||||||
"userAgent": "some_web_crawler/1.4",
|
"cityName": "Cupertino",
|
||||||
"visitLocation": null,
|
"countryCode": "US",
|
||||||
"potentialBot": true
|
"countryName": "United States",
|
||||||
|
"latitude": 37.3042,
|
||||||
|
"longitude": -122.0946,
|
||||||
|
"regionName": "California",
|
||||||
|
"timezone": "America/Los_Angeles"
|
||||||
|
},
|
||||||
|
"potentialBot": false
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"referer": null,
|
||||||
|
"date": "2015-08-20T05:05:03+04:00",
|
||||||
|
"userAgent": "some_web_crawler/1.4",
|
||||||
|
"visitLocation": null,
|
||||||
|
"potentialBot": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"pagination": {
|
||||||
|
"currentPage": 5,
|
||||||
|
"pagesCount": 12,
|
||||||
|
"itemsPerPage": 10,
|
||||||
|
"itemsInCurrentPage": 10,
|
||||||
|
"totalItems": 115
|
||||||
}
|
}
|
||||||
],
|
|
||||||
"pagination": {
|
|
||||||
"currentPage": 5,
|
|
||||||
"pagesCount": 12,
|
|
||||||
"itemsPerPage": 10,
|
|
||||||
"itemsInCurrentPage": 10,
|
|
||||||
"totalItems": 115
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@ -57,18 +57,42 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
},
|
||||||
}
|
"examples": {
|
||||||
},
|
"Without stats": {
|
||||||
"examples": {
|
"value": {
|
||||||
"application/json": {
|
"tags": {
|
||||||
"tags": {
|
"data": [
|
||||||
"data": [
|
"games",
|
||||||
"games",
|
"php",
|
||||||
"php",
|
"shlink",
|
||||||
"shlink",
|
"tech"
|
||||||
"tech"
|
]
|
||||||
]
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"With stats": {
|
||||||
|
"value": {
|
||||||
|
"tags": {
|
||||||
|
"data": [
|
||||||
|
"games",
|
||||||
|
"shlink"
|
||||||
|
],
|
||||||
|
"stats": [
|
||||||
|
{
|
||||||
|
"tag": "games",
|
||||||
|
"shortUrlsCount": 10,
|
||||||
|
"visitsCount": 521
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"tag": "shlink",
|
||||||
|
"shortUrlsCount": 7,
|
||||||
|
"visitsCount": 1087
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -149,18 +173,6 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
|
||||||
"examples": {
|
|
||||||
"application/json": {
|
|
||||||
"tags": {
|
|
||||||
"data": [
|
|
||||||
"games",
|
|
||||||
"php",
|
|
||||||
"shlink",
|
|
||||||
"tech"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"500": {
|
"500": {
|
||||||
|
|||||||
@ -53,45 +53,43 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
},
|
||||||
}
|
"example": {
|
||||||
},
|
"domains": {
|
||||||
"examples": {
|
"data": [
|
||||||
"application/json": {
|
{
|
||||||
"domains": {
|
"domain": "example.com",
|
||||||
"data": [
|
"isDefault": true,
|
||||||
{
|
"redirects": {
|
||||||
"domain": "example.com",
|
"baseUrlRedirect": "https://example.com/my-landing-page",
|
||||||
"isDefault": true,
|
"regular404Redirect": null,
|
||||||
"redirects": {
|
"invalidShortUrlRedirect": "https://example.com/invalid-url"
|
||||||
"baseUrlRedirect": "https://example.com/my-landing-page",
|
}
|
||||||
"regular404Redirect": null,
|
},
|
||||||
"invalidShortUrlRedirect": "https://example.com/invalid-url"
|
{
|
||||||
}
|
"domain": "aaa.com",
|
||||||
},
|
"isDefault": false,
|
||||||
{
|
"redirects": {
|
||||||
"domain": "aaa.com",
|
"baseUrlRedirect": null,
|
||||||
"isDefault": false,
|
"regular404Redirect": null,
|
||||||
"redirects": {
|
"invalidShortUrlRedirect": null
|
||||||
"baseUrlRedirect": null,
|
}
|
||||||
"regular404Redirect": null,
|
},
|
||||||
"invalidShortUrlRedirect": null
|
{
|
||||||
}
|
"domain": "bbb.com",
|
||||||
},
|
"isDefault": false,
|
||||||
{
|
"redirects": {
|
||||||
"domain": "bbb.com",
|
"baseUrlRedirect": null,
|
||||||
"isDefault": false,
|
"regular404Redirect": null,
|
||||||
"redirects": {
|
"invalidShortUrlRedirect": "https://example.com/invalid-url"
|
||||||
"baseUrlRedirect": null,
|
}
|
||||||
"regular404Redirect": null,
|
|
||||||
"invalidShortUrlRedirect": "https://example.com/invalid-url"
|
|
||||||
}
|
}
|
||||||
|
],
|
||||||
|
"defaultRedirects": {
|
||||||
|
"baseUrlRedirect": "https://somewhere.com",
|
||||||
|
"regular404Redirect": null,
|
||||||
|
"invalidShortUrlRedirect": null
|
||||||
}
|
}
|
||||||
],
|
|
||||||
"defaultRedirects": {
|
|
||||||
"baseUrlRedirect": "https://somewhere.com",
|
|
||||||
"regular404Redirect": null,
|
|
||||||
"invalidShortUrlRedirect": null
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@ -55,15 +55,13 @@
|
|||||||
"$ref": "../definitions/NotFoundRedirects.json"
|
"$ref": "../definitions/NotFoundRedirects.json"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
},
|
||||||
|
"example": {
|
||||||
|
"baseUrlRedirect": "https://example.com/my-landing-page",
|
||||||
|
"regular404Redirect": null,
|
||||||
|
"invalidShortUrlRedirect": "https://example.com/invalid-url"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
|
||||||
"examples": {
|
|
||||||
"application/json": {
|
|
||||||
"baseUrlRedirect": "https://example.com/my-landing-page",
|
|
||||||
"regular404Redirect": null,
|
|
||||||
"invalidShortUrlRedirect": "https://example.com/invalid-url"
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"400": {
|
"400": {
|
||||||
|
|||||||
@ -23,15 +23,13 @@
|
|||||||
"application/json": {
|
"application/json": {
|
||||||
"schema": {
|
"schema": {
|
||||||
"$ref": "../definitions/MercureInfo.json"
|
"$ref": "../definitions/MercureInfo.json"
|
||||||
|
},
|
||||||
|
"example": {
|
||||||
|
"mercureHubUrl": "https://example.com/.well-known/mercure",
|
||||||
|
"jwt": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJTaGxpbmsiLCJpYXQiOjE1ODY2ODY3MzIsImV4cCI6MTU4Njk0NTkzMiwibWVyY3VyZSI6eyJzdWJzY3JpYmUiOltdfX0.P-519lgU7dFz0bbNlRG1CXyqugGbaHon4kw6fu4QBdQ",
|
||||||
|
"jwtExpiration": "2020-04-15T12:18:52+02:00"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
|
||||||
"examples": {
|
|
||||||
"application/json": {
|
|
||||||
"mercureHubUrl": "https://example.com/.well-known/mercure",
|
|
||||||
"jwt": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJTaGxpbmsiLCJpYXQiOjE1ODY2ODY3MzIsImV4cCI6MTU4Njk0NTkzMiwibWVyY3VyZSI6eyJzdWJzY3JpYmUiOltdfX0.P-519lgU7dFz0bbNlRG1CXyqugGbaHon4kw6fu4QBdQ",
|
|
||||||
"jwtExpiration": "2020-04-15T12:18:52+02:00"
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"501": {
|
"501": {
|
||||||
@ -40,16 +38,14 @@
|
|||||||
"application/problem+json": {
|
"application/problem+json": {
|
||||||
"schema": {
|
"schema": {
|
||||||
"$ref": "../definitions/Error.json"
|
"$ref": "../definitions/Error.json"
|
||||||
|
},
|
||||||
|
"example": {
|
||||||
|
"title": "Mercure integration not configured",
|
||||||
|
"type": "MERCURE_NOT_CONFIGURED",
|
||||||
|
"detail": "This Shlink instance is not integrated with a mercure hub.",
|
||||||
|
"status": 501
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
|
||||||
"examples": {
|
|
||||||
"application/json": {
|
|
||||||
"title": "Mercure integration not configured",
|
|
||||||
"type": "MERCURE_NOT_CONFIGURED",
|
|
||||||
"detail": "This Shlink instance is not integrated with a mercure hub.",
|
|
||||||
"status": 501
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"500": {
|
"500": {
|
||||||
|
|||||||
@ -94,49 +94,47 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
},
|
||||||
}
|
"example": {
|
||||||
},
|
"visits": {
|
||||||
"examples": {
|
"data": [
|
||||||
"application/json": {
|
{
|
||||||
"visits": {
|
"referer": "https://twitter.com",
|
||||||
"data": [
|
"date": "2015-08-20T05:05:03+04:00",
|
||||||
{
|
"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://twitter.com",
|
"visitLocation": null,
|
||||||
"date": "2015-08-20T05:05:03+04:00",
|
"potentialBot": false
|
||||||
"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",
|
|
||||||
"visitLocation": null,
|
|
||||||
"potentialBot": false
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"referer": "https://t.co",
|
|
||||||
"date": "2015-08-20T05:05:03+04:00",
|
|
||||||
"userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36",
|
|
||||||
"visitLocation": {
|
|
||||||
"cityName": "Cupertino",
|
|
||||||
"countryCode": "US",
|
|
||||||
"countryName": "United States",
|
|
||||||
"latitude": 37.3042,
|
|
||||||
"longitude": -122.0946,
|
|
||||||
"regionName": "California",
|
|
||||||
"timezone": "America/Los_Angeles"
|
|
||||||
},
|
},
|
||||||
"potentialBot": false
|
{
|
||||||
},
|
"referer": "https://t.co",
|
||||||
{
|
"date": "2015-08-20T05:05:03+04:00",
|
||||||
"referer": null,
|
"userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36",
|
||||||
"date": "2015-08-20T05:05:03+04:00",
|
"visitLocation": {
|
||||||
"userAgent": "some_web_crawler/1.4",
|
"cityName": "Cupertino",
|
||||||
"visitLocation": null,
|
"countryCode": "US",
|
||||||
"potentialBot": true
|
"countryName": "United States",
|
||||||
|
"latitude": 37.3042,
|
||||||
|
"longitude": -122.0946,
|
||||||
|
"regionName": "California",
|
||||||
|
"timezone": "America/Los_Angeles"
|
||||||
|
},
|
||||||
|
"potentialBot": false
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"referer": null,
|
||||||
|
"date": "2015-08-20T05:05:03+04:00",
|
||||||
|
"userAgent": "some_web_crawler/1.4",
|
||||||
|
"visitLocation": null,
|
||||||
|
"potentialBot": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"pagination": {
|
||||||
|
"currentPage": 5,
|
||||||
|
"pagesCount": 12,
|
||||||
|
"itemsPerPage": 10,
|
||||||
|
"itemsInCurrentPage": 10,
|
||||||
|
"totalItems": 115
|
||||||
}
|
}
|
||||||
],
|
|
||||||
"pagination": {
|
|
||||||
"currentPage": 5,
|
|
||||||
"pagesCount": 12,
|
|
||||||
"itemsPerPage": 10,
|
|
||||||
"itemsInCurrentPage": 10,
|
|
||||||
"totalItems": 115
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@ -28,14 +28,12 @@
|
|||||||
"$ref": "../definitions/VisitStats.json"
|
"$ref": "../definitions/VisitStats.json"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
},
|
||||||
}
|
"example": {
|
||||||
},
|
"visits": {
|
||||||
"examples": {
|
"visitsCount": 1569874,
|
||||||
"application/json": {
|
"orphanVisitsCount": 71345
|
||||||
"visits": {
|
}
|
||||||
"visitsCount": 1569874,
|
|
||||||
"orphanVisitsCount": 71345
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@ -85,55 +85,53 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
},
|
||||||
}
|
"example": {
|
||||||
},
|
"visits": {
|
||||||
"examples": {
|
"data": [
|
||||||
"application/json": {
|
{
|
||||||
"visits": {
|
"referer": "https://twitter.com",
|
||||||
"data": [
|
"date": "2015-08-20T05:05:03+04:00",
|
||||||
{
|
"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://twitter.com",
|
"visitLocation": null,
|
||||||
"date": "2015-08-20T05:05:03+04:00",
|
"potentialBot": false,
|
||||||
"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",
|
"visitedUrl": "https://doma.in",
|
||||||
"visitLocation": null,
|
"type": "base_url"
|
||||||
"potentialBot": false,
|
|
||||||
"visitedUrl": "https://doma.in",
|
|
||||||
"type": "base_url"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"referer": "https://t.co",
|
|
||||||
"date": "2015-08-20T05:05:03+04:00",
|
|
||||||
"userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36",
|
|
||||||
"visitLocation": {
|
|
||||||
"cityName": "Cupertino",
|
|
||||||
"countryCode": "US",
|
|
||||||
"countryName": "United States",
|
|
||||||
"latitude": 37.3042,
|
|
||||||
"longitude": -122.0946,
|
|
||||||
"regionName": "California",
|
|
||||||
"timezone": "America/Los_Angeles"
|
|
||||||
},
|
},
|
||||||
"potentialBot": false,
|
{
|
||||||
"visitedUrl": "https://doma.in/foo",
|
"referer": "https://t.co",
|
||||||
"type": "invalid_short_url"
|
"date": "2015-08-20T05:05:03+04:00",
|
||||||
},
|
"userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36",
|
||||||
{
|
"visitLocation": {
|
||||||
"referer": null,
|
"cityName": "Cupertino",
|
||||||
"date": "2015-08-20T05:05:03+04:00",
|
"countryCode": "US",
|
||||||
"userAgent": "some_web_crawler/1.4",
|
"countryName": "United States",
|
||||||
"visitLocation": null,
|
"latitude": 37.3042,
|
||||||
"potentialBot": true,
|
"longitude": -122.0946,
|
||||||
"visitedUrl": "https://doma.in/foo/bar/baz",
|
"regionName": "California",
|
||||||
"type": "regular_404"
|
"timezone": "America/Los_Angeles"
|
||||||
|
},
|
||||||
|
"potentialBot": false,
|
||||||
|
"visitedUrl": "https://doma.in/foo",
|
||||||
|
"type": "invalid_short_url"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"referer": null,
|
||||||
|
"date": "2015-08-20T05:05:03+04:00",
|
||||||
|
"userAgent": "some_web_crawler/1.4",
|
||||||
|
"visitLocation": null,
|
||||||
|
"potentialBot": true,
|
||||||
|
"visitedUrl": "https://doma.in/foo/bar/baz",
|
||||||
|
"type": "regular_404"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"pagination": {
|
||||||
|
"currentPage": 5,
|
||||||
|
"pagesCount": 12,
|
||||||
|
"itemsPerPage": 10,
|
||||||
|
"itemsInCurrentPage": 10,
|
||||||
|
"totalItems": 115
|
||||||
}
|
}
|
||||||
],
|
|
||||||
"pagination": {
|
|
||||||
"currentPage": 5,
|
|
||||||
"pagesCount": 12,
|
|
||||||
"itemsPerPage": 10,
|
|
||||||
"itemsInCurrentPage": 10,
|
|
||||||
"totalItems": 115
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user