Page MenuHomePhabricator
Create Task
Maniphest T167022

Inventory requirements for summary 2.0 endpoint across Reading teams
Closed, ResolvedPublic
Actions

Description

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:

  1. The summary endpoint https://en.wikipedia.org/api/rest_v1/page/summary/dog
  2. The feed endpoint https://en.wikipedia.org/api/rest_v1/feed/featured/2017/05/29
  3. On This Day https://en.wikipedia.org/api/rest_v1/feed/onthisday/all/06/20
  4. 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)
TBD

Related Objects
Search...

StatusSubtypeAssignedTask
 ResolvedNoneT169242 Develop Page Content Service for Reading Clients
 ResolvedNoneT177425 Develop General Layer of PCS
 Resolved• JhernandezT177426 Develop structured JSON APIs for general consumption
 Resolved• MhollowayT177431 Develop a Summary JSON API
 ResolvedDerecksonT68374 Enable Hovercards on se.wikimedia.org (Swedish chapter wiki)
 ResolvedJdlrobsonT70860 [GOAL] Graduate Page Previews feature (Popups extension) out of Beta Feature
 ResolvedovasilevaT154635 [EPIC] Deploy page previews to English and German Wikipedia
 ResolvedovasilevaT192622 [EPIC] Page previews post-deploy cleanup
 ResolvedJdlrobsonT173952 Remove A/B testing instrumentation code
 DuplicateNoneT167433 Switch all projects to the new (and yet to be built) summary-html endpoint for page previews
 DuplicateNoneT167429 Make enwiki and dewiki fetch previews from the summary-html RESTBase endpoint
 ResolvedovasilevaT165018 Page previews can consume new summary-HTML endpoint
 DeclinedJdlrobsonT111329 [GOAL] Page previews on mobileweb
 ResolvedJdlrobsonT164010 [EPIC] Strengthen the APIs we provide in reading web maintained extensions
 ResolvedovasilevaT113094 [EPIC] The Page Summary API needs to provide useful content for the majority of articles
 Resolved• FjalapenoT167022 Inventory requirements for summary 2.0 endpoint across Reading teams
 ResolvedphuedxT168400 [EPIC] Add notion of emptiness to page summary API
 DeclinedpmiazgaT168328 Extracts for Wikimedia List articles display partial previews
 DeclinedNoneT168391 Page previews should display generic preview for disambiguation pages
 ResolvedphuedxT114418 Disable TextExtracts on file pages
 DeclinedNoneT168418 Page Previews should accept the service's notion of emptiness
 Resolved• PcheloloT164291 Make title-related properties consistent
 Resolved• bearNDT169761 Review Summary 2.0 Spec
 Resolved• MhollowayT170692 Return common URLs in summary API so clients do not have to perform bug prone string manipulation
ResolvedMSantosT177619 Return variant URLs and titles in the metadata response
 Resolved• MhollowayT178446 Expose display titles for a page in all available language variants through the action API

Event Timeline

• Fjalapeno created this task.Jun 5 2017, 2:11 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptJun 5 2017, 2:11 PM
• Fjalapeno moved this task from Needs triage to Kanban on the Product-Infrastructure-Team-Backlog-Deprecated board.Jun 5 2017, 2:11 PM
• Fjalapeno edited projects, added Product-Infrastructure-Team-Backlog-Deprecated (Kanban); removed Product-Infrastructure-Team-Backlog-Deprecated.
• Fjalapeno moved this task from To Do to Doing on the Product-Infrastructure-Team-Backlog-Deprecated (Kanban) board.
• mobrovac edited projects, added Services (watching); removed Services, RESTBase-API.Jun 5 2017, 2:43 PM
• Jhernandez added a subscriber: phuedx.Jun 26 2017, 4:48 PM

cc/ @phuedx who is working on gathering requirements for the html version of the summary endpoint for Page-Previews.

• Fjalapeno added a comment.Jun 26 2017, 7:17 PM

@Jhernandez I was taking this on… I hadn't started yet as this was mostly about the next version of the summary end point (specifically around reworking the title properties) - and that was being pushed out a few months.

However the Page-Previews discussion (empty pages topics) is also happening. That may change our timing.

After we decide the scope of the changes at the next reading services sync, I can circle back here with more concrete plans

• Jhernandez added a comment.Jun 27 2017, 9:04 AM

Sounds great!

• Fjalapeno added a subtask: T168400: [EPIC] Add notion of emptiness to page summary API.Jun 29 2017, 5:13 PM
• Fjalapeno added a subtask: T164291: Make title-related properties consistent.Jul 5 2017, 3:41 PM
• Fjalapeno added a parent task: T113094: [EPIC] The Page Summary API needs to provide useful content for the majority of articles.Jul 5 2017, 3:43 PM
• Fjalapeno added a subtask: T169761: Review Summary 2.0 Spec.Jul 5 2017, 3:48 PM
• Fjalapeno added a comment.Jul 12 2017, 3:10 PM

FYI - the work of this ticket is largely being done here:
T169761: Review Summary 2.0 Spec

• Fjalapeno moved this task from Doing to Sign off on the Product-Infrastructure-Team-Backlog-Deprecated (Kanban) board.Jul 13 2017, 2:50 PM
phuedx closed subtask T168400: [EPIC] Add notion of emptiness to page summary API as Resolved.Jul 14 2017, 9:43 AM
• Fjalapeno created subtask T170692: Return common URLs in summary API so clients do not have to perform bug prone string manipulation .Jul 14 2017, 4:29 PM
Jdlrobson added a parent task: T171871: Text inside the <math> tag is displayed as plain text or correctly with odd spacing on the 'descriptions' of Wikipedia pages on mobile..Aug 4 2017, 1:58 PM
• Fjalapeno removed a parent task: T171871: Text inside the <math> tag is displayed as plain text or correctly with odd spacing on the 'descriptions' of Wikipedia pages on mobile..Oct 4 2017, 5:57 PM
• Fjalapeno closed this task as Resolved.Oct 6 2017, 4:06 PM
• Fjalapeno closed subtask T169761: Review Summary 2.0 Spec as Resolved.
• bearND closed subtask T170692: Return common URLs in summary API so clients do not have to perform bug prone string manipulation as Resolved.Nov 9 2017, 3:15 AM
• Mholloway closed subtask T164291: Make title-related properties consistent as Resolved.Jan 10 2018, 3:50 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL