Curator reads a revision offline
Open, MediumPublic
Actions

Assigned To

None

Authored By

	• eprodromou
	Oct 11 2019, 1:42 AM

Description

"As a Curator, I want to get a revision and its contents, so that I can read it whenever I want."

GET /revision/{id}/with_html

Return the revision of a page without content.

Request payload: none

Body: JSON, object with following fields:

id: revision ID
page: Object with these fields
- id: ID of the page
- title: current title of the page (might have been changed)
user: user who made the change, object with these fields
- id: ID of the user or null for anonymous
- name: name of the user or unique identifier for anonymous
comment: User comment ("edit summary") describing the change that generated this revision
timestamp: time the revision was made
size: size of the revision in "bogobytes" (as from DB, usually bytes)
delta: change from previous revision in "bogobytes" (as from DB, usually bytes)
html: reversible HTML content of the page as generated by Parsoid, including all slots, for current user

Related Objects
Search...

Status	Assigned	Task
Invalid	None	T229661 Core REST API in MediaWiki
Open	None	T234951 Extended history API
Open	None	T235240 Curator reads a revision offline

Event Timeline

• eprodromou created this task.Oct 11 2019, 1:42 AM

• eprodromou updated the task description. (Show Details)

User story T231345 used to have HTML embedded, but due to schedule pressures we dropped it. It's now in this user story instead.

• eprodromou moved this task from Backlog to Needs Review on the Platform Team Workboards (User Stories) board.Nov 6 2019, 7:37 PM

This is kind of a bigger task than it looks like, because currently we don't have Parsoid/PHP available in MediaWiki core. We need to include it via PHP Composer (I don't think it's yet part of the PHP Composer repository, either).

We also need to cache the Parsoid/PHP HTML output; probably using the same cache that RESTBase uses.

• eprodromou updated the task description. (Show Details)Nov 6 2019, 8:53 PM

• eprodromou triaged this task as Medium priority.Nov 6 2019, 9:03 PM

• eprodromou mentioned this in T237868: Curator reads a revision with slots.Nov 10 2019, 5:35 PM

What is "bogobytes"?

• eprodromou edited projects, added Platform Team Workboards (Green); removed Platform Team Workboards (User Stories).Nov 14 2019, 9:39 PM

• eprodromou moved this task from Backlog to Next Sprint on the Platform Team Workboards (Green) board.

• eprodromou moved this task from Next Sprint to Backlog on the Platform Team Workboards (Green) board.Dec 2 2019, 8:46 PM

In T235240#5654910, @tstarling wrote:

What is "bogobytes"?

It's the (theoretically) arbitrary size system that each content model implements.

includes/content/Content.php

	/**
	 * Returns the content's nominal size in "bogo-bytes".
	 *
	 * @return int
	 */
	public function getSize();

Krenair subscribed.Dec 28 2019, 10:14 AM

• eprodromou removed a project: Platform Team Workboards (Green).Jul 29 2020, 2:00 PM

Aklapper removed • eprodromou as the assignee of this task.Apr 1 2021, 5:52 AM

Curator reads a revision offlineOpen, MediumPublicActions

Description

Related ObjectsSearch...

Event Timeline

Curator reads a revision offline
Open, MediumPublic
Actions

Related Objects
Search...