Feature reference audit: search parameters #1016
Conversation
…their expected values and examples more consistent and clear
There was a problem hiding this comment.
The shifu examples are bad at showcasing the features. The most clear example is attributeToHighlight where you have to scroll to see the actual highlight.
It might be interesting to reconsider the film used for the example
| ```json | ||
| { | ||
| "hits": [ | ||
| { | ||
| "id":"50393", | ||
| "title":"Kung Fu Panda Holiday", | ||
| "poster":"https://image.tmdb.org/t/p/w500/rV77WxY35LuYLOuQvBeD1nyWMuI.jpg", | ||
| "overview":"The Winter Feast is Po's favorite holiday. Every year he and his father hang decorations, cook together, and serve noodle soup to the villagers. But this year Shifu informs Po that as Dragon Warrior, it is his duty to host the formal Winter Feast at the Jade Palace. Po is caught between his obligations as the Dragon Warrior and his family traditions: between Shifu and Mr. Ping.", | ||
| "release_date":1290729600, | ||
| "genres":["Animation","Family","TV Movie"] | ||
| }, | ||
| … | ||
| ], | ||
| … | ||
| "query":"shifu" | ||
| } | ||
| ``` |
There was a problem hiding this comment.
This example is very long, I regret using that one. If you want to use a smaller one I think it would be more clear on first sight
There was a problem hiding this comment.
We are discussing decoupling examples from the movies.json dataset, so that anything outside e.g. the Quick Start tutorial refers to a non-existent dataset. This would allow us to have very focussed examples; the above bit, for instance, could be abbreviated to:
{
"id":"50393",
"title":"Kung Fu Panda Holiday",
"overview":" <em>Shifu</em> informs Po that as Dragon Warrior, it is his duty to host the formal Winter Feast at the Jade Palace.",
"genres":["Animation","Family","TV Movie"]
}
|
Closing this in favour of #1027 |
Proposals:
GETendpoint directly without an SDK (information verified with @curquiza).