راهنمای واسط برنامه‌نویسی کاربردی مدیاویکی
این یک صفحهٔ مستندات برای واسط برنامه‌نویسی کاربردی مدیاویکی است که به‌طور خودکار ایجاد شده‌است.
مستندات و نمونه‌ها: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=edit
- این پودمان نیازمند اختیارات خواندن است.
- این پودمان نیازمند اختیارات خواندن است.
- این پودمان تنها درخواست‌های POST را می‌پذیرد.
- منبع: MediaWiki
- مجوز: GPL-2.0-or-later
ایجاد و ویرایش صفحه
- title
عنوان صفحه‌ای که قصد ویرایشش را دارید. نمی‌تواند در کنار pageid استفاده شود.
- pageid
شناسه صفحهٔ صفحه‌ای که می‌خواهید ویرایشش کنید. نمی‌تواند در کنار title استفاده شود.
- نوع: عدد صحیح
- section
شماره بخش. ۰ برای بخش بالا، «تازه» برای یک بخش تازه.
- sectiontitle
عنوان برای بخش جدید.
- text
محتوای صفحه.
- summary
خلاصه را ویرایش کنید. همچنین عنوان بخش را زمانی که section=تازه و sectiontitle تنظیم نشده‌است.
- tags
برچسب‌های تغییر برای اعمال بر نسخه.
- مقدارهای (جداشده با | یا جایگزین‌های آن):
- minor
این ویرایش را به‌عنوان «ویرایش جزئی» نشانه‌گذاری کن.
- نوع: بولی (جزئیات)
- notminor
ویرایش غیر جزئی.
- نوع: بولی (جزئیات)
- bot
این ویرایش را به‌عنوان «ویرایش ربات» نشانه‌گذاری کن.
- نوع: بولی (جزئیات)
- baserevid
ID of the base revision, used to detect edit conflicts. May be obtained through action=query&prop=revisions. Self-conflicts cause the edit to fail unless basetimestamp is set.
- نوع: عدد صحیح
- basetimestamp
Timestamp of the base revision, used to detect edit conflicts. May be obtained through action=query&prop=revisions&rvprop=timestamp. Self-conflicts are ignored.
- نوع: برچسب زمان (قالب‌های مجاز)
- starttimestamp
برچسب زمان آغاز فرایند ویرایش، مورد استفاده برای شناسایی تعارض‌های ویرایشی. مقدار مناسب را می‌توان با استفاده از curtimestamp در زمان آغاز فرانید ویرایش (در زمان بارگیری محتوای صفحه به‌منظور ویرایش) به‌دست آورد.
- نوع: برچسب زمان (قالب‌های مجاز)
- recreate
باطل‌کردن هرگونه خطا پیرامون حذف صفحه در مدت عمل.
- نوع: بولی (جزئیات)
- createonly
اگر صفحه موجود بود، ویرایش نکن.
- نوع: بولی (جزئیات)
- nocreate
رها کردن خطا در صورتی که صفحه وجود ندارد.
- نوع: بولی (جزئیات)
- watch
- منسوخ‌شده.
افزودن صفحه به فهرست پیگیری‌‌تان
- نوع: بولی (جزئیات)
- unwatch
- منسوخ‌شده.
حذف صفحه از فهرست پیگیری کاربر کنونی
- نوع: بولی (جزئیات)
- watchlist
افزودن یا حذف بدون قید و شرط صفحه از فهرست پیگیری‌های کاربر کنونی، پیروی از ترجیحات (برای کاربران ربات نادیده گرفته می‌شود) یا عدم تغییر وضعیت پیگیری.
- یکی از مقدارهای زیر: nochange، preferences، unwatch، watch
- پیش‌فرض: preferences
- md5
هش MD5 پارامتر text، یا پارامترهای prependtext و appendtext به‌هم‌پیوسته. اگر تنظیم شود، ویرایش تا پیش از صحیح بودن هش انجام نخواهد شد.
- prependtext
افزودن این متن به ابتدای صفحه یا بخش. text را باطل می‌کند.
- appendtext
افزودن این متن به انتهای صفحه یا بخش. text را باطل می‌کند.
برای افزودن یک بخش تازه، به‌جای این پارامتر از section=new استفاده کنید.
- undo
خنثی‌سازی این نسخه. text، prependtext و appendtext را باطل می‌کند.
- نوع: عدد صحیح
- The value must be no less than ۰.
- undoafter
بازگردانی تمام نسخه‌ها از undo تا این یکی. اگر تنظیم نشود، فقط یک نسخه بازگردانده می‌شود.
- نوع: عدد صحیح
- The value must be no less than ۰.
- redirect
اصلاح خودکار تغییرمسیرها.
- نوع: بولی (جزئیات)
- contentformat
قالب تسلسل محتوای مورد استفاده برای متن ورودی.
- یکی از مقدارهای زیر: application/json، application/octet-stream، application/unknown، application/x-binary، text/css، text/javascript، text/plain، text/unknown، text/x-wiki، unknown/unknown
- contentmodel
مدل محتوا برای محتوای تازه.
- یکی از مقدارهای زیر: GadgetDefinition، MassMessageListContent، Scribunto، css، javascript، json، sanitized-css، text، unknown، wikitext
- token
یک بلیط «csrf» واکشی‌شده از action=query&meta=tokens
بلیط باید همیشه به عنوان آخرین پارامتر، یا دست کم بعد از پارامتر text فرستاده شود.
- این پارامتر الزامی است.
- ویرایش صفحه
- api.php?action=edit&title=Test&summary=test%20summary&text=article%20content&baserevid=1234567&token=123ABC [باز کردن در صفحهٔ تمرین]
- افزودن __بی‌فهرست__ به ابتدای یک صفحه.
- api.php?action=edit&title=Test&summary=NOTOC&minor=&prependtext=__NOTOC__%0A&basetimestamp=2007-08-24T12:34:54Z&token=123ABC [باز کردن در صفحهٔ تمرین]
- واگردانی نسخه‌های ۱۳۵۷۹ تا ۱۳۵۸۵ با خلاصهٔ خودکار.
- api.php?action=edit&title=Test&undo=13585&undoafter=13579&basetimestamp=2007-08-24T12:34:54Z&token=123ABC [باز کردن در صفحهٔ تمرین]