Tagged and summarized all endpoints in swagger docs

This commit is contained in:
Alejandro Celaya 2016-10-23 00:07:31 +02:00
parent b225c03ef1
commit 8af9b0ee02
5 changed files with 26 additions and 0 deletions

View File

@ -1,5 +1,9 @@
{ {
"post": { "post": {
"tags": [
"Authentication"
],
"summary": "Perform authentication",
"description": "Performs an authentication", "description": "Performs an authentication",
"parameters": [ "parameters": [
{ {

View File

@ -1,5 +1,9 @@
{ {
"get": { "get": {
"tags": [
"ShortCodes"
],
"summary": "List short URLs",
"description": "Returns the list of short codes", "description": "Returns the list of short codes",
"parameters": [ "parameters": [
{ {
@ -77,6 +81,10 @@
} }
}, },
"post": { "post": {
"tags": [
"ShortCodes"
],
"summary": "Create short URL",
"description": "Creates a new short code", "description": "Creates a new short code",
"parameters": [ "parameters": [
{ {

View File

@ -1,5 +1,9 @@
{ {
"get": { "get": {
"tags": [
"ShortCodes"
],
"summary": "Parse short code",
"description": "Get the long URL behind a short code.", "description": "Get the long URL behind a short code.",
"parameters": [ "parameters": [
{ {

View File

@ -1,5 +1,10 @@
{ {
"put": { "put": {
"tags": [
"ShortCodes",
"Tags"
],
"summary": "Edit tags on short URL",
"description": "Edit the tags on provided short code.", "description": "Edit the tags on provided short code.",
"parameters": [ "parameters": [
{ {

View File

@ -1,5 +1,10 @@
{ {
"get": { "get": {
"tags": [
"ShortCodes",
"Visits"
],
"summary": "List visits for short URL",
"description": "Get the list of visits on provided short code.", "description": "Get the list of visits on provided short code.",
"parameters": [ "parameters": [
{ {