עזרה של MediaWiki API

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

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

prop=revisions (rv)

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

קבלת מידע על גרסה.

יכול לשמש בכמה דרכים:

  1. קבלת נתונים על ערכת דפים (גרסה אחרונה), באמצעות כותרות או מזהי דף.
  2. קבלת גרסאות עבור דף נתון אחד, באמצעות שימוש בכותרות או במזהי דף עם start‏, end או limit.
  3. קבלת נתונים על ערכת גרסאות באמצעות הגדרת המזהים שלהם עם revid־ים.
פרמטרים:
rvprop

אילו מאפיינים לקבל עבור כל גרסה:

ids
מזהה הגרסה.
flags
דגלי גרסה (משני).
timestamp
חותם־הזמן של הגרסה.
user
המשתמש שעשה את הגרסה. אם המשתמש נמחק במחיקת גרסאות, יוחזר המאפיין userhidden.
userid
מזהה המשתמש של יוצר הגרסה. אם המשתמש נמחק במחיקת גרסאות, יוחזר המאפיין userhidden.
size
אורך (בבתים) של הגרסה.
slotsize
אורך (בבתים) של כל משבצת גרסה.
sha1
SHA-1 (בבסיס 16) של הגרסה. אם התוכן נמחק במחיקת גרסאות, יוחזר המאפיין sha1hidden.
slotsha1
SHA-1 (בסיס 16) של כל משבצת גרסה. אם התוכן נמחק במחיקת גרסאות, יוחזר המאפיין sha1hidden.
contentmodel
מזהה מודל התוכן של כל משבצת גרסה.
comment
הערה מאת המשתמש על הגרסה. אם התקציר נמחק במחיקת גרסאות, יוחזר המאפיין commenthidden.
parsedcomment
הערה מפוענחת מאת המשתמש על הגרסה. אם התקציר נמחק במחיקת גרסאות, יוחזר המאפיין commenthidden.
content
התוכן של כל משבצת גרסה. אם התקציר נמחק במחיקת גרסאות, יוחזר המאפיין texthidden.
tags
התגים עבור הגרסה.
roles
רשימת תפקידי משבצות תוכן שקיימות בגרסה.
parsetree
מיושן. יש להשתמש ב־ action=expandtemplates או ב־ action=parse במקום בזה.

עץ פענוח XML של תוכן הגרסה (דורש מודל תוכן wikitext).

ערכים (מופרדים באמצעות "|" או or תו חלופי): comment, content, contentmodel, flags, ids, parsedcomment, roles, sha1, size, slotsha1, slotsize, tags, timestamp, user, userid, parsetree
ברירת המחדל: ids|timestamp|flags|comment|user
rvslots

עבור אילו משבצות תוכן להחזיר נתונים, כאשר מאפיינים שקשורים למשבצת כלולים ב־rvprops. אם זה מושמט, נתונים ממשבצת main יוחזרו בתסדיר תואם לאחור.

ערכים (מופרדים באמצעות "|" או or תו חלופי): main
כדי לתת את כל הערכים, יש להשתמש ב־*.
rvlimit

הגבלת מספר הגרסאות שיוחזרו.

יכול לשמש רק עם דף בודד (mode #2).
סוג: מספר שלם או max
הערך חייב להיות בין 1 ל־500.
rvexpandtemplates
מיושן.

יש להשתמש ב־action=expandtemplates במקום בזה. להרחיב תבניות בתוכן הגרסה (דורש rvprop=content).

סוג: בוליאני (פרטים)
rvgeneratexml
מיושן.

יש להשתמש ב־action=expandtemplates או ב־action=parse במקום בזה. יצירת עץ פענוח XML עבור תוכן הגרסה (דורש את rvprop=content; מוחלף ב־rvprop=parsetree).

סוג: בוליאני (פרטים)
rvparse
מיושן.

יש להשתמש ב־action=parse במקום בזה. פענוח תוכן הגרסה (דורש rvprop=content). מסיבות של ביצועים, אם האפשרות הזאת משמשת, rvlimit נכפה לערך 1.

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

לאחזר רק את התוכן של הפרק עם המספר הזה.

rvdiffto
מיושן.

יש להשתמש ב־action=compare במקום בזה. מזהה הגרסה שכל גרסה תושווה אליה. יש להשתמש ב־prev‏, next ו־cur עבור הגרסה הקודמת, הבא והנוכחית, בהתאמה.

rvdifftotext
מיושן.

יש להשתמש ב־action=compare במקום בזה. הטקסט שכל גרסה גרסה תושווה אליו. מבצע השוואה רק של מספר מוגבל של גרסאות. דורס את rvdiffto. אם מוגדר rvsection, רק הפסקה הזאת תושווה אל מול הטקסט הזה.

rvdifftotextpst
מיושן.

יש להשתמש ב־action=compare במקום בזה. ביצוע התמרה לפני שמירה על הטקסט לפני הרצת השוואה. תקף רק כשמשמש עם rvdifftotext.

סוג: בוליאני (פרטים)
rvcontentformat
מיושן.

תסדיר ההסדרה שמשמש את rvdifftotext וצפוי לפלט של תוכן.

אחד מהערכים הבאים: application/json, text/css, text/javascript, text/plain, text/x-wiki
rvstartid

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

יכול לשמש רק עם דף בודד (mode #2).
סוג: מספר שלם
rvendid

להפסיק למנות מחותם הזמן של הגרסה הזאת. הגרסה צריכה להיות קיימת, אבל לא חייבת להיות שייכת לדף הזה.

יכול לשמש רק עם דף בודד (mode #2).
סוג: מספר שלם
rvstart

מאיזה חותם־זמן של גרסה להתחיל למנות.

יכול לשמש רק עם דף בודד (mode #2).
סוג: חותם־זמן (תסדירים מורשים)
rvend

למנות עד חותם־הזמן הזה.

יכול לשמש רק עם דף בודד (mode #2).
סוג: חותם־זמן (תסדירים מורשים)
rvdir

באיזה כיוון למנות:

newer
לרשום את הישנים ביותר בהתחלה. לתשומת לבך: rvstart חייב להיות לפני rvend.
older
לרשום את החדשים ביותר בהתחלה (ברירת מחדל). לתשומת לבך: rvstart חייב להיות אחרי rvend.
יכול לשמש רק עם דף בודד (mode #2).
אחד מהערכים הבאים: newer, older
ברירת המחדל: older
rvuser

לכלול רק גרסאות מאת משתמש.

יכול לשמש רק עם דף בודד (mode #2).
סוג: משתמש, בכל אחת מהצורות הבאות: שם משתמש, כתובת IP, שם משתמש שהגיע מאתר ויקי אחר (כגון "prefix>ExampleName") וגם מספר מזהה של משתמש (כגון "#12345")
rvexcludeuser

לא לכלול שינויים מאת משתמש.

יכול לשמש רק עם דף בודד (mode #2).
סוג: משתמש, בכל אחת מהצורות הבאות: שם משתמש, כתובת IP, שם משתמש שהגיע מאתר ויקי אחר (כגון "prefix>ExampleName") וגם מספר מזהה של משתמש (כגון "#12345")
rvtag

לרשום רק גרסאות עם התג הזה.

rvtoken
מיושן.

אילו אסימונים לקבל עבור כל גרסה.

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

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

דוגמאות:
קבל נתונים על תוכן עבור הגרסאות האחרונות של הכותרות API ו־Main Page.
api.php?action=query&prop=revisions&titles=API|Main%20Page&rvslots=*&rvprop=timestamp|user|comment|content [פתיחה בארגז חול]
קבלת 5 הגרסאות האחרונות של Main Page.
api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment [פתיחה בארגז חול]
קבלת 5 הגרסאות הראשונות של Main Page.
api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer [פתיחה בארגז חול]
קבלת 5 הגרסאות הראשונות של Main Page שנעשו אחרי 2006-05-01.
api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer&rvstart=2006-05-01T00:00:00Z [פתיחה בארגז חול]
קבלת 5 הגרבאות הראשונות של Main Page שלא נעשו על־ידי המשתמש האלמוני 127.0.0.1.
api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvexcludeuser=127.0.0.1 [פתיחה בארגז חול]
קבלת 5 הגרסאות הראשונות של Main Page שנעשו על־ידי המשתמש MediaWiki default.
api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvuser=MediaWiki%20default [פתיחה בארגז חול]