| { | |
| "swagger": "2.0", | |
| "info": { | |
| "version": "2.0.0", | |
| "title": "UrbanCrawl API" | |
| }, | |
| "basePath": "/api/v2", | |
| "paths": { | |
| "/cities": { | |
| "get": { | |
| "tags": [ | |
| "city" | |
| ], | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "description": "Request was successful", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "cities": { | |
| "type": "array", | |
| "items": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": false | |
| } | |
| }, | |
| "/cities/search": { | |
| "get": { | |
| "tags": [ | |
| "city" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "q", | |
| "in": "query", | |
| "required": false, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Request was successful", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "cities": { | |
| "type": "array", | |
| "items": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": false | |
| } | |
| }, | |
| "/cities/{city}": { | |
| "get": { | |
| "tags": [ | |
| "city" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "city", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Request was successful", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "cityDetails": { | |
| "description": "Returns a JSON object containing details and places of a city whose ID is supplied", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": false | |
| } | |
| }, | |
| "/city/{city}/places": { | |
| "get": { | |
| "tags": [ | |
| "city", | |
| "place" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "city", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Request was successful", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "places": { | |
| "type": "array", | |
| "items": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": false | |
| } | |
| }, | |
| "/cities/{city}/places/{place}": { | |
| "get": { | |
| "tags": [ | |
| "city", | |
| "place" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "city", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "place", | |
| "in": "path", | |
| "required": true, | |
| "type": "number" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Request was successful", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "placeDetails": { | |
| "description": "Returns a JSON array of all the available places, belonging to the city whose id is supplied", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": false | |
| } | |
| }, | |
| "/cities/{city}/places/{place}/media/{type}": { | |
| "get": { | |
| "tags": [ | |
| "city", | |
| "place", | |
| "media" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "city", | |
| "in": "path", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "place", | |
| "in": "path", | |
| "required": true, | |
| "type": "number" | |
| }, | |
| { | |
| "name": "type", | |
| "in": "path", | |
| "description": "you can provide 'image', 'video', or 'all' to get images or videos or all respectively.", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Request was successful", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "media": { | |
| "type": "array", | |
| "items": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": false | |
| } | |
| }, | |
| "/cities/{city}/media/{type}": { | |
| "get": { | |
| "tags": [ | |
| "city", | |
| "media" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "city", | |
| "in": "path", | |
| "description": "The cityid with which you want to search", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "name": "type", | |
| "in": "path", | |
| "description": "you can provide 'image', 'video', or 'all' to get images, videos, or all respectively.", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Request was successful", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "media": { | |
| "type": "array", | |
| "items": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": false | |
| } | |
| }, | |
| "/cart": { | |
| "post": { | |
| "tags": [ | |
| "cart" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "items", | |
| "in": "body", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/x-any" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Request was successful", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "item": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": false | |
| }, | |
| "get": { | |
| "tags": [ | |
| "cart" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "userid", | |
| "in": "query", | |
| "required": false, | |
| "type": "number", | |
| "format": "double" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Request was successful", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "item": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": false | |
| } | |
| }, | |
| "/cart/checkout": { | |
| "put": { | |
| "tags": [ | |
| "cart" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "params", | |
| "in": "body", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/definitions/x-any" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Request was successful", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "items": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": false | |
| } | |
| }, | |
| "/account": { | |
| "put": { | |
| "tags": [ | |
| "account" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "items", | |
| "in": "body", | |
| "required": false, | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Request was successful", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "result": { | |
| "description": "Returns a JWT key when successful", | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": false | |
| }, | |
| "post": { | |
| "tags": [ | |
| "account" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "items", | |
| "in": "body", | |
| "required": false, | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Request was successful", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "result": { | |
| "description": "Returns a JWT key when successful", | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": false | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| { | |
| "name": "city" | |
| }, | |
| { | |
| "name": "cart" | |
| }, | |
| { | |
| "name": "account" | |
| } | |
| ], | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "definitions": { | |
| "x-any": { | |
| "properties": {} | |
| } | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment