Provide actual examples in Open API schema
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	WMDE-leszek
	Jan 31 2023, 10:06 AM

Description

provide actual real-life-like values instead autogenerated ones, e.g. "id": "Q123" over "id": "string"
Add an example to the lowest level fields where it makes sense. E.g. site, title, and badges of sitelinks.

Subject	Repo	Branch	Lines +/-
REST: Add an example of sitelink badge in OpenAPI spec	mediawiki/extensions/Wikibase	master	+1 -1
REST: Provide example of mediawiki edit request elements in OpenAPI spec	mediawiki/extensions/Wikibase	master	+4 -2
REST: Provide examples of item ID and type in response data in OpenAPI spec	mediawiki/extensions/Wikibase	master	+4 -2

Status	Assigned	Task
Open	None	T347304 Non-functionality REST API v1
Open	None	T322917 Improve examples in OpenAPI Schema
Resolved	WMDE-leszek	T328412 Provide actual examples in Open API schema

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

[mediawiki/extensions/Wikibase@master] REST: Provide examples of item ID and type in response data in OpenAPI spec

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

[mediawiki/extensions/Wikibase@master] REST: Add an example of sitelink badge in OpenAPI spec

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

[mediawiki/extensions/Wikibase@master] REST: Provide example of mediawiki edit request elements in OpenAPI spec

Change 889876 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] REST: Provide examples of item ID and type in response data in OpenAPI spec

Change 889877 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] REST: Add an example of sitelink badge in OpenAPI spec

Change 889878 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] REST: Provide example of mediawiki edit request elements in OpenAPI spec

WMDE-leszek claimed this task.