REST API: Improve the block type schema for the name field

[gziolo]

Trac ticket: https://core.trac.wordpress.org/ticket/59346

The goal of this PR is to align the schema between block.json and the REST API endpoint for block types. It looks like the name field isn't validated in all places and if it uses pattern matching in the REST API code, then it's slightly different.

https://github.com/WordPress/gutenberg/blob/aa938166f28bcfff6c7b8d1caac5a95f78852f97/schemas/json/block.json#L26

https://github.com/WordPress/gutenberg/blob/f6d16f0b9f0a71d51c7178d35902c078b0d33c08/packages/blocks/src/api/registration.js#L231

I opted for using the same pattern as during block registration in JavaScript:

'^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$'

---

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

[spacedmonkey]

@gziolo Don't we need to regenerate this line -https://github.com/WordPress/wordpress-develop/blob/trunk/tests/qunit/fixtures/wp-api-generated.js

[gziolo]

@gziolo Don't we need to regenerate this line -https://github.com/WordPress/wordpress-develop/blob/trunk/tests/qunit/fixtures/wp-api-generated.js

Do you mean we should also update the pattern used with URLs, like:

wordpress-develop/tests/qunit/fixtures/wp-api-generated.js

Line 9931 in e413569

"/wp/v2/block-types/(?P<namespace>[a-zA-Z0-9_-]+)": {

or

wordpress-develop/tests/qunit/fixtures/wp-api-generated.js

Line 9962 in e413569

"/wp/v2/block-types/(?P<namespace>[a-zA-Z0-9_-]+)/(?P<name>[a-zA-Z0-9_-]+)": {

I executed all unit tests and this file hasn't changed. The comment included explains that the file is auto-generated with test_build_wp_api_client_fixtures.

[ockham]

Thank you! I'll have a closer look in a bit, but one thing I was wondering -- could we express the fact that the keys in blockHooks are block names (as defined earlier in the schema) even more semantically (rather than using the same RegEx as a constant)? I've seen there's something called $ref in the JSON schema spec -- think that could work here? 🤔

[gziolo]

I've seen there's something called $ref in the JSON schema spec -- think that could work here? 🤔

There is a code comment included in the same method which suggests it can't be used:

wordpress-develop/src/wp-includes/rest-api/endpoints/class-wp-rest-block-types-controller.php

Line 397 in e00f028

// rest_validate_value_from_schema doesn't understand $refs, pull out reused definitions for readability.

[spacedmonkey]

Looks good to me.

[gziolo]

Committed with 56676.