Change filter predicate in example

kolja-lucht commented 1 year ago

Summary

While working on the documentation I tried out some of the example API requests. I noticed that https://api.potterdb.com/v1/characters?filter[name_eq]=Weasley doesn't return anything (I'm assuming because the character's name consists of first name and last name).

Also the paragraph mentions [name_cont]. That's why I'm tweaking it slightly to use [name_cont] to fix this small inconsistency and to give users an example that actually returns something.

Related Issues

n/a

Checklist

[x] This pull request has a meaningful title and description.
[x] I have read and followed the Contributing guidelines.
[x] My code follows the conventions and coding style of this project.
[x] All tests pass and I have added tests for my changes
[x] I have updated necessary documentation

Additional information

Just curious: How would you query the characters' endpoint when using [name_eq]? I tried a few things but never got any results back...

vercel[bot] commented 1 year ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
potter-db-docs	✅ Ready (Inspect)	Visit Preview	Oct 30, 2023 6:50pm

1 Ignored Deployment

kolja-lucht commented 1 year ago

Found another small thing to fix @danielschuster-muc :)

danielschuster-muc commented 1 year ago

Just curious: How would you query the characters' endpoint when using [name_eq]? I tried a few things but never got any results back...

https://api.potterdb.com/v1/characters?filter[name_eq]=Harry+James+Potter

this should work

danielschuster-muc / potter-db