עזרה של MediaWiki API

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

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

action=upload

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

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

יש כמה שיטות:

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

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

פרמטרים ייעודיים:
זמינים פרמטרים כלליים אחרים.
filename

שם קובץ היעד.

comment

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

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

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

ערכים (מופרדים באמצעות "|" או or תו חלופי):
text

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

watch
מיושן.

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

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

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

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

חותם־זמן לתפוגת רשימת המעקב. יש להשמיט את הפרמטר הזה לגמרי כדי להותיר את התפוגה הנוכחית ללא שינוי.

סוג: תפוגה (פרטים)
ignorewarnings

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

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

תוכן הקובץ.

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

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

filekey

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

sessionkey
מיושן.

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

stash

אם זה מוגדר, השרת יאחסן את הקובץ במאגר ההעלאות הזמני (stash) במקום להוסיף אותו למאגר הרגיל.

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

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

סוג: מספר שלם
הערך חייב להיות בין 0 ל־5,368,709,120.
offset

היסט הפלח בבתים.

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

תוכן החתיכה.

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

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

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

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

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

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

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