<!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>[2357] 2013/rmccue/trunk/docs/schema.md: Add documentation on the Media schema</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/2357">2357</a></dd>
<dt>Author</dt> <dd>rmccue</dd>
<dt>Date</dt> <dd>2013-09-22 04:04:56 +0000 (Sun, 22 Sep 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Add documentation on the Media schema
Fixes <a href="http://gsoc.trac.wordpress.org/ticket/264">#264</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#2013rmccuetrunkdocsschemamd">2013/rmccue/trunk/docs/schema.md</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="2013rmccuetrunkdocsschemamd"></a>
<div class="modfile"><h4>Modified: 2013/rmccue/trunk/docs/schema.md (2356 => 2357)</h4>
<pre class="diff"><span>
<span class="info">--- 2013/rmccue/trunk/docs/schema.md 2013-09-22 04:04:48 UTC (rev 2356)
+++ 2013/rmccue/trunk/docs/schema.md 2013-09-22 04:04:56 UTC (rev 2357)
</span><span class="lines">@@ -587,6 +587,72 @@
</span><span class="cx"> Post entity.
</span><span class="cx">
</span><span class="cx">
</span><ins>+Media
+-----
+The Media entity is a JSON object based on the Post entity. It contains all
+properties of the Post entity, with the following additional properties defined:
+
+### `source`
+The `source` field is a string with the URL of the entity's original file. For
+image media, this is the source file that intermediate representations are
+generated from. For non-image media, this is the attached media file itself.
+
+### `is_image`
+The `is_image` field is a boolean which indicates whether the entity's
+associated file should be handled as an image.
+
+### `attachment_meta`
+The `attachment_meta` field is a Media Meta entity. If the file is not an image
+(as indicated by the `is_image` field), this is an empty JSON object.
+
+
+Media Meta
+----------
+The Media Meta entity is a JSON object with properties relating to the
+associated Media entity. The following properties are defined for the entity:
+
+### `width`
+The `width` field is an integer with the original file's width in pixels.
+
+### `height`
+The `height` field is an integer with the original file's height in pixels.
+
+### `file`
+The `file` field is a string with the path to the original file, relative to the
+site's upload directory.
+
+### `sizes`
+The `sizes` field is a JSON object mapping intermediate image sizes to image
+data objects. The key of each item is the size of the intermediate image as an
+internal string representation. The value of each item has the following
+properties defined.
+
+* `file`: The filename of the intermediate file, relative to the directory of
+ the original file.
+* `width`: The width of the intermediate file in pixels.
+* `height`: The height of the intermediate file in pixels.
+* `mime-type`: The MIME type of the intermediate file.
+* `url`: The full URL to the intermediate file.
+
+### `image_meta`
+The `image_meta` field is a JSON object mapping image meta properties to their
+values. This data is taken from the EXIF data on the original image. The
+following properties are defined.
+
+* `aperture`: The aperture used to create the original image as a decimal number
+ (with two decimal places).
+* `credit`: Credit for the original image.
+* `camera`: The camera used to create the original image.
+* `created_timestamp`: When the file was created, as a Unix timestamp.
+* `copyright`: Copyright for the original image.
+* `focal_length`: The focal length used to create the original image as a
+ decimal string.
+* `iso`: The ISO used to create the original image.
+* `shutter_speed`: The shutter speed used to create the original image, as a
+ decimal string.
+* `title`: The original title of the image.
+
+
</ins><span class="cx"> Documents
</span><span class="cx"> =========
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>