diff --git a/docs/async-api/async-api.json b/docs/async-api/async-api.json index df9bc6d6..3360d897 100644 --- a/docs/async-api/async-api.json +++ b/docs/async-api/async-api.json @@ -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": { diff --git a/docs/swagger/definitions/ShortUrl.json b/docs/swagger/definitions/ShortUrl.json index 3e4c6ead..b2ffd3f6 100644 --- a/docs/swagger/definitions/ShortUrl.json +++ b/docs/swagger/definitions/ShortUrl.json @@ -41,6 +41,10 @@ "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." } } } diff --git a/docs/swagger/paths/v1_short-urls.json b/docs/swagger/paths/v1_short-urls.json index b034dcf3..4d30e4de 100644 --- a/docs/swagger/paths/v1_short-urls.json +++ b/docs/swagger/paths/v1_short-urls.json @@ -140,7 +140,8 @@ "maxVisits": 100 }, "domain": null, - "title": "Welcome to Steam" + "title": "Welcome to Steam", + "crawlable": false }, { "shortCode": "12Kb3", @@ -157,7 +158,8 @@ "maxVisits": null }, "domain": null, - "title": null + "title": null, + "crawlable": false }, { "shortCode": "123bA", @@ -172,7 +174,8 @@ "maxVisits": null }, "domain": "example.com", - "title": null + "title": null, + "crawlable": false } ], "pagination": { @@ -305,7 +308,9 @@ "validUntil": null, "maxVisits": 500 }, - "domain": null + "domain": null, + "title": null, + "crawlable": false } } }, diff --git a/docs/swagger/paths/v1_short-urls_shorten.json b/docs/swagger/paths/v1_short-urls_shorten.json index b6184d8d..90c3eda5 100644 --- a/docs/swagger/paths/v1_short-urls_shorten.json +++ b/docs/swagger/paths/v1_short-urls_shorten.json @@ -74,7 +74,8 @@ "maxVisits": 100 }, "domain": null, - "title": null + "title": null, + "crawlable": false }, "text/plain": "https://doma.in/abc123" } diff --git a/docs/swagger/paths/v1_short-urls_{shortCode}.json b/docs/swagger/paths/v1_short-urls_{shortCode}.json index 2281d9b8..11ff276f 100644 --- a/docs/swagger/paths/v1_short-urls_{shortCode}.json +++ b/docs/swagger/paths/v1_short-urls_{shortCode}.json @@ -54,7 +54,8 @@ "maxVisits": 100 }, "domain": null, - "title": null + "title": null, + "crawlable": false } } }, @@ -184,7 +185,8 @@ "maxVisits": 100 }, "domain": null, - "title": "Shlink - The URL shortener" + "title": "Shlink - The URL shortener", + "crawlable": false } } },