<!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>[2284] 2013/rmccue/trunk/docs: Split the post-related routes into a separate document</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 { 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">
<dt>Revision</dt> <dd><a href="http://gsoc.trac.wordpress.org/changeset/2284">2284</a></dd>
<dt>Author</dt> <dd>rmccue</dd>
<dt>Date</dt> <dd>2013-09-11 13:35:44 +0000 (Wed, 11 Sep 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Split the post-related routes into a separate document</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#2013rmccuetrunkdocsroutesmd">2013/rmccue/trunk/docs/routes.md</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#2013rmccuetrunkdocsroutespostsmd">2013/rmccue/trunk/docs/routes-posts.md</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="2013rmccuetrunkdocsroutespostsmdfromrev22832013rmccuetrunkdocsroutesmd"></a>
<div class="copfile"><h4>Copied: 2013/rmccue/trunk/docs/routes-posts.md (from rev 2283, 2013/rmccue/trunk/docs/routes.md) (0 => 2284)</h4>
<pre class="diff"><span>
<span class="info">--- 2013/rmccue/trunk/docs/routes-posts.md (rev 0)
+++ 2013/rmccue/trunk/docs/routes-posts.md 2013-09-11 13:35:44 UTC (rev 2284)
</span><span class="lines">@@ -0,0 +1,126 @@
</span><ins>+Posts
+=====
+
+Retrieve Posts
+--------------
+The Posts endpoint returns a Post Collection containing a subset of the site's
+posts.
+
+ GET /posts
+
+### Input
+#### `filter`
+The `filter` parameter controls the query parameters. It is essentially a subset
+of the parameters available to [`WP_Query`](http://codex.wordpress.org/Class_Reference/WP_Query).
+
+The parameter should be an array of the following key/value pairs:
+
+* `post_status` - Comma-separated list of [status
+ values](http://codex.wordpress.org/Class_Reference/WP_Query#Status_Parameters).
+ Default is "publish". (string)
+* `numberposts` - Number of posts to retrieve, use `-1` for all posts. Default
+ is set by the site. (integer)
+* `offset` - Number of posts to skip. Default is 0. (integer)
+* `orderby` - Parameter to search by, as per [WP Query](http://codex.wordpress.org/Class_Reference/WP_Query#Order_.26_Orderby_Parameters).
+ Default is "date". (string)
+* `order` - Order to sort by. Default is "DESC". (string, "ASC" or "DESC")
+* `s` - Keyword to search for. (string)
+
+
+#### `fields`
+...
+
+
+#### `type`
+The `type` parameter specifies the post type to retrieve. Default is "post".
+(string)
+
+
+### Response
+The response is a Post Collection document containing the requested Posts if
+available.
+
+
+Create a Post
+-------------
+
+ POST /posts
+
+### Input
+The supplied data should be a Post object. This data can be submitted via a
+regular HTTP multipart body, with Post values set as values to the `data`
+parameter, or through a direct JSON body.
+
+That is, the following are equivalent:
+
+Content-Type: application/x-www-form-urlencoded
+
+ data[post_title]=Hello%20World!&data[post_content]=Content
+
+
+Content-Type: application/json
+
+ {"post_title":"Hello World!","post_content":"Content"}
+
+### Response
+On a successful creation, a 201 Created status is given, indicating that the
+post has been created. The post is available canonically from the URL specified
+in the Location header.
+
+The new Post entity is also returned in the body for convienience.
+
+
+Retrieve a Post
+---------------
+
+ GET /posts/<id>
+
+### Input
+#### `fields`
+...
+
+### Response
+The response is a Post entity containing the requested Post if available.
+
+
+Edit a Post
+-----------
+
+ PUT /posts/<id>
+
+For compatibility reasons, this endpoint also accepts the POST and PATCH
+methods. Both of these methods have the same behaviour as using PUT. It is
+recommended to use PUT if available to fit with REST convention.
+
+### Input
+The supplied data should be a Post object. This data can be submitted via a
+regular HTTP multipart body, with Post values set as values to the `data`
+parameter, or through a direct JSON body. See the Create Post endpoint for an
+example.
+
+### Response
+On a successful update, a 200 OK status is given, indicating the post has been
+updated. The updated Post entity is returned in the body.
+
+
+Delete a Post
+-------------
+
+ DELETE /posts/<id>
+
+### Input
+#### `force`
+The `force` parameter controls whether the post is permanently deleted or not.
+By default, this is set to false, indicating that the post will be sent to an
+intermediate storage (such as the trash) allowing it to be restored later. If
+set to true, the post will not be able to be restored by the user.
+
+Default is false. (boolean)
+
+### Response
+On successful deletion, a 202 Accepted status code will be returned, indicating
+that the post has been moved to the trash for permanent deletion at a
+later date.
+
+If force was set to true, a 200 OK status code will be returned instead,
+indicating that the post has been permanently deleted.
</ins><span class="cx">\ No newline at end of file
</span></span></pre></div>
<a id="2013rmccuetrunkdocsroutesmd"></a>
<div class="modfile"><h4>Modified: 2013/rmccue/trunk/docs/routes.md (2283 => 2284)</h4>
<pre class="diff"><span>
<span class="info">--- 2013/rmccue/trunk/docs/routes.md 2013-09-11 13:20:52 UTC (rev 2283)
+++ 2013/rmccue/trunk/docs/routes.md 2013-09-11 13:35:44 UTC (rev 2284)
</span><span class="lines">@@ -42,128 +42,3 @@
</span><span class="cx"> may be passed via the URL with the value set to a valid HTTP method (DELETE,
</span><span class="cx"> GET, HEAD, PATCH, POST, PUT, DELETE). Note that this must be passed via the URL
</span><span class="cx"> and cannot be passed in the HTTP body.
</span><del>-
-
-Retrieve Posts
---------------
-The Posts endpoint returns a Post Collection containing a subset of the site's
-posts.
-
- GET /posts
-
-### Input
-#### `filter`
-The `filter` parameter controls the query parameters. It is essentially a subset
-of the parameters available to [`WP_Query`](http://codex.wordpress.org/Class_Reference/WP_Query).
-
-The parameter should be an array of the following key/value pairs:
-
-* `post_status` - Comma-separated list of [status
- values](http://codex.wordpress.org/Class_Reference/WP_Query#Status_Parameters).
- Default is "publish". (string)
-* `numberposts` - Number of posts to retrieve, use `-1` for all posts. Default
- is set by the site. (integer)
-* `offset` - Number of posts to skip. Default is 0. (integer)
-* `orderby` - Parameter to search by, as per [WP Query](http://codex.wordpress.org/Class_Reference/WP_Query#Order_.26_Orderby_Parameters).
- Default is "date". (string)
-* `order` - Order to sort by. Default is "DESC". (string, "ASC" or "DESC")
-* `s` - Keyword to search for. (string)
-
-
-#### `fields`
-...
-
-
-#### `type`
-The `type` parameter specifies the post type to retrieve. Default is "post".
-(string)
-
-
-### Response
-The response is a Post Collection document containing the requested Posts if
-available.
-
-
-Create a Post
--------------
-
- POST /posts
-
-### Input
-The supplied data should be a Post object. This data can be submitted via a
-regular HTTP multipart body, with Post values set as values to the `data`
-parameter, or through a direct JSON body.
-
-That is, the following are equivalent:
-
-Content-Type: application/x-www-form-urlencoded
-
- data[post_title]=Hello%20World!&data[post_content]=Content
-
-
-Content-Type: application/json
-
- {"post_title":"Hello World!","post_content":"Content"}
-
-### Response
-On a successful creation, a 201 Created status is given, indicating that the
-post has been created. The post is available canonically from the URL specified
-in the Location header.
-
-The new Post entity is also returned in the body for convienience.
-
-
-Retrieve a Post
----------------
-
- GET /posts/<id>
-
-### Input
-#### `fields`
-...
-
-### Response
-The response is a Post entity containing the requested Post if available.
-
-
-Edit a Post
------------
-
- PUT /posts/<id>
-
-For compatibility reasons, this endpoint also accepts the POST and PATCH
-methods. Both of these methods have the same behaviour as using PUT. It is
-recommended to use PUT if available to fit with REST convention.
-
-### Input
-The supplied data should be a Post object. This data can be submitted via a
-regular HTTP multipart body, with Post values set as values to the `data`
-parameter, or through a direct JSON body. See the Create Post endpoint for an
-example.
-
-### Response
-On a successful update, a 200 OK status is given, indicating the post has been
-updated. The updated Post entity is returned in the body.
-
-
-Delete a Post
--------------
-
- DELETE /posts/<id>
-
-### Input
-#### `force`
-The `force` parameter controls whether the post is permanently deleted or not.
-By default, this is set to false, indicating that the post will be sent to an
-intermediate storage (such as the trash) allowing it to be restored later. If
-set to true, the post will not be able to be restored by the user.
-
-Default is false. (boolean)
-
-### Response
-On successful deletion, a 202 Accepted status code will be returned, indicating
-that the post has been moved to the trash for permanent deletion at a
-later date.
-
-If force was set to true, a 200 OK status code will be returned instead,
-indicating that the post has been permanently deleted.
</del><span class="cx">\ No newline at end of file
</span></span></pre>
</div>
</div>
</body>
</html>