REST: add structure test that checks if param schemas are valid
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	daniel
	Jun 21 2024, 9:08 AM

Description

RestStructureTest should examine any schemas defined in the ArrayDef::PARAM_SCHEMA field of param settings returned by getBodyParamSettings. The value contained in this field should (after applicable normalization) be a valid JSON schema.

The schema validation should be implemented in a (static?) method in ArrayDef, so we keep the knowledge about the validation library in a single place. It should be implemented using JsonSchema\Validator from the justinrainbow/json-validator package, probably using CHECK_MODE_VALIDATE_SCHEMA (though it's not clear how to do that without a known-good target document).

Furthermore, getParamSettings should not be allowed to make use of the "array" parameter type. That type is only supported in getBodyParamSettings.

RestStructureTest change implemented
getParamSettings prohibited from using array type

Details

Related Changes in Gerrit:

	Subject	Repo	Branch	Lines +/-
	getParamSettings prohibited from using array type	mediawiki/core	master	+5 -0
	add structure test that checks if param schemas are valid	mediawiki/core	master	+36 -0

Customize query in gerrit

Related Objects
Search...

		Status	Subtype	Assigned	Task
		In Progress		None	T366833 REST: Request Body Validation (tracking)
		Resolved		• codebug	T368133 REST: add structure test that checks if param schemas are valid

Event Timeline

daniel created this task.Jun 21 2024, 9:08 AM

Reedy renamed this task from REST: add structure test that checks if param schemas are valid. to REST: add structure test that checks if param schemas are valid.Jun 21 2024, 9:43 AM

Reedy updated the task description. (Show Details)

BPirkle triaged this task as Medium priority.Jun 27 2024, 3:18 PM

BPirkle moved this task from Incoming (Needs Triage) to Backlog (Triaged and Ready) on the MW-Interfaces-Team board.

BPirkle assigned this task to • codebug.Jul 8 2024, 3:45 PM

daniel changed the task status from Open to In Progress.Jul 8 2024, 3:47 PM

daniel moved this task from Backlog (Triaged and Ready) to In Progress on the MW-Interfaces-Team board.

Change #1053637 had a related patch set uploaded (by WQuarshie; author: WQuarshie):

[mediawiki/core@master] add structure test that checks if param schemas are valid

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

gerritbot added a project: Patch-For-Review.Jul 11 2024, 10:54 AM

Change #1053637 merged by jenkins-bot:

[mediawiki/core@master] add structure test that checks if param schemas are valid