{ "openapi": "3.1.0", "info": { "title": "Generated API Specification", "version": "1.0.0", "description": "Auto-generated OpenAPI specification from tested endpoints" }, "servers": [ { "url": "http://localhost:4000", "description": "API Server" } ], "paths": { "/auth/login": { "post": { "summary": "This is a simple authentication workflow", "description": "This is a simple authentication workflow", "tags": [ "Authentication" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/POSTauthloginRequest" } } } }, "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/POSTauthloginResponse200" } } } } } } }, "/deliveries": { "get": { "summary": "Retrieves a list of all deliveries", "description": "Retrieves a list of all deliveries", "tags": [ "Deliveries" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETdeliveriesResponse200" } } } } } }, "post": { "summary": "Create a delivery", "description": "Create a delivery", "tags": [ "Deliveries" ], "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/POSTdeliveriesRequest" } } } }, "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/POSTdeliveriesResponse200" } } } } } } }, "/deliveries/2": { "get": { "summary": "Retrieves just a single delivery", "description": "Retrieves just a single delivery", "tags": [ "Deliveries" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETdeliveries2Response200" } } } } } } }, "/deliveries/%7Bid%7D": { "patch": { "summary": "PATCH /deliveries/%7Bid%7D", "tags": [ "Deliveries" ], "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PATCHdeliveries%7Bid%7DRequest" } } } }, "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PATCHdeliveries%7Bid%7DResponse200" } } } } } } }, "/deliveries/%7B5%7D": { "delete": { "summary": "Remove a particular delivery information", "description": "Remove a particular delivery information", "tags": [ "Deliveries" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DELETEdeliveries%7B5%7DResponse200" } } } } } } }, "/deliveries/status/%7Bstatus%7D": { "get": { "summary": "GET /deliveries/status/%7Bstatus%7D", "tags": [ "Deliveries" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETdeliveriesstatus%7Bstatus%7DResponse200" } } } } } } }, "/deliveries/city/%7Bcity%7D": { "get": { "summary": "GET /deliveries/city/%7Bcity%7D", "tags": [ "Deliveries" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETdeliveriescity%7Bcity%7DResponse200" } } } } } } }, "/deliveries/country/%7Bcountry%7D": { "get": { "summary": "GET /deliveries/country/%7Bcountry%7D", "description": "", "tags": [ "Deliveries" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETdeliveriescountry%7Bcountry%7DResponse200" } } } } } } }, "/deliveries/customer/%7Bcustomer%7D": { "get": { "summary": "GET /deliveries/customer/%7Bcustomer%7D", "tags": [ "Deliveries" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETdeliveriescustomer%7Bcustomer%7DResponse200" } } } } } } }, "/deliveries/date/%7Bdate%7D": { "get": { "summary": "GET /deliveries/date/%7Bdate%7D", "tags": [ "Deliveries" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETdeliveriesdate%7Bdate%7DResponse200" } } } } } } }, "/deliveries/range/%7Bstart%7D/%7Bend%7D": { "get": { "summary": "GET /deliveries/range/%7Bstart%7D/%7Bend%7D", "tags": [ "Deliveries" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETdeliveriesrange%7Bstart%7D%7Bend%7DResponse200" } } } } } } }, "/drivers": { "get": { "summary": "This retrieves all drivers information", "description": "This retrieves all drivers information", "tags": [ "Drivers" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETdriversResponse200" } } } } } }, "post": { "summary": "Creating and adding a new driver information", "description": "Creating and adding a new driver information", "tags": [ "Drivers" ], "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/POSTdriversRequest" } } } }, "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/POSTdriversResponse200" } } } } } } }, "/drivers/%7Bid%7D": { "get": { "summary": "This retrieves a particular driver's information", "description": "This retrieves a particular driver's information", "tags": [ "Drivers" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETdrivers%7Bid%7DResponse200" } } } } } }, "patch": { "summary": "PATCH /drivers/%7Bid%7D", "tags": [ "Drivers" ], "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PATCHdrivers%7Bid%7DRequest" } } } }, "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PATCHdrivers%7Bid%7DResponse200" } } } } } }, "delete": { "summary": "DELETE /drivers/%7Bid%7D", "tags": [ "Drivers" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DELETEdrivers%7Bid%7DResponse200" } } } } } } }, "/drivers/state/%7Bstate%7D": { "get": { "summary": "GET /drivers/state/%7Bstate%7D", "tags": [ "Drivers" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETdriversstate%7Bstate%7DResponse200" } } } } } } }, "/drivers/country/%7Bcountry%7D": { "get": { "summary": "GET /drivers/country/%7Bcountry%7D", "tags": [ "Drivers" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETdriverscountry%7Bcountry%7DResponse200" } } } } } } }, "/drivers/vehicle/%7Bvehicle%7D": { "get": { "summary": "GET /drivers/vehicle/%7Bvehicle%7D", "tags": [ "Drivers" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETdriversvehicle%7Bvehicle%7DResponse200" } } } } } } }, "/drivers/car/%7BcarModel%7D": { "get": { "summary": "GET /drivers/car/%7BcarModel%7D", "tags": [ "Drivers" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETdriverscar%7BcarModel%7DResponse200" } } } } } } }, "/drivers/availability/%7Bstatus%7D": { "get": { "summary": "GET /drivers/availability/%7Bstatus%7D", "tags": [ "Drivers" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETdriversavailability%7Bstatus%7DResponse200" } } } } } } }, "/drivers/experience/%7Byears%7D": { "get": { "summary": "GET /drivers/experience/%7Byears%7D", "tags": [ "Drivers" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETdriversexperience%7Byears%7DResponse200" } } } } } } }, "/drivers/rating/%7Bmin%7D": { "get": { "summary": "GET /drivers/rating/%7Bmin%7D", "tags": [ "Drivers" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETdriversrating%7Bmin%7DResponse200" } } } } } } }, "/parcels": { "get": { "summary": "This retrieves all list of parcels information", "description": "This retrieves all list of parcels information", "tags": [ "Percels" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETparcelsResponse200" } } } } } }, "post": { "summary": "http://localhost:4000/drivers/state/{state}", "tags": [ "Percels" ], "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/POSTparcelsRequest" } } } }, "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/POSTparcelsResponse200" } } } } } } }, "/parcels/%7Bid%7D": { "get": { "summary": "This retrieves a particular parcels information", "description": "This retrieves a particular parcels information", "tags": [ "Percels" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETparcels%7Bid%7DResponse200" } } } } } }, "patch": { "summary": "PATCH /parcels/%7Bid%7D", "tags": [ "Percels" ], "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PATCHparcels%7Bid%7DRequest" } } } }, "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PATCHparcels%7Bid%7DResponse200" } } } } } }, "delete": { "summary": "DELETE /parcels/%7Bid%7D", "tags": [ "Percels" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DELETEparcels%7Bid%7DResponse200" } } } } } } }, "/parcels/description/%7Bdescription%7D": { "get": { "summary": "GET /parcels/description/%7Bdescription%7D", "tags": [ "Percels" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETparcelsdescription%7Bdescription%7DResponse200" } } } } } } }, "/parcels/weight/min/%7Bmin%7D/max/%7Bmax%7D": { "get": { "summary": "GET /parcels/weight/min/%7Bmin%7D/max/%7Bmax%7D", "tags": [ "Percels" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETparcelsweightmin%7Bmin%7Dmax%7Bmax%7DResponse200" } } } } } } }, "/parcels/weight/min/%7Bmin%7D": { "get": { "summary": "GET /parcels/weight/min/%7Bmin%7D", "tags": [ "Percels" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETparcelsweightmin%7Bmin%7DResponse200" } } } } } } }, "/parcels/weight/max/%7Bmax%7D": { "get": { "summary": "GET /parcels/weight/max/%7Bmax%7D", "tags": [ "Percels" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETparcelsweightmax%7Bmax%7DResponse200" } } } } } } }, "/parcels/delivery/%7BdeliveryId%7D": { "get": { "summary": "GET /parcels/delivery/%7BdeliveryId%7D", "tags": [ "Percels" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETparcelsdelivery%7BdeliveryId%7DResponse200" } } } } } } }, "/parcels/hub/%7BhubId%7D": { "get": { "summary": "GET /parcels/hub/%7BhubId%7D", "tags": [ "Percels" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETparcelshub%7BhubId%7DResponse200" } } } } } } }, "/hubs": { "get": { "summary": "This retrieves list of all hubs information", "description": "This retrieves list of all hubs information", "tags": [ "Hubs" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GEThubsResponse200" } } } } } }, "post": { "summary": "POST /hubs", "tags": [ "Hubs" ], "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/POSThubsRequest" } } } }, "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/POSThubsResponse200" } } } } } } }, "/hubs/%7Bid%7D": { "get": { "summary": "This retrieves just a particular hubs information", "description": "This retrieves just a particular hub's information", "tags": [ "Hubs" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GEThubs%7Bid%7DResponse200" } } } } } }, "patch": { "summary": "PATCH /hubs/%7Bid%7D", "tags": [ "Hubs" ], "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PATCHhubs%7Bid%7DRequest" } } } }, "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PATCHhubs%7Bid%7DResponse200" } } } } } }, "delete": { "summary": "DELETE /hubs/%7Bid%7D", "tags": [ "Hubs" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DELETEhubs%7Bid%7DResponse200" } } } } } } }, "/hubs/city/%7Bcity%7D": { "get": { "summary": "GET /hubs/city/%7Bcity%7D", "tags": [ "Hubs" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GEThubscity%7Bcity%7DResponse200" } } } } } } }, "/hubs/country/%7Bcountry%7D": { "get": { "summary": "GET /hubs/country/%7Bcountry%7D", "tags": [ "Hubs" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GEThubscountry%7Bcountry%7DResponse200" } } } } } } }, "/hubs/capacity/min/%7Bmin%7D/max/%7Bmax%7D": { "get": { "summary": "GET /hubs/capacity/min/%7Bmin%7D/max/%7Bmax%7D", "tags": [ "Hubs" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GEThubscapacitymin%7Bmin%7Dmax%7Bmax%7DResponse200" } } } } } } }, "/reports/deliveries/status": { "get": { "summary": "This gets the counts of deliveries by status", "description": "This gets the counts of deliveries by status", "tags": [ "Report" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETreportsdeliveriesstatusResponse200" } } } } } } }, "/reports/drivers/vehicle": { "get": { "summary": "This gets the count drivers by vehicle", "description": "This gets the count drivers by vehicle", "tags": [ "Report" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETreportsdriversvehicleResponse200" } } } } } } }, "/reports/parcels/type": { "get": { "summary": "GET /reports/parcels/type", "tags": [ "Report" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETreportsparcelstypeResponse200" } } } } } } }, "/reports/hubs/capacity": { "get": { "summary": "GET /reports/hubs/capacity", "tags": [ "Report" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETreportshubscapacityResponse200" } } } } } } }, "/assignments/delivery/%7BdeliveryId%7D/driver/%7BdriverId%7D": { "post": { "summary": "This assign's driver to delivery", "description": "This assign's driver to delivery", "tags": [ "Assignments" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/POSTassignmentsdelivery%7BdeliveryId%7Ddriver%7BdriverId%7DResponse200" } } } } } } }, "/assignments/driver/%7BdriverId%7D": { "get": { "summary": "This get's deliveries assigned to driver", "description": "This get's deliveries assigned to driver", "tags": [ "Assignments" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETassignmentsdriver%7BdriverId%7DResponse200" } } } } } } }, "/assignments/hub/%7BhubId%7D": { "get": { "summary": "GET /assignments/hub/%7BhubId%7D", "tags": [ "Assignments" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETassignmentshub%7BhubId%7DResponse200" } } } } } } }, "/tracking/delivery/%7BdeliveryId%7D": { "get": { "summary": "delivery tracking", "description": "delivery tracking", "tags": [ "Tracking" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETtrackingdelivery%7BdeliveryId%7DResponse200" } } } } } } }, "/tracking/parcel/%7BparcelId%7D": { "get": { "summary": "parcel tracking", "description": "parcel tracking", "tags": [ "Tracking" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Response with status 200", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GETtrackingparcel%7BparcelId%7DResponse200" } } } } } } } }, "components": { "schemas": { "POSTauthloginRequest": { "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" } }, "required": [ "username", "password" ] }, "POSTauthloginResponse200": { "type": "object", "properties": { "token": { "type": "string" }, "user": { "type": "string" } }, "required": [ "token", "user" ] }, "GETdeliveriesResponse200": { "type": "object", "properties": { "page": { "type": "number" }, "limit": { "type": "number" }, "total": { "type": "number" }, "results": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "status": { "type": "string" }, "address": { "type": "string" }, "customer": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "driverId": { "type": "number" }, "date": { "type": "string" } }, "required": [ "id", "status", "address", "customer", "city", "country", "driverId", "date" ] } } }, "required": [ "page", "limit", "total", "results" ] }, "GETdeliveries2Response200": { "type": "object", "properties": { "id": { "type": "number" }, "status": { "type": "string" }, "address": { "type": "string" }, "customer": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "driverId": { "type": "number" }, "date": { "type": "string" } }, "required": [ "id", "status", "address", "customer", "city", "country", "driverId", "date" ] }, "POSTdeliveriesRequest": { "type": "object", "properties": { "status": { "type": "string" }, "address": { "type": "string" }, "customer": { "type": "string" }, "parcelId": { "type": "number" }, "driverId": { "type": "number" }, "city": { "type": "string" }, "country": { "type": "string" }, "date": { "type": "string" } }, "required": [ "status", "address", "customer", "parcelId", "driverId", "city", "country", "date" ] }, "POSTdeliveriesResponse200": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] }, "PATCHdeliveries%7Bid%7DRequest": { "type": "object", "properties": { "status": { "type": "string" }, "address": { "type": "string" }, "customer": { "type": "string" }, "parcelId": { "type": "number" }, "driverId": { "type": "number" }, "city": { "type": "string" }, "country": { "type": "string" }, "date": { "type": "string" } }, "required": [ "status", "address", "customer", "parcelId", "driverId", "city", "country", "date" ] }, "PATCHdeliveries%7Bid%7DResponse200": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] }, "DELETEdeliveries%7B5%7DResponse200": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] }, "GETdeliveriesstatus%7Bstatus%7DResponse200": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "status": { "type": "string" }, "address": { "type": "string" }, "customer": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "driverId": { "type": "number" }, "date": { "type": "string" } }, "required": [ "id", "status", "address", "customer", "city", "country", "driverId", "date" ] } }, "GETdeliveriescity%7Bcity%7DResponse200": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "status": { "type": "string" }, "address": { "type": "string" }, "customer": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "driverId": { "type": "number" }, "date": { "type": "string" } }, "required": [ "id", "status", "address", "customer", "city", "country", "driverId", "date" ] } }, "GETdeliveriescountry%7Bcountry%7DResponse200": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "status": { "type": "string" }, "address": { "type": "string" }, "customer": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "driverId": { "type": "number" }, "date": { "type": "string" } }, "required": [ "id", "status", "address", "customer", "city", "country", "driverId", "date" ] } }, "GETdeliveriescustomer%7Bcustomer%7DResponse200": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "status": { "type": "string" }, "address": { "type": "string" }, "customer": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "driverId": { "type": "number" }, "date": { "type": "string" } }, "required": [ "id", "status", "address", "customer", "city", "country", "driverId", "date" ] } }, "GETdeliveriesdate%7Bdate%7DResponse200": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "status": { "type": "string" }, "address": { "type": "string" }, "customer": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "driverId": { "type": "number" }, "date": { "type": "string" } }, "required": [ "id", "status", "address", "customer", "city", "country", "driverId", "date" ] } }, "GETdeliveriesrange%7Bstart%7D%7Bend%7DResponse200": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "status": { "type": "string" }, "address": { "type": "string" }, "customer": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "driverId": { "type": "number" }, "date": { "type": "string" } }, "required": [ "id", "status", "address", "customer", "city", "country", "driverId", "date" ] } }, "GETdriversResponse200": { "type": "object", "properties": { "page": { "type": "number" }, "limit": { "type": "number" }, "total": { "type": "number" }, "results": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "vehicle": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "carModel": { "type": "string" }, "availability": { "type": "string" }, "experience": { "type": "number" }, "rating": { "type": "number" } }, "required": [ "id", "name", "vehicle", "state", "country", "carModel", "availability", "experience", "rating" ] } } }, "required": [ "page", "limit", "total", "results" ] }, "GETdrivers%7Bid%7DResponse200": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "vehicle": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "carModel": { "type": "string" }, "availability": { "type": "string" }, "experience": { "type": "number" }, "rating": { "type": "number" } }, "required": [ "id", "name", "vehicle", "state", "country", "carModel", "availability", "experience", "rating" ] }, "POSTdriversRequest": { "type": "object", "properties": { "name": { "type": "string" }, "vehicle": { "type": "string" }, "carModel": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "availability": { "type": "string" }, "experience": { "type": "number" }, "rating": { "type": "number" } }, "required": [ "name", "vehicle", "carModel", "state", "country", "availability", "experience", "rating" ] }, "POSTdriversResponse200": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] }, "PATCHdrivers%7Bid%7DRequest": { "type": "object", "properties": { "name": { "type": "string" }, "vehicle": { "type": "string" }, "carModel": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "availability": { "type": "string" }, "experience": { "type": "number" }, "rating": { "type": "number" } }, "required": [ "name", "vehicle", "carModel", "state", "country", "availability", "experience", "rating" ] }, "PATCHdrivers%7Bid%7DResponse200": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] }, "DELETEdrivers%7Bid%7DResponse200": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] }, "GETdriversstate%7Bstate%7DResponse200": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "vehicle": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "carModel": { "type": "string" }, "availability": { "type": "string" }, "experience": { "type": "number" }, "rating": { "type": "number" } }, "required": [ "id", "name", "vehicle", "state", "country", "carModel", "availability", "experience", "rating" ] } }, "GETdriverscountry%7Bcountry%7DResponse200": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "vehicle": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "carModel": { "type": "string" }, "availability": { "type": "string" }, "experience": { "type": "number" }, "rating": { "type": "number" } }, "required": [ "id", "name", "vehicle", "state", "country", "carModel", "availability", "experience", "rating" ] } }, "GETdriversvehicle%7Bvehicle%7DResponse200": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "vehicle": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "carModel": { "type": "string" }, "availability": { "type": "string" }, "experience": { "type": "number" }, "rating": { "type": "number" } }, "required": [ "id", "name", "vehicle", "state", "country", "carModel", "availability", "experience", "rating" ] } }, "GETdriverscar%7BcarModel%7DResponse200": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "vehicle": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "carModel": { "type": "string" }, "availability": { "type": "string" }, "experience": { "type": "number" }, "rating": { "type": "number" } }, "required": [ "id", "name", "vehicle", "state", "country", "carModel", "availability", "experience", "rating" ] } }, "GETdriversavailability%7Bstatus%7DResponse200": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "vehicle": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "carModel": { "type": "string" }, "availability": { "type": "string" }, "experience": { "type": "number" }, "rating": { "type": "number" } }, "required": [ "id", "name", "vehicle", "state", "country", "carModel", "availability", "experience", "rating" ] } }, "GETdriversexperience%7Byears%7DResponse200": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "vehicle": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "carModel": { "type": "string" }, "availability": { "type": "string" }, "experience": { "type": "number" }, "rating": { "type": "number" } }, "required": [ "id", "name", "vehicle", "state", "country", "carModel", "availability", "experience", "rating" ] } }, "GETdriversrating%7Bmin%7DResponse200": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "vehicle": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "carModel": { "type": "string" }, "availability": { "type": "string" }, "experience": { "type": "number" }, "rating": { "type": "number" } }, "required": [ "id", "name", "vehicle", "state", "country", "carModel", "availability", "experience", "rating" ] } }, "GETparcelsResponse200": { "type": "object", "properties": { "page": { "type": "number" }, "limit": { "type": "number" }, "total": { "type": "number" }, "results": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "weight": { "type": "number" }, "description": { "type": "string" }, "destinationHubId": { "type": "number" }, "deliveryId": { "type": "number" } }, "required": [ "id", "weight", "description", "destinationHubId", "deliveryId" ] } } }, "required": [ "page", "limit", "total", "results" ] }, "GETparcels%7Bid%7DResponse200": { "type": "object", "properties": { "id": { "type": "number" }, "weight": { "type": "number" }, "description": { "type": "string" }, "destinationHubId": { "type": "number" }, "deliveryId": { "type": "number" } }, "required": [ "id", "weight", "description", "destinationHubId", "deliveryId" ] }, "POSTparcelsRequest": { "type": "object", "properties": { "weight": { "type": "number" }, "description": { "type": "string" }, "deliveryId": { "type": "number" }, "destinationHubId": { "type": "number" } }, "required": [ "weight", "description", "deliveryId", "destinationHubId" ] }, "POSTparcelsResponse200": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] }, "PATCHparcels%7Bid%7DRequest": { "type": "object", "properties": { "weight": { "type": "number" }, "description": { "type": "string" }, "deliveryId": { "type": "number" }, "destinationHubId": { "type": "number" } }, "required": [ "weight", "description", "deliveryId", "destinationHubId" ] }, "PATCHparcels%7Bid%7DResponse200": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] }, "DELETEparcels%7Bid%7DResponse200": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] }, "GETparcelsdescription%7Bdescription%7DResponse200": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "weight": { "type": "number" }, "description": { "type": "string" }, "destinationHubId": { "type": "number" }, "deliveryId": { "type": "number" } }, "required": [ "id", "weight", "description", "destinationHubId", "deliveryId" ] } }, "GETparcelsweightmin%7Bmin%7Dmax%7Bmax%7DResponse200": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "weight": { "type": "number" }, "description": { "type": "string" }, "destinationHubId": { "type": "number" }, "deliveryId": { "type": "number" } }, "required": [ "id", "weight", "description", "destinationHubId", "deliveryId" ] } }, "GETparcelsweightmin%7Bmin%7DResponse200": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "weight": { "type": "number" }, "description": { "type": "string" }, "destinationHubId": { "type": "number" }, "deliveryId": { "type": "number" } }, "required": [ "id", "weight", "description", "destinationHubId", "deliveryId" ] } }, "GETparcelsweightmax%7Bmax%7DResponse200": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "weight": { "type": "number" }, "description": { "type": "string" }, "destinationHubId": { "type": "number" }, "deliveryId": { "type": "number" } }, "required": [ "id", "weight", "description", "destinationHubId", "deliveryId" ] } }, "GETparcelsdelivery%7BdeliveryId%7DResponse200": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "weight": { "type": "number" }, "description": { "type": "string" }, "destinationHubId": { "type": "number" }, "deliveryId": { "type": "number" } }, "required": [ "id", "weight", "description", "destinationHubId", "deliveryId" ] } }, "GETparcelshub%7BhubId%7DResponse200": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "weight": { "type": "number" }, "description": { "type": "string" }, "destinationHubId": { "type": "number" }, "deliveryId": { "type": "number" } }, "required": [ "id", "weight", "description", "destinationHubId", "deliveryId" ] } }, "GEThubsResponse200": { "type": "object", "properties": { "page": { "type": "number" }, "limit": { "type": "number" }, "total": { "type": "number" }, "results": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "city": { "type": "string" }, "country": { "type": "string" }, "capacity": { "type": "number" }, "region": { "type": "string" } }, "required": [ "id", "city", "country", "capacity", "region" ] } } }, "required": [ "page", "limit", "total", "results" ] }, "GEThubs%7Bid%7DResponse200": { "type": "object", "properties": { "id": { "type": "number" }, "city": { "type": "string" }, "country": { "type": "string" }, "capacity": { "type": "number" }, "region": { "type": "string" } }, "required": [ "id", "city", "country", "capacity", "region" ] }, "POSThubsRequest": { "type": "object", "properties": { "city": { "type": "string" }, "country": { "type": "string" }, "capacity": { "type": "number" }, "region": { "type": "string" } }, "required": [ "city", "country", "capacity", "region" ] }, "POSThubsResponse200": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] }, "PATCHhubs%7Bid%7DRequest": { "type": "object", "properties": { "city": { "type": "string" }, "country": { "type": "string" }, "capacity": { "type": "number" }, "region": { "type": "string" } }, "required": [ "city", "country", "capacity", "region" ] }, "PATCHhubs%7Bid%7DResponse200": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] }, "DELETEhubs%7Bid%7DResponse200": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] }, "GEThubscity%7Bcity%7DResponse200": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "city": { "type": "string" }, "country": { "type": "string" }, "capacity": { "type": "number" }, "region": { "type": "string" } }, "required": [ "id", "city", "country", "capacity", "region" ] } }, "GEThubscountry%7Bcountry%7DResponse200": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "city": { "type": "string" }, "country": { "type": "string" }, "capacity": { "type": "number" }, "region": { "type": "string" } }, "required": [ "id", "city", "country", "capacity", "region" ] } }, "GEThubscapacitymin%7Bmin%7Dmax%7Bmax%7DResponse200": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "city": { "type": "string" }, "country": { "type": "string" }, "capacity": { "type": "number" }, "region": { "type": "string" } }, "required": [ "id", "city", "country", "capacity", "region" ] } }, "GETreportsdeliveriesstatusResponse200": { "type": "object", "properties": { "pending": { "type": "number" }, "in_transit": { "type": "number" }, "delivered": { "type": "number" } }, "required": [ "pending", "in_transit", "delivered" ] }, "GETreportsdriversvehicleResponse200": { "type": "object", "properties": { "Bike": { "type": "number" }, "Car": { "type": "number" }, "Van": { "type": "number" } }, "required": [ "Bike", "Car", "Van" ] }, "GETreportsparcelstypeResponse200": { "type": "object", "properties": { "Electronics": { "type": "number" }, "Books": { "type": "number" }, "Clothes": { "type": "number" } }, "required": [ "Electronics", "Books", "Clothes" ] }, "GETreportshubscapacityResponse200": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "capacity": { "type": "number" } }, "required": [ "id", "capacity" ] } }, "POSTassignmentsdelivery%7BdeliveryId%7Ddriver%7BdriverId%7DResponse200": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] }, "GETassignmentsdriver%7BdriverId%7DResponse200": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "status": { "type": "string" }, "address": { "type": "string" }, "customer": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "driverId": { "type": "number" }, "date": { "type": "string" } }, "required": [ "id", "status", "address", "customer", "city", "country", "driverId", "date" ] } }, "GETassignmentshub%7BhubId%7DResponse200": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "weight": { "type": "number" }, "description": { "type": "string" }, "destinationHubId": { "type": "number" }, "deliveryId": { "type": "number" } }, "required": [ "id", "weight", "description", "destinationHubId", "deliveryId" ] } }, "GETtrackingdelivery%7BdeliveryId%7DResponse200": { "type": "object", "properties": { "deliveryId": { "type": "string" }, "status": { "type": "string" } }, "required": [ "deliveryId", "status" ] }, "GETtrackingparcel%7BparcelId%7DResponse200": { "type": "object", "properties": { "parcelId": { "type": "string" }, "location": { "type": "string" } }, "required": [ "parcelId", "location" ] } }, "securitySchemes": { "bearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } } }