Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Just an example as a possible jumping off point. #5

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Just an example as a possible jumping off point. #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 27 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,27 @@
# flask-test
# War on Ice API

### Getting Players
```
GET /api/players
```
Get all players, ever.

| parameter | description |
| --------- | ------------|
| page | Return player information by page. Default is 1 |
| limit | Limit the number of player records returned. Default is 20 |
| order | Sort player records. Default is name |

These below are for acceptance, edit and flat out rejection. What will be the
approach to detailing data? Will it be endpoints with many, many `query params`
or providing longer detailed `urls` or a nice balance of both?

```
GET /api/players/ryan-getzlaf
GET /api/teams/new-jersey-devils
GET /api/seasons/2014
GET /api/games
GET /api/games/2015/05/30
GET /api/playoffs/2012
GET /api/goalies
```