~shreyasminocha/rice-dining-api

f4e59d036f4dfc4010a43c88816a2b9e7f7aafcd — Shreyas Minocha 2 years ago 5040db1
Add readme and license
2 files changed, 99 insertions(+), 0 deletions(-)

A LICENSE
A README.md
A LICENSE => LICENSE +21 -0
@@ 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.

A README.md => README.md +78 -0
@@ 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).