{"id":22499869,"url":"https://github.com/sharonina/burgerqueen-db","last_synced_at":"2026-04-12T13:39:16.284Z","repository":{"id":65748356,"uuid":"593429988","full_name":"Sharonina/BurgerQueen-DB","owner":"Sharonina","description":"Data base created for restaurants who need to create their employees work environment.","archived":false,"fork":false,"pushed_at":"2023-03-07T04:53:47.000Z","size":207,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-27T22:31:00.550Z","etag":null,"topics":["express","mongodb","mongoo","postman"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Sharonina.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-26T00:56:18.000Z","updated_at":"2023-02-21T00:48:45.000Z","dependencies_parsed_at":null,"dependency_job_id":"5bdd4995-7793-43b3-9088-4bf6ab48f814","html_url":"https://github.com/Sharonina/BurgerQueen-DB","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Sharonina/BurgerQueen-DB","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sharonina%2FBurgerQueen-DB","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sharonina%2FBurgerQueen-DB/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sharonina%2FBurgerQueen-DB/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sharonina%2FBurgerQueen-DB/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Sharonina","download_url":"https://codeload.github.com/Sharonina/BurgerQueen-DB/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sharonina%2FBurgerQueen-DB/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267804107,"owners_count":24146537,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-30T02:00:09.044Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["express","mongodb","mongoo","postman"],"created_at":"2024-12-06T22:17:12.035Z","updated_at":"2026-04-12T13:39:16.249Z","avatar_url":"https://github.com/Sharonina.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Burger Queen API\n\nhttps://burguerqueenapi.onrender.com\n\n## API Reference: auth\n\n```http\n  POST /users/login\n```\n\nRequest body\n\n```\n    {\n        \"email\": \"shadmin@test.com\",\n        \"password\": \"1234abc\"\n    }\n```\n\n#### Responses\n\n| Code  | Message               |\n| :---- | :-------------------- |\n| `200` | OK                    |\n| `400` | All input is required |\n| `404` | Invalid credentials   |\n\n## API Reference: admin user\n\n```http\n  POST /users/admin\n```\n\n#### Headers\n\n```\n    adminregisterkey: key value\n```\n\n#### Request body\n\n```\n    {\n      \"admin\": {\n          \"first_name\": \"Sharon\",\n          \"last_name\": \"Test\",\n          \"email\": \"shadmin@test.com\",\n          \"password\": \"1234abc\",\n          \"role\": \"admin\",\n          \"admin\": \"true\"\n        },\n        \"restaurant\": {\n            \"name\": \"Las Hamburguesitas\",\n        }\n    }\n```\n\n| Parameter    | Type      | Description      |\n| :----------- | :-------- | :--------------- |\n| `first_name` | _string_  | Required         |\n| `last_name`  | _string_  | Required         |\n| `email`      | _string_  | Required, unique |\n| `password`   | _string_  | Required         |\n| `role`       | _string_  | Required         |\n| `admin`      | _boolean_ |                  |\n| `restaurant` | _object_  | ref: restaurant  |\n\n#### Responses\n\n| Code  | Message                                     |\n| :---- | :------------------------------------------ |\n| `201` | User created                                |\n| `400` | All input is required                       |\n| `400` | Role must be waiter, chef, admin or manager |\n| `409` | User already exist                          |\n\n## API Reference: users\n\n```http\n  POST /users\n```\n\n#### Headers\n\n```\n    authorization: admin token\n```\n\n#### Request body\n\n```\n    {\n        \"first_name\": \"Sharon\",\n        \"last_name\": \"Test\",\n        \"email\": \"shachef@test.com\",\n        \"password\": \"1234abc\",\n        \"role\": \"chef\",\n        \"admin\": \"false\",\n        \"restaurant\": \"63db2d8dd4a39b95d1f7f5eb\",\n\n    }\n```\n\n| Parameter    | Type      | Description      |\n| :----------- | :-------- | :--------------- |\n| `first_name` | _string_  | Required         |\n| `last_name`  | _string_  | Required         |\n| `email`      | _string_  | Required, unique |\n| `password`   | _string_  | Required         |\n| `role`       | _string_  | Required         |\n| `admin`      | _boolean_ |                  |\n| `restaurant` | _string_  | ref: restaurant  |\n\n#### Responses\n\n| Code  | Message                                     |\n| :---- | :------------------------------------------ |\n| `201` | User created                                |\n| `400` | All input is required                       |\n| `400` | Role must be waiter, chef, admin or manager |\n| `409` | User already exist                          |\n\n##\n\n```http\n  GET /users\n```\n\n#### Headers\n\n```\n    authorization: admin token\n```\n\n#### Querys\n\n```\n    /users?limit=5\u0026page=1\n```\n\n| Query   | Type     | Description                      |\n| :------ | :------- | :------------------------------- |\n| `limit` | _number_ | number of users by page          |\n| `page`  | _number_ | page number based on users limit |\n\n#### Responses\n\n| Code  | Message                               |\n| :---- | :------------------------------------ |\n| `200` | OK                                    |\n| `400` | Limit and page must be numbers        |\n| `400` | Limit and page must be greater than 1 |\n\n##\n\n```http\n  GET /users/:userId\n```\n\n#### Headers\n\n```\n    authorization: admin token\n```\n\n#### Responses\n\n| Code  | Message         |\n| :---- | :-------------- |\n| `200` | OK              |\n| `400` | Invalid user id |\n| `404` | User not found  |\n\n##\n\n```http\n  PUT /users/:userId\n```\n\n#### Headers\n\n```\n    authorization: admin token\n```\n\n#### Request body\n\n```\n    {\n        \"first_name\": \"Sharon\",\n        \"last_name\": \"Test\",\n        \"email\": \"shachef@test.com\",\n        \"password\": \"1234abc\",\n        \"role\": \"chef\",\n        \"restaurant\": \"63db2d8dd4a39b95d1f7f5eb\",\n    }\n```\n\n| Parameter    | Type     | Description      |\n| :----------- | :------- | :--------------- |\n| `first_name` | _string_ | Required         |\n| `last_name`  | _string_ | Required         |\n| `email`      | _string_ | Required, unique |\n| `password`   | _string_ | Required         |\n| `role`       | _string_ | Required         |\n| `restaurant` | _string_ | ref: restaurant  |\n\n#### Responses\n\n| Code  | Message                                     |\n| :---- | :------------------------------------------ |\n| `200` | User updated                                |\n| `400` | Invalid user id                             |\n| `400` | Role must be waiter, chef, admin or manager |\n| `404` | User not found                              |\n\n##\n\n```http\n  DELETE /users/:userId\n```\n\n#### Headers\n\n```\n    authorization: admin token\n```\n\n#### Responses\n\n| Code  | Message         |\n| :---- | :-------------- |\n| `200` | Deleted user    |\n| `400` | Invalid user id |\n| `404` | User not found  |\n\n## API Reference: restaurants\n\n```http\n  POST /restaurants\n```\n\n#### Headers\n\n```\n    authorization: admin token\n```\n\n#### Request body\n\n```\n    {\n        \"name\": \"Las hamburguesitas\"\n    }\n```\n\n| Parameter | Type     | Description |\n| :-------- | :------- | :---------- |\n| `name`    | _string_ | Required    |\n\n#### Responses\n\n| Code  | Message               |\n| :---- | :-------------------- |\n| `201` | Restaurant created    |\n| `400` | All input is required |\n\n##\n\n```http\n  GET /restaurants/:restaurantId\n```\n\n#### Headers\n\n```\n    authorization: admin token\n```\n\n#### Responses\n\n| Code  | Message               |\n| :---- | :-------------------- |\n| `200` | OK                    |\n| `400` | Invalid restaurant id |\n| `404` | Restaurant not found  |\n\n##\n\n```http\n  PUT /restaurants/:restaurantId\n```\n\n#### Headers\n\n```\n    authorization: admin token\n```\n\n#### Request body\n\n```\n    {\n        \"name\": \"Las hamburguesotas\",\n    }\n```\n\n| Parameter | Type     | Description |\n| :-------- | :------- | :---------- |\n| `name`    | _string_ | Required    |\n\n#### Responses\n\n| Code  | Message               |\n| :---- | :-------------------- |\n| `200` | Restaurant updated    |\n| `400` | Invalid restaurant id |\n| `404` | Restaurant not found  |\n\n##\n\n```http\n  DELETE /restaurants/:restaurantId\n```\n\n#### Headers\n\n```\n    authorization: admin token\n```\n\n#### Responses\n\n| Code  | Message               |\n| :---- | :-------------------- |\n| `200` | Deleted restaurant    |\n| `400` | Invalid restaurant id |\n| `404` | Restaurant not found  |\n\n## API Reference: products\n\n```http\n  POST /products\n```\n\n#### Headers\n\n```\n    authorization: admin token\n```\n\n#### Request body\n\n```\n    {\n        \"name\": \"hot dog\",\n        \"price\": \"150\",\n        \"type\": \"alimentos\",\n        \"image\": \"https://thumbs.dreamstime.com/b/homemade-detroit-style-chili-dog-rustic-wooden-board-black-surface-side-view-close-up-homemade-detroit-style-chili-dog-156599438.jpg\",\n        \"restaurant\": \"63e131ceb2fba17a85ebf9be\"\n    }\n```\n\n| Parameter    | Type     | Description      |\n| :----------- | :------- | :--------------- |\n| `name`       | _string_ | Required, unique |\n| `price`      | _number_ | Required         |\n| `type`       | _string_ | Required         |\n| `image`      | _url_    | Required         |\n| `restaurant` | _string_ | ref: restaurant  |\n\n#### Responses\n\n| Code  | Message               |\n| :---- | :-------------------- |\n| `201` | Product created       |\n| `400` | All input is required |\n| `400` | Invalid restaurant id |\n| `404` | Restaurant not found  |\n| `409` | Product already exist |\n\n##\n\n```http\n  GET /products\n```\n\n#### Headers\n\n```\n    authorization: user token\n```\n\n#### Querys\n\n```\n    /products?limit=5\u0026page=1\n```\n\n| Query   | Type     | Description                      |\n| :------ | :------- | :------------------------------- |\n| `limit` | _number_ | number of users by page          |\n| `page`  | _number_ | page number based on users limit |\n\n#### Responses\n\n| Code  | Message                               |\n| :---- | :------------------------------------ |\n| `200` | OK                                    |\n| `400` | Limit and page must be numbers        |\n| `400` | Limit and page must be greater than 1 |\n\n##\n\n```http\n  GET /products/:productId\n```\n\n#### Headers\n\n```\n    authorization: user token\n```\n\n#### Responses\n\n| Code  | Message            |\n| :---- | :----------------- |\n| `200` | OK                 |\n| `400` | Invalid product id |\n| `404` | Product not found  |\n\n##\n\n```http\n  PUT /products/:productId\n```\n\n#### Headers\n\n```\n    authorization: admin token\n```\n\n#### Request body\n\n```\n    {\n        \"name\": \"hot dog mini\",\n        \"price\": \"100\",\n        \"type\": \"alimentos\",\n        \"image\": \"https://thumbs.dreamstime.com/b/homemade-detroit-style-chili-dog-rustic-wooden-board-black-surface-side-view-close-up-homemade-detroit-style-chili-dog-156599438.jpg\",\n    }\n```\n\n| Parameter | Type     | Description      |\n| :-------- | :------- | :--------------- |\n| `name`    | _string_ | Required, unique |\n| `price`   | _number_ | Required         |\n| `type`    | _string_ | Required         |\n| `image`   | _url_    | Required         |\n\n#### Responses\n\n| Code  | Message               |\n| :---- | :-------------------- |\n| `201` | Product updated       |\n| `400` | Invalid restaurant id |\n| `404` | Product not found     |\n\n##\n\n```http\n  DELETE /products/:productId\n```\n\n#### Headers\n\n```\n    authorization: admin token\n```\n\n#### Responses\n\n| Code  | Message            |\n| :---- | :----------------- |\n| `200` | Deleted product    |\n| `400` | Invalid product id |\n| `404` | Product not found  |\n\n## API Reference: orders\n\n```http\n  POST /orders\n```\n\n#### Headers\n\n```\n    authorization: user token\n```\n\n#### Request body\n\n```\n    {\n      \"client\": \"Mary\",\n      \"waiter\": \"63e13207b2fba17a85ebf9c7\",\n      \"products\": [\"63db301bd4a39b95d1f7f601\"],\n      \"restaurant\": \"63db2e3ad4a39b95d1f7f5f4\"\n    }\n```\n\n| Parameter    | Type     | Description            |\n| :----------- | :------- | :--------------------- |\n| `client`     | _string_ | Required               |\n| `waiter`     | _string_ | Required, ref: user    |\n| `products`   | _array_  | Required, ref: product |\n| `restaurant` | _string_ | ref: restaurant        |\n\n#### Responses\n\n| Code  | Message                   |\n| :---- | :------------------------ |\n| `201` | Order created             |\n| `400` | All input is required     |\n| `400` | Products must be an array |\n| `400` | Invalid restaurant id     |\n| `400` | Invalid user id           |\n| `400` | Invalid product id        |\n| `404` | Waiter not found          |\n| `404` | Restaurant not found      |\n\n##\n\n```http\n  GET /orders?restaurant=restaurantId\n```\n\n#### Headers\n\n```\n    authorization: user token\n```\n\n#### Querys\n\n```\n    /orders?limit=5\u0026page=1\n```\n\n| Query   | Type     | Description                      |\n| :------ | :------- | :------------------------------- |\n| `limit` | _number_ | number of users by page          |\n| `page`  | _number_ | page number based on users limit |\n\n#### Responses\n\n| Code  | Message                               |\n| :---- | :------------------------------------ |\n| `200` | OK                                    |\n| `400` | Limit and page must be numbers        |\n| `400` | Limit and page must be greater than 1 |\n| `400` | Invalid restaurant id                 |\n\n##\n\n```http\n  GET /orders/:orderId\n```\n\n#### Headers\n\n```\n    authorization: user token\n```\n\n#### Responses\n\n| Code  | Message          |\n| :---- | :--------------- |\n| `200` | OK               |\n| `400` | Invalid order id |\n| `404` | Order not found  |\n\n##\n\n```http\n  PUT /orders/:orderId\n```\n\n#### Headers\n\n```\n    authorization: user token\n```\n\n#### Request body\n\n```\n    {\n      \"client\": \"Maria\",\n      \"waiter\": \"63e13207b2fba17a85ebf9c7\",\n      \"products\": [\"63db301bd4a39b95d1f7f601\", \"63db301bd4a39b95d1f7f601\"],\n      \"restaurant\": \"63db2e3ad4a39b95d1f7f5f4\"\n    }\n```\n\n| Parameter    | Type     | Description            |\n| :----------- | :------- | :--------------------- |\n| `client`     | _string_ | Required               |\n| `waiter`     | _string_ | Required, ref: user    |\n| `products`   | _array_  | Required, ref: product |\n| `restaurant` | _string_ | ref: restaurant        |\n\n#### Responses\n\n| Code  | Message                   |\n| :---- | :------------------------ |\n| `201` | Order updated             |\n| `400` | Products must be an array |\n| `400` | Invalid restaurant id     |\n| `400` | Invalid user id           |\n| `400` | Invalid product id        |\n| `404` | Waiter not found          |\n| `404` | Restaurant not found      |\n| `404` | Order not found           |\n\n##\n\n```http\n  DELETE /orders/:orderId\n```\n\n#### Headers\n\n```\n    authorization: user token\n```\n\n#### Responses\n\n| Code  | Message          |\n| :---- | :--------------- |\n| `200` | Deleted order    |\n| `400` | Invalid order id |\n| `404` | Order not found  |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsharonina%2Fburgerqueen-db","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsharonina%2Fburgerqueen-db","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsharonina%2Fburgerqueen-db/lists"}