diff --git a/docs/swagger/paths/v1_authenticate.json b/docs/swagger/paths/v1_authenticate.json index 55160087..49a690fb 100644 --- a/docs/swagger/paths/v1_authenticate.json +++ b/docs/swagger/paths/v1_authenticate.json @@ -1,5 +1,6 @@ { "post": { + "operationId": "authenticate", "tags": [ "Authentication" ], diff --git a/docs/swagger/paths/v1_short-codes.json b/docs/swagger/paths/v1_short-codes.json index 48d16a16..80c950e8 100644 --- a/docs/swagger/paths/v1_short-codes.json +++ b/docs/swagger/paths/v1_short-codes.json @@ -1,7 +1,8 @@ { "get": { + "operationId": "listShortUrls", "tags": [ - "ShortCodes" + "Short URLs" ], "summary": "List short URLs", "description": "Returns the list of short codes", @@ -142,8 +143,9 @@ }, "post": { + "operationId": "createShortUrl", "tags": [ - "ShortCodes" + "Short URLs" ], "summary": "Create short URL", "description": "Creates a new short code", diff --git a/docs/swagger/paths/v1_short-codes_shorten.json b/docs/swagger/paths/v1_short-codes_shorten.json index 1ee3387c..cb3fd18b 100644 --- a/docs/swagger/paths/v1_short-codes_shorten.json +++ b/docs/swagger/paths/v1_short-codes_shorten.json @@ -1,7 +1,8 @@ { "get": { + "operationId": "shortenUrl", "tags": [ - "ShortCodes" + "Short URLs" ], "summary": "Create a short URL", "description": "Creates a short URL in a single API call. Useful for third party integrations", diff --git a/docs/swagger/paths/v1_short-codes_{shortCode}.json b/docs/swagger/paths/v1_short-codes_{shortCode}.json index e17881af..e6ad06f2 100644 --- a/docs/swagger/paths/v1_short-codes_{shortCode}.json +++ b/docs/swagger/paths/v1_short-codes_{shortCode}.json @@ -1,7 +1,8 @@ { "get": { + "operationId": "getShortUrl", "tags": [ - "ShortCodes" + "Short URLs" ], "summary": "Parse short code", "description": "Get the long URL behind a short code.", @@ -78,8 +79,9 @@ }, "put": { + "operationId": "editShortUrl", "tags": [ - "ShortCodes" + "Short URLs" ], "summary": "Edit short code", "description": "Update certain meta arguments from an existing short URL.", @@ -162,8 +164,9 @@ }, "delete": { + "operationId": "deleteShortUrl", "tags": [ - "ShortCodes" + "Short URLs" ], "summary": "Delete short code", "description": "Deletes the short URL for provided short code.", diff --git a/docs/swagger/paths/v1_short-codes_{shortCode}_tags.json b/docs/swagger/paths/v1_short-codes_{shortCode}_tags.json index 7a1c1759..95e24038 100644 --- a/docs/swagger/paths/v1_short-codes_{shortCode}_tags.json +++ b/docs/swagger/paths/v1_short-codes_{shortCode}_tags.json @@ -1,8 +1,8 @@ { "put": { + "operationId": "editShortUrlTags", "tags": [ - "ShortCodes", - "Tags" + "Short URLs" ], "summary": "Edit tags on short URL", "description": "Edit the tags on provided short code.", diff --git a/docs/swagger/paths/v1_short-codes_{shortCode}_visits.json b/docs/swagger/paths/v1_short-codes_{shortCode}_visits.json index ec8d372e..c075e774 100644 --- a/docs/swagger/paths/v1_short-codes_{shortCode}_visits.json +++ b/docs/swagger/paths/v1_short-codes_{shortCode}_visits.json @@ -1,7 +1,7 @@ { "get": { + "operationId": "getShortUrlVisits", "tags": [ - "ShortCodes", "Visits" ], "summary": "List visits for short URL", diff --git a/docs/swagger/paths/v1_tags.json b/docs/swagger/paths/v1_tags.json index b33b9606..fb4df70d 100644 --- a/docs/swagger/paths/v1_tags.json +++ b/docs/swagger/paths/v1_tags.json @@ -1,5 +1,6 @@ { "get": { + "operationId": "listTags", "tags": [ "Tags" ], @@ -60,6 +61,7 @@ }, "post": { + "operationId": "createTags", "tags": [ "Tags" ], @@ -143,6 +145,7 @@ }, "put": { + "operationId": "renameTag", "tags": [ "Tags" ], @@ -216,6 +219,7 @@ }, "delete": { + "operationId": "deleteTags", "tags": [ "Tags" ], diff --git a/docs/swagger/swagger.json b/docs/swagger/swagger.json index c5dbd791..8dec455c 100644 --- a/docs/swagger/swagger.json +++ b/docs/swagger/swagger.json @@ -32,21 +32,40 @@ } }, + "tags": [ + { + "name": "Authentication", + "description": "Authentication-related endpoints" + }, + { + "name": "Short URLs", + "description": "Operations that can be performed on short URLs" + }, + { + "name": "Tags", + "description": "Let you handle the list of available tags" + }, + { + "name": "Visits", + "description": "Operations to manage visits on short URLs" + } + ], + "paths": { "/v1/authenticate": { "$ref": "paths/v1_authenticate.json" }, - "/v1/short-codes": { + "/v1/short-urls": { "$ref": "paths/v1_short-codes.json" }, - "/v1/short-codes/shorten": { + "/v1/short-urls/shorten": { "$ref": "paths/v1_short-codes_shorten.json" }, - "/v1/short-codes/{shortCode}": { + "/v1/short-urls/{shortCode}": { "$ref": "paths/v1_short-codes_{shortCode}.json" }, - "/v1/short-codes/{shortCode}/tags": { + "/v1/short-urls/{shortCode}/tags": { "$ref": "paths/v1_short-codes_{shortCode}_tags.json" }, @@ -54,7 +73,7 @@ "$ref": "paths/v1_tags.json" }, - "/v1/short-codes/{shortCode}/visits": { + "/v1/short-urls/{shortCode}/visits": { "$ref": "paths/v1_short-codes_{shortCode}_visits.json" } }