עזרה של MediaWiki API

זהו דף תיעוד של API שנוצר באופן אוטומטי.

תיעוד ודוגמאות: https://www.mediawiki.org/wiki/API

action=upload

(main | upload)
  • יחידה זו דורשת הרשאות קריאה.
  • היחידה הזאת דורשת הרשאות כתיבה.
  • יחידה זו מקבלת רק בקשות POST.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

העלאת קובץ, או קבלת מצב ההעלאות הממתינות.

יש מספר שיטות:

  • להעלות את הקובץ ישירות, באמצעות הפרמטר file.
  • להעלות את הקובץ בחלקים, באמצעות הפרמטרים filesize‏, chunk ו־offset.
  • לגרום לשרת מדיה־ויקי לאחזר את הקובץ מ־URL באמצעות הפרמטר url.
  • להשלים העלאה קודמת שנכשלה בשל אזהרות באמצעות הפרמטר filekey.

לתשומך לבך, יש לעשות את HTTP POST בתור העלאת קובץ (כלומר באמצעות multipart/form-data) בעת שליחת ה־file.

פרמטרים:
filename

שם קובץ היעד.

comment

הערת העלאה. משמש גם בתור טקסט הדף ההתחלתי עבור קבצים חדשים אם text אינו מצוין.

ברירת מחדל: (ריק)
text

טקסט הדף ההתחלתי לקבצים חדשים.

watch
מיושן.

לעקוב אחרי הדף.

סוג: בוליאני (פרטים)
watchlist

הוספה או הסרה של הדף ללא תנאי מרשימת המעקב של המשתמש הנוכחי, להשתמש בהעדפות או לא לשנות את המעקב.

אחד מהערכים הבאים: watch, preferences, nochange
ברירת מחדל: preferences
ignorewarnings

להתעלם מכל האזהרות.

סוג: בוליאני (פרטים)
file

תוכן הקובץ.

חייב להישלח (posted) בתור העלאת קובץ באמצעות multipart/form-data.
url

URL לאחזור הקובץ.

filekey

מפתח שמזהה העלאה קודמת שהונחה בצד באופן זמני.

sessionkey
מיושן.

אותו דבר כמו filekey, מושאר לצור תאימות אחורה.

stash

אם זה מוגדר, השרת יסליק את הקובץ זמנית במקום להוסיף אותו למאגר.

סוג: בוליאני (פרטים)
filesize

גודל הקובץ של כל ההעלאה.

הערך חייב להיות בין 0 ל־104,857,600.
סוג: מספר שלם
offset

היסט החתיכה בבתים.

הערך לא יכולים להיות קטנים מ־0.
סוג: מספר שלם
chunk

תוכן החתיכה.

חייב להישלח (posted) בתור העלאת קובץ באמצעות multipart/form-data.
async

להפוך פעולות קבצים גדולות לאסינכרוניות כשאפשר.

סוג: בוליאני (פרטים)
asyncdownload

להפוך אחזור URL לאסינכרוני.

סוג: בוליאני (פרטים)
leavemessage

אם משמש asyncdownload, להשאיר הודעה על דף שיחת משתמש אם זה מסתיים.

סוג: בוליאני (פרטים)
statuskey

לאחזר את מצב העלאת הקובץ עבור מפתח הקובץ הזה (העלאה באמצעות URL).

checkstatus

לאחזר רק מצב העלאה עבור מפתח הקובץ שניתן.

סוג: בוליאני (פרטים)
token

אסימון "csrf" שאוחזר מ־action=query&meta=tokens

פרמטר זה נדרש.