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..17b5bc23 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 URLs.
**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.
**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.
**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 89%
rename from docs/swagger/paths/v1_short-codes_{shortCode}.json
rename to docs/swagger/paths/v1_short-urls_{shortCode}.json
index e6ad06f2..3ff49443 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 URL's short code.
**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.
**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.
**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.",
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.
**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.
**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"
}
}
}