Adding @srishakatux, as a subscriber. We're currently working on improving on-wiki documentation for the API, and this may be relevant.

@awight I am an Outreachy applicant working on this task. Please I need some clarification. Am I to document only what has been listed as TODO?

In T203025#5611015, @AwahNadege wrote:

@awight I am an Outreachy applicant working on this task.

Hi, that's great news. Thank you for putting time into this work!

Please I need some clarification. Am I to document only what has been listed as TODO?

No, sorry for the confusion. The "TODO" notes were to indicate that the task isn't fully defined, but at this point I think it makes sense to include the TODOs in the work itself, I'll take a pass at cleaning up the task description.

The situation as I understand it is that action=edit has no documentation of its response structure. Checking the built-in API documentation and the wiki page, I wouldn't know to expect an oldrevid after every edit for example, or what to do with it, or what it will contain if this is the first revision of an article. This could be a bigger deal than it looks like, note Anomie's point in T203025#4542344 that we don't have a standard way to document response structure for the built-in API docs, and maybe not even for the wiki docs.

Happily, it looks like the errors are already documented on-wiki, just not in the source code.

On that note, I assume that the scope of the Outreachy project T232816 is to update the wiki docs first, but built-in docs would fall under the "OPTIONAL" note about editing sample code or even in later follow-up work?

Thank you @awight . I will start from documenting the possible result values and their structure for the API:Edit wiki page first.

When a user is editing a redirect page and wants to create a new section in the target page. The first redirect is the target page and the second is the new section created in this target page. So you have section=new.
@awight Please is that how action=Edit API creates redirects using batched params. Please could you clarify me.

In T203025#5618364, @AwahNadege wrote:

When a user is editing a redirect page and wants to create a new section in the target page. The first redirect is the target page and the second is the new section created in this target page. So you have section=new.
@awight Please is that how action=Edit API creates redirects using batched params. Please could you clarify me.

Good question. Looking more closely, I think that the Edit API only supports a single edit, so there is no "batch" mode like I was hypothesizing yesterday. In case it helps, here's the source code I'm reading from: https://phabricator.wikimedia.org/source/mediawiki/browse/master/includes/api/ApiEditPage.php . Your understanding of the logic sounds better than mine, but I'll try to paraphrase what I see in the code just in case it helps us both:

The redirects output field is only populated when the redirect input parameter is passed. redirect can only be passed when prepending or appending a section=new. When the page being edited is a redirect, and the redirect parameter was set, then we resolve the title to its target. This shows up as "from" and "to" in the first item of the redirects output list. Although double (and more) redirects are not supposed to work, we still seem to support them here, and these additional redirects will be returns as successive elements in the output redirects list.

Very strange feature, but at leasts it starts to make sense.

Thank you @awight it looks clearer to me now.

@awight Please review. Thank you. https://www.mediawiki.org/wiki/User:Awah_Nadege/Sandbox/Return_values_for_action%3Dedit_API

@awight Please could you review what i have done in my sandbox. Here is the link https://www.mediawiki.org/wiki/User:Awah_Nadege/Sandbox/Return_values_for_action%3Dedit_API