Skip to content

Commit 412f3a3

Browse files
TimothyBJacobsTimothyBJacobs
committed
Update reference for 5.6
1 parent 2f924da commit 412f3a3

File tree

5 files changed

+294
-8
lines changed

5 files changed

+294
-8
lines changed

Diff for: ‎bin/manifest.json

+6-1
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,11 @@
7474
"parent": "extending-the-rest-api",
7575
"markdown_source": "https://github.com/WP-API/docs/blob/master/extending-the-rest-api/schema.md"
7676
},
77+
"reference/application-passwords": {
78+
"slug": "application-passwords",
79+
"parent": "reference",
80+
"markdown_source": "https://github.com/WP-API/docs/blob/master/reference/application-passwords.md"
81+
},
7782
"reference/block-directory-items": {
7883
"slug": "block-directory-items",
7984
"parent": "reference",
@@ -214,4 +219,4 @@
214219
"parent": "using-the-rest-api",
215220
"markdown_source": "https://github.com/WP-API/docs/blob/master/using-the-rest-api/pagination.md"
216221
}
217-
}
222+
}

Diff for: ‎reference/application-passwords.md

+269
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,269 @@
1+
---
2+
---
3+
4+
# Application Passwords
5+
6+
<section class="route">
7+
<div class="primary">
8+
<h2>Schema</h2>
9+
<p>The schema defines all the fields that exist within a application password 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>
10+
<table class="attributes">
11+
<tr id="schema-uuid">
12+
<td>
13+
<code>uuid</code><br />
14+
<span class="type">
15+
string,
16+
uuid
17+
</span>
18+
</td>
19+
<td>
20+
<p>The unique identifier for the application password.</p>
21+
<p class="read-only">Read only</p>
22+
<p class="context">Context: <code>view</code>, <code>edit</code>, <code>embed</code></p>
23+
</td>
24+
</tr>
25+
<tr id="schema-app_id">
26+
<td>
27+
<code>app_id</code><br />
28+
<span class="type">
29+
string,
30+
uuid
31+
</span>
32+
</td>
33+
<td>
34+
<p>A uuid provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace.</p>
35+
<p class="context">Context: <code>view</code>, <code>edit</code>, <code>embed</code></p>
36+
</td>
37+
</tr>
38+
<tr id="schema-name">
39+
<td>
40+
<code>name</code><br />
41+
<span class="type">
42+
string </span>
43+
</td>
44+
<td>
45+
<p>The name of the application password.</p>
46+
<p class="context">Context: <code>view</code>, <code>edit</code>, <code>embed</code></p>
47+
</td>
48+
</tr>
49+
<tr id="schema-password">
50+
<td>
51+
<code>password</code><br />
52+
<span class="type">
53+
string </span>
54+
</td>
55+
<td>
56+
<p>The generated password. Only available after adding an application.</p>
57+
<p class="read-only">Read only</p>
58+
<p class="context">Context: <code>edit</code></p>
59+
</td>
60+
</tr>
61+
<tr id="schema-created">
62+
<td>
63+
<code>created</code><br />
64+
<span class="type">
65+
string,
66+
datetime (<a href="https://core.trac.wordpress.org/ticket/41032">details</a>)
67+
</span>
68+
</td>
69+
<td>
70+
<p>The GMT date the application password was created.</p>
71+
<p class="read-only">Read only</p>
72+
<p class="context">Context: <code>view</code>, <code>edit</code></p>
73+
</td>
74+
</tr>
75+
<tr id="schema-last_used">
76+
<td>
77+
<code>last_used</code><br />
78+
<span class="type">
79+
string or null,
80+
datetime (<a href="https://core.trac.wordpress.org/ticket/41032">details</a>)
81+
</span>
82+
</td>
83+
<td>
84+
<p>The GMT date the application password was last used.</p>
85+
<p class="read-only">Read only</p>
86+
<p class="context">Context: <code>view</code>, <code>edit</code></p>
87+
</td>
88+
</tr>
89+
<tr id="schema-last_ip">
90+
<td>
91+
<code>last_ip</code><br />
92+
<span class="type">
93+
string or null,
94+
ip
95+
</span>
96+
</td>
97+
<td>
98+
<p>The IP address the application password was last used by.</p>
99+
<p class="read-only">Read only</p>
100+
<p class="context">Context: <code>view</code>, <code>edit</code></p>
101+
</td>
102+
</tr>
103+
</table>
104+
105+
</div>
106+
</section>
107+
108+
<div><section class="route">
109+
<div class="primary">
110+
<h2>Retrieve a Application Password</h2>
111+
112+
<h3>Definition & Example Request</h3>
113+
114+
<code>GET /wp/v2/users/&lt;user_id&gt;)/application-passwords</code>
115+
116+
<p>Query this endpoint to retrieve a specific application password record.</p>
117+
118+
<code>$ curl https://example.com/wp-json/wp/v2/users/&lt;user_id&gt;)/application-passwords</code>
119+
</div>
120+
<div class="secondary">
121+
<h3>Arguments</h3>
122+
<table class="arguments">
123+
<tr>
124+
<td>
125+
<code>context</code><br />
126+
</td>
127+
<td>
128+
<p>Scope under which the request is made; determines fields present in response.</p>
129+
<p class="default">
130+
Default: <code>view</code>
131+
</p>
132+
<p>One of: <code>view</code>, <code>embed</code>, <code>edit</code></p>
133+
</td>
134+
</tr>
135+
</table>
136+
137+
</div>
138+
</section>
139+
<section class="route">
140+
<div class="primary">
141+
<h2>Create a Application Password</h2>
142+
<h3>Arguments</h3>
143+
<table class="arguments">
144+
<tr>
145+
<td>
146+
<code><a href="#schema-app_id">app_id</a></code><br />
147+
</td>
148+
<td>
149+
<p>A uuid provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace.</p>
150+
</td>
151+
</tr>
152+
<tr>
153+
<td>
154+
<code><a href="#schema-name">name</a></code><br />
155+
</td>
156+
<td>
157+
<p>The name of the application password.</p>
158+
<p class="required">
159+
Required: 1
160+
</p>
161+
</td>
162+
</tr>
163+
</table>
164+
165+
</div>
166+
<div class="secondary">
167+
<h3>Definition</h3>
168+
169+
<code>POST /wp/v2/users/&lt;user_id&gt;)/application-passwords</code>
170+
</div>
171+
</section>
172+
<section class="route">
173+
<div class="primary">
174+
<h2>Delete a Application Password</h2>
175+
<p>There are no arguments for this endpoint.</p>
176+
177+
</div>
178+
<div class="secondary">
179+
<h3>Definition</h3>
180+
181+
<code>DELETE /wp/v2/users/&lt;user_id&gt;)/application-passwords</code>
182+
183+
<h3>Example Request</h3>
184+
185+
<code>$ curl -X DELETE https://example.com/wp-json/wp/v2/users/&lt;user_id&gt;)/application-passwords</code>
186+
</div>
187+
</section>
188+
<section class="route">
189+
<div class="primary">
190+
<h2>Retrieve a Application Password</h2>
191+
192+
<h3>Definition & Example Request</h3>
193+
194+
<code>GET /wp/v2/users/&lt;user_id&gt;)/application-passwords/&lt;uuid&gt;</code>
195+
196+
<p>Query this endpoint to retrieve a specific application password record.</p>
197+
198+
<code>$ curl https://example.com/wp-json/wp/v2/users/&lt;user_id&gt;)/application-passwords/&lt;uuid&gt;</code>
199+
</div>
200+
<div class="secondary">
201+
<h3>Arguments</h3>
202+
<table class="arguments">
203+
<tr>
204+
<td>
205+
<code>context</code><br />
206+
</td>
207+
<td>
208+
<p>Scope under which the request is made; determines fields present in response.</p>
209+
<p class="default">
210+
Default: <code>view</code>
211+
</p>
212+
<p>One of: <code>view</code>, <code>embed</code>, <code>edit</code></p>
213+
</td>
214+
</tr>
215+
</table>
216+
217+
</div>
218+
</section>
219+
<section class="route">
220+
<div class="primary">
221+
<h2>Update a Application Password</h2>
222+
<h3>Arguments</h3>
223+
<table class="arguments">
224+
<tr>
225+
<td>
226+
<code><a href="#schema-app_id">app_id</a></code><br />
227+
</td>
228+
<td>
229+
<p>A uuid provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace.</p>
230+
</td>
231+
</tr>
232+
<tr>
233+
<td>
234+
<code><a href="#schema-name">name</a></code><br />
235+
</td>
236+
<td>
237+
<p>The name of the application password.</p>
238+
</td>
239+
</tr>
240+
</table>
241+
242+
</div>
243+
<div class="secondary">
244+
<h3>Definition</h3>
245+
246+
<code>POST /wp/v2/users/&lt;user_id&gt;)/application-passwords/&lt;uuid&gt;</code>
247+
248+
<h3>Example Request</h3>
249+
250+
<code></code>
251+
</div>
252+
</section>
253+
<section class="route">
254+
<div class="primary">
255+
<h2>Delete a Application Password</h2>
256+
<p>There are no arguments for this endpoint.</p>
257+
258+
</div>
259+
<div class="secondary">
260+
<h3>Definition</h3>
261+
262+
<code>DELETE /wp/v2/users/&lt;user_id&gt;)/application-passwords/&lt;uuid&gt;</code>
263+
264+
<h3>Example Request</h3>
265+
266+
<code>$ curl -X DELETE https://example.com/wp-json/wp/v2/users/&lt;user_id&gt;)/application-passwords/&lt;uuid&gt;</code>
267+
</div>
268+
</section>
269+
</div>

Diff for: ‎reference/block-types.md

+14-2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,18 @@
88
<h2>Schema</h2>
99
<p>The schema defines all the fields that exist within a block type 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">
11+
<tr id="schema-api_version">
12+
<td>
13+
<code>api_version</code><br />
14+
<span class="type">
15+
integer </span>
16+
</td>
17+
<td>
18+
<p>Version of block API.</p>
19+
<p class="read-only">Read only</p>
20+
<p class="context">Context: <code>embed</code>, <code>view</code>, <code>edit</code></p>
21+
</td>
22+
</tr>
1123
<tr id="schema-title">
1224
<td>
1325
<code>title</code><br />
@@ -339,15 +351,15 @@
339351
<code>name</code><br />
340352
</td>
341353
<td>
342-
<p>Block name</p>
354+
<p>Block name.</p>
343355
</td>
344356
</tr>
345357
<tr>
346358
<td>
347359
<code>namespace</code><br />
348360
</td>
349361
<td>
350-
<p>Block namespace</p>
362+
<p>Block namespace.</p>
351363
</td>
352364
</tr>
353365
<tr>

Diff for: ‎reference/rendered-blocks.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
<code><a href="#schema-attributes">attributes</a></code><br />
5555
</td>
5656
<td>
57-
<p>Attributes for the block</p>
57+
<p>Attributes for the block.</p>
5858
</td>
5959
</tr>
6060
<tr>

Diff for: ‎reference/search-results.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<td>
1313
<code>id</code><br />
1414
<span class="type">
15-
integer </span>
15+
integer or string </span>
1616
</td>
1717
<td>
1818
<p>Unique identifier for the object.</p>
@@ -56,7 +56,7 @@
5656
<p>Object type.</p>
5757
<p class="read-only">Read only</p>
5858
<p class="context">Context: <code>view</code>, <code>embed</code></p>
59-
<p>One of: <code>post</code></p>
59+
<p>One of: <code>post</code>, <code>term</code>, <code>post-format</code></p>
6060
</td>
6161
</tr>
6262
<tr id="schema-subtype">
@@ -69,7 +69,7 @@
6969
<p>Object subtype.</p>
7070
<p class="read-only">Read only</p>
7171
<p class="context">Context: <code>view</code>, <code>embed</code></p>
72-
<p>One of: <code>post</code>, <code>page</code></p>
72+
<p>One of: <code>post</code>, <code>page</code>, <code>category</code>, <code>post_tag</code></p>
7373
</td>
7474
</tr>
7575
</table>
@@ -144,7 +144,7 @@
144144
<p class="default">
145145
Default: <code>post</code>
146146
</p>
147-
<p>One of: <code>post</code></p>
147+
<p>One of: <code>post</code>, <code>term</code>, <code>post-format</code></p>
148148
</td>
149149
</tr>
150150
<tr>

0 commit comments

Comments
 (0)