Topic on Talk:Core Platform Team/Initiative/Core REST API in MediaWiki/Epics, User Stories, and Requirements

Epic 1, User Story 1

1
EProdromou (WMF) (talkcontribs)

Per discussion with Tim and Corey last night, we realized that there are some finer-grained user stories that require different solutions. I'm going to separate it into three different user stories.

  • Reader reads a page offline. This is the most basic use case, retrieving the metadata about the page and the page text in HTML form in a single request.
  • Reader reads a page online. Downloading a large document encoded in JSON, then loading the HTML from the JSON into a browser or native HTML widget, is much less efficient that letting the browser or widget download the HTML itself. So, if the user is "online", we want to have two endpoints: one for the JSON representation of the page without HTML, and one for HTML only.
  • Contributor gets a page for editing. For a contributor, it's important to get the wikitext source for a page, which can be edited and then updated (user story 3). Because this representation is so similar to the representation for the Create and Update stories, it makes sense to keep this at the GET /page/{title} endpoint.

I'm going to update the user stories to include this information.

Reply to "Epic 1, User Story 1"