Context Navigation

← Previous Ticket
Next Ticket →

#64168 new defect (bug)

Inaccurate JSON schema for template-parts endpoint

Reported by:	johnbillion	Owned by:
Priority:	normal	Milestone:	Future Release
Component:	REST API	Version:	5.8
Severity:	normal	Keywords:	good-first-bug has-patch has-unit-tests
Cc:		Focuses:

Description

The schema provided by the wp/v2/template-parts REST API endpoint has some inaccuracies:

The origin property can be null as well as a string. This property maps directly to WP_Block_Template::origin which is string|null.
The modified property can be false as well as a date-time string.

Both of these properties can be seen with null/false values by performing an authenticated request to /wp/v2/template-parts on a freshly installed vanilla WordPress site.

Any updates will need unit test coverage.

Here's an untested update to the modified property to replace its type and format.

'oneOf' => array(
	array(
		'type'   => 'string',
		'format' => 'date-time'
	),
	array(
		'type' => 'boolean',
		'enum' => array( false ),
	)
),

Attachments (1)

64168.diff (3.8 KB ) - added by motylanogha 4 months ago.: Refreshed patch for current trunk (r609f25f). Schema fix for origin (string|null) and modified (oneOf string|false) with 3 unit tests. All 51 template controller tests pass.

Download all attachments as: .zip

Change History (3)

This ticket was mentioned in PR #10441 on WordPress/wordpress-develop by @nimeshatxecurify.

9 months ago #1

Keywords has-patch has-unit-tests added; needs-patch needs-unit-tests removed

Fix as suggested by John

@motylanogha
4 months ago

Attachment 64168.diff added

Refreshed patch for current trunk (r609f25f). Schema fix for origin (string|null) and modified (oneOf string|false) with 3 unit tests. All 51 template controller tests pass.

This ticket was mentioned in PR #11699 on WordPress/wordpress-develop by @motylanogha.

3 months ago #2

WP_REST_Templates_Controller::prepare_item_for_response() can return:

origin: null for templates that do not come from a customizer/theme/plugin source
modified: false for templates whose modified timestamp cannot be resolved

The schema declared origin as string and modified as string/date-time, so both responses failed schema validation under strict-mode REST clients.

This PR widens the schema to match the runtime behavior:

origin becomes [ string, null ]
modified becomes a oneOf of date-time string or false

Tests cover:

The origin schema accepts null
The modified schema accepts both date-time string and false
A theme template returns null for origin against the new schema

Complements GH-10441.

Note: See TracTickets for help on using tickets.

Download in other formats:

Make WordPress Core