Curator reads revision metadata
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	• eprodromou
	Aug 27 2019, 4:25 PM

Description

"As a Curator, I want to get metadata about a revision of a page, so that I can understand what was changed."

GET /revision/{id}/bare

Return the revision of a page without content.

Request payload: none

Status code:

200 - OK
403 - Not authorized
404 - No such revision

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)

Related Objects
Search...

Status	Assigned	Task
Invalid	None	T229661 Core REST API in MediaWiki
Resolved	• eprodromou	T231338 Page history API
Resolved	• eprodromou	T231345 Curator reads revision metadata
Resolved	BPirkle	T231588 Implement GET Page Revision
Resolved	apaskulin	T233422 Document single revision endpoint
Resolved	• Clarakosi	T235564 Implement Integration Tests for Existing iOS Endpoints
Resolved	brennen	T236333 Install wikidiff2 into mediawiki-quibble-api-testing-vendor-mysql-php72-docker

Event Timeline

• eprodromou created this task.Aug 27 2019, 4:25 PM

• eprodromou edited projects, added Story; removed Epic.Aug 27 2019, 4:32 PM

• eprodromou moved this task from Epic Backlog to User Story Tasks being created on the Platform Team Workboards (Epics) board.Aug 27 2019, 6:13 PM

• eprodromou moved this task from User Story Tasks being created to User Stories Needing EM Sign Off on the Platform Team Workboards (Epics) board.

• eprodromou renamed this task from Curator reads a version to Curator reads a revision .Aug 28 2019, 11:53 PM

• eprodromou updated the task description. (Show Details)

WDoranWMF moved this task from User Stories Needing EM Sign Off to User Stories Ready for Engineering on the Platform Team Workboards (Epics) board.Aug 29 2019, 12:34 PM

WDoranWMF moved this task from User Stories Ready for Engineering to Teleport to User Story Workboard on the Platform Team Workboards (Epics) board.Aug 29 2019, 2:42 PM

WDoranWMF edited projects, added Platform Team Workboards (User Stories); removed Platform Team Workboards (Epics).

WDoranWMF moved this task from Backlog to Need Engineering Tasks on the Platform Team Workboards (User Stories) board.

WDoranWMF moved this task from Need Engineering Tasks to User Stories Ready for Engineering Tasks on the Platform Team Workboards (User Stories) board.Aug 29 2019, 4:12 PM

WDoranWMF added a project: Platform Team Initiatives (MW REST API in PHP).Sep 3 2019, 2:26 PM

WDoranWMF moved this task from User Stories Ready for Engineering Tasks to Waiting to be Scheduled on the Platform Team Workboards (User Stories) board.

WDoranWMF moved this task from Waiting to be Scheduled to Doing on the Platform Team Workboards (User Stories) board.Sep 5 2019, 5:56 PM

• eprodromou updated the task description. (Show Details)Oct 2 2019, 8:14 PM

Based on conversations with @tstarling, we decided the caching header support is a premature optimization that is getting in the way of getting these endpoints finished. I'm moving the requirements to a separate ticket that we can get to as needed.

I also added the comment field and bundled the page ID and title and the user id and name. @tstarling pointed out that we should probably bundle up these properties related to the same object as sub-objects in the JSON.

comment per @Pchelolo , thanks

• eprodromou updated the task description. (Show Details)Oct 2 2019, 8:24 PM

• eprodromou updated the task description. (Show Details)Oct 8 2019, 7:38 PM

• eprodromou renamed this task from Curator reads a revision to Curator reads revision metadata .Oct 11 2019, 1:17 AM

• eprodromou updated the task description. (Show Details)

Per discussion in Green Team checkin, we removed HTML from this endpoint.

We'd like to use only Parsoid reversible HTML in all the Mediawiki REST API endpoints, but we don't have time to build that into the MediaWiki endpoints. So, we're removing HTML entirely.

I've changed the endpoint to use a different URL, similar to the structure used in T234377. I also added in the size and delta properties, since we use them in the page history output also.