Page MenuHomePhabricator

Minimal client REST API
Open, MediumPublic

Description

This is an epic task, for creating the minimal API functionality necessary for building a wiki client (mobile, desktop, web).

It includes the following endpoints:

EndpointUser storyTicket
GET /page/{title}"As a Contributor, I want to get the source code for a page, so that I can edit it locally."T229663: Contributor gets page source
POST /page/"As a Contributor, I want to create a new page, so that I can add information to the project."T230842: Contributor creates a page
PUT /page/{title}"As a Contributor, I want to update a page, so that I can include more information or restructure the content."T230843: Contributor updates a page
GET /search/page?q={search term}"As a Reader, I want to get a list of pages that match a search term, so that I can find pages about a topic I’m interested in."T230844: Reader searches for a topic
GET /page/{title}/links/media"As a Reader, I want to get a list of media files embedded in a page, so that I can view, read or listen to them. "T230845: Reader gets media links
GET /page/{title}/links/language"As a Reader, I want to get a list of alternate language versions of a page, so that I can switch to another language version."T230846: Reader gets language links
GET /file/{title}"As a Reader, I want to get the current version of a media file, so I can read, view or listen to it. "T230848: Reader gets file description
GET /page/{title}/with_html"As a Reader, I want to get a page and its contents, so that I can read it whenever I want."T234375: Reader reads a page offline
GET /page/{title}/bare"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."T234377: Reader reads a page online
GET /page/{title}/html" " "" "

Related Objects

StatusSubtypeAssignedTask
OpenNone
OpenNone
Resolvednnikkhoui
InvalidNone
Invalidapaskulin
Declinednnikkhoui
Resolved eprodromou
InvalidNone
Invalidapaskulin
Resolved eprodromou
InvalidNone
Invalidapaskulin
Opendaniel
Resolveddaniel
Resolvednnikkhoui
InvalidNone
Invalidapaskulin
Resolvednnikkhoui
Resolved eprodromou
Resolved eprodromou
OpenNone
Resolved eprodromou
OpenNone
OpenNone
Resolvedtstarling
Resolved eprodromou
InvalidNone
Invalidapaskulin
Resolved eprodromou
InvalidNone
InvalidNone
Invalidapaskulin
Invalidapaskulin
OpenNone
OpenNone

Event Timeline

eprodromou set the point value for this task to 89.
eprodromou updated the task description. (Show Details)

@Pchelolo I've updated all the endpoints that talked about the "content model of the page" so they now talk about the "content model of the main slot of the page". I think that should get us clear of T230607 and keep the process moving forward.

@Pchelolo We talked about finding a way to review the API quickly. If the table format in this epic description works for you, I can do it for the other epics in the initiative, and I can do a big table at the initiative level.

This is still open since the routes aren't released in v1.

Aklapper added a subscriber: eprodromou.