Page MenuHomePhabricator

MediaWiki API deprecation warnings - 'rvslots' isn't documented
Closed, InvalidPublic

Description

Queries without 'rvslots' get this message in response: "Because \"rvslots\" was not specified, a legacy format has been used for the output. This format is deprecated, and in the future the new format will always be used."

But online API documentation for the 'query' action doesn't have 'rvslots': https://en.wiktionary.org/w/api.php?action=help&modules=query

Did you forget to document it?

Event Timeline

Yurivict created this task.Aug 2 2018, 8:23 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptAug 2 2018, 8:23 PM
Yurivict updated the task description. (Show Details)Aug 2 2018, 8:23 PM
Dalba added a subscriber: Dalba.Aug 3 2018, 3:00 AM
Lofhi renamed this task from 'rvslots' isn't documented in https://en.wiktionary.org/w/api.php?action=help&modules=query to MediaWiki API deprecation warnings - 'rvslots' isn't documented.Aug 3 2018, 6:04 AM
Lofhi added a subscriber: ssastry.

More informations :

https://lists.wikimedia.org/pipermail/wikitech-l/2018-August/090463.html says documentation is missing and will be updated tomorrow -- but that this can be safely ignored for now.

Masti added a subscriber: Masti.Aug 3 2018, 9:44 PM
Anomie closed this task as Invalid.Aug 4 2018, 1:03 PM
Anomie added a subscriber: Anomie.

But online API documentation for the 'query' action doesn't have 'rvslots': https://en.wiktionary.org/w/api.php?action=help&modules=query

You're looking in the wrong place. The warning comes from the revisions module, and the parameter is documented there: https://en.wiktionary.org/w/api.php?action=help&modules=query+revisions

Some of the text on https://www.mediawiki.org/wiki/API:Revisions probably could use updating. That's a wiki, anyone should feel free to do so.

I see that some examples still need to be updated.

I've updated the main example in the MediaWiki's wiki documentation, but someone should also update the Examples section of Special:apihelp/query+revisions, defined as follow:

ApiQueryRevisions.php$486:

	protected function getExamplesMessages() {
			return [
				'action=query&prop=revisions&titles=API|Main%20Page&' .
					'rvprop=timestamp|user|comment|content'
					=> 'apihelp-query+revisions-example-content',
				'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
					'rvprop=timestamp|user|comment'
					=> 'apihelp-query+revisions-example-last5',
				'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
					'rvprop=timestamp|user|comment&rvdir=newer'
					=> 'apihelp-query+revisions-example-first5',
				'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
					'rvprop=timestamp|user|comment&rvdir=newer&rvstart=2006-05-01T00:00:00Z'
					=> 'apihelp-query+revisions-example-first5-after',
				'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
					'rvprop=timestamp|user|comment&rvexcludeuser=127.0.0.1'
					=> 'apihelp-query+revisions-example-first5-not-localhost',
				'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
					'rvprop=timestamp|user|comment&rvuser=MediaWiki%20default'
					=> 'apihelp-query+revisions-example-first5-user',
			];
		}

Filed T202909 for that.

Fae awarded a token.Mar 19 2019, 10:01 AM
Fae added a subscriber: Fae.