Skip to content

Commit 78ae006

Browse files
committed
fixed readme issue
1 parent c45097f commit 78ae006

File tree

1 file changed

+14
-15
lines changed

1 file changed

+14
-15
lines changed

README.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -41,21 +41,20 @@ The backend will automatically restart if you change any of the files in the `to
4141

4242
To manually test the endpoints, simply start up the server and visit PORT/endpoints. Then you will be able to see all the swagger doc and can do the following testing actions. Do these in order to ensure reproducible results. The best way to gaurantee this is if you spin up the service locally, that way a fresh database is gauranteed. If you insert enough uniquely named teams, then send a request along the lines of /towns/scores/5, the results should be a status 200 and list of the 5 highest scores without using a hint (if there are less than 5 that did not use a hint, than some with a hint might be shown). Regardless of time, if a team uses a hint, they are bumped below a team that did not.
4343

44-
| Endpoint | Expected Behaviour |
45-
| ------------------------------------------- | --------------------------------------------------------------------------------- |
46-
| /towns/scores/5 | returns ScoreFindResponse with status 200 and an empty list |
47-
| /towns/scores/0 | returns ScoreFindResponse with status 400 and an invalid parameter error |
48-
| /towns/scores/11 | returns ScoreFindResponse with status 400 and an invalid parameter error |
49-
| /towns/scores/zero | returns ScoreFindResponse with status 400 and an invalid parameter error |
50-
| /towns/scores/teams/test | returns TeamInUseResponse with status 200 and boolean value of false |
51-
| /towns/score (with preset example for body) | returns ScoreModifyResponse with status 201 and scoreModel that matches the input |
52-
| /towns/scores/teams/test | returns TeamInUseResponse with status 200 and boolean value of true |
53-
| /towns/scores/teams/test1 | returns TeamInUseResponse with status 200 and boolean value of false |
54-
55-
| /towns/scores/5 | returns ScoreFindResponse with status 200 and a list populated solely by the inserted score |
56-
| /towns/score (with preset example for body) | returns ScoreModifyResponse with status 400 and MongoServerError error with message that reads along the lines of "name already exists"|
57-
| /towns/score (change name of preset to test1) | returns ScoreModifyResponse with status 201 and scoreModel that matches the input |
58-
| /towns/scores/5 | returns ScoreFindResponse with status 200 and a list with score models that have the names "test" and "test1" |
44+
| Endpoint | Expected Behaviour |
45+
| --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
46+
| /towns/scores/5 | returns ScoreFindResponse with status 200 and an empty list |
47+
| /towns/scores/0 | returns ScoreFindResponse with status 400 and an invalid parameter error |
48+
| /towns/scores/11 | returns ScoreFindResponse with status 400 and an invalid parameter error |
49+
| /towns/scores/zero | returns ScoreFindResponse with status 400 and an invalid parameter error |
50+
| /towns/scores/teams/test | returns TeamInUseResponse with status 200 and boolean value of false |
51+
| /towns/score (with preset example for body) | returns ScoreModifyResponse with status 201 and scoreModel that matches the input |
52+
| /towns/scores/teams/test | returns TeamInUseResponse with status 200 and boolean value of true |
53+
| /towns/scores/teams/test1 | returns TeamInUseResponse with status 200 and boolean value of false |
54+
| /towns/scores/5 | returns ScoreFindResponse with status 200 and a list populated solely by the inserted score |
55+
| /towns/score (with preset example for body) | returns ScoreModifyResponse with status 400 and MongoServerError error with message that reads along the lines of "name already exists" |
56+
| /towns/score (change name of preset to test1) | returns ScoreModifyResponse with status 201 and scoreModel that matches the input |
57+
| /towns/scores/5 | returns ScoreFindResponse with status 200 and a list with score models that have the names "test" and "test1" |
5958

6059
### Configuring the frontend
6160

0 commit comments

Comments
 (0)