From 8784843a7aab0a54038f57c56cc0f68ea780940d Mon Sep 17 00:00:00 2001
From: Alejandro Celaya <alejandro@alejandrocelaya.com>
Date: Mon, 24 Sep 2018 22:49:30 +0200
Subject: [PATCH] Noticed that old endpoints will keep working
---
.../paths/{v1_short-codes.json => v1_short-urls.json} | 4 ++--
...t-codes_shorten.json => v1_short-urls_shorten.json} | 2 +-
...{shortCode}.json => v1_short-urls_{shortCode}.json} | 6 +++---
...}_tags.json => v1_short-urls_{shortCode}_tags.json} | 2 +-
...sits.json => v1_short-urls_{shortCode}_visits.json} | 2 +-
docs/swagger/swagger.json | 10 +++++-----
6 files changed, 13 insertions(+), 13 deletions(-)
rename docs/swagger/paths/{v1_short-codes.json => v1_short-urls.json} (94%)
rename docs/swagger/paths/{v1_short-codes_shorten.json => v1_short-urls_shorten.json} (94%)
rename docs/swagger/paths/{v1_short-codes_{shortCode}.json => v1_short-urls_{shortCode}.json} (91%)
rename docs/swagger/paths/{v1_short-codes_{shortCode}_tags.json => v1_short-urls_{shortCode}_tags.json} (92%)
rename docs/swagger/paths/{v1_short-codes_{shortCode}_visits.json => v1_short-urls_{shortCode}_visits.json} (94%)
diff --git a/docs/swagger/paths/v1_short-codes.json b/docs/swagger/paths/v1_short-urls.json
similarity index 94%
rename from docs/swagger/paths/v1_short-codes.json
rename to docs/swagger/paths/v1_short-urls.json
index 80c950e8..36355f54 100644
--- a/docs/swagger/paths/v1_short-codes.json
+++ b/docs/swagger/paths/v1_short-urls.json
@@ -5,7 +5,7 @@
"Short URLs"
],
"summary": "List short URLs",
- "description": "Returns the list of short codes",
+ "description": "Returns the list of short codes.<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": []
diff --git a/docs/swagger/paths/v1_short-codes_shorten.json b/docs/swagger/paths/v1_short-urls_shorten.json
similarity index 94%
rename from docs/swagger/paths/v1_short-codes_shorten.json
rename to docs/swagger/paths/v1_short-urls_shorten.json
index cb3fd18b..6c736251 100644
--- a/docs/swagger/paths/v1_short-codes_shorten.json
+++ b/docs/swagger/paths/v1_short-urls_shorten.json
@@ -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",
diff --git a/docs/swagger/paths/v1_short-codes_{shortCode}.json b/docs/swagger/paths/v1_short-urls_{shortCode}.json
similarity index 91%
rename from docs/swagger/paths/v1_short-codes_{shortCode}.json
rename to docs/swagger/paths/v1_short-urls_{shortCode}.json
index e6ad06f2..ee2735c8 100644
--- a/docs/swagger/paths/v1_short-codes_{shortCode}.json
+++ b/docs/swagger/paths/v1_short-urls_{shortCode}.json
@@ -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 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",
@@ -84,7 +84,7 @@
"Short URLs"
],
"summary": "Edit short code",
- "description": "Update certain meta arguments from an existing 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",
@@ -169,7 +169,7 @@
"Short URLs"
],
"summary": "Delete short code",
- "description": "Deletes the short URL for provided short code.",
+ "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",
diff --git a/docs/swagger/paths/v1_short-codes_{shortCode}_tags.json b/docs/swagger/paths/v1_short-urls_{shortCode}_tags.json
similarity index 92%
rename from docs/swagger/paths/v1_short-codes_{shortCode}_tags.json
rename to docs/swagger/paths/v1_short-urls_{shortCode}_tags.json
index d3bb8b86..89bdd0fd 100644
--- a/docs/swagger/paths/v1_short-codes_{shortCode}_tags.json
+++ b/docs/swagger/paths/v1_short-urls_{shortCode}_tags.json
@@ -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",
diff --git a/docs/swagger/paths/v1_short-codes_{shortCode}_visits.json b/docs/swagger/paths/v1_short-urls_{shortCode}_visits.json
similarity index 94%
rename from docs/swagger/paths/v1_short-codes_{shortCode}_visits.json
rename to docs/swagger/paths/v1_short-urls_{shortCode}_visits.json
index a59fd5d4..1383edfd 100644
--- a/docs/swagger/paths/v1_short-codes_{shortCode}_visits.json
+++ b/docs/swagger/paths/v1_short-urls_{shortCode}_visits.json
@@ -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",
diff --git a/docs/swagger/swagger.json b/docs/swagger/swagger.json
index 8dec455c..ba8da350 100644
--- a/docs/swagger/swagger.json
+++ b/docs/swagger/swagger.json
@@ -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"
}
}
}