From 8d0bac9478090ede2a102c2175726e5b8cc5e92c Mon Sep 17 00:00:00 2001 From: Alejandro Celaya Date: Sat, 15 Jul 2017 12:13:59 +0200 Subject: [PATCH] Documented delete and edit tags endpoints --- docs/swagger/paths/v1_tags.json | 82 +++++++++++++++++++++++++++++++++ 1 file changed, 82 insertions(+) diff --git a/docs/swagger/paths/v1_tags.json b/docs/swagger/paths/v1_tags.json index 92005b12..9f7cefb2 100644 --- a/docs/swagger/paths/v1_tags.json +++ b/docs/swagger/paths/v1_tags.json @@ -50,6 +50,7 @@ } } }, + "post": { "tags": [ "Tags" @@ -107,5 +108,86 @@ } } } + }, + + "put": { + "tags": [ + "Tags" + ], + "summary": "Rename tag", + "description": "Renames one existing tag", + "parameters": [ + { + "$ref": "../parameters/Authorization.json" + }, + { + "name": "oldName", + "in": "formData", + "description": "Current name of the tag", + "required": true, + "type": "string" + }, + { + "name": "newName", + "in": "formData", + "description": "New name of the tag", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "The tag has been properly renamed" + }, + "400": { + "description": "You have not provided either the oldName or the newName params.", + "schema": { + "$ref": "../definitions/Error.json" + } + }, + "404": { + "description": "There's no tag found with the name provided in oldName param.", + "schema": { + "$ref": "../definitions/Error.json" + } + }, + "500": { + "description": "Unexpected error.", + "schema": { + "$ref": "../definitions/Error.json" + } + } + } + }, + + "delete": { + "tags": [ + "Tags" + ], + "summary": "Delete tags", + "description": "Deletes provided list of tags", + "parameters": [ + { + "$ref": "../parameters/Authorization.json" + }, + { + "name": "tags[]", + "in": "query", + "description": "The names of the tags to delete", + "required": true, + "type": "array" + } + ], + "responses": { + "204": { + "description": "Tags properly deleted" + }, + "500": { + "description": "Unexpected error.", + "schema": { + "$ref": "../definitions/Error.json" + } + } + } } }