<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[53315] trunk: REST API: Correct the schema for the `wp/v2/block-directory/search` endpoint.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/53315">53315</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/53315","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnbillion</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-04-29 16:53:55 +0000 (Fri, 29 Apr 2022)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>REST API: Correct the schema for the `wp/v2/block-directory/search` endpoint.
Props zieladam, TimothyBlynJacobs, spacedmonkey, johnbillion
Fixes <a href="https://core.trac.wordpress.org/ticket/53621">#53621</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestblockdirectorycontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-block-directory-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestblockdirectorycontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-block-directory-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiendpointsclasswprestblockdirectorycontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-block-directory-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-block-directory-controller.php 2022-04-29 14:44:15 UTC (rev 53314)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-block-directory-controller.php 2022-04-29 16:53:55 UTC (rev 53315)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -239,7 +239,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'rating' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => __( 'The star rating of the block.' ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'type' => 'integer',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'type' => 'number',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'context' => array( 'view' ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'rating_count' => array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -249,12 +249,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'active_installs' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => __( 'The number sites that have activated this block.' ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'type' => 'string',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'type' => 'integer',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'context' => array( 'view' ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'author_block_rating' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => __( 'The average rating of blocks published by the same author.' ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'type' => 'integer',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'type' => 'number',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'context' => array( 'view' ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'author_block_count' => array(
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestblockdirectorycontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/rest-api/rest-block-directory-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-block-directory-controller.php 2022-04-29 14:44:15 UTC (rev 53314)
+++ trunk/tests/phpunit/tests/rest-api/rest-block-directory-controller.php 2022-04-29 16:53:55 UTC (rev 53315)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -213,6 +213,46 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 53621
+ */
+ public function test_get_items_response_conforms_to_schema() {
+ wp_set_current_user( self::$admin_id );
+ $plugin = $this->get_mock_plugin();
+
+ // Fetch the block directory schema.
+ $request = new WP_REST_Request( 'OPTIONS', '/wp/v2/block-directory/search' );
+ $schema = rest_get_server()->dispatch( $request )->get_data()['schema'];
+
+ add_filter(
+ 'plugins_api',
+ static function () use ( $plugin ) {
+ return (object) array(
+ 'info' =>
+ array(
+ 'page' => 1,
+ 'pages' => 1,
+ 'results' => 1,
+ ),
+ 'plugins' => array(
+ $plugin,
+ ),
+ );
+ }
+ );
+
+ // Fetch a block plugin.
+ $request = new WP_REST_Request( 'GET', '/wp/v2/block-directory/search' );
+ $request->set_query_params( array( 'term' => 'cache' ) );
+
+ $result = rest_get_server()->dispatch( $request );
+ $data = $result->get_data();
+
+ $valid = rest_validate_value_from_schema( $data[0], $schema );
+
+ $this->assertNotWPError( $valid );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Simulate a network failure on outbound http requests to a given hostname.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span></span></pre>
</div>
</div>
</body>
</html>