Run CI to validate API against OpenApi Spec
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	Tarrow
	Sep 23 2020, 4:39 PM

Description

*Questions to answer*

What should be validated -- just the manifest JSON response or the whole API including path
Should the validation be included in the already existing api tests or should it be a separate job?

ACs

It should not be possible to merge a patch where the output format of the API does not match the API spec
It should also validate that the OpenAPI spec is a valid OpenAPI spec Hint: apparently the RESTful dreams team have a linter that does this, and maybe we can use that

Details

	Subject	Repo	Branch	Lines +/-
	Add api test to validate manifest against schema	mediawiki/extensions/WikibaseManifest	master	+270 -20

Customize query in gerrit

Related Objects
Search...

		Status	Subtype	Assigned	Task
		Resolved		Silvan_WMDE	T263661 Run CI to validate API against OpenApi Spec
		Resolved		• Tonina_Zhelyazkova_WMDE	T263985 Test that openapi.json is a valid OpenAPI spec

Event Timeline

Tarrow created this task.Sep 23 2020, 4:39 PM

Restricted Application added a project: Wikidata. · View Herald TranscriptSep 23 2020, 4:39 PM

Restricted Application added a subscriber: Aklapper. · View Herald Transcript

Blocked by openapi spec task

• Samantha_Alipio_WMDE changed the task status from Open to Stalled.Sep 24 2020, 2:00 PM

• Samantha_Alipio_WMDE updated the task description. (Show Details)

• Samantha_Alipio_WMDE moved this task from Ready for story writing to Ready for Breakdown on the Wikibase - Automated Configuration Detection (WikibaseManifest) board.

• Samantha_Alipio_WMDE triaged this task as High priority.Sep 25 2020, 8:22 AM

• Tonina_Zhelyazkova_WMDE moved this task from Ready for Breakdown to Sprint 3 on the Wikibase - Automated Configuration Detection (WikibaseManifest) board.Sep 28 2020, 10:54 AM

• Tonina_Zhelyazkova_WMDE edited projects, added Wikibase - Automated Configuration Detection (WikibaseManifest) (Sprint 3); removed Wikibase - Automated Configuration Detection (WikibaseManifest).

• Tonina_Zhelyazkova_WMDE moved this task from To do to Doing on the Wikibase - Automated Configuration Detection (WikibaseManifest) (Sprint 3) board.

• Tonina_Zhelyazkova_WMDE moved this task from Doing to To do on the Wikibase - Automated Configuration Detection (WikibaseManifest) (Sprint 3) board.

Silvan_WMDE claimed this task.Sep 29 2020, 1:40 PM

Silvan_WMDE moved this task from To do to Doing on the Wikibase - Automated Configuration Detection (WikibaseManifest) (Sprint 3) board.

Change 631757 had a related patch set uploaded (by Silvan Heintze; owner: Silvan Heintze):
[mediawiki/extensions/WikibaseManifest@master] Add api test to validate manifest against schema

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

gerritbot added a project: Patch-For-Review.Oct 2 2020, 11:45 AM

Silvan_WMDE moved this task from Doing to Peer Review on the Wikibase - Automated Configuration Detection (WikibaseManifest) (Sprint 3) board.Oct 6 2020, 1:14 PM

• Samantha_Alipio_WMDE edited projects, added Wikibase - Automated Configuration Detection (WikibaseManifest) (Sprint 4); removed Wikibase - Automated Configuration Detection (WikibaseManifest) (Sprint 3).Oct 7 2020, 11:42 AM

• Samantha_Alipio_WMDE moved this task from To do to Peer Review on the Wikibase - Automated Configuration Detection (WikibaseManifest) (Sprint 4) board.

Silvan_WMDE moved this task from Peer Review to Doing on the Wikibase - Automated Configuration Detection (WikibaseManifest) (Sprint 4) board.Oct 8 2020, 9:07 AM

Silvan_WMDE moved this task from Doing to Peer Review on the Wikibase - Automated Configuration Detection (WikibaseManifest) (Sprint 4) board.Oct 8 2020, 1:54 PM

Change 631757 merged by jenkins-bot:
[mediawiki/extensions/WikibaseManifest@master] Add api test to validate manifest against schema

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

Maintenance_bot removed a project: Patch-For-Review.Oct 9 2020, 8:10 PM

• Tonina_Zhelyazkova_WMDE moved this task from Peer Review to Done on the Wikibase - Automated Configuration Detection (WikibaseManifest) (Sprint 4) board.Oct 12 2020, 7:43 AM

darthmon_wmde closed subtask T263985: Test that openapi.json is a valid OpenAPI spec as Resolved.Oct 19 2020, 8:18 AM