Documented crawlable prop in API specs

This commit is contained in:
Alejandro Celaya
2021-05-22 07:32:47 +02:00
parent 7280b48cdc
commit 2e6b3c0561
5 changed files with 31 additions and 8 deletions

View File

@@ -116,6 +116,15 @@
"domain": {
"type": "string",
"description": "The domain in which the short URL was created. Null if it belongs to default domain."
},
"title": {
"type": "string",
"nullable": true,
"description": "A descriptive title of the short URL."
},
"crawlable": {
"type": "boolean",
"description": "Tells if this URL will be included as 'Allow' in Shlink's robots.txt."
}
},
"example": {
@@ -133,7 +142,9 @@
"validUntil": null,
"maxVisits": 100
},
"domain": "example.com"
"domain": "example.com",
"title": "The title",
"crawlable": false
}
},
"ShortUrlMeta": {