mirrors/shlink
1
0
Fork 0
mirror of https://github.com/shlinkio/shlink.git synced 2024-11-27 16:26:37 +03:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #217 from acelaya/feature/deprecated-endpoints

Browse source 
Noticed that old endpoints will keep working
This commit is contained in:
Alejandro Celaya 2018-09-24 23:05:38 +02:00 committed by GitHub
commit 2241279bb6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 16 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/swagger/paths/v1_short-codes.json → docs/swagger/paths/v1_short-urls.json
View file

@ -5,7 +5,7 @@
"Short URLs"
],
"summary": "List short URLs",
"description": "Returns the list of short codes",
"description": "Returns the list of short URLs.<br><br>**Important note**: Before shlink v1.13, this endpoint used to use the `/short-codes` path instead of `/short-urls`. Both of them will keep working, while the first one is considered deprecated.",
"parameters": [
{
"name": "page",
@ -148,7 +148,7 @@
"Short URLs"
],
"summary": "Create short URL",
"description": "Creates a new short code",
"description": "Creates a new short URL.<br><br>**Important note**: Before shlink v1.13, this endpoint used to use the `/short-codes` path instead of `/short-urls`. Both of them will keep working, while the first one is considered deprecated.",
"security": [
{
"Bearer": []

2
docs/swagger/paths/v1_short-codes_shorten.json → docs/swagger/paths/v1_short-urls_shorten.json
View file

@ -5,7 +5,7 @@
"Short URLs"
],
"summary": "Create a short URL",
"description": "Creates a short URL in a single API call. Useful for third party integrations",
"description": "Creates a short URL in a single API call. Useful for third party integrations.<br><br>**Important note**: Before shlink v1.13, this endpoint used to use the `/short-codes` path instead of `/short-urls`. Both of them will keep working, while the first one is considered deprecated.",
"parameters": [
{
"name": "apiKey",

12
docs/swagger/paths/v1_short-codes_{shortCode}.json → docs/swagger/paths/v1_short-urls_{shortCode}.json
View file

@ -5,7 +5,7 @@
"Short URLs"
],
"summary": "Parse short code",
"description": "Get the long URL behind a short code.",
"description": "Get the long URL behind a short URL's short code.<br><br>**Important note**: Before shlink v1.13, this endpoint used to use the `/short-codes` path instead of `/short-urls`. Both of them will keep working, while the first one is considered deprecated.",
"parameters": [
{
"name": "shortCode",
@ -83,8 +83,8 @@
"tags": [
"Short URLs"
],
"summary": "Edit short code",
"description": "Update certain meta arguments from an existing short URL.",
"summary": "Edit short URL",
"description": "Update certain meta arguments from an existing short URL.<br><br>**Important note**: Before shlink v1.13, this endpoint used to use the `/short-codes` path instead of `/short-urls`. Both of them will keep working, while the first one is considered deprecated.",
"parameters": [
{
"name": "shortCode",
@ -168,8 +168,8 @@
"tags": [
"Short URLs"
],
"summary": "Delete short code",
"description": "Deletes the short URL for provided short code.",
"summary": "Delete short URL",
"description": "Deletes the short URL for provided short code.<br><br>**Important note**: Before shlink v1.13, this endpoint used to use the `/short-codes` path instead of `/short-urls`. Both of them will keep working, while the first one is considered deprecated.",
"parameters": [
{
"name": "shortCode",
@ -188,7 +188,7 @@
],
"responses": {
"204": {
"description": "The short code has been properly deleted."
"description": "The short URL has been properly deleted."
},
"400": {
"description": "The visits threshold in shlink does not allow this short URL to be deleted.",

2
docs/swagger/paths/v1_short-codes_{shortCode}_tags.json → docs/swagger/paths/v1_short-urls_{shortCode}_tags.json
View file

@ -5,7 +5,7 @@
"Short URLs"
],
"summary": "Edit tags on short URL",
"description": "Edit the tags on provided short code.",
"description": "Edit the tags on URL identified by provided short code.<br><br>**Important note**: Before shlink v1.13, this endpoint used to use the `/short-codes` path instead of `/short-urls`. Both of them will keep working, while the first one is considered deprecated.",
"parameters": [
{
"name": "shortCode",

2
docs/swagger/paths/v1_short-codes_{shortCode}_visits.json → docs/swagger/paths/v1_short-urls_{shortCode}_visits.json
View file

@ -5,7 +5,7 @@
"Visits"
],
"summary": "List visits for short URL",
"description": "Get the list of visits on provided short code.",
"description": "Get the list of visits on the short URL behind provided short code.<br><br>**Important note**: Before shlink v1.13, this endpoint used to use the `/short-codes` path instead of `/short-urls`. Both of them will keep working, while the first one is considered deprecated.",
"parameters": [
{
"name": "shortCode",

10
docs/swagger/swagger.json
View file

@ -57,16 +57,16 @@
},
"/v1/short-urls": {
"$ref": "paths/v1_short-codes.json"
"$ref": "paths/v1_short-urls.json"
},
"/v1/short-urls/shorten": {
"$ref": "paths/v1_short-codes_shorten.json"
"$ref": "paths/v1_short-urls_shorten.json"
},
"/v1/short-urls/{shortCode}": {
"$ref": "paths/v1_short-codes_{shortCode}.json"
"$ref": "paths/v1_short-urls_{shortCode}.json"
},
"/v1/short-urls/{shortCode}/tags": {
"$ref": "paths/v1_short-codes_{shortCode}_tags.json"
"$ref": "paths/v1_short-urls_{shortCode}_tags.json"
},
"/v1/tags": {
@ -74,7 +74,7 @@
},
"/v1/short-urls/{shortCode}/visits": {
"$ref": "paths/v1_short-codes_{shortCode}_visits.json"
"$ref": "paths/v1_short-urls_{shortCode}_visits.json"
}
}
}