Prior to making large changes to the summary response (as laid out here: T164291: Make title-related properties consistent), we should inventory all the data we need from summary responses.
Summaries are returned from several APIs:
- The summary endpoint https://en.wikipedia.org/api/rest_v1/page/summary/dog
- The feed endpoint https://en.wikipedia.org/api/rest_v1/feed/featured/2017/05/29
- On This Day https://en.wikipedia.org/api/rest_v1/feed/onthisday/all/06/20
- Trending https://en.wikipedia.org/api/rest_v1/feed/trending/edits/3
Summaries are typical used when displaying a list of articles from some discovery mechanism. Reading use cases include:
- The feed - which includes top read, featured, random, in the news, because you read (iOS Android)
- Read more (iOS, Android, Web)
- Page Previews / Link Previews (Desktop web, Android)
- Text Search Results
- Location Search Results
- Saved / History
While not all of the use cases above use RESTBase summaries, the goal is to eventually use the well structured response in all places in order to simplify parsing code.
Each context requires slightly different information, but is mostly the same:
(Will be filling in needs for each platform)