Page MenuHomePhabricator

Update all example API requests to use formatversion=2 and https
Open, Needs TriagePublic

Description

(this may be a duplicate)

formatversion=2 in API requests gets a cleaner better response. It's the recommended future, so we should show it in all API requests, both on-wiki and in generated getExamplesMessages(). Related, ApiSandbox needs to support formatversion (T98083) and default it to on.

Similarly, Wikimedia wikis are transitioning to only supporting https, including api.php, so all sample API URLs that show http: as the scheme should switch to https:. The {{ApiEx}} wiki template and generated getExamplesMessages() don't show the scheme.

(We also should have shown continue= in all examples to encourage the improved continue format, but that will become the default in July 2015.)

Event Timeline

Spage raised the priority of this task from to Needs Triage.
Spage updated the task description. (Show Details)
Spage added a subscriber: Spage.
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptJun 18 2015, 9:31 PM
Anomie moved this task from Unsorted to Non-Code on the MediaWiki-API board.Jun 19 2015, 1:46 PM
Anomie moved this task from Non-Code to Needs details or plan on the MediaWiki-API board.

Change 400074 had a related patch set uploaded (by Gergő Tisza; owner: Gergő Tisza):
[mediawiki/core@master] Add formatversion=2 to all API examples

https://gerrit.wikimedia.org/r/400074

Tgr added a subscriber: Tgr.Dec 23 2017, 10:38 PM

Hi. I'm Diksha and I'm an outreachy applicant. I want to contribute to this project. May I know the repository name of this task?

Restricted Application added a project: Platform Engineering. · View Herald TranscriptOct 23 2019, 2:00 PM
Restricted Application added a subscriber: Liuxinyu970226. · View Herald Transcript
WDoranWMF added a subscriber: WDoranWMF.

@Dikshagupta99 this might not be a great task to look at as part of Outreachy. I'd suggest looking through good first task tasks and pull from there. You could filter by Platform Engineering. Let me know if I can help more!