API:Main module - Revision history

Rebulka: editace

2026-02-04T17:26:26Z

editace

← Older revision		Revision as of 17:26, 4 February 2026
Line 120:		Line 120:
	== See also == <!--T:14-->		== See also == <!--T:14-->
	</translate>		</translate>
	* {{ll\|Manual:Parameters to index.php}} - <translate><!--T:15--> A '''partial''' list of the parameters to <tvar name=1>{{ll\|Manual:index.php\|index.php}}</tvar>, the main script of the MediaWiki software.</translate>		* {{ll\|Manual:Parameters to index.php}} – <translate><!--T:15--> A '''partial''' list of the parameters to <tvar name=1>{{ll\|Manual:index.php\|index.php}}</tvar>, the main script of the MediaWiki software.</translate>

Matma Rex: Use API documentation frame from the template

2024-08-29T17:39:28Z

Use API documentation frame from the template

← Older revision		Revision as of 17:39, 29 August 2024
Line 7:		Line 7:
	== API documentation == <!--T:2-->		== API documentation == <!--T:2-->
	</translate>		</translate>
		⚫	{{Api help\|main\|frame=yes}}
	{\| style="color: black; background-color: #f8f8f8; border-spacing: 20px; border: 1px solid darkgray;"
⚫	\| {{Api help\|main}}
	\|}

	<translate>		<translate>

Shirayuki: wrong markup

2021-11-25T22:08:58Z

wrong markup

← Older revision		Revision as of 22:08, 25 November 2021
Line 117:		Line 117:
	</translate>		</translate>
	* v1.17: <translate><!--T:12--> Introduced <tvar name=1><code>servedby</code></tvar></translate>		* v1.17: <translate><!--T:12--> Introduced <tvar name=1><code>servedby</code></tvar></translate>
	* v1.14: <translate><!--T:13-->		* v1.14: <translate><!--T:13--> Introduced <tvar name=1><code>requestid</code></tvar></translate>
	Introduced <tvar name=1><code>requestid</code></tvar>

			<translate>
	== See also == <!--T:14-->		== See also == <!--T:14-->
	</translate>		</translate>

Shirayuki at 01:38, 2 October 2021

2021-10-02T01:38:24Z

← Older revision		Revision as of 01:38, 2 October 2021
Line 27:		Line 27:
	</translate>		</translate>
	<div style="width:60%;">		<div style="width:60%;">
	<syntaxhighlight lang="~~json~~">		<syntaxhighlight lang="html">
	...		...
	</head>		</head>

Ameisenigel: Marked this version for translation

2021-08-28T14:25:38Z

Marked this version for translation

← Older revision		Revision as of 14:25, 28 August 2021
Line 2:		Line 2:
	{{API}}		{{API}}
	<translate>		<translate>
			<!--T:1-->
	The main module includes parameters that can be used for any API request.		The main module includes parameters that can be used for any API request.

	== API documentation ==		== API documentation == <!--T:2-->
	</translate>		</translate>
	{\| style="color: black; background-color: #f8f8f8; border-spacing: 20px; border: 1px solid darkgray;"		{\| style="color: black; background-color: #f8f8f8; border-spacing: 20px; border: 1px solid darkgray;"
Line 11:		Line 12:

	<translate>		<translate>
	== Example ==		== Example == <!--T:3-->

	=== GET request ===		=== GET request === <!--T:4-->
	</translate>		</translate>
	{{ApiEx		{{ApiEx
	\|desc=<translate>Get help for the main module.</translate>		\|desc=<translate><!--T:5--> Get help for the main module.</translate>
	\|p1=action=help		\|p1=action=help
	\|p2=format=json		\|p2=format=json
Line 23:		Line 24:

	<translate>		<translate>
	=== Response ===		=== Response === <!--T:6-->
	</translate>		</translate>
	<div style="width:60%;">		<div style="width:60%;">
Line 51:		Line 52:

	<translate>		<translate>
	=== Sample code ===		=== Sample code === <!--T:7-->
	</translate>		</translate>
	{{:{{translatable}}/Sample code 1}}		{{:{{translatable}}/Sample code 1}}

	<translate>		<translate>
	== Possible errors ==		== Possible errors == <!--T:8-->
	</translate>		</translate>
	{\| class="wikitable"		{\| class="wikitable"
	\|+		\|+
	!<translate>Code</translate>		!<translate><!--T:9--> Code</translate>
	!<translate>Info</translate>		!<translate><!--T:10--> Info</translate>
	\|-		\|-
	\|unknownaction		\|unknownaction
Line 113:		Line 114:

	<translate>		<translate>
	== Parameter history ==		== Parameter history == <!--T:11-->
	</translate>		</translate>
	* v1.17: <translate>Introduced <tvar name=1><code>servedby</code></tvar></translate>		* v1.17: <translate><!--T:12--> Introduced <tvar name=1><code>servedby</code></tvar></translate>
	* v1.14: <translate>Introduced <tvar name=1><code>requestid</code></tvar>		* v1.14: <translate><!--T:13-->
			Introduced <tvar name=1><code>requestid</code></tvar>

	== See also ==		== See also == <!--T:14-->
	</translate>		</translate>
	* {{ll\|Manual:Parameters to index.php}} - <translate>A '''partial''' list of the parameters to <tvar name=1>{{ll\|Manual:index.php\|index.php}}</tvar>, the main script of the MediaWiki software.</translate>		* {{ll\|Manual:Parameters to index.php}} - <translate><!--T:15--> A '''partial''' list of the parameters to <tvar name=1>{{ll\|Manual:index.php\|index.php}}</tvar>, the main script of the MediaWiki software.</translate>

Ameisenigel: prepared for translation

2021-08-28T14:25:17Z

prepared for translation

← Older revision		Revision as of 14:25, 28 August 2021
Line 1:		Line 1:
			<languages/>
	{{API}}		{{API}}
			<translate>
	The main module includes parameters that can be used for any API request.		The main module includes parameters that can be used for any API request.

	== API documentation ==		== API documentation ==
			</translate>
	{\| style="color: black; background-color: #f8f8f8; border-spacing: 20px; border: 1px solid darkgray;"		{\| style="color: black; background-color: #f8f8f8; border-spacing: 20px; border: 1px solid darkgray;"
	\| {{Api help\|main}}		\| {{Api help\|main}}
	\|}		\|}

			<translate>
	== Example ==		== Example ==

	=== GET request ===		=== GET request ===
			</translate>
	{{ApiEx		{{ApiEx
	\|desc=Get help for the main module.		\|desc=<translate>Get help for the main module.</translate>
	\|p1=action=help		\|p1=action=help
	\|p2=format=json		\|p2=format=json
Line 17:		Line 22:
	}}		}}

			<translate>
	=== Response ===		=== Response ===
			</translate>
	<div style="width:60%;">		<div style="width:60%;">
	<syntaxhighlight lang="json">		<syntaxhighlight lang="json">
Line 43:		Line 50:
	</div>		</div>

			<translate>
	=== Sample code ===		=== Sample code ===
			</translate>
	{{:{{translatable}}/Sample code 1}}		{{:{{translatable}}/Sample code 1}}

			<translate>
	== Possible errors ==		== Possible errors ==
			</translate>
	{\| class="wikitable"		{\| class="wikitable"
	\|+		\|+
			!<translate>Code</translate>
	!Code
			!<translate>Info</translate>
	!Info
	\|-		\|-
	\|unknownaction		\|unknownaction
Line 101:		Line 112:
	\|}		\|}

			<translate>
	== Parameter history ==		== Parameter history ==
			</translate>
⚫	* v1.17: Introduced <code>~~servedby~~</code>
	* v1.14: Introduced <code>~~requestid~~</code>		* v1.17: <translate>Introduced <tvar name=1><code>servedby</code></tvar></translate>
		⚫	* v1.14: <translate>Introduced <tvar name=1><code>requestid</code></tvar>

	== See also ==		== See also ==
			</translate>
	* {{ll\|Manual:Parameters to index.php}} - A '''partial''' list of the parameters to {{ll\|Manual:index.php\|index.php}}, the main script of the MediaWiki software.		* {{ll\|Manual:Parameters to index.php}} - <translate>A '''partial''' list of the parameters to <tvar name=1>{{ll\|Manual:index.php\|index.php}}</tvar>, the main script of the MediaWiki software.</translate>

Shirayuki: use UI messages

2021-08-14T04:37:39Z

use UI messages

@@ Line 51: / Line 51: @@
 !Code
 !Info
 |-
 |maxlag
 |-
 |maxlag
 |-
 |-
 |-
 |}

Zaycodes: Updated as per phab:T232816 API documentation improvements

2020-03-04T07:16:31Z

Updated as per phab:T232816 API documentation improvements

@@ Line 1: / Line 1: @@
 {{API}}
 The main module includes parameters that can be used for any API request.
-==Error codes==
+=== Response ===
-==See also==
+== Possible errors ==

DBarratt (WMF): /* Parameters / Add details that is a valid value to the origin param

2019-07-24T19:28:38Z

Parameters: Add details that * is a valid value to the origin param

← Older revision		Revision as of 19:28, 24 July 2019
Line 22:		Line 22:
	*{{ApiParam\|servedby\|type=boolean\|version=1.17\|Include the hostname that served the request in the results.}}		*{{ApiParam\|servedby\|type=boolean\|version=1.17\|Include the hostname that served the request in the results.}}
	*{{ApiParam\|curtimestamp\|type=boolean\|Include the current timestamp in the result. Not included in case of error prior to 1.29<!-- T110015 -->.}}		*{{ApiParam\|curtimestamp\|type=boolean\|Include the current timestamp in the result. Not included in case of error prior to 1.29<!-- T110015 -->.}}
	*{{ApiParam\|origin\|When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain. This must be included in any pre-flight request, and therefore must be part of the request URI (not the POST body). This must match one of the origins in the <code>Origin</code> header exactly, so it has to be set to something like https://en.wikipedia.org or https://meta.wikimedia.org. If this parameter does not match the Origin header, a 403 response will be returned. If this parameter matches the Origin header and the origin is whitelisted, an <code>Access-Control-Allow-Origin</code> header will be set.}}		{{ApiParam\|origin\|When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain. This must be included in any pre-flight request, and therefore must be part of the request URI (not the POST body). This must match one of the origins in the <code>Origin</code> header exactly, so it has to be set to something like https://en.wikipedia.org or https://meta.wikimedia.org. If this parameter does not match the Origin header, a 403 response will be returned. If this parameter matches the Origin header and the origin is whitelisted, an <code>Access-Control-Allow-Origin</code> header will be set. Setting to <code></code> is valid and should be used for non-whitelisted cross-domain requests.}}
	*{{ApiParam\|uselang\|2=The [[wikipedia:List of ISO 639-1 codes\|language code]] to use for message translations and content parsing ("en" for English, "fr" for French, etc.) A full list of codes may be fetched from [[API:siteinfo]] with <code>siprop=languages</code>, or specify user to use the current user's language preference, or specify content to use this wiki's content language. This is useful for language-dependent content, such as generated by the {{<nowiki/>[[commons:Template:LangSwitch\|LangSwitch]]}} template at the Commons, or generally by things dependent on <code>{{<nowiki/>int:Lang}}</code>. Prior to MediaWiki 1.17, this worked by accident; since 1.17, it works by design.\|type=string}}		*{{ApiParam\|uselang\|2=The [[wikipedia:List of ISO 639-1 codes\|language code]] to use for message translations and content parsing ("en" for English, "fr" for French, etc.) A full list of codes may be fetched from [[API:siteinfo]] with <code>siprop=languages</code>, or specify user to use the current user's language preference, or specify content to use this wiki's content language. This is useful for language-dependent content, such as generated by the {{<nowiki/>[[commons:Template:LangSwitch\|LangSwitch]]}} template at the Commons, or generally by things dependent on <code>{{<nowiki/>int:Lang}}</code>. Prior to MediaWiki 1.17, this worked by accident; since 1.17, it works by design.\|type=string}}
	*{{ApiParam\|centralauthtoken\|2=When accessing the API using a cross-domain AJAX request (CORS), use this to authenticate as the current SUL user. Use action=centralauthtoken on this wiki to retrieve the token, before making the CORS request. Each token may only be used once, and expires after 10 seconds. This should be included in any pre-flight request, and therefore should be included in the request URI (not the POST body)}}		*{{ApiParam\|centralauthtoken\|2=When accessing the API using a cross-domain AJAX request (CORS), use this to authenticate as the current SUL user. Use action=centralauthtoken on this wiki to retrieve the token, before making the CORS request. Each token may only be used once, and expires after 10 seconds. This should be included in any pre-flight request, and therefore should be included in the request URI (not the POST body)}}

Lucas Werkmeister (WMDE): /* Parameters */ curtimestamp is now returned even in case of error (since commit 4e6810e4a2)

2019-03-11T23:11:04Z

Parameters: curtimestamp is now returned even in case of error (since commit 4e6810e4a2)

← Older revision		Revision as of 23:11, 11 March 2019
Line 21:		Line 21:
	*{{ApiParam\|requestid\|version=1.14\|Any value given here will be included in the response. May be used to distinguish requests.}}		*{{ApiParam\|requestid\|version=1.14\|Any value given here will be included in the response. May be used to distinguish requests.}}
	*{{ApiParam\|servedby\|type=boolean\|version=1.17\|Include the hostname that served the request in the results.}}		*{{ApiParam\|servedby\|type=boolean\|version=1.17\|Include the hostname that served the request in the results.}}
	*{{ApiParam\|curtimestamp\|type=boolean\|Include the current timestamp in the result. Not included in an error <!-- T110015 -->.}}		*{{ApiParam\|curtimestamp\|type=boolean\|Include the current timestamp in the result. Not included in case of error prior to 1.29<!-- T110015 -->.}}
	*{{ApiParam\|origin\|When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain. This must be included in any pre-flight request, and therefore must be part of the request URI (not the POST body). This must match one of the origins in the <code>Origin</code> header exactly, so it has to be set to something like https://en.wikipedia.org or https://meta.wikimedia.org. If this parameter does not match the Origin header, a 403 response will be returned. If this parameter matches the Origin header and the origin is whitelisted, an <code>Access-Control-Allow-Origin</code> header will be set.}}		*{{ApiParam\|origin\|When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain. This must be included in any pre-flight request, and therefore must be part of the request URI (not the POST body). This must match one of the origins in the <code>Origin</code> header exactly, so it has to be set to something like https://en.wikipedia.org or https://meta.wikimedia.org. If this parameter does not match the Origin header, a 403 response will be returned. If this parameter matches the Origin header and the origin is whitelisted, an <code>Access-Control-Allow-Origin</code> header will be set.}}
	*{{ApiParam\|uselang\|2=The [[wikipedia:List of ISO 639-1 codes\|language code]] to use for message translations and content parsing ("en" for English, "fr" for French, etc.) A full list of codes may be fetched from [[API:siteinfo]] with <code>siprop=languages</code>, or specify user to use the current user's language preference, or specify content to use this wiki's content language. This is useful for language-dependent content, such as generated by the {{<nowiki/>[[commons:Template:LangSwitch\|LangSwitch]]}} template at the Commons, or generally by things dependent on <code>{{<nowiki/>int:Lang}}</code>. Prior to MediaWiki 1.17, this worked by accident; since 1.17, it works by design.\|type=string}}		*{{ApiParam\|uselang\|2=The [[wikipedia:List of ISO 639-1 codes\|language code]] to use for message translations and content parsing ("en" for English, "fr" for French, etc.) A full list of codes may be fetched from [[API:siteinfo]] with <code>siprop=languages</code>, or specify user to use the current user's language preference, or specify content to use this wiki's content language. This is useful for language-dependent content, such as generated by the {{<nowiki/>[[commons:Template:LangSwitch\|LangSwitch]]}} template at the Commons, or generally by things dependent on <code>{{<nowiki/>int:Lang}}</code>. Prior to MediaWiki 1.17, this worked by accident; since 1.17, it works by design.\|type=string}}

← Older revision		Revision as of 19:28, 24 July 2019
Line 22:		Line 22:
	*{{ApiParam\|servedby\|type=boolean\|version=1.17\|Include the hostname that served the request in the results.}}		*{{ApiParam\|servedby\|type=boolean\|version=1.17\|Include the hostname that served the request in the results.}}
	*{{ApiParam\|curtimestamp\|type=boolean\|Include the current timestamp in the result. Not included in case of error prior to 1.29<!-- T110015 -->.}}		*{{ApiParam\|curtimestamp\|type=boolean\|Include the current timestamp in the result. Not included in case of error prior to 1.29<!-- T110015 -->.}}
	*{{ApiParam\|origin\|When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain. This must be included in any pre-flight request, and therefore must be part of the request URI (not the POST body). This must match one of the origins in the <code>Origin</code> header exactly, so it has to be set to something like https://en.wikipedia.org or https://meta.wikimedia.org. If this parameter does not match the Origin header, a 403 response will be returned. If this parameter matches the Origin header and the origin is whitelisted, an <code>Access-Control-Allow-Origin</code> header will be set.}}		{{ApiParam\|origin\|When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain. This must be included in any pre-flight request, and therefore must be part of the request URI (not the POST body). This must match one of the origins in the <code>Origin</code> header exactly, so it has to be set to something like https://en.wikipedia.org or https://meta.wikimedia.org. If this parameter does not match the Origin header, a 403 response will be returned. If this parameter matches the Origin header and the origin is whitelisted, an <code>Access-Control-Allow-Origin</code> header will be set. Setting to <code></code> is valid and should be used for non-whitelisted cross-domain requests.}}
	*{{ApiParam\|uselang\|2=The [[wikipedia:List of ISO 639-1 codes\|language code]] to use for message translations and content parsing ("en" for English, "fr" for French, etc.) A full list of codes may be fetched from [[API:siteinfo]] with <code>siprop=languages</code>, or specify user to use the current user's language preference, or specify content to use this wiki's content language. This is useful for language-dependent content, such as generated by the {{<nowiki/>[[commons:Template:LangSwitch\|LangSwitch]]}} template at the Commons, or generally by things dependent on <code>{{<nowiki/>int:Lang}}</code>. Prior to MediaWiki 1.17, this worked by accident; since 1.17, it works by design.\|type=string}}		*{{ApiParam\|uselang\|2=The [[wikipedia:List of ISO 639-1 codes\|language code]] to use for message translations and content parsing ("en" for English, "fr" for French, etc.) A full list of codes may be fetched from [[API:siteinfo]] with <code>siprop=languages</code>, or specify user to use the current user's language preference, or specify content to use this wiki's content language. This is useful for language-dependent content, such as generated by the {{<nowiki/>[[commons:Template:LangSwitch\|LangSwitch]]}} template at the Commons, or generally by things dependent on <code>{{<nowiki/>int:Lang}}</code>. Prior to MediaWiki 1.17, this worked by accident; since 1.17, it works by design.\|type=string}}
	*{{ApiParam\|centralauthtoken\|2=When accessing the API using a cross-domain AJAX request (CORS), use this to authenticate as the current SUL user. Use action=centralauthtoken on this wiki to retrieve the token, before making the CORS request. Each token may only be used once, and expires after 10 seconds. This should be included in any pre-flight request, and therefore should be included in the request URI (not the POST body)}}		*{{ApiParam\|centralauthtoken\|2=When accessing the API using a cross-domain AJAX request (CORS), use this to authenticate as the current SUL user. Use action=centralauthtoken on this wiki to retrieve the token, before making the CORS request. Each token may only be used once, and expires after 10 seconds. This should be included in any pre-flight request, and therefore should be included in the request URI (not the POST body)}}

← Older revision		Revision as of 23:11, 11 March 2019
Line 21:		Line 21:
	*{{ApiParam\|requestid\|version=1.14\|Any value given here will be included in the response. May be used to distinguish requests.}}		*{{ApiParam\|requestid\|version=1.14\|Any value given here will be included in the response. May be used to distinguish requests.}}
	*{{ApiParam\|servedby\|type=boolean\|version=1.17\|Include the hostname that served the request in the results.}}		*{{ApiParam\|servedby\|type=boolean\|version=1.17\|Include the hostname that served the request in the results.}}
	*{{ApiParam\|curtimestamp\|type=boolean\|Include the current timestamp in the result. Not included in an error <!-- T110015 -->.}}		*{{ApiParam\|curtimestamp\|type=boolean\|Include the current timestamp in the result. Not included in case of error prior to 1.29<!-- T110015 -->.}}
	*{{ApiParam\|origin\|When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain. This must be included in any pre-flight request, and therefore must be part of the request URI (not the POST body). This must match one of the origins in the <code>Origin</code> header exactly, so it has to be set to something like https://en.wikipedia.org or https://meta.wikimedia.org. If this parameter does not match the Origin header, a 403 response will be returned. If this parameter matches the Origin header and the origin is whitelisted, an <code>Access-Control-Allow-Origin</code> header will be set.}}		*{{ApiParam\|origin\|When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain. This must be included in any pre-flight request, and therefore must be part of the request URI (not the POST body). This must match one of the origins in the <code>Origin</code> header exactly, so it has to be set to something like https://en.wikipedia.org or https://meta.wikimedia.org. If this parameter does not match the Origin header, a 403 response will be returned. If this parameter matches the Origin header and the origin is whitelisted, an <code>Access-Control-Allow-Origin</code> header will be set.}}
	*{{ApiParam\|uselang\|2=The [[wikipedia:List of ISO 639-1 codes\|language code]] to use for message translations and content parsing ("en" for English, "fr" for French, etc.) A full list of codes may be fetched from [[API:siteinfo]] with <code>siprop=languages</code>, or specify user to use the current user's language preference, or specify content to use this wiki's content language. This is useful for language-dependent content, such as generated by the {{<nowiki/>[[commons:Template:LangSwitch\|LangSwitch]]}} template at the Commons, or generally by things dependent on <code>{{<nowiki/>int:Lang}}</code>. Prior to MediaWiki 1.17, this worked by accident; since 1.17, it works by design.\|type=string}}		*{{ApiParam\|uselang\|2=The [[wikipedia:List of ISO 639-1 codes\|language code]] to use for message translations and content parsing ("en" for English, "fr" for French, etc.) A full list of codes may be fetched from [[API:siteinfo]] with <code>siprop=languages</code>, or specify user to use the current user's language preference, or specify content to use this wiki's content language. This is useful for language-dependent content, such as generated by the {{<nowiki/>[[commons:Template:LangSwitch\|LangSwitch]]}} template at the Commons, or generally by things dependent on <code>{{<nowiki/>int:Lang}}</code>. Prior to MediaWiki 1.17, this worked by accident; since 1.17, it works by design.\|type=string}}