From f4e59d036f4dfc4010a43c88816a2b9e7f7aafcd Mon Sep 17 00:00:00 2001 From: Shreyas Minocha Date: Mon, 31 Jan 2022 17:19:06 -0600 Subject: [PATCH] Add readme and license --- LICENSE | 21 +++++++++++++++ README.md | 78 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 99 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6ce7e5f --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License + +Copyright © 2022 Shreyas Minocha + +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and associated documentation files (the "Software"), +to deal in the Software without restriction, including without limitation +the rights to use, copy, modify, merge, publish, distribute, sublicense, +and/or sell copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +The software is provided "as is", without warranty of any kind, express +or implied, including but not limited to the warranties of merchantability, +fitness for a particular purpose and noninfringement. In no event shall +the authors or copyright holders be liable for any claim, damages or other +liability, whether in an action of contract, tort or otherwise, arising +from, out of or in connection with the software or the use or other +dealings in the software. diff --git a/README.md b/README.md new file mode 100644 index 0000000..a0d8939 --- /dev/null +++ b/README.md @@ -0,0 +1,78 @@ +# [Rice Dining](https://dining.rice.edu) API + +A REST API for accessing Rice servery menus. + +## API + +`servery` is one of: + +- `west-servery` +- `seibel-servery` +- `baker-kitchen` +- `north-servery` + +### `GET /:servery` + +Response layout: + +```json +[ + { + "meal": "Lunch", + "menu": [ + { "item": "Foo", "tags": ["vegan", "soy"] }, + { "item": "Bar", "tags": ["soy"] } + ] + }, + { + "meal": "Dinner", + "menu": [ + { "item": "Foo", "tags": ["vegetarian", "milk"] }, + { "item": "Baz", "tags": ["gluten", "soy", "milk"] } + ] + } +] +``` + +### `GET /:servery/full-week-menu` + +Response layout: + +```json +[ + { + "meal": "Monday Lunch", + "menu": [ + { "item": "Foo", "tags": ["vegan"] }, + { "item": "Bar", "tags": ["milk"] } + ] + }, + ... + { + "meal": "Sunday Lunch", + "menu": [ + { "item": "Baz", "tags": ["vegan"] }, + { "item": "Bar", "tags": ["vegan"] } + ] + }, + { + "meal": "Monday Dinner", + "menu": [ + { "item": "Bar", "tags": ["vegan", "soy"] }, + { "item": "Foo", "tags": ["vegan"] } + ] + }, + ... + { + "meal": "Sunday Dinner", + "menu": [ + { "item": "Foo", "tags": ["vegan"] }, + { "item": "Baz", "tags": ["vegan"] } + ] + } +] +``` + +## License + +See [`LICENSE`](./LICENSE). -- 2.45.2