Page MenuHomePhabricator

Document how to get the current contents of a page via the MediaWiki API
Open, Needs TriagePublic

Description

Right now this information is spread across several somewhat obscure pages:

Not to mention the Page Content Service for Wikimedia wikis.

As this is one of the most common things that the MediaWiki API is used for, we should have a high-level documentation page that points developers in the right direction depending on their specific needs.

Acceptance criteria:

  • A page exists on https://www.mediawiki.org called something like "API:Get the contents of a page"
  • This page describes the various options available for retrieving page content via the API, with examples, and either links off to more specific documentation or transcludes such documentation within the page.
  • The page is linked from https://www.mediawiki.org/wiki/Template:API.

Event Timeline

kaldari created this task.Oct 14 2019, 12:50 AM
Restricted Application added a project: Core Platform Team. · View Herald TranscriptOct 14 2019, 12:50 AM
Restricted Application added a subscriber: Aklapper. · View Herald Transcript
kaldari updated the task description. (Show Details)Oct 14 2019, 12:51 AM
kaldari updated the task description. (Show Details)
Restricted Application added a subscriber: Liuxinyu970226. · View Herald TranscriptOct 14 2019, 12:52 AM

I think it is better to put relevant information in the manual namespace.

No, because the Manual: is for configuration. The API: is for API stuff.

@jeropbrenda could this task be a microtask or part of the Outreachy project T232816? What do you think?

srishakatux moved this task from Unsorted to Non-Code on the MediaWiki-API board.Oct 14 2019, 8:08 PM

@srishakatux, @jeropbrenda - Agreed. This seems like a nice addition to T232816. Thank you!

@Dikshagupta99: Hi! You assigned this task to yourself a while ago. Are you still working (or plan to work) on this task? Is there anything that others could help with?