MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

meta=WikiSearchHighlight

(main | query | WikiSearchHighlight)

Create highlight snippets from an ElasticSearch search query

Parameters:
query

The query to generate highlights from

This parameter is required.
properties

The properties to generate highlights from

This parameter is required.
page_id

The page for which you want to generate highlights

This parameter is required.
Type: integer
limit

The maximum number of highlights to return

This parameter is required.
Type: integer
size

The size of the snippets to return (leave blank to highlight individual words)

Type: integer
The value must be between 1 and 250.
highlighter_type
⧼apihelp-query+WikiSearchHighlight-param-highlighter_type⧽