Skip to content

Commit 4854bfb

Browse files
rmccuermccue
committed
Regenerate reference
1 parent 4ca55ce commit 4854bfb

13 files changed

Lines changed: 5837 additions & 5134 deletions

‎reference/categories.md‎

Lines changed: 450 additions & 259 deletions
Large diffs are not rendered by default.

‎reference/comments.md‎

Lines changed: 756 additions & 502 deletions
Large diffs are not rendered by default.

‎reference/media.md‎

Lines changed: 614 additions & 1134 deletions
Large diffs are not rendered by default.

‎reference/page-revisions.md‎

Lines changed: 289 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,289 @@
1+
---
2+
---
3+
4+
# Page-revisions
5+
6+
<section class="route">
7+
<div class="primary">
8+
<h2>Schema</h2>
9+
<p>The schema defines all the fields that exist for a page-revision object.</p>
10+
<table class="attributes">
11+
<tr id="schema-author">
12+
<td>
13+
<code>author</code><br />
14+
<span class="type">
15+
integer </span>
16+
</td>
17+
<td>
18+
<p>The ID for the author of the object.</p>
19+
<p class="context">Context: <code>view</code>, <code>edit</code>, <code>embed</code></p>
20+
</td>
21+
</tr>
22+
<tr id="schema-date">
23+
<td>
24+
<code>date</code><br />
25+
<span class="type">
26+
string,
27+
datetime (ISO8601)
28+
</span>
29+
</td>
30+
<td>
31+
<p>The date the object was published, in the site&#039;s timezone.</p>
32+
<p class="context">Context: <code>view</code>, <code>edit</code>, <code>embed</code></p>
33+
</td>
34+
</tr>
35+
<tr id="schema-date_gmt">
36+
<td>
37+
<code>date_gmt</code><br />
38+
<span class="type">
39+
string,
40+
datetime (ISO8601)
41+
</span>
42+
</td>
43+
<td>
44+
<p>The date the object was published, as GMT.</p>
45+
<p class="context">Context: <code>view</code>, <code>edit</code></p>
46+
</td>
47+
</tr>
48+
<tr id="schema-guid">
49+
<td>
50+
<code>guid</code><br />
51+
<span class="type">
52+
object </span>
53+
</td>
54+
<td>
55+
<p>The globally unique identifier for the object.</p>
56+
<p class="read-only">Read only</p>
57+
<p class="context">Context: <code>view</code>, <code>edit</code></p>
58+
</td>
59+
</tr>
60+
<tr id="schema-id">
61+
<td>
62+
<code>id</code><br />
63+
<span class="type">
64+
integer </span>
65+
</td>
66+
<td>
67+
<p>Unique identifier for the object.</p>
68+
<p class="context">Context: <code>view</code>, <code>edit</code>, <code>embed</code></p>
69+
</td>
70+
</tr>
71+
<tr id="schema-modified">
72+
<td>
73+
<code>modified</code><br />
74+
<span class="type">
75+
string,
76+
datetime (ISO8601)
77+
</span>
78+
</td>
79+
<td>
80+
<p>The date the object was last modified, in the site&#039;s timezone.</p>
81+
<p class="context">Context: <code>view</code>, <code>edit</code></p>
82+
</td>
83+
</tr>
84+
<tr id="schema-modified_gmt">
85+
<td>
86+
<code>modified_gmt</code><br />
87+
<span class="type">
88+
string,
89+
datetime (ISO8601)
90+
</span>
91+
</td>
92+
<td>
93+
<p>The date the object was last modified, as GMT.</p>
94+
<p class="context">Context: <code>view</code>, <code>edit</code></p>
95+
</td>
96+
</tr>
97+
<tr id="schema-parent">
98+
<td>
99+
<code>parent</code><br />
100+
<span class="type">
101+
integer </span>
102+
</td>
103+
<td>
104+
<p>The ID for the parent of the object.</p>
105+
<p class="context">Context: <code>view</code>, <code>edit</code>, <code>embed</code></p>
106+
</td>
107+
</tr>
108+
<tr id="schema-slug">
109+
<td>
110+
<code>slug</code><br />
111+
<span class="type">
112+
string </span>
113+
</td>
114+
<td>
115+
<p>An alphanumeric identifier for the object unique to its type.</p>
116+
<p class="context">Context: <code>view</code>, <code>edit</code>, <code>embed</code></p>
117+
</td>
118+
</tr>
119+
<tr id="schema-title">
120+
<td>
121+
<code>title</code><br />
122+
<span class="type">
123+
object </span>
124+
</td>
125+
<td>
126+
<p>The title for the object.</p>
127+
<p class="context">Context: <code>view</code>, <code>edit</code>, <code>embed</code></p>
128+
</td>
129+
</tr>
130+
<tr id="schema-content">
131+
<td>
132+
<code>content</code><br />
133+
<span class="type">
134+
object </span>
135+
</td>
136+
<td>
137+
<p>The content for the object.</p>
138+
<p class="context">Context: <code>view</code>, <code>edit</code></p>
139+
</td>
140+
</tr>
141+
<tr id="schema-excerpt">
142+
<td>
143+
<code>excerpt</code><br />
144+
<span class="type">
145+
object </span>
146+
</td>
147+
<td>
148+
<p>The excerpt for the object.</p>
149+
<p class="context">Context: <code>view</code>, <code>edit</code>, <code>embed</code></p>
150+
</td>
151+
</tr>
152+
</table>
153+
154+
</div>
155+
<div class="secondary">
156+
<h3>Example Request</h3>
157+
158+
<code>$ curl -X OPTIONS -i http://demo.wp-api.org/wp-json/wp/v2/pages/&lt;parent&gt;/revisions</code>
159+
</div>
160+
</section>
161+
162+
<div><section class="route">
163+
<div class="primary">
164+
<h2>Retrieve a Page-revision</h2>
165+
<h3>Arguments</h3>
166+
<table class="arguments">
167+
<tr>
168+
<td>
169+
<code>parent</code><br />
170+
</td>
171+
<td>
172+
<p>The ID for the parent of the object.</p>
173+
</td>
174+
</tr>
175+
<tr>
176+
<td>
177+
<code>context</code><br />
178+
</td>
179+
<td>
180+
<p>Scope under which the request is made; determines fields present in response.</p>
181+
<p class="default">
182+
Default: <code>view</code>
183+
</p>
184+
<p>One of: <code>view</code>, <code>embed</code>, <code>edit</code></p>
185+
</td>
186+
</tr>
187+
</table>
188+
189+
</div>
190+
<div class="secondary">
191+
<h3>Definition</h3>
192+
193+
<code>GET /wp/v2/pages/&lt;parent&gt;/revisions</code>
194+
195+
<h3>Example Request</h3>
196+
197+
<code>$ curl http://demo.wp-api.org/wp-json/wp/v2/pages/&lt;parent&gt;/revisions</code>
198+
</div>
199+
</section>
200+
<section class="route">
201+
<div class="primary">
202+
<h2>Retrieve a Page-revision</h2>
203+
<h3>Arguments</h3>
204+
<table class="arguments">
205+
<tr>
206+
<td>
207+
<code>parent</code><br />
208+
</td>
209+
<td>
210+
<p>The ID for the parent of the object.</p>
211+
</td>
212+
</tr>
213+
<tr>
214+
<td>
215+
<code>id</code><br />
216+
</td>
217+
<td>
218+
<p>Unique identifier for the object.</p>
219+
</td>
220+
</tr>
221+
<tr>
222+
<td>
223+
<code>context</code><br />
224+
</td>
225+
<td>
226+
<p>Scope under which the request is made; determines fields present in response.</p>
227+
<p class="default">
228+
Default: <code>view</code>
229+
</p>
230+
<p>One of: <code>view</code>, <code>embed</code>, <code>edit</code></p>
231+
</td>
232+
</tr>
233+
</table>
234+
235+
</div>
236+
<div class="secondary">
237+
<h3>Definition</h3>
238+
239+
<code>GET /wp/v2/pages/&lt;parent&gt;/revisions/&lt;id&gt;</code>
240+
241+
<h3>Example Request</h3>
242+
243+
<code>$ curl http://demo.wp-api.org/wp-json/wp/v2/pages/&lt;parent&gt;/revisions/&lt;id&gt;</code>
244+
</div>
245+
</section>
246+
<section class="route">
247+
<div class="primary">
248+
<h2>Delete a Page-revision</h2>
249+
<h3>Arguments</h3>
250+
<table class="arguments">
251+
<tr>
252+
<td>
253+
<code>parent</code><br />
254+
</td>
255+
<td>
256+
<p>The ID for the parent of the object.</p>
257+
</td>
258+
</tr>
259+
<tr>
260+
<td>
261+
<code>id</code><br />
262+
</td>
263+
<td>
264+
<p>Unique identifier for the object.</p>
265+
</td>
266+
</tr>
267+
<tr>
268+
<td>
269+
<code>force</code><br />
270+
</td>
271+
<td>
272+
<p>Required to be true, as revisions do not support trashing.</p>
273+
</td>
274+
</tr>
275+
</table>
276+
277+
</div>
278+
<div class="secondary">
279+
<h3>Definition</h3>
280+
281+
<code>DELETE /wp/v2/pages/&lt;parent&gt;/revisions/&lt;id&gt;</code>
282+
283+
<h3>Example Request</h3>
284+
285+
<code>$ curl -X DELETE http://demo.wp-api.org/wp-json/wp/v2/pages/&lt;parent&gt;/revisions/&lt;id&gt;</code>
286+
</div>
287+
</section>
288+
</div>
289+

0 commit comments

Comments
 (0)