עזרה של MediaWiki API
זהו דף תיעוד של API שנוצר באופן אוטומטי.
תיעוד ודוגמאות: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=edit
- יחידה זו דורשת הרשאות קריאה.
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0-or-later
יצירה ועריכה של דפים.
- title
שם הדף לעריכה. לא לשימוש עם pageid.
- pageid
מזהה הדף לעריכה. לא לשימוש עם title.
- סוג: מספר שלם
- section
מספר הפסקה 0 לפסקה העליונה, new לפסקה חדשה.
- sectiontitle
הכותרת לפסקה החדשה.
- text
תוכן הדף.
- summary
תקציר עריכה. גם כותרת פסקה כש־section=new ו־sectiontitle אינו מוגדר.
- tags
אילו תגי שינוי להחיל על הגרסה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי):
- minor
סימון העריכה בתור משנית.
- סוג: בוליאני (פרטים)
- notminor
לא לסמן את העריכה הזאת בתור משנית אפילו כשמופעלת ההעדפה "סימון כל העריכות כמשניות בתור ברירת מחדל".
- סוג: בוליאני (פרטים)
- bot
סימון עריכה זו כעריכת בוט.
- סוג: בוליאני (פרטים)
- baserevid
מזהה גרסת הבסיס, משמש לזיהוי התנגשויות עריכה. אפשר להשיג אותו באמצעות action=query&prop=revisions. התנגשויות עצמיות גורמות לעריכה להיכשל אלא אם מוגדר basetimestamp.
- סוג: מספר שלם
- basetimestamp
חותם־זמן של גרסת הבסיס, משמש לזיהוי התנגשויות עריכה. אפשר לקבל אותו באמצעות action=query&prop=revisions&rvprop=timestamp. התנגשויות עצמיות אינן בשימוש.
- סוג: חותם־זמן (תסדירים מורשים)
- 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.
- סוג: מספר שלם
- הערך לא יכול להיות קטן מ־0.
- undoafter
ביטול כל הגרסאות מ־undo עד כאן. אם זה לא מוגדר, לבטל רק גרסה אחת.
- סוג: מספר שלם
- הערך לא יכול להיות קטן מ־0.
- redirect
לפתור הפניות אוטומטית.
- סוג: בוליאני (פרטים)
- contentformat
תסדיר להסדרת תוכן שמשמש את טקסט הקלט.
- אחד מהערכים הבאים: application/json, text/css, text/javascript, text/plain, text/x-wiki
- contentmodel
מודל התוכן של התוכן החדש.
- אחד מהערכים הבאים: css, javascript, json, text, wikitext
- token
אסימון "csrf" שאוחזר מ־action=query&meta=tokens
האסימון תמיד צריך להישלח בתור הפרמטר האחרון, או לפחות אחרי הפרמטר text parameter.
- הפרמטר הזה נדרש.
- עריכת דף
- api.php?action=edit&title=Test&summary=test%20summary&text=article%20content&baserevid=1234567&token=123ABC [פתיחה בארגז חול]
- הוספת __NOTOC__ לתחילת הדף.
- api.php?action=edit&title=Test&summary=NOTOC&minor=&prependtext=__NOTOC__%0A&basetimestamp=2007-08-24T12:34:54Z&token=123ABC [פתיחה בארגז חול]
- ביטול גרסאות מ־13579 עד 13585 עם תקציר אוטומטי.
- api.php?action=edit&title=Test&undo=13585&undoafter=13579&basetimestamp=2007-08-24T12:34:54Z&token=123ABC [פתיחה בארגז חול]