jasima/majuna
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc(rdr): adds new parameters for /link

Browse source
This commit is contained in:
Iain Learmonth 2024-07-12 15:22:50 +01:00
parent 08bba74c34
commit 2d549fb823
1 changed files with 6 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

7
docs/admin/redirector/http.rst
View file

@ -66,8 +66,13 @@ Generate a short link or a direct mirror link.
Query Parameters:
- `url` (required): The URL for which a link needs to be generated.
- `type` (optional): The type of link to generate. Valid values are "direct" or "short". If not provided, "direct" is used.
- `type` (optional): The type of link to generate. Valid values are "direct", "short", or "getsitecopy". If not provided, "direct" is used.
- `key` (optional): The API key of the pool. If not provided, the public API key is used.
- `expiry` (optional): The duration that a GetSiteCopy article will remain published for. Valid values are "long" and "short". If not provided, "short" is used.
- `footer_text` (optional): Defines the footer text to be used when publishing a GetSiteCopy article.
- `footer_link` (optional): Defines the footer link to be used when publishing a GetSiteCopy article.
When neither `footer_text` or `footer_link` are specified, if a mirror link is available to the site's homepage, this will be used for the footer link.
Response: