Page MenuHomePhabricator

Make "try out" button in Swagger docs of the Wikibase REST API work for Wikidata and Beta Wikidata
Open, MediumPublicFeature

Description

Feature summary:
The Wikibase REST API swagger docs at https://doc.wikimedia.org/Wikibase/master/js/rest-api/ have a try out feature. There is a server selection that currently only allows selecting wikibase.example as a server. We should add beta Wikidata and Wikidata as additional options. Wikidata because it is the largest consumer of the Wikibase REST API and is expected to stay that for a long time and beta Wikidata because it is a good playground.

Benefits:
It'll be easier to see the actual actions on a live Wikibase instance right from the documentation. This will make it easier to understand the API and make it easier to get started developing with the API.

Event Timeline

Lydia_Pintscher moved this task from Backlog to Next on the Wikibase REST API (archieved) board.

the naive but not very satisfying approach of adding more "servers" to pick from on the central docs page is a cheap workaround we can also do. Meanwhile we're exploring the option of generating site-specific autodocs and deploying it on site as, hypothesis to validate, more intuitive, and more "clean" approach. See T329606 for partial details

Change 952264 had a related patch set uploaded (by WMDE-leszek; author: WMDE-leszek):

[mediawiki/extensions/Wikibase@master] REST: Temporarily added Wikidata specific examples to spec/docs

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

Change 953730 had a related patch set uploaded (by WMDE-leszek; author: WMDE-leszek):

[mediawiki/extensions/Wikibase@master] REST: Temporary hack to allow multiple example API targets

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