Provide the way to generate local autodocs based on the Open API spec to be published together with the instance
Closed, ResolvedPublic3 Estimated Story Points
Actions

Assigned To

Authored By

	WMDE-leszek
	Feb 14 2023, 7:51 AM

Description

As a Wikibase instance admin I want to provide my users with accurate and up-to-date documentation of the REST API so that users have a clear overview of the provided functionality.
As a beginner user of Wikibase REST API I want to have a way to practice making requests so that I can quickly try out the API

Goal: Provide Wikibase instance admins with the way to create an up-to-date version of swagger UI generated autodocs site. It should include the "Try it out" button targetting the local wiki's API -- using a provided public URL if wanted.

Notes:

for the time being the "central" version of autodocs on doc.wikimedia.org is to be kept as it is now

Acceptance criteria:

It is possible to generate local copy of the REST API autodocs (e.g. npm/composer script)
Autodocs generated with the above have "Try it out" button" that runs requests to the configured URL
autodocs on doc.wikimedia.org continue to operate.. Its "Try it out" button targets the wikibase.example exemplary API.

Details

	Subject	Repo	Branch	Lines +/-
	REST: Make API docs base URL configurable	mediawiki/extensions/Wikibase	master	+14 -1

Customize query in gerrit

Related Objects

Mentioned In: T329080: Make "try out" button in Swagger docs of the Wikibase REST API work for Wikidata and Beta Wikidata

Event Timeline

WMDE-leszek created this task.Feb 14 2023, 7:51 AM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptFeb 14 2023, 7:51 AM

WMDE-leszek renamed this task from Provide the way to generate autodocs to Provide the way to generate local autodocs based on the Open API spec to be published together with the instance.Feb 14 2023, 7:57 AM

WMDE-leszek updated the task description. (Show Details)

WMDE-leszek added projects: Wikibase Product Platform (v1), Story.

WMDE-leszek moved this task from Backlog to Next on the Wikibase Product Platform (v1) board.

Ollie.Shotton_WMDE set the point value for this task to 3.Feb 14 2023, 10:55 AM

Ollie.Shotton_WMDE moved this task from Next to Sprint 23 on the Wikibase Product Platform (v1) board.Feb 14 2023, 11:17 AM

Ollie.Shotton_WMDE edited projects, added Wikibase Product Platform (v1) (Sprint 23); removed Wikibase Product Platform (v1).

Change 889135 had a related patch set uploaded (by Jakob; author: Jakob):

[mediawiki/extensions/Wikibase@master] REST: Make API docs base URL configurable

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

gerritbot added a project: Patch-For-Review.Feb 14 2023, 2:01 PM

Jakob_WMDE claimed this task.Feb 14 2023, 4:25 PM

Jakob_WMDE moved this task from To Do to Peer Review on the Wikibase Product Platform (v1) (Sprint 23) board.