Updated async API docs

This commit is contained in:
Alejandro Celaya 2023-01-02 20:02:50 +01:00
parent a5929ebb29
commit 0b96a79c41

View File

@ -116,7 +116,11 @@
"format": "date-time", "format": "date-time",
"description": "The date in which the short URL was created in ISO format." "description": "The date in which the short URL was created in ISO format."
}, },
"visitsSummary": {
"$ref": "#/components/schemas/VisitsSummary"
},
"visitsCount": { "visitsCount": {
"deprecated": true,
"type": "integer", "type": "integer",
"description": "The number of visits that this short URL has received." "description": "The number of visits that this short URL has received."
}, },
@ -149,7 +153,11 @@
"shortUrl": "https://doma.in/12C18", "shortUrl": "https://doma.in/12C18",
"longUrl": "https://store.steampowered.com", "longUrl": "https://store.steampowered.com",
"dateCreated": "2016-08-21T20:34:16+02:00", "dateCreated": "2016-08-21T20:34:16+02:00",
"visitsCount": 328, "visitsSummary": {
"total": 328,
"nonBots": 285,
"bots": 43
},
"tags": [ "tags": [
"games", "games",
"tech" "tech"
@ -189,6 +197,24 @@
} }
} }
}, },
"VisitsSummary": {
"type": "object",
"required": ["total", "nonBots", "bots"],
"properties": {
"total": {
"description": "The total amount of visits",
"type": "number"
},
"nonBots": {
"description": "The amount of visits which were not identified as bots",
"type": "number"
},
"bots": {
"description": "The amount of visits that were identified as potential bots",
"type": "number"
}
}
},
"Visit": { "Visit": {
"type": "object", "type": "object",
"properties": { "properties": {