Справка MediaWiki API
Это автоматически сгенерированная страница документации MediaWiki API.
Документация и примеры: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
Главный модуль
- Источник: MediaWiki
- Лицензия: GPL-2.0-or-later
Статус: MediaWiki API — зрелый и стабильный интерфейс, активно поддерживаемый и улучшаемый. Мы стараемся избегать ломающих изменений, однако изредка они могут быть необходимы. Подпишитесь на почтовую рассылку mediawiki-api-announce, чтобы быть в курсе обновлений.
Ошибочные запросы: Если API получает запрос с ошибкой, вернётся заголовок HTTP с ключом «MediaWiki-API-Error», после чего значение заголовка и код ошибки будут отправлены обратно и установлены в то же значение. Более подробную информацию см. API: Ошибки и предупреждения.
Тестирование: для удобства тестирования API-запросов, см. Special:ApiSandbox.
- action
Действие, которое следует выполнить.
- block
- Блокировка участника.
- changeauthenticationdata
- Смена параметров аутентификации для текущего участника.
- changecontentmodel
- Изменить модель содержимого страницы
- checktoken
- Проверить корректность токена из action=query&meta=token.
- clearhasmsg
- Очистить флаг
hasmsg
для текущего участника. - clientlogin
- Вход в вики с помощью интерактивного потока.
- compare
- Получение разницы между двумя страницами.
- createaccount
- Создание новой учётной записи.
- delete
- Удаление страницы.
- edit
- Создание и редактирование страниц.
- emailuser
- Написание электронных писем участнику.
- expandtemplates
- Разворачивание всех шаблонов в вики-текст.
- feedcontributions
- Возвращает ленту с вкладом участников.
- feedrecentchanges
- Возвращает ленту последних изменений.
- feedwatchlist
- Возвращает ленту списка наблюдения.
- filerevert
- Возвращение файла к старой версии.
- help
- Отображение справки указанных модулей.
- imagerotate
- Поворот одного или нескольких изображений.
- import
- Импорт страницы из другой вики или XML-файла.
- linkaccount
- Связать аккаунт третьей стороны с текущим участником.
- login
- Вход и получение аутентификационных cookie.
- logout
- Выйти и очистить данные сессии.
- managetags
- Осуществление задач, связанных с изменением меток.
- mergehistory
- Объединение историй правок.
- move
- Переименование страницы.
- opensearch
- Поиск по вики с использованием протокола OpenSearch.
- options
- Смена настроек текущего участника.
- paraminfo
- Получение информации о модулях API.
- parse
- Парсит содержимое и возвращает результат парсинга.
- patrol
- Патрулирование страницы или версии.
- protect
- Изменение уровня защиты страницы.
- purge
- Очистка кэша заданных страниц.
- query
- Запросить данные с и о MediaWiki.
- removeauthenticationdata
- Удаление аутентификационных данных для текущего участника.
- resetpassword
- Отправить участнику письмо для сброса пароля.
- revisiondelete
- Удаление и восстановление версий страниц.
- rollback
- Отмена последней правки на странице.
- rsd
- Экспорт схемы RSD (Really Simple Discovery).
- setnotificationtimestamp
- Обновление временной метки уведомления для отслеживаемых страниц.
- setpagelanguage
- Изменить язык страницы.
- tag
- Добавление или удаление меток отдельных правок или записей журналов.
- unblock
- Разблокировка участника.
- undelete
- Восстановление версий удалённой страницы.
- unlinkaccount
- Удаление связанного стороннего аккаунта с текущим участником.
- upload
- Загрузка файла или получение статуса незавершённых загрузок.
- userrights
- Изменение групп участника.
- validatepassword
- Проверка пароля на удовлетворение политики вики.
- watch
- Добавление или удаление страниц из списка наблюдения текущего участника.
- cspreport
- Внутренний. Используется браузерами, чтобы сообщать о нарушениях политики безопасности (CSP). Этот модуль никогда не должен использоваться, за исключением случаев автоматического использования совместимыми с CSP браузерами.
- stashedit
- Внутренний. Подготовка правки в общем кэше.
- Одно из следующих значений: block, changeauthenticationdata, changecontentmodel, checktoken, clearhasmsg, clientlogin, compare, createaccount, delete, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, linkaccount, login, logout, managetags, mergehistory, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, setnotificationtimestamp, setpagelanguage, tag, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, cspreport, stashedit
- По умолчанию: help
- format
Формат вывода.
- json
- Выводить данные в формате JSON.
- jsonfm
- Выводить данные в формате JSON (отформатированном в HTML).
- none
- Ничего не выводить.
- php
- Выводить данные в сериализованном формате PHP.
- phpfm
- Выводить данные в сериализованном формате PHP (отформатированном в HTML).
- rawfm
- Выводить данные, включая элементы отладки, в формате JSON (отформатированном в HTML).
- xml
- Выводить данные в формате XML.
- xmlfm
- Выводить данные в формате XML (отформатированном в HTML).
- Одно из следующих значений: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
- По умолчанию: jsonfm
- maxlag
Значение максимального отставания может использоваться, когда MediaWiki установлена на кластер из реплицируемых баз данных. Чтобы избежать ухудшения ситуации с отставанием репликации сайта, этот параметр может заставить клиента ждать, когда задержка репликации станет ниже указанного значения. В случае чрезмерной задержки возвращается код ошибки «maxlag» с сообщением «Waiting for $host: $lag seconds lagged».
См. подробнее на странице с описанием Manual: параметра Maxlag.- Type: integer
- smaxage
Установить значение HTTP-заголовка Cache-Control
s-maxage
в заданное число секунд. Ошибки никогда не кэшируются.- Type: integer
- По умолчанию: 0
- maxage
Установить значение HTTP-заголовка Cache-Control
max-age
в заданное число секунд. Ошибки никогда не кэшируются.- Type: integer
- По умолчанию: 0
- assert
Проверить, авторизован ли участник, если задано user, not авторизирован если задано anon или что он имеет права бота, если задано bot.
- Одно из следующих значений: anon, bot, user
- assertuser
Проверить, что ник текущего участника совпадает с заданным.
- Тип: пользователь, из Имя пользователя
- requestid
Любое заданное здесь значение будет включено в ответ. Может быть использовано для различения запросов.
- servedby
Включить в результаты имя хоста, обработавшего запрос.
- Type: boolean (details)
- curtimestamp
Включить в результат временную метку.
- Type: boolean (details)
- responselanginfo
Включить языки, использованные для uselang и errorlang, в результат.
- Type: boolean (details)
- origin
При обращении к API с использованием кросс-доменного AJAX-запроса (CORS), задайте параметру значение исходного домена. Этот параметр должен быть включён в любой предварительный запрос и таким образом должен быть частью URI-запроса (не тела POST).
Для аутентифицированных запросов он должен точно соответствовать одному из источников в заголовке
Origin
, так что он должен быть задан наподобие https://ru.wikipedia.org или https://meta.wikimedia.org. Если параметр не соответствует заголовкуOrigin
, будет возвращён ответ с кодом ошибки 403. Если параметр соответствует заголовкуOrigin
, и источник разрешается, будут установлены заголовкиAccess-Control-Allow-Origin
иAccess-Control-Allow-Credentials
.Для неаутентифицированных запросов укажите значение *. В результате заголовок
Access-Control-Allow-Origin
будет установлен, ноAccess-Control-Allow-Credentials
примет значениеfalse
и все пользовательские данные будут ограничены.- uselang
Язык, используемый для перевода сообщений. Запрос action=query&meta=siteinfo с siprop=languages возвращает список кодов языков; укажите user, чтобы использовать текущие языковые настройки участника, или content для использования основного языка этой вики.
- По умолчанию: user
- errorformat
Формат, используемый для вывода текста предупреждений и ошибок
- plaintext
- Wikitext with HTML tags removed and entities replaced.
- wikitext
- Unparsed wikitext.
- html
- HTML
- raw
- Message key and parameters.
- none
- No text output, only the error codes.
- bc
- Format used prior to MediaWiki 1.29. errorlang and errorsuselocal are ignored.
- Одно из следующих значений: bc, html, none, plaintext, raw, wikitext
- По умолчанию: bc
- errorlang
Язык, используемый для вывода предупреждений и сообщений об ошибках. Запрос action=query&meta=siteinfo с siprop=languages возвращает список кодов языков; укажите content для использования основного языка этой вики, или uselang для использования того же значения, что и в параметре uselang.
- По умолчанию: uselang
- errorsuselocal
Если задан, тексты ошибок будут использовать локально модифицированные сообщения из пространства имён MediaWiki.
- Type: boolean (details)
- Помощь по главному модулю.
- api.php?action=help [открыть в песочнице]
- Вся справка на одной странице.
- api.php?action=help&recursivesubmodules=1 [открыть в песочнице]
action=block
- Этот модуль требует прав на чтение.
- Этот модуль требует прав на запись.
- Этот модуль принимает только POST-запросы.
- Источник: MediaWiki
- Лицензия: GPL-2.0-or-later
Блокировка участника.
- user
Имя участника, которого вы хотите заблокировать.
- Тип: пользователь, любой из Имя пользователя, IP-адрес, IP-диапазон и идентификатор участника (например, «#12345»)
- userid
- Устарело.
Вместо этого укажите user=#ID.
- Type: integer
- expiry
Время истечения срока действия. Может быть относительным (например, 5 months или 2 weeks) или абсолютным (например, 2014-09-18T12:34:56Z). Если задано infinite, indefinite или never, блокировка никогда не истечёт.
- По умолчанию: never
- reason
Причина блокировки.
- По умолчанию: (пусто)
- anononly
Заблокировать только анонимных участников (т. е. запретить анонимные правки для этого IP-адреса).
- Type: boolean (details)
- nocreate
Запретить создание учётных записей.
- Type: boolean (details)
- autoblock
Автоматически блокировать последний использованный IP-адрес и все последующие, с которых будут совершаться попытки авторизации.
- Type: boolean (details)
- noemail
Запретить участнику отправлять электронную почту через интерфейс вики. (Требуется право
blockemail
).- Type: boolean (details)
- hidename
Скрыть имя участника из журнала блокировок. (Требуется право
hideuser
).- Type: boolean (details)
- allowusertalk
Разрешить участнику редактировать свою страницу обсуждения (зависит от $wgBlockAllowsUTEdit).
- Type: boolean (details)
- reblock
Если участник уже заблокирован, перезаписать существующую блокировку.
- Type: boolean (details)
- watchuser
Следить за страницей участника и соответствующей страницей обсуждения, принадлежащей участнику или IP-адресу.
- Type: boolean (details)
- tags
Изменить метки записи в журнале блокировок.
- Значения (разделённые с помощью | или альтернативного разделителя):
- partial
Блокировать пользователю доступ только к определённым страницам или пространствам имён, а не ко всему сайту.
- Type: boolean (details)
- pagerestrictions
Список заголовков страниц, редактирование которых заблокировано для этого участника. Действителен, только если partial установлен в true.
- Тип: название страницы
- Разделяйте значения с помощью | или альтернативного разделителя.
- Максимальное количество значений — 10.
- Принимает только существующие страницы.
- namespacerestrictions
Список пространств имён, редактирование в которых заблокировано для этого участника. Действителен, только если partial установлен в true.
- Значения (разделённые с помощью | или альтернативного разделителя): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- Для указания всех значений, используйте *.
- token
Токен «csrf», полученный из action=query&meta=tokens
- Это обязательный параметр.
- Заблокировать IP-адрес 192.0.2.5 на три дня по причине.
- api.php?action=block&user=192.0.2.5&expiry=3%20days&reason=First%20strike&token=123ABC [открыть в песочнице]
- Бессрочно заблокировать участника с указанием причины, и предотвратить создание новых аккаунтов и отправку электронной почты.
- api.php?action=block&user=Vandal&expiry=never&reason=Vandalism&nocreate=&autoblock=&noemail=&token=123ABC [открыть в песочнице]
action=changeauthenticationdata (changeauth)
- Этот модуль требует прав на чтение.
- Этот модуль требует прав на запись.
- Этот модуль принимает только POST-запросы.
- Источник: MediaWiki
- Лицензия: GPL-2.0-or-later
Смена параметров аутентификации для текущего участника.
- changeauthrequest
Использовать этот аутентификационный запрос, с id, возвращённом из action=query&meta=authmanagerinfo с amirequestsfor=change.
- Это обязательный параметр.
- changeauthtoken
Токен «csrf», полученный из action=query&meta=tokens
- Это обязательный параметр.
- *
- Этот модуль принимает дополнительные параметры в зависимости от доступных аутентификационных запросов. Используйте action=query&meta=authmanagerinfo с amirequestsfor=change (или предыдущий ответ этого модуля, если доступен) для определения, какие запросы доступны и какие поля они используют.
- Попытаться изменить текущий пароль участника на ExamplePassword.
- api.php?action=changeauthenticationdata&changeauthrequest=MediaWiki%5CAuth%5CPasswordAuthenticationRequest&password=ExamplePassword&retype=ExamplePassword&changeauthtoken=123ABC [открыть в песочнице]
action=changecontentmodel
- Этот модуль требует прав на чтение.
- Этот модуль требует прав на запись.
- Этот модуль принимает только POST-запросы.
- Источник: MediaWiki
- Лицензия: GPL-2.0-or-later
Изменить модель содержимого страницы
- title
Title of the page to change the contentmodel of. Cannot be used together with pageid.
- pageid
Page ID of the page to change the contentmodel of. Cannot be used together with title.
- Type: integer
- summary
Изменить сводку и причину записи в журнале
- tags
Change tags to apply to the log entry and edit.
- Значения (разделённые с помощью | или альтернативного разделителя):
- model
Модель нового содержимого.
- Это обязательный параметр.
- Одно из следующих значений: css, javascript, json, text, wikitext
- bot
Пометьте изменение модели содержимого с помощью флага бота.
- Type: boolean (details)
- token
Токен «csrf», полученный из action=query&meta=tokens
- Это обязательный параметр.
- Измените главную страницу, чтобы получить модель
текстового
содержимого - api.php?action=changecontentmodel&title=Main Page&model=text&token=123ABC [открыть в песочнице]
action=checktoken
- Этот модуль требует прав на чтение.
- Источник: MediaWiki
- Лицензия: GPL-2.0-or-later
Проверить корректность токена из action=query&meta=token.
- type
Тип проверяемого токена.
- Это обязательный параметр.
- Одно из следующих значений: createaccount, csrf, login, patrol, rollback, userrights, watch
- token
Проверяемый токен.
- Это обязательный параметр.
- maxtokenage
Максимально допустимый возраст токена (в секундах).
- Type: integer
- Проверить корректность csrf-токена.
- api.php?action=checktoken&type=csrf&token=123ABC [открыть в песочнице]
action=clearhasmsg
- Этот модуль требует прав на чтение.
- Этот модуль требует прав на запись.
- Этот модуль принимает только POST-запросы.
- Источник: MediaWiki
- Лицензия: GPL-2.0-or-later
Очистить флаг hasmsg
для текущего участника.
- Очистить флаг
hasmsg
для текущего участника. - api.php?action=clearhasmsg [открыть в песочнице]
action=clientlogin (login)
- Этот модуль принимает только POST-запросы.
- Источник: MediaWiki
- Лицензия: GPL-2.0-or-later
Вход в вики с помощью интерактивного потока.
Стандартная процедура использования этого модуля такова:
- Запрос полей, доступных из action=query&meta=authmanagerinfo с amirequestsfor=login, и токена login из action=query&meta=tokens.
- Предоставление полей пользователю и получение его данных.
- Запрос к этому модулю, содержащий loginreturnurl или аналогичное поле.
- Проверка поля status ответа.
- Если вы получили PASS или FAIL, вы закончили. Операция либо завершилась успехом, либо нет.
- Если вы получили UI, предоставьте новые поля пользователю и получите новые данные. Затем совершите новый запрос с параметром logincontinue и новыми полями, после чего повторите пункт 4.
- Если вы получили REDIRECT, отправьте пользователя на redirecttarget и подождите возвращения на loginreturnurl. Затем совершите запрос к этому модулю с параметром logincontinue и всеми полями, содержащимися в возвращённой ссылке, и повторите пункт 4.
- Если вы получили RESTART, это означает, что аутентификация работает, но мы не привязали пользовательский аккаунт. Вы можете рассматривать это как UI или FAIL.
- loginrequests
Использовать только эти аутентификационные запросы, с id, возвращённом из action=query&meta=authmanagerinfo с amirequestsfor=login, или из предыдущего ответа этого модуля.
- Разделяйте значения с помощью | или альтернативного разделителя.
- Maximum number of values is 50 (500 for clients allowed higher limits).
- loginmessageformat
Формат, используемый для возвращаемых сообщений.
- Одно из следующих значений: html, none, raw, wikitext
- По умолчанию: wikitext
- loginmergerequestfields
Слить поля информации со всех аутентификационных запросов в один массив.
- Type: boolean (details)
- loginpreservestate
Сохранить состояние с предыдущей провалившейся попытки авторизации, если возможно.
- Type: boolean (details)
- loginreturnurl
Вернуть ссылку для стороннего процесса аутентификации, должна быть абсолютной. Либо этот параметр, либо logincontinue, обязателен.
После получения ответа REDIRECT, вы, как правило, должны открыть в браузере или вэб-просмотрщике указанную в redirecttarget ссылку для продолжения стороннего процесса аутентификации. По завершению, сторонний сервис отошлёт браузеру или веб-просмотрщику эту ссылку. Вы должны извлечь все параметры из ссылки и отослать их в параметр logincontinue запроса к этому модулю.
- logincontinue
Этот запрос — продолжение после предшествующего ответа UI или REDIRECT. Либо этот параметр, либо loginreturnurl, обязателен.
- Type: boolean (details)
- logintoken
Токен «login», полученный из action=query&meta=tokens
- Это обязательный параметр.
- *
- Этот модуль принимает дополнительные параметры в зависимости от доступных аутентификационных запросов. Используйте action=query&meta=authmanagerinfo с amirequestsfor=login (или предыдущий ответ этого модуля, если доступен) для определения, какие запросы доступны и какие поля они используют.
- Начать вход в вики в качестве участника Example с паролем ExamplePassword.
- api.php?action=clientlogin&username=Example&password=ExamplePassword&loginreturnurl=http://example.org/&logintoken=123ABC [открыть в песочнице]
- Продолжить вход после ответа UI для двухфакторной аутентификации, предоставив 987654 в качестве токена OATHToken.
- api.php?action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC [открыть в песочнице]
action=compare
- Этот модуль требует прав на чтение.
- Источник: MediaWiki
- Лицензия: GPL-2.0-or-later
Получение разницы между двумя страницами.
Номер версии, заголовок страницы, её идентификатор, текст, или относительная сноска должна быть задана как для «from», так и для «to».
- fromtitle
Заголовок первой сравниваемой страницы.
- fromid
Идентификатор первой сравниваемой страницы.
- Type: integer
- fromrev
Первая сравниваемая версия.
- Type: integer
- fromslots
Переопределение содержимого версии, заданной параметром fromtitle, fromid или fromrev.
Этот параметр определяет слоты, которые должны быть изменены. Используйте fromtext-{slot}, fromcontentmodel-{slot}, и fromcontentformat-{slot} для определения содержимого для каждого слота.
- Значения (разделённые с помощью | или альтернативного разделителя): main
- fromtext-{slot}
Text of the specified slot. If omitted, the slot is removed from the revision.
- Это шаблонный параметр. При отправке запроса {slot} в названии параметра должно быть заменено значениями fromslots.
- fromsection-{slot}
When fromtext-{slot} is the content of a single section, this is the section number. It will be merged into the revision specified by fromtitle, fromid or fromrev as if for a section edit.
- Это шаблонный параметр. При отправке запроса {slot} в названии параметра должно быть заменено значениями fromslots.
- fromcontentformat-{slot}
Content serialization format of fromtext-{slot}.
- Это шаблонный параметр. При отправке запроса {slot} в названии параметра должно быть заменено значениями fromslots.
- Одно из следующих значений: application/json, application/octet-stream, application/unknown, application/x-binary, text/css, text/javascript, text/plain, text/unknown, text/x-wiki, unknown/unknown
- fromcontentmodel-{slot}
Content model of fromtext-{slot}. If not supplied, it will be guessed based on the other parameters.
- Это шаблонный параметр. При отправке запроса {slot} в названии параметра должно быть заменено значениями fromslots.
- Одно из следующих значений: css, javascript, json, text, unknown, wikitext
- frompst
Выполнить преобразование перед записью правки (PST) над fromtext-{slot}.
- Type: boolean (details)
- fromtext
- Устарело.
Укажите fromslots=main и используйте fromtext-main.
- fromcontentformat
- Устарело.
Укажите fromslots=main и используйте fromcontentformat-main.
- Одно из следующих значений: application/json, application/octet-stream, application/unknown, application/x-binary, text/css, text/javascript, text/plain, text/unknown, text/x-wiki, unknown/unknown
- fromcontentmodel
- Устарело.
Укажите fromslots=main и используйте fromcontentmodel-main.
- Одно из следующих значений: css, javascript, json, text, unknown, wikitext
- fromsection
- Устарело.
Использовать только указанную секцию из содержимого «from».
- totitle
Заголовок второй сравниваемой страницы.
- toid
Идентификатор второй сравниваемой страницы.
- Type: integer
- torev
Вторая сравниваемая версия.
- Type: integer
- torelative
Использовать версию, относящуюся к определённой fromtitle, fromid или fromrev. Все другие опции 'to' будут проигнорированы.
- Одно из следующих значений: cur, next, prev
- toslots
Override content of the revision specified by totitle, toid or torev.
This parameter specifies the slots that are to be modified. Use totext-{slot}, tocontentmodel-{slot}, and tocontentformat-{slot} to specify content for each slot.
- Значения (разделённые с помощью | или альтернативного разделителя): main
- totext-{slot}
Text of the specified slot. If omitted, the slot is removed from the revision.
- Это шаблонный параметр. При отправке запроса {slot} в названии параметра должно быть заменено значениями toslots.
- tosection-{slot}
When totext-{slot} is the content of a single section, this is the section number. It will be merged into the revision specified by totitle, toid or torev as if for a section edit.
- Это шаблонный параметр. При отправке запроса {slot} в названии параметра должно быть заменено значениями toslots.
- tocontentformat-{slot}
Content serialization format of totext-{slot}.
- Это шаблонный параметр. При отправке запроса {slot} в названии параметра должно быть заменено значениями toslots.
- Одно из следующих значений: application/json, application/octet-stream, application/unknown, application/x-binary, text/css, text/javascript, text/plain, text/unknown, text/x-wiki, unknown/unknown
- tocontentmodel-{slot}
Модель содержимого totext-{slot}. Если не задана, будет угадана по другим параметрам.
- Это шаблонный параметр. При отправке запроса {slot} в названии параметра должно быть заменено значениями toslots.
- Одно из следующих значений: css, javascript, json, text, unknown, wikitext
- topst
Выполнить преобразование перед записью правки (PST) над totext.
- Type: boolean (details)
- totext
- Устарело.
Укажите toslots=main и используйте totext-main.
- tocontentformat
- Устарело.
Укажите toslots=main и используйте tocontentformat-main.
- Одно из следующих значений: application/json, application/octet-stream, application/unknown, application/x-binary, text/css, text/javascript, text/plain, text/unknown, text/x-wiki, unknown/unknown
- tocontentmodel
- Устарело.
Укажите toslots=main и используйте tocontentmodel-main.
- Одно из следующих значений: css, javascript, json, text, unknown, wikitext
- tosection
- Устарело.
Использовать только указанную секцию из содержимого «to».
- prop
Какую информацию получить.
- diff
- HTML-код разницы.
- diffsize
- Размер HTML-кода разницы в байтах.
- rel
- Идентификаторы предыдущей к «from» и следующей за «to» версий.
- ids
- Идентификаторы страниц и версий «from» и «to».
- title
- Названия страниц для версий «from» и «to».
- user
- Имя и идентификатор участника для версий «from» и «to». Если версия пользователя была удалена, будет возвращено свойство fromuserhidden или touserhidden.
- comment
- Описания правок для версий «from» и «to». Если версия комментария была удалена, будет возвращено свойство fromcommenthidden или tocommenthidden.
- parsedcomment
- Распарсенные описания правок для версий «from» и «to». Если версия комментария была удалена, будет возвращено свойство fromcommenthidden или tocommenthidden.
- size
- Размер версий «from» и «to».
- timestamp
- (описание отсутствует)
- Значения (разделённые с помощью | или альтернативного разделителя): comment, diff, diffsize, ids, parsedcomment, rel, size, timestamp, title, user
- По умолчанию: diff|ids|title
- slots
Return individual diffs for these slots, rather than one combined diff for all slots.
- Значения (разделённые с помощью | или альтернативного разделителя): main
- Для указания всех значений, используйте *.
- Создать разницу между версиями 1 и 2.
- api.php?action=compare&fromrev=1&torev=2 [открыть в песочнице]
action=createaccount (create)
- Этот модуль требует прав на запись.
- Этот модуль принимает только POST-запросы.
- Источник: MediaWiki
- Лицензия: GPL-2.0-or-later
Создание новой учётной записи.
Стандартная процедура использования этого модуля такова:
- Запрос полей, доступных из action=query&meta=authmanagerinfo с amirequestsfor=create, и токена createaccount из action=query&meta=tokens.
- Предоставление полей пользователю и получение его данных.
- Запрос к этому модулю, содержащий createreturnurl или аналогичное поле.
- Проверка поля status ответа.
- Если вы получили PASS или FAIL, вы закончили. Операция либо завершилась успехом, либо нет.
- Если вы получили UI, предоставьте новые поля пользователю и получите новые данные. Затем совершите новый запрос с параметром createcontinue и новыми полями, после чего повторите пункт 4.
- Если вы получили REDIRECT, отправьте пользователя на redirecttarget и подождите возвращения на createreturnurl. Затем совершите запрос к этому модулю с параметром createcontinue и всеми полями, содержащимися в возвращённой ссылке, и повторите пункт 4.
- Если вы получили RESTART, это означает, что аутентификация работает, но мы не привязали пользовательский аккаунт. Вы можете рассматривать это как UI или FAIL.
- createrequests
Использовать только эти аутентификационные запросы, с id, возвращённом из action=query&meta=authmanagerinfo с amirequestsfor=create, или из предыдущего ответа этого модуля.
- Разделяйте значения с помощью | или альтернативного разделителя.
- Maximum number of values is 50 (500 for clients allowed higher limits).
- createmessageformat
Формат, используемый для возвращаемых сообщений.
- Одно из следующих значений: html, none, raw, wikitext
- По умолчанию: wikitext
- createmergerequestfields
Слить поля информации со всех аутентификационных запросов в один массив.
- Type: boolean (details)
- createpreservestate
Сохранить состояние с предыдущей провалившейся попытки авторизации, если возможно.
Если запрос action=query&meta=authmanagerinfo возвращает true для hasprimarypreservedstate, то запросы, отмеченные как primary-required, должны быть пропущены. Если запрос возвращает непустое значение поля preservedusername, то это значение должно быть использовано в параметре username.
- Type: boolean (details)
- createreturnurl
Вернуть ссылку для стороннего процесса аутентификации, должна быть абсолютной. Либо этот параметр, либо createcontinue, обязателен.
После получения ответа REDIRECT, вы, как правило, должны открыть в браузере или вэб-просмотрщике указанную в redirecttarget ссылку для продолжения стороннего процесса аутентификации. По завершению, сторонний сервис отошлёт браузеру или веб-просмотрщику эту ссылку. Вы должны извлечь все параметры из ссылки и отослать их в параметр createcontinue запроса к этому модулю.
- createcontinue
Этот запрос — продолжение после предшествующего о