Skip to content

Commit

Permalink
added search documentation for api
Browse files Browse the repository at this point in the history
  • Loading branch information
Thatskat authored Jul 1, 2023
1 parent fecbe08 commit 725b453
Showing 1 changed file with 46 additions and 6 deletions.
52 changes: 46 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,20 +47,60 @@ Returns an array of `{number}` South Park quotes. E.g. `GET /v1/quotes/3`
```
[
{
"quote": "I'm not fat, I'm festively plump.",
"character": "Cartman"
"quote": "I'm not fat, I'm festively plump.",
"character": "Cartman"
},
{
"quote": "But what does being Hawaiian have to do with me being like an emo chick on her period?",
"character": "Butters"
"quote": "But what does being Hawaiian have to do with me being like an emo chick on her period?",
"character": "Butters"
},
{
"quote": "Cartman doesn’t know a rainforest from a Pop-Tart.",
"character": "Stan"
"quote": "Cartman doesn’t know a rainforest from a Pop-Tart.",
"character": "Stan"
}
]
```

### `GET /v1/quotes/search/{searchTerm}`
Returns an array that is either said by or includes the `{searchTerm}` from South Park quotes. E.g. `GET /v1/quotes/search/randy`

> [https://southparkquotes.up.railway.app/v1/quotes/search/randy](https://southparkquotes.up.railway.app/v1/quotes/search/randy)

```
[
{
"quote": "as you get older, boobs will start becoming a major part of your life. but you can’t let them get in the way of your friends. there are a lot of boobs out there. but they’re just boobs. your friends are forever.",
"character": "randy"
},
{
"quote": "we must stop frivolous spending! instead of paying for cable, let us watch clouds! instead of buying clothes, wear but sheets from thine beds! cut spending to only the bare essentials! water and bread and margaritas!",
"character": "randy"
},
{
"quote": "oh, i forgot to tell you that part. i'm lorde.",
"character": "randy"
},
{
"quote": "i ammm lorde. lawdy lawdy lorde!",
"character": "randy"
},
{
"quote": "winter's coming, sharon, and i'm a busy little bee. buzz! buzz!",
"character": "randy"
},
{
"quote": "oh, i’m sorry! i thought this was america!",
"character": "randy"
},
{
"quote": "i’m not having a glass of wine, i’m having six. it’s called a tasting, and it’s classy.",
"character": "randy"
}
]
```


## Contributions
Want to add some South Park quotes? All you need to do is simply add them in the `quotes.js` file and then create a pull request.

Expand Down

0 comments on commit 725b453

Please sign in to comment.