User:APaskulin (WMF)/Sandbox/Reference

Search pages
Searches wiki page titles and contents for the provided search terms, and returns matching pages. This endpoint responds to the presence of a logged-in user and returns search results appropriate to that user's permissions.

This endpoint uses the search engine configured in the $wgSearchType configuration setting and returns results in the namespaces configured by $wgNamespacesToBeSearchedDefault.

Autocomplete page title
Searches wiki page titles, and returns pages with titles that start with the provided search terms. You can use this endpoint for a typeahead search that autocompletes the page title. This endpoint responds to the presence of a logged-in user and returns search results appropriate to that user's permissions.

This endpoint uses the search engine configured in the $wgSearchType configuration setting and returns results in the namespaces configured by $wgNamespacesToBeSearchedDefault.

Create page
Creates a wiki page.

 Request examples 

 Request body schema 

 Responses 

 Response schema 

Create or update page
Creates a wiki page, or updates an existing page. This endpoint responds to the presence of a logged-in user and allows updates appropriate to that user's permissions.

 Request examples 

 Request parameters 

 Request body schema 

 Responses 

 Response schema 

Get wikitext
Returns the content of a wiki page as wikitext, the page license, and information about the latest revision. This endpoint responds to the presence of a logged-in user and displays content appropriate to that user's permissions.

 Request examples 

 Request parameters 

 Responses 

 Response schema 

Get HTML
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. This endpoint responds to the presence of a logged-in user and displays content appropriate to that user's permissions.

To use this endpoint on your wiki, install RESTBase and configure VirtualRESTService.

 Request examples 

 Request parameters 

 Responses 

 Response schema 

Get HTML only
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. This endpoint responds to the presence of a logged-in user and displays content appropriate to that user's permissions.

To use this endpoint on your wiki, install RESTBase and configure VirtualRESTService.

 Request examples 

 Request parameters 

 Responses 

Get HTML offline
Returns information about a wiki page, including the license, information about the latest revision, and the latest content of the page as HTML. 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. This endpoint responds to the presence of a logged-in user and displays content appropriate to that user's permissions.

To use this endpoint on your wiki, install RESTBase and configure VirtualRESTService.

 Request examples 

 Request parameters 

 Responses 

 Response schema 

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. This endpoint responds to the presence of a logged-in user and displays content appropriate to that user's permissions.

 Request examples 

 Request parameters 

 Responses 

 Response schema 

Get media files
Returns information about media files used on a wiki page. This endpoint responds to the presence of a logged-in user and displays content appropriate to that user's permissions.

 Request examples 

 Request parameters 

 Responses 

 Response schema 

Get file
Returns information about a file, including links to download the file in thumbnail, preview, and original formats. This endpoint responds to the presence of a logged-in user and displays content appropriate to that user's permissions.

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. This endpoint responds to the presence of a logged-in user and displays content appropriate to that user's permissions.

 Request examples 

 Request parameters 

 Responses 

 Response schema 

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

 Request examples 

 Request parameters 

 Responses 

 Response schema 

Get revision
Returns details for an individual revision. This endpoint responds to the presence of a logged-in user and displays content appropriate to that user's permissions.

 Request example 

 Request parameters 

 Responses 

 Response schema 

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; trying to compare revisions of other page types, such as image pages, results in a 400 response code. This endpoint responds to the presence of a logged-in user and displays content appropriate to that user's permissions.

The compare revisions endpoint requires Wikidiff2 1.9.0 or later.

 Request example 

 Request parameters 

 Responses 

 Response schema