Requests for comment/API roadmap - Revision history

MusikAnimal: /* Deprecation process */ rm hatnote to nonexistent page

2024-12-12T06:01:25Z

Deprecation process: rm hatnote to nonexistent page

← Older revision		Revision as of 06:01, 12 December 2024
Line 12:		Line 12:

	== Deprecation process ==		== Deprecation process ==
	:''Historical; the canonical location for the deprecation process is [[API:Deprecation]]''
	Discussion at the Architecture Summit in January 2014 was generally favorable to deprecations of major features, as long as we give people enough time to update. Minor changes will continue to be announced to the [http://lists.wikimedia.org/pipermail/mediawiki-api-announce/ mediawiki-api-announce] mailing list.		Discussion at the Architecture Summit in January 2014 was generally favorable to deprecations of major features, as long as we give people enough time to update. Minor changes will continue to be announced to the [http://lists.wikimedia.org/pipermail/mediawiki-api-announce/ mediawiki-api-announce] mailing list.

Tgr (WMF): /* Deprecation process */

2024-08-11T20:11:19Z

Deprecation process

← Older revision		Revision as of 20:11, 11 August 2024
Line 12:		Line 12:

	== Deprecation process ==		== Deprecation process ==
			:''Historical; the canonical location for the deprecation process is [[API:Deprecation]]''
	{{Deprecation policies}}
	Discussion at the Architecture Summit in January 2014 was generally favorable to deprecations of major features, as long as we give people enough time to update. Minor changes will continue to be announced to the [http://lists.wikimedia.org/pipermail/mediawiki-api-announce/ mediawiki-api-announce] mailing list.		Discussion at the Architecture Summit in January 2014 was generally favorable to deprecations of major features, as long as we give people enough time to update. Minor changes will continue to be announced to the [http://lists.wikimedia.org/pipermail/mediawiki-api-announce/ mediawiki-api-announce] mailing list.

Taavi: do not modify old rfcs

2020-12-14T09:44:34Z

do not modify old rfcs

← Older revision		Revision as of 09:44, 14 December 2020
Line 11:		Line 11:
	This RFC proposes making some significant changes to the API, along with a process for handling deprecations.		This RFC proposes making some significant changes to the API, along with a process for handling deprecations.

	== ~~[[Deprecating Inline Styles\|~~Deprecation]] process ==		== Deprecation process ==
	{{Deprecation policies}}		{{Deprecation policies}}
	Discussion at the Architecture Summit in January 2014 was generally favorable to deprecations of major features, as long as we give people enough time to update. Minor changes will continue to be announced to the [http://lists.wikimedia.org/pipermail/mediawiki-api-announce/ mediawiki-api-announce] mailing list.		Discussion at the Architecture Summit in January 2014 was generally favorable to deprecations of major features, as long as we give people enough time to update. Minor changes will continue to be announced to the [http://lists.wikimedia.org/pipermail/mediawiki-api-announce/ mediawiki-api-announce] mailing list.
Line 40:		Line 40:
	# Any flag to select the new version explicitly may at some point be removed, leading to "unrecognized parameter" warnings.		# Any flag to select the new version explicitly may at some point be removed, leading to "unrecognized parameter" warnings.

	== [[Architectural ~~vision discussion\|Architectural]]~~ changes ==		== Architectural changes ==

	Changes reviewed for this RFC include:		Changes reviewed for this RFC include:

Catie99: Sidebar

2020-12-14T09:29:45Z

Sidebar

← Older revision		Revision as of 09:29, 14 December 2020
Line 40:		Line 40:
	# Any flag to select the new version explicitly may at some point be removed, leading to "unrecognized parameter" warnings.		# Any flag to select the new version explicitly may at some point be removed, leading to "unrecognized parameter" warnings.

	== Architectural changes ==		== [[Architectural vision discussion\|Architectural]] changes ==

	Changes reviewed for this RFC include:		Changes reviewed for this RFC include:

Catie99: Y

2020-12-14T09:28:45Z

← Older revision		Revision as of 09:28, 14 December 2020
Line 11:		Line 11:
	This RFC proposes making some significant changes to the API, along with a process for handling deprecations.		This RFC proposes making some significant changes to the API, along with a process for handling deprecations.

	== Deprecation process ==		== [[Deprecating Inline Styles\|Deprecation]] process ==
	{{Deprecation policies}}		{{Deprecation policies}}
	Discussion at the Architecture Summit in January 2014 was generally favorable to deprecations of major features, as long as we give people enough time to update. Minor changes will continue to be announced to the [http://lists.wikimedia.org/pipermail/mediawiki-api-announce/ mediawiki-api-announce] mailing list.		Discussion at the Architecture Summit in January 2014 was generally favorable to deprecations of major features, as long as we give people enough time to update. Minor changes will continue to be announced to the [http://lists.wikimedia.org/pipermail/mediawiki-api-announce/ mediawiki-api-announce] mailing list.

NicoScribe: Undid revision 3954812 by 70.125.177.176 (talk) unexplained removal

2020-07-09T06:58:42Z

Undid revision 3954812 by 70.125.177.176 (talk) unexplained removal

← Older revision		Revision as of 06:58, 9 July 2020
Line 1:		Line 1:
			{{RFC
			\| created = 2013-01-14
			\| authors = [[User:Anomie\|Anomie]], [[User:Yurik\|Yurik]]
			\| bug = T482
			\| status = accepted
			}}

	== Background ==		== Background ==

70.125.177.176 at 06:38, 9 July 2020

2020-07-09T06:38:12Z

← Older revision		Revision as of 06:38, 9 July 2020
Line 1:		Line 1:
	{{RFC
	\| created = 2013-01-14
	\| authors = [[User:Anomie\|Anomie]], [[User:Yurik\|Yurik]]
	\| bug = T482
	\| status = accepted
	}}

	== Background ==		== Background ==

Cronolio: Reverted edits by 70.125.177.176 (talk) to last version by DannyS712

2020-07-09T06:37:54Z

Reverted edits by 70.125.177.176 (talk) to last version by DannyS712

← Older revision		Revision as of 06:37, 9 July 2020
Line 1:		Line 1:
			{{RFC
			\| created = 2013-01-14
			\| authors = [[User:Anomie\|Anomie]], [[User:Yurik\|Yurik]]
			\| bug = T482
			\| status = accepted
			}}

	== Background ==		== Background ==
Line 5:		Line 11:
	This RFC proposes making some significant changes to the API, along with a process for handling deprecations.		This RFC proposes making some significant changes to the API, along with a process for handling deprecations.

	== ~~Depreciation~~ process ==		== Deprecation process ==
			{{Deprecation policies}}
	Discussion at the Architecture Summit in January 2014 was generally favorable to deprecations of major features, as long as we give people enough time to update. Minor changes will continue to be announced to the mediawiki-api-announce mailing list.		Discussion at the Architecture Summit in January 2014 was generally favorable to deprecations of major features, as long as we give people enough time to update. Minor changes will continue to be announced to the [http://lists.wikimedia.org/pipermail/mediawiki-api-announce/ mediawiki-api-announce] mailing list.

	When it is possible for the new version of the feature to coexist with the old (e.g. prop=imageinfo and prop=fileinfo):		When it is possible for the new version of the feature to coexist with the old (e.g. prop=imageinfo and prop=fileinfo):
	# The new feature will be implemented.		# The new feature will be implemented.
	# The deprecation will be announced:		# The deprecation will be announced:
	#* A message will be sent to the mediawiki-api-announce mailing list.		#* A message will be sent to the [http://lists.wikimedia.org/pipermail/mediawiki-api-announce/ mediawiki-api-announce] mailing list.
	#* The old feature will report deprecation warnings.		#* The old feature will report deprecation warnings.
	#* Uses of the deprecated feature will be logged on the server (currently in WMF's case this is on fluorine where deployers have access).		#* Uses of the deprecated feature will be logged on the server (currently in WMF's case this is on fluorine where deployers have access).
Line 19:		Line 26:
	# The new feature will be implemented, but must be explicitly requested by clients via a query parameter.		# The new feature will be implemented, but must be explicitly requested by clients via a query parameter.
	# The deprecation will be announced:		# The deprecation will be announced:
	#* A message will be sent to the mediawiki-api-announce mailing list.		#* A message will be sent to the [http://lists.wikimedia.org/pipermail/mediawiki-api-announce/ mediawiki-api-announce] mailing list.
	#* Deprecation warnings will be output when the parameter to request the new version is not given.		#* Deprecation warnings will be output when the parameter to request the new version is not given.
	#* Uses of the deprecated feature will be logged privately.		#* Uses of the deprecated feature will be logged privately.
Line 28:		Line 35:
	# If not already present, a request parameter will be added to specifically request the old behavior.		# If not already present, a request parameter will be added to specifically request the old behavior.
	# The change will be announced:		# The change will be announced:
	#* A message will be sent to the mediawiki-api-announce mailing list.		#* A message will be sent to the [http://lists.wikimedia.org/pipermail/mediawiki-api-announce/ mediawiki-api-announce] mailing list.
	#* Deprecation warnings will be output when neither the select-new-version nor the select-old-version flags are used. Logs will also be made.		#* Deprecation warnings will be output when neither the select-new-version nor the select-old-version flags are used. Logs will also be made.
	# After a suitable timeframe, the new version will become the default.		# After a suitable timeframe, the new version will become the default.
Line 36:		Line 43:

	Changes reviewed for this RFC include:		Changes reviewed for this RFC include:
	* Removal of obsolete output formats		* [[API/Architecture work/Planning#Remove obsolete output formats\|Removal of obsolete output formats]]
	* Replacing format=json to clean up cruft inherited from its origin as a dump of data intended for XML output		* [[API/Architecture work/Planning#Changes to JSON output format\|Replacing format=json to clean up cruft inherited from its origin as a dump of data intended for XML output]]
	* [[API/Architecture work/Planning#Changes to PHP output format\|The same for format=php]]		* [[API/Architecture work/Planning#Changes to PHP output format\|The same for format=php]]
	* [[API/Architecture work/Planning#Changes to XML output format\|Adjusting format=xml to no longer throw exceptions if hoops aren't jumped through]]		* [[API/Architecture work/Planning#Changes to XML output format\|Adjusting format=xml to no longer throw exceptions if hoops aren't jumped through]]
Line 43:		Line 50:
	* [[API/Architecture work/Planning#Changes to pretty-printed HTML formats\|Don't try to syntax-highlight pretty-printed output in core]]		* [[API/Architecture work/Planning#Changes to pretty-printed HTML formats\|Don't try to syntax-highlight pretty-printed output in core]]
	* [[API/Architecture work/Planning#HTMLizing action=help\|HTMLification, pagination, and i18n of action=help]]		* [[API/Architecture work/Planning#HTMLizing action=help\|HTMLification, pagination, and i18n of action=help]]
	* I18n for warnings and errors		* [[API/Architecture work/Planning#Internationalizing API warnings and errors\|I18n for warnings and errors]]
	* [[API/Architecture work/Planning#Support uselang\|Officially support uselang]]		* [[API/Architecture work/Planning#Support uselang\|Officially support uselang]]
	* [[API/Architecture work/Planning#Removal of long-deprecated parameters\|Removal of long-deprecated parameters]]		* [[API/Architecture work/Planning#Removal of long-deprecated parameters\|Removal of long-deprecated parameters]]
Line 50:		Line 57:
	* A few other enhancements that crept into the RFC when it was being treated as a TODO list.		* A few other enhancements that crept into the RFC when it was being treated as a TODO list.

	Full details are at API/Architecture work and API/Architecture work/Planning.		Full details are at [[API/Architecture work]] and [[API/Architecture work/Planning]].

	== See also ==		== See also ==

70.125.177.176 at 06:37, 9 July 2020

2020-07-09T06:37:52Z

← Older revision		Revision as of 06:37, 9 July 2020
Line 43:		Line 43:
	* [[API/Architecture work/Planning#Changes to pretty-printed HTML formats\|Don't try to syntax-highlight pretty-printed output in core]]		* [[API/Architecture work/Planning#Changes to pretty-printed HTML formats\|Don't try to syntax-highlight pretty-printed output in core]]
	* [[API/Architecture work/Planning#HTMLizing action=help\|HTMLification, pagination, and i18n of action=help]]		* [[API/Architecture work/Planning#HTMLizing action=help\|HTMLification, pagination, and i18n of action=help]]
	* ~~[[API/Architecture work/Planning#Internationalizing API warnings and errors\|~~I18n for warnings and errors]]		* I18n for warnings and errors
	* [[API/Architecture work/Planning#Support uselang\|Officially support uselang]]		* [[API/Architecture work/Planning#Support uselang\|Officially support uselang]]
	* [[API/Architecture work/Planning#Removal of long-deprecated parameters\|Removal of long-deprecated parameters]]		* [[API/Architecture work/Planning#Removal of long-deprecated parameters\|Removal of long-deprecated parameters]]

70.125.177.176 at 06:37, 9 July 2020

2020-07-09T06:37:25Z

← Older revision		Revision as of 06:37, 9 July 2020
Line 50:		Line 50:
	* A few other enhancements that crept into the RFC when it was being treated as a TODO list.		* A few other enhancements that crept into the RFC when it was being treated as a TODO list.

	Full details are at [[API/Architecture work]] and API/Architecture work/Planning.		Full details are at API/Architecture work and API/Architecture work/Planning.

	== See also ==		== See also ==

← Older revision		Revision as of 06:37, 9 July 2020
Line 43:		Line 43:
	* [[API/Architecture work/Planning#Changes to pretty-printed HTML formats\|Don't try to syntax-highlight pretty-printed output in core]]		* [[API/Architecture work/Planning#Changes to pretty-printed HTML formats\|Don't try to syntax-highlight pretty-printed output in core]]
	* [[API/Architecture work/Planning#HTMLizing action=help\|HTMLification, pagination, and i18n of action=help]]		* [[API/Architecture work/Planning#HTMLizing action=help\|HTMLification, pagination, and i18n of action=help]]
	* ~~[[API/Architecture work/Planning#Internationalizing API warnings and errors\|~~I18n for warnings and errors]]		* I18n for warnings and errors
	* [[API/Architecture work/Planning#Support uselang\|Officially support uselang]]		* [[API/Architecture work/Planning#Support uselang\|Officially support uselang]]
	* [[API/Architecture work/Planning#Removal of long-deprecated parameters\|Removal of long-deprecated parameters]]		* [[API/Architecture work/Planning#Removal of long-deprecated parameters\|Removal of long-deprecated parameters]]