עזרה של MediaWiki API
זהו דף תיעוד של API שנוצר באופן אוטומטי.
תיעוד ודוגמאות: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=visualeditoredit
- המודול הזה פנימי או בלתי־יציב, ולא כדאי לך להשתמש בו. הפעולה שלו יכולה להשתנות ללא הודעה מוקדמת.
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: VisualEditor
- רישיון: MIT
שמירת דף HTML5 למדיה־ויקי (מומר לקוד ויקי דרך שירות פרסואיד).
- paction
איזו פעולה לבצע.
- הפרמטר הזה נדרש.
- אחד מהערכים הבאים: diff, save, serialize, serializeforcache
- page
על איזה דף לבצע את הפעולה.
- הפרמטר הזה נדרש.
- token
אסימון "csrf" שאוחזר מ־action=query&meta=tokens
- הפרמטר הזה נדרש.
- wikitext
עם איזה קוד ויקי לפעול.
- section
על איזה פרק לפעול.
- sectiontitle
הכותרת של הפרק החדש.
- basetimestamp
בעת שמירה, להגדיר את זה בתור חותם־הזמן של הגרסה שנערכה. זה משמש לזיהוי התנגשויות.
- סוג: חותם־זמן (תסדירים מורשים)
- starttimestamp
בעת השמירה, להגדיר את זה לחותם־זמן כאשר הדף לא נטען. משמש לזיהוי התנגשויות עריכה.
- סוג: חותם־זמן (תסדירים מורשים)
- oldid
באיזה מספר גרסה להשתמש. ברירת המחדל היא הגרסה האחרונה.
- סוג: מספר שלם
- minor
דגל עריכה משנית.
- watchlist
להוסיף ללא תנאים את הדף לרשימת המעקב של המשתמש הנוכחי או להסיר אותו משם, להשתמש בהעדפות (לא חל על משתמשי בוט) או לא לשנות את מצב המעקב.
- html
איזה HTML לשלוח לפרסואיד כדי לקבל חזרה קוד ויקי.
- etag
איזה ETag לשלוח.
- summary
תקציר עריכה.
- captchaid
מזהה Captcha (בעת שמירה עם תשובת captcha).
- captchaword
תשובה ל־captcha (בעת שמירה עם תשובת captcha).
- cachekey
להשתמש בתוצאה של בקשת ה־serializeforcache הקודמת עם המפתח הזה. עוקף את html.
- nocontent
להשמיט את תוכן ה־HTML של הגרסה החדשה בתשובה.
- סוג: בוליאני (פרטים)
- returnto
כותרת הדף. אם שמירת העריכה יצרה חשבון זמני, ה־API עשוי להשיב עם כתובת URL שהלקוח צריך לבקר בה כדי להשלים את הכניסה. אם הפרמטר הזה מסופק, ה־URL יפנה לדף הנתון, במקום לדף שנערך.
- סוג: כותרת דף
- מקבל דפים שאינם קיימים.
- returntoquery
פרמטרים של שאילתה עבור ה־URL (עם ?). אם שמירת העריכה יצרה חשבון זמני, ה־API עשוי להשיב עם כתובת URL שהלקוח צריך לבקר בה כדי להשלים את הכניסה. אם הפרמטר הזה מסופק, ה־URL יפנה לדף הנתון, במקום לדף שנערך.
- ברירת מחדל: (ריק)
- returntoanchor
קטע של URL (עם # מוביל). אם שמירת העריכה יצרה חשבון זמני, ה־API עשוי להשיב עם כתובת URL שהלקוח צריך לבקר בה כדי להשלים את הכניסה. אם הפרמטר הזה מסופק, ה־URL יפנה לדף עם הקטע שניתן.
- ברירת מחדל: (ריק)
- useskin
להחיל את העיצוב שנבחר לפלט המפענח. יכול להשפיע על המאפיינים הבאים: text, langlinks, headitems, modules, jsconfigvars, indicators.
- אחד מהערכים הבאים: apioutput, cologneblue, contenttranslation, fallback, minerva, modern, monobook, timeless, vector, vector-2022
אילו תגי שינוי להחיל על הגרסה.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי.
- המספר המרבי של ערכים הוא 50 (או 500 עבור לקוחות שמותרות להם מגבלות גבוהות יותר).
- plugins
תוספים מזוהים עם בקשת ה־API.
- ge-task-link-recommendation
- לשימוש בעת שמירת העריכה המבנית "הוספת קישור" של GrowthExperiments.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי.
- המספר המרבי של ערכים הוא 50 (או 500 עבור לקוחות שמותרות להם מגבלות גבוהות יותר).
- data-{plugin}
נתונים שרירותיים שנשלחים באמצעות תוסף עם בקשת ה־API.
- בשביל תוסף ge-task-link-recommendation
-
מחרוזת JSON של עצם עם המפתחות האלה:
- acceptedTargets: (רשות) מערך עם כותרות הדפים שהמשתמש קיבל את הקישור המומלץ אליהם.
- rejectedTargets: (רשות) מערך עם כותרות הדפים שהמשתמש דחה את הקישור המומלץ אליהם.
- skippedTargets: (רשות) מערך עם כותרות הדפים שהמשתמש פסח על הקישור המומלץ אליהם.-
- זהו פרמטר בתבנית. בעת ביצוע הבקשה, יש להחליף את הטקסט {plugin} (בשם הפרמטר) עם הערכים של הפרמטר plugins.
- mobileformat
החזרת פלט הפענוח בתסדיר שתואם להתקנים ניידים.
- סוג: בוליאני (פרטים)