Extension:Flow/API

From MediaWiki.org
Jump to: navigation, search
See also Flow/Architecture/API and Gerrit change 107411

Most Flow API read and write interactions are submodules of action=flow. Flow also implements a query property flowinfo and a parsing utility module flow-parsoid-utils.

§action=query&prop=flowinfo[edit | edit source]

Indicates if Flow is enabled on the specified pages.

prop=flowinfo (fli)

(main | query | flowinfo)
  • This module requires read rights.

Get basic Flow information about a page.

§action=flow[edit | edit source]

All action=flow requests take the following parameters:

  • submodule: The specific flow submodule you want to use. See below for documentation on some of them
  • workflow: Id of the workflow to take action upon
  • page: Page title of the page to take action upon
  • token: An edit token (see API:Tokens). This is required for all write modules.
  • render: Include this to have an HTML rendering be returned in the output. Used by the extension's JS modules.

For any action that posts data, you will need a token, which defeats cross-site request forgery. To get this, use meta=tokens: Gets a CSRF token

§new-topic[edit | edit source]

submodule=new-topic (nt)

(main | flow | new-topic)
  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.

Creates a new Flow topic on the given workflow.

Parameters:
nttopic

Text for new topic title.

This parameter is required.
ntcontent

Content for the topic's initial reply.

This parameter is required.
ntmetadataonly

Whether to include only metadata about the new content, excluding everything else

token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.

(Since this edit operation has to be an HTTP POST, the link in the generated example above won't work.)

§action=flow-parsoid-utils[edit | edit source]

action=flow-parsoid-utils

(main | flow-parsoid-utils)
  • This module requires read rights.

Convert text between wikitext and HTML.

Parameters:
from

Format to convert content from.

This parameter is required.
One value: html, wikitext
to

Format to convert content to.

This parameter is required.
One value: html, wikitext
content

Content to be converted.

This parameter is required.
title

Title of the page. Cannot be used together with pageid.

pageid

ID of the page. Cannot be used together with title.