From 8af9b0ee02de3dbd30ffd6ed4c027c8885aba75b Mon Sep 17 00:00:00 2001 From: Alejandro Celaya Date: Sun, 23 Oct 2016 00:07:31 +0200 Subject: [PATCH] Tagged and summarized all endpoints in swagger docs --- docs/swagger/paths/v1_authenticate.json | 4 ++++ docs/swagger/paths/v1_short-codes.json | 8 ++++++++ docs/swagger/paths/v1_short-codes_{shortCode}.json | 4 ++++ docs/swagger/paths/v1_short-codes_{shortCode}_tags.json | 5 +++++ docs/swagger/paths/v1_short-codes_{shortCode}_visits.json | 5 +++++ 5 files changed, 26 insertions(+) diff --git a/docs/swagger/paths/v1_authenticate.json b/docs/swagger/paths/v1_authenticate.json index d7828f52..843081bb 100644 --- a/docs/swagger/paths/v1_authenticate.json +++ b/docs/swagger/paths/v1_authenticate.json @@ -1,5 +1,9 @@ { "post": { + "tags": [ + "Authentication" + ], + "summary": "Perform authentication", "description": "Performs an authentication", "parameters": [ { diff --git a/docs/swagger/paths/v1_short-codes.json b/docs/swagger/paths/v1_short-codes.json index 27448d4d..42b22f82 100644 --- a/docs/swagger/paths/v1_short-codes.json +++ b/docs/swagger/paths/v1_short-codes.json @@ -1,5 +1,9 @@ { "get": { + "tags": [ + "ShortCodes" + ], + "summary": "List short URLs", "description": "Returns the list of short codes", "parameters": [ { @@ -77,6 +81,10 @@ } }, "post": { + "tags": [ + "ShortCodes" + ], + "summary": "Create short URL", "description": "Creates a new short code", "parameters": [ { diff --git a/docs/swagger/paths/v1_short-codes_{shortCode}.json b/docs/swagger/paths/v1_short-codes_{shortCode}.json index 1a24dcf5..a706f675 100644 --- a/docs/swagger/paths/v1_short-codes_{shortCode}.json +++ b/docs/swagger/paths/v1_short-codes_{shortCode}.json @@ -1,5 +1,9 @@ { "get": { + "tags": [ + "ShortCodes" + ], + "summary": "Parse short code", "description": "Get the long URL behind a short code.", "parameters": [ { diff --git a/docs/swagger/paths/v1_short-codes_{shortCode}_tags.json b/docs/swagger/paths/v1_short-codes_{shortCode}_tags.json index 8ff67199..3cbfc952 100644 --- a/docs/swagger/paths/v1_short-codes_{shortCode}_tags.json +++ b/docs/swagger/paths/v1_short-codes_{shortCode}_tags.json @@ -1,5 +1,10 @@ { "put": { + "tags": [ + "ShortCodes", + "Tags" + ], + "summary": "Edit tags on short URL", "description": "Edit the tags on provided short code.", "parameters": [ { diff --git a/docs/swagger/paths/v1_short-codes_{shortCode}_visits.json b/docs/swagger/paths/v1_short-codes_{shortCode}_visits.json index 3b416eb0..f90daf7a 100644 --- a/docs/swagger/paths/v1_short-codes_{shortCode}_visits.json +++ b/docs/swagger/paths/v1_short-codes_{shortCode}_visits.json @@ -1,5 +1,10 @@ { "get": { + "tags": [ + "ShortCodes", + "Visits" + ], + "summary": "List visits for short URL", "description": "Get the list of visits on provided short code.", "parameters": [ {