User:APaskulin (WMF)/Sandbox/Reference

The MediaWiki REST API lets you interact with a MediaWiki instance using a RESTful HTTP interface. You can read and edit pages, download media files, explore page history, and more.

= Search =

Search result object
The search result object represents a wiki page matching the requested search.

Search pages
Searches wiki page titles and contents for the provided search terms, and returns matching pages.

Autocomplete page title
Searches wiki page titles, and returns matches between the beginning of a title and the provided search terms. You can use this endpoint for a typeahead search that automatically suggests relevant pages by title.

Responses
= Pages =

Page object
The page object represents the latest revision of a wiki page.

Create page
Creates a wiki page. This endpoint is designed to be used with the OAuth extension authorization process. Callers who instead use cookie-based authentication must add a CSRF  to the request body. See the Action API docs to learn how to retrieve a CSRF token.

Update page
Updates an existing wiki page. You can also use this endpoint to create a page by omitting the  property from the request body.

When updating the page, the client should always first fetch the page content from the get page source endpoint, modify the source, and copy the content of the  key. In the event of an edit conflict, this endpoint performs automatic conflict resolution if possible.

This endpoint is designed to be used with the OAuth extension authorization process. Callers who instead use cookie-based authentication must add a CSRF  to the request body. See the Action API docs to learn how to retrieve a CSRF token.

Get page
Returns the standard Page object for a wiki page, including the API route to fetch the content of the page in HTML, the license, and information about the latest revision.

Get page offline
{| style="width: 100%;" ! style="text-align:left;"|Route ! style="text-align:left;"|Content type ! style="text-align:left;"|Method ! style="text-align:left;"|Returns
 * Page object with

Responses
Returns the content of a wiki page in the format specified by the  property, the page license, and information about the latest revision.

Get HTML
Returns the latest HTML for a wiki page. See the HTML 2.1.0 spec for a description of the MediaWiki-specific semantic markup in this HTML. Note that additional metadata is available in the HTML head.

Responses
= Languages =

Language object
The language object represents a wiki page and its language.

Get languages
Searches connected wikis for pages with the same topic in different languages. Returns an array of language objects that include the name of the language, the language code, and the translated page title.

Responses
= Media files =

File object
The file object represents a file uploaded to a wiki.

Get file
Returns information about a file, including links to download the file in thumbnail, preview, and original formats.

Get media files
Returns information about media files used on a wiki page.

Responses
= History =

Revision object
A revision object represents a change to a wiki page.

Get page history
Returns information about the 20 latest revisions to a wiki page, starting with the latest revision. The returned revision segment includes API routes for the next oldest, next newest, and latest revisions, letting you scroll through page history.

Get page history counts
Returns data about a page's history.

Get revision
Returns details for an individual revision.

Compare revisions
Returns data that lets you display a line-by-line comparison of two revisions. (See an example.) Only text-based wiki pages can be compared.