schema for "/__experimental/menu-items" errors

[MohammedFaragallah]

I'm not sure any if these cases are intentional but,

gutenberg/lib/class-wp-rest-menu-items-controller.php

Lines 1067 to 1070 in dd5fd6b

	if ( 'nav_menu' === $taxonomy->name ) {
	$schema['properties'][ $base ]['type'] = 'integer';
	unset( $schema['properties'][ $base ]['items'] );
	}

this endpoint return array of numbers for menus not a number

gutenberg/lib/class-wp-rest-menu-items-controller.php

Lines 1046 to 1051 in dd5fd6b

	$schema['properties']['_invalid'] = array(
	'description' => __( 'Whether the menu item represents an object that no longer exists.', 'gutenberg' ),
	'context' => array( 'view', 'edit', 'embed' ),
	'type' => 'boolean',
	'readonly' => true,
	);

also _invalid is missing not null or any falsy value

[talldan]

cc @spacedmonkey

[spacedmonkey]

Hello @MohammedFaragallah I am developer of this endpoint.

Let me explain these schema issues.

gutenberg/lib/class-wp-rest-menu-items-controller.php

Lines 1067 to 1070 in dd5fd6b

	if ( 'nav_menu' === $taxonomy->name ) {
	$schema['properties'][ $base ]['type'] = 'integer';
	unset( $schema['properties'][ $base ]['items'] );
	}

This is not a mistake. A menu item can not be assigned to multiple menus. So I highjacked the schema, so that you only assign it to one endpoint.

gutenberg/lib/class-wp-rest-menu-items-controller.php

Lines 1046 to 1051 in dd5fd6b

	$schema['properties']['_invalid'] = array(
	'description' => __( 'Whether the menu item represents an object that no longer exists.', 'gutenberg' ),
	'context' => array( 'view', 'edit', 'embed' ),
	'type' => 'boolean',
	'readonly' => true,
	);

I will look into this

[MohammedFaragallah]

@spacedmonkey thank you for your fast response

This is not a mistake. A menu item can not be assigned to multiple menus. So I highjacked the schema so that you only assign it to one endpoint.

maybe add maxItems to match the endpoint array response/or change the response to a number

if ( 'nav_menu' === $taxonomy->name ) { 
	$schema['properties'][ $base ]['maxItems'] = 1; 
} 

[spacedmonkey]

maybe add maxItems to match the endpoint array response/or change the response to a number

I don't like this idea, personally. Thoughts @TimothyBJacobs ?

[MohammedFaragallah]

@spacedmonkey just a question does the schema represent the response?

I'm asking because I'm generating typescript definitions from it to make the response typesafe

it's working fine even with third-party plugins

[spacedmonkey]

@MohammedFaragallah I have pushed a couple of fixes. The schema should match up now. Can you checkout trunk and see if fixes your issues.

[github-actions]

Help us move this issue forward. This issue is being marked stale since it has no activity after 15 days of requesting more information. Please add info requested so we can help move the issue forward. Note: The triage policy is to close stale issues that need more info and no response after 2 weeks.