diff --git a/public/swagger.json b/public/swagger.json index 140f227..036faf1 100644 --- a/public/swagger.json +++ b/public/swagger.json @@ -2,172 +2,419 @@ "apiVersion": "1.0.0", "swaggerVersion": "1.2", "basePath": "http://localhost:3000/aappii", + "resourcePath": "/api-documentation", "consumes": ["application/json"], "produces": ["application/json"], - "apis": { - "/items/:item_id/comments(.:format)": { - "GET": { - "name": "item_comments", - "tags": [ - "comments", - "items" - ], - "summary": "Comment", - "description": "{:model=>\"Comment\", :resources=>\"comments\", :parent_resource=>:items, :controller=>\"active_api/nested_active_api\", :action=>\"index\"}" - }, - "POST": { - "name": "item_comments", - "tags": [ - "comments", - "items" - ], - "summary": "Comment", - "description": "{:model=>\"Comment\", :resources=>\"comments\", :parent_resource=>:items, :controller=>\"active_api/nested_active_api\", :action=>\"create\"}" - } + "apis": [ + { + "operations": [ + { + "method": "GET", + "summary": "item_comments", + "notes": { + "model": "Comment", + "resources": "comments", + "parent_resource": "items", + "controller": "active_api/nested_active_api", + "action": "index" + }, + "nickname": "item_comments", + "parameters": [ + { + "name": "body", + "description": "param description.", + "required": true, + "type": "Comment", + "paramType": "body" + } + ] + }, + { + "method": "POST", + "summary": "item_comments", + "notes": { + "model": "Comment", + "resources": "comments", + "parent_resource": "items", + "controller": "active_api/nested_active_api", + "action": "create" + }, + "nickname": "item_comments", + "parameters": [ + { + "name": "body", + "description": "param description.", + "required": true, + "type": "Comment", + "paramType": "body" + } + ] + } + ], + "description": "POST : item_comments", + "path": "/items/:item_id/comments(.:format)" }, - "/items/:item_id/comments/:id(.:format)": { - "GET": { - "name": "item_comment", - "tags": [ - "comments", - "items" - ], - "summary": "Comment", - "description": "{:model=>\"Comment\", :resources=>\"comments\", :parent_resource=>:items, :controller=>\"active_api/nested_active_api\", :action=>\"show\"}" - }, - "PATCH": { - "name": "item_comment", - "tags": [ - "comments", - "items" - ], - "summary": "Comment", - "description": "{:model=>\"Comment\", :resources=>\"comments\", :parent_resource=>:items, :controller=>\"active_api/nested_active_api\", :action=>\"update\"}" - }, - "PUT": { - "name": "item_comment", - "tags": [ - "comments", - "items" - ], - "summary": "Comment", - "description": "{:model=>\"Comment\", :resources=>\"comments\", :parent_resource=>:items, :controller=>\"active_api/nested_active_api\", :action=>\"update\"}" - }, - "DELETE": { - "name": "item_comment", - "tags": [ - "comments", - "items" - ], - "summary": "Comment", - "description": "{:model=>\"Comment\", :resources=>\"comments\", :parent_resource=>:items, :controller=>\"active_api/nested_active_api\", :action=>\"destroy\"}" - } + { + "operations": [ + { + "method": "GET", + "summary": "item_comment", + "notes": { + "model": "Comment", + "resources": "comments", + "parent_resource": "items", + "controller": "active_api/nested_active_api", + "action": "show" + }, + "nickname": "item_comment", + "parameters": [ + { + "name": "body", + "description": "param description.", + "required": true, + "type": "Comment", + "paramType": "body" + } + ] + }, + { + "method": "PATCH", + "summary": "item_comment", + "notes": { + "model": "Comment", + "resources": "comments", + "parent_resource": "items", + "controller": "active_api/nested_active_api", + "action": "update" + }, + "nickname": "item_comment", + "parameters": [ + { + "name": "body", + "description": "param description.", + "required": true, + "type": "Comment", + "paramType": "body" + } + ] + }, + { + "method": "PUT", + "summary": "item_comment", + "notes": { + "model": "Comment", + "resources": "comments", + "parent_resource": "items", + "controller": "active_api/nested_active_api", + "action": "update" + }, + "nickname": "item_comment", + "parameters": [ + { + "name": "body", + "description": "param description.", + "required": true, + "type": "Comment", + "paramType": "body" + } + ] + }, + { + "method": "DELETE", + "summary": "item_comment", + "notes": { + "model": "Comment", + "resources": "comments", + "parent_resource": "items", + "controller": "active_api/nested_active_api", + "action": "destroy" + }, + "nickname": "item_comment", + "parameters": [ + { + "name": "body", + "description": "param description.", + "required": true, + "type": "Comment", + "paramType": "body" + } + ] + } + ], + "description": "DELETE : item_comment", + "path": "/items/:item_id/comments/:id(.:format)" }, - "/items(.:format)": { - "GET": { - "name": "items", - "tags": [ - "items" - ], - "summary": "Item", - "description": "{:model=>\"Item\", :resources=>\"items\", :controller=>\"active_api/active_api\", :action=>\"index\"}" - }, - "POST": { - "name": "items", - "tags": [ - "items" - ], - "summary": "Item", - "description": "{:model=>\"Item\", :resources=>\"items\", :controller=>\"active_api/active_api\", :action=>\"create\"}" - } + { + "operations": [ + { + "method": "GET", + "summary": "items", + "notes": { + "model": "Item", + "resources": "items", + "controller": "active_api/active_api", + "action": "index" + }, + "nickname": "items", + "parameters": [ + { + "name": "body", + "description": "param description.", + "required": true, + "type": "Item", + "paramType": "body" + } + ] + }, + { + "method": "POST", + "summary": "items", + "notes": { + "model": "Item", + "resources": "items", + "controller": "active_api/active_api", + "action": "create" + }, + "nickname": "items", + "parameters": [ + { + "name": "body", + "description": "param description.", + "required": true, + "type": "Item", + "paramType": "body" + } + ] + } + ], + "description": "POST : items", + "path": "/items(.:format)" }, - "/items/:id(.:format)": { - "GET": { - "name": "item", - "tags": [ - "items" - ], - "summary": "Item", - "description": "{:model=>\"Item\", :resources=>\"items\", :controller=>\"active_api/active_api\", :action=>\"show\"}" - }, - "PATCH": { - "name": "item", - "tags": [ - "items" - ], - "summary": "Item", - "description": "{:model=>\"Item\", :resources=>\"items\", :controller=>\"active_api/active_api\", :action=>\"update\"}" - }, - "PUT": { - "name": "item", - "tags": [ - "items" - ], - "summary": "Item", - "description": "{:model=>\"Item\", :resources=>\"items\", :controller=>\"active_api/active_api\", :action=>\"update\"}" - }, - "DELETE": { - "name": "item", - "tags": [ - "items" - ], - "summary": "Item", - "description": "{:model=>\"Item\", :resources=>\"items\", :controller=>\"active_api/active_api\", :action=>\"destroy\"}" - } + { + "operations": [ + { + "method": "GET", + "summary": "item", + "notes": { + "model": "Item", + "resources": "items", + "controller": "active_api/active_api", + "action": "show" + }, + "nickname": "item", + "parameters": [ + { + "name": "body", + "description": "param description.", + "required": true, + "type": "Item", + "paramType": "body" + } + ] + }, + { + "method": "PATCH", + "summary": "item", + "notes": { + "model": "Item", + "resources": "items", + "controller": "active_api/active_api", + "action": "update" + }, + "nickname": "item", + "parameters": [ + { + "name": "body", + "description": "param description.", + "required": true, + "type": "Item", + "paramType": "body" + } + ] + }, + { + "method": "PUT", + "summary": "item", + "notes": { + "model": "Item", + "resources": "items", + "controller": "active_api/active_api", + "action": "update" + }, + "nickname": "item", + "parameters": [ + { + "name": "body", + "description": "param description.", + "required": true, + "type": "Item", + "paramType": "body" + } + ] + }, + { + "method": "DELETE", + "summary": "item", + "notes": { + "model": "Item", + "resources": "items", + "controller": "active_api/active_api", + "action": "destroy" + }, + "nickname": "item", + "parameters": [ + { + "name": "body", + "description": "param description.", + "required": true, + "type": "Item", + "paramType": "body" + } + ] + } + ], + "description": "DELETE : item", + "path": "/items/:id(.:format)" }, - "/users(.:format)": { - "GET": { - "name": "users", - "tags": [ - "users" - ], - "summary": "User", - "description": "{:model=>\"User\", :resources=>\"users\", :serializer=>\"human\", :controller=>\"active_api/active_api\", :action=>\"index\"}" - }, - "POST": { - "name": "users", - "tags": [ - "users" - ], - "summary": "User", - "description": "{:model=>\"User\", :resources=>\"users\", :serializer=>\"human\", :controller=>\"active_api/active_api\", :action=>\"create\"}" - } + { + "operations": [ + { + "method": "GET", + "summary": "users", + "notes": { + "model": "User", + "resources": "users", + "serializer": "human", + "controller": "active_api/active_api", + "action": "index" + }, + "nickname": "users", + "parameters": [ + { + "name": "body", + "description": "param description.", + "required": true, + "type": "User", + "paramType": "body" + } + ] + }, + { + "method": "POST", + "summary": "users", + "notes": { + "model": "User", + "resources": "users", + "serializer": "human", + "controller": "active_api/active_api", + "action": "create" + }, + "nickname": "users", + "parameters": [ + { + "name": "body", + "description": "param description.", + "required": true, + "type": "User", + "paramType": "body" + } + ] + } + ], + "description": "POST : users", + "path": "/users(.:format)" }, - "/users/:id(.:format)": { - "GET": { - "name": "user", - "tags": [ - "users" - ], - "summary": "User", - "description": "{:model=>\"User\", :resources=>\"users\", :serializer=>\"human\", :controller=>\"active_api/active_api\", :action=>\"show\"}" - }, - "PATCH": { - "name": "user", - "tags": [ - "users" - ], - "summary": "User", - "description": "{:model=>\"User\", :resources=>\"users\", :serializer=>\"human\", :controller=>\"active_api/active_api\", :action=>\"update\"}" - }, - "PUT": { - "name": "user", - "tags": [ - "users" - ], - "summary": "User", - "description": "{:model=>\"User\", :resources=>\"users\", :serializer=>\"human\", :controller=>\"active_api/active_api\", :action=>\"update\"}" - }, - "DELETE": { - "name": "user", - "tags": [ - "users" - ], - "summary": "User", - "description": "{:model=>\"User\", :resources=>\"users\", :serializer=>\"human\", :controller=>\"active_api/active_api\", :action=>\"destroy\"}" - } + { + "operations": [ + { + "method": "GET", + "summary": "user", + "notes": { + "model": "User", + "resources": "users", + "serializer": "human", + "controller": "active_api/active_api", + "action": "show" + }, + "nickname": "user", + "parameters": [ + { + "name": "body", + "description": "param description.", + "required": true, + "type": "User", + "paramType": "body" + } + ] + }, + { + "method": "PATCH", + "summary": "user", + "notes": { + "model": "User", + "resources": "users", + "serializer": "human", + "controller": "active_api/active_api", + "action": "update" + }, + "nickname": "user", + "parameters": [ + { + "name": "body", + "description": "param description.", + "required": true, + "type": "User", + "paramType": "body" + } + ] + }, + { + "method": "PUT", + "summary": "user", + "notes": { + "model": "User", + "resources": "users", + "serializer": "human", + "controller": "active_api/active_api", + "action": "update" + }, + "nickname": "user", + "parameters": [ + { + "name": "body", + "description": "param description.", + "required": true, + "type": "User", + "paramType": "body" + } + ] + }, + { + "method": "DELETE", + "summary": "user", + "notes": { + "model": "User", + "resources": "users", + "serializer": "human", + "controller": "active_api/active_api", + "action": "destroy" + }, + "nickname": "user", + "parameters": [ + { + "name": "body", + "description": "param description.", + "required": true, + "type": "User", + "paramType": "body" + } + ] + } + ], + "description": "DELETE : user", + "path": "/users/:id(.:format)" } -}, +], "info": { "title": "Rails HackerNews-Reddit-ProductHunt Clone.", "description": "StarterKit for a social news/product site.",