mirrors/shlink
1
0
Fork 0
mirror of https://github.com/shlinkio/shlink.git synced 2025-03-14 04:00:57 +03:00
Code Issues Projects Releases Packages Wiki Activity

Documented crawlable prop in API specs

Browse source
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
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docs/async-api/async-api.json
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": {

4
docs/swagger/definitions/ShortUrl.json
View file

@ -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."
}
}
}

13
docs/swagger/paths/v1_short-urls.json
View file

@ -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
}
}
},

3
docs/swagger/paths/v1_short-urls_shorten.json
View file

@ -74,7 +74,8 @@
"maxVisits": 100
},
"domain": null,
"title": null
"title": null,
"crawlable": false
},
"text/plain": "https://doma.in/abc123"
}

6
docs/swagger/paths/v1_short-urls_{shortCode}.json
View file

@ -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
}
}
},