Skip to content

Commit 5816c62

Browse files
kadamwhitekadamwhite
committed
Regenerate reference for WP 5.4
1 parent b543fd7 commit 5816c62

18 files changed

+515
-481
lines changed

‎reference/wp_block-revisions.md‎ renamed to ‎reference/block-revisions.md‎

Lines changed: 25 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
---
33

4-
# wp_block Revisions
4+
# Block Revisions
55

66
<section class="route">
77
<div class="primary">
88
<h2>Schema</h2>
9-
<p>The schema defines all the fields that exist for a wp_block-revision object.</p>
9+
<p>The schema defines all the fields that exist within a Block Revision record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.</p>
1010
<table class="attributes">
1111
<tr id="schema-author">
1212
<td>
@@ -155,16 +155,21 @@
155155
</table>
156156

157157
</div>
158-
<div class="secondary">
159-
<h3>Example Request</h3>
160-
161-
<code>$ curl -X OPTIONS -i https://example.com/wp-json/wp/v2/blocks/&lt;id&gt;/autosaves</code>
162-
</div>
163158
</section>
164159

165160
<div><section class="route">
166161
<div class="primary">
167-
<h2>Retrieve a wp_block-revision</h2>
162+
<h2>Retrieve a Block Revision</h2>
163+
164+
<h3>Definition & Example Request</h3>
165+
166+
<code>GET /wp/v2/blocks/&lt;id&gt;/autosaves</code>
167+
168+
<p>Query this endpoint to retrieve a specific Block Revision record.</p>
169+
170+
<code>$ curl https://example.com/wp-json/wp/v2/blocks/&lt;id&gt;/autosaves</code>
171+
</div>
172+
<div class="secondary">
168173
<h3>Arguments</h3>
169174
<table class="arguments">
170175
<tr>
@@ -190,19 +195,10 @@
190195
</table>
191196

192197
</div>
193-
<div class="secondary">
194-
<h3>Definition</h3>
195-
196-
<code>GET /wp/v2/blocks/&lt;id&gt;/autosaves</code>
197-
198-
<h3>Example Request</h3>
199-
200-
<code>$ curl https://example.com/wp-json/wp/v2/blocks/&lt;id&gt;/autosaves</code>
201-
</div>
202198
</section>
203199
<section class="route">
204200
<div class="primary">
205-
<h2>Create a wp_block-revision</h2>
201+
<h2>Create a Block Revision</h2>
206202
<h3>Arguments</h3>
207203
<table class="arguments">
208204
<tr>
@@ -289,7 +285,17 @@
289285
</section>
290286
<section class="route">
291287
<div class="primary">
292-
<h2>Retrieve a wp_block-revision</h2>
288+
<h2>Retrieve a Block Revision</h2>
289+
290+
<h3>Definition & Example Request</h3>
291+
292+
<code>GET /wp/v2/blocks/&lt;parent&gt;/autosaves/&lt;id&gt;</code>
293+
294+
<p>Query this endpoint to retrieve a specific Block Revision record.</p>
295+
296+
<code>$ curl https://example.com/wp-json/wp/v2/blocks/&lt;parent&gt;/autosaves/&lt;id&gt;</code>
297+
</div>
298+
<div class="secondary">
293299
<h3>Arguments</h3>
294300
<table class="arguments">
295301
<tr>
@@ -323,14 +329,5 @@
323329
</table>
324330

325331
</div>
326-
<div class="secondary">
327-
<h3>Definition</h3>
328-
329-
<code>GET /wp/v2/blocks/&lt;parent&gt;/autosaves/&lt;id&gt;</code>
330-
331-
<h3>Example Request</h3>
332-
333-
<code>$ curl https://example.com/wp-json/wp/v2/blocks/&lt;parent&gt;/autosaves/&lt;id&gt;</code>
334-
</div>
335332
</section>
336333
</div>

‎reference/wp_blocks.md‎ renamed to ‎reference/blocks.md‎

Lines changed: 31 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
---
22
---
33

4-
# wp_blocks
4+
# Editor Blocks
55

66
<section class="route">
77
<div class="primary">
88
<h2>Schema</h2>
9-
<p>The schema defines all the fields that exist for a wp_block object.</p>
9+
<p>The schema defines all the fields that exist within a Editor Block record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.</p>
1010
<table class="attributes">
1111
<tr id="schema-date">
1212
<td>
1313
<code>date</code><br />
1414
<span class="type">
15-
string,
15+
Array,
1616
datetime ([details](https://core.trac.wordpress.org/ticket/41032))
1717
</span>
1818
</td>
@@ -25,7 +25,7 @@
2525
<td>
2626
<code>date_gmt</code><br />
2727
<span class="type">
28-
string,
28+
Array,
2929
datetime ([details](https://core.trac.wordpress.org/ticket/41032))
3030
</span>
3131
</td>
@@ -182,16 +182,22 @@
182182
</table>
183183

184184
</div>
185-
<div class="secondary">
186-
<h3>Example Request</h3>
187-
188-
<code>$ curl -X OPTIONS -i https://example.com/wp-json/wp/v2/blocks</code>
189-
</div>
190185
</section>
191186

192187
<div><section class="route">
193188
<div class="primary">
194-
<h2>List wp_blocks</h2>
189+
<h2>List Editor Blocks</h2>
190+
<p>Query this endpoint to retrieve a collection of Editor Blocks. The response you receive can be controlled and filtered using the URL query parameters below.</p>
191+
192+
<h3>Definition</h3>
193+
194+
<code>GET /wp/v2/blocks</code>
195+
196+
<h3>Example Request</h3>
197+
198+
<code>$ curl https://example.com/wp-json/wp/v2/blocks</code>
199+
</div>
200+
<div class="secondary">
195201
<h3>Arguments</h3>
196202
<table class="arguments">
197203
<tr>
@@ -322,19 +328,10 @@
322328
</table>
323329

324330
</div>
325-
<div class="secondary">
326-
<h3>Definition</h3>
327-
328-
<code>GET /wp/v2/blocks</code>
329-
330-
<h3>Example Request</h3>
331-
332-
<code>$ curl https://example.com/wp-json/wp/v2/blocks</code>
333-
</div>
334331
</section>
335332
<section class="route">
336333
<div class="primary">
337-
<h2>Create a wp_block</h2>
334+
<h2>Create a Editor Block</h2>
338335
<h3>Arguments</h3>
339336
<table class="arguments">
340337
<tr>
@@ -413,7 +410,17 @@
413410
</section>
414411
<section class="route">
415412
<div class="primary">
416-
<h2>Retrieve a wp_block</h2>
413+
<h2>Retrieve a Editor Block</h2>
414+
415+
<h3>Definition & Example Request</h3>
416+
417+
<code>GET /wp/v2/blocks/&lt;id&gt;</code>
418+
419+
<p>Query this endpoint to retrieve a specific Editor Block record.</p>
420+
421+
<code>$ curl https://example.com/wp-json/wp/v2/blocks/&lt;id&gt;</code>
422+
</div>
423+
<div class="secondary">
417424
<h3>Arguments</h3>
418425
<table class="arguments">
419426
<tr>
@@ -447,19 +454,10 @@
447454
</table>
448455

449456
</div>
450-
<div class="secondary">
451-
<h3>Definition</h3>
452-
453-
<code>GET /wp/v2/blocks/&lt;id&gt;</code>
454-
455-
<h3>Example Request</h3>
456-
457-
<code>$ curl https://example.com/wp-json/wp/v2/blocks/&lt;id&gt;</code>
458-
</div>
459457
</section>
460458
<section class="route">
461459
<div class="primary">
462-
<h2>Update a wp_block</h2>
460+
<h2>Update a Editor Block</h2>
463461
<h3>Arguments</h3>
464462
<table class="arguments">
465463
<tr>
@@ -550,7 +548,7 @@
550548
</section>
551549
<section class="route">
552550
<div class="primary">
553-
<h2>Delete a wp_block</h2>
551+
<h2>Delete a Editor Block</h2>
554552
<h3>Arguments</h3>
555553
<table class="arguments">
556554
<tr>
@@ -566,7 +564,7 @@
566564
<code>force</code><br />
567565
</td>
568566
<td>
569-
<p>Whether to bypass trash and force deletion.</p>
567+
<p>Whether to bypass Trash and force deletion.</p>
570568
</td>
571569
</tr>
572570
</table>

‎reference/categories.md‎

Lines changed: 22 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<section class="route">
77
<div class="primary">
88
<h2>Schema</h2>
9-
<p>The schema defines all the fields that exist for a category object.</p>
9+
<p>The schema defines all the fields that exist within a category record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.</p>
1010
<table class="attributes">
1111
<tr id="schema-id">
1212
<td>
@@ -117,16 +117,22 @@
117117
</table>
118118

119119
</div>
120-
<div class="secondary">
121-
<h3>Example Request</h3>
122-
123-
<code>$ curl -X OPTIONS -i https://example.com/wp-json/wp/v2/categories</code>
124-
</div>
125120
</section>
126121

127122
<div><section class="route">
128123
<div class="primary">
129124
<h2>List Categories</h2>
125+
<p>Query this endpoint to retrieve a collection of categories. The response you receive can be controlled and filtered using the URL query parameters below.</p>
126+
127+
<h3>Definition</h3>
128+
129+
<code>GET /wp/v2/categories</code>
130+
131+
<h3>Example Request</h3>
132+
133+
<code>$ curl https://example.com/wp-json/wp/v2/categories</code>
134+
</div>
135+
<div class="secondary">
130136
<h3>Arguments</h3>
131137
<table class="arguments">
132138
<tr>
@@ -246,15 +252,6 @@
246252
</table>
247253

248254
</div>
249-
<div class="secondary">
250-
<h3>Definition</h3>
251-
252-
<code>GET /wp/v2/categories</code>
253-
254-
<h3>Example Request</h3>
255-
256-
<code>$ curl https://example.com/wp-json/wp/v2/categories</code>
257-
</div>
258255
</section>
259256
<section class="route">
260257
<div class="primary">
@@ -316,6 +313,16 @@
316313
<section class="route">
317314
<div class="primary">
318315
<h2>Retrieve a Category</h2>
316+
317+
<h3>Definition & Example Request</h3>
318+
319+
<code>GET /wp/v2/categories/&lt;id&gt;</code>
320+
321+
<p>Query this endpoint to retrieve a specific category record.</p>
322+
323+
<code>$ curl https://example.com/wp-json/wp/v2/categories/&lt;id&gt;</code>
324+
</div>
325+
<div class="secondary">
319326
<h3>Arguments</h3>
320327
<table class="arguments">
321328
<tr>
@@ -341,15 +348,6 @@
341348
</table>
342349

343350
</div>
344-
<div class="secondary">
345-
<h3>Definition</h3>
346-
347-
<code>GET /wp/v2/categories/&lt;id&gt;</code>
348-
349-
<h3>Example Request</h3>
350-
351-
<code>$ curl https://example.com/wp-json/wp/v2/categories/&lt;id&gt;</code>
352-
</div>
353351
</section>
354352
<section class="route">
355353
<div class="primary">

0 commit comments

Comments
 (0)