"As a Reader, I want to get a page online, so that I can read it with my browser or HTML widget and it will load fast."
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.
Note: TWO endpoints follow.
GET /page/{title}/bare
Returns the page as JSON. Title is escaped for slashes
Payload: empty
Request headers:
If-Modified-Since: for cache
If-None-Match: for cacheNotable request headers: none
Status:
200 – this is the page
304 – not modified; body should be empty
404 – page does not exist (never created or deleted)
HNotable response headers:: none
Body: JSON
Last-modified: last modification date* id: numeric id of the page
ETag: entity tag for* key: prefixed DB key of the pageage, like "Talk:Main_Page"
Location: actual location if redirected
Body: JSON* title: title for display, like "Talk:Main Page"
* latest: latest revision of the page, object with these properties
** id: revision ID
id: id of the page ** timestamp: revision timestamp
revision_id: revision ID of* license: SPDX code for the preferred license for the page
key: prefixed DB key of the page, like "Talk:Main_Page"* other_licenses: array of SPDX codes for alternative licenses for the page
title: title* contributors: array of User objects for displaythe contributors to the page, like "Talk:Main Page"each with these properties
html_url: full API URL for retrieving ** id: user ID
** name: user name
* html_url: URL for the HTML stream for the page
----
GET /page/{title}/html
Returns the page HTML. Title is escaped for slashes
Payload: empty
Request headers:
If-Modified-Since: for cache
If-None-Match: for cacheNotable request headers: none
Status:
200 – this is the page
304 – not modified; body should be empty
404 – page does not exist (never created or deleted)
Headers:
Last-modified: last modification date of the page
ETag: entity tag for the page
Location: actual location if redirectedNotable response headers: none
Body: HTML
Reversible HTML for the page as generated by Parsoid. No skin or navigation.