json-api-schema
Version:
JSON Api Schema is a JSON dialect that can describe any Web Based API that uses JSON to exchange data.
371 lines • 9.95 kB
HTML
<html>
<head>
<meta charset='UTF-8'>
<title>JSON API Schema Documentation</title>
<link rel='stylesheet' href='assets/codo.css' type='text/css'>
<script src='assets/codo.js'></script>
<script src='assets/search_data.js'></script>
</head>
<body>
<div id='base' data-path=''></div>
<div id='header'>
<div id='menu'>
<nav>
<ul>
<li class='noframes'>
(<a class='noframes' href='#'>no frames</a>)
</li>
</ul>
</nav>
<div id='search'>
<a id='class_list_link' href='class_list.html'>Classes</a>
<a id='file_list_link' href='file_list.html'>Files</a>
<a id='method_list_link' href='method_list.html'>Methods</a>
<a id='extra_list_link' href='extra_list.html'>Extras</a>
</div>
</div>
<iframe id='search_frame'></iframe>
<div id='fuzzySearch'>
<input type='text'>
<ol></ol>
</div>
<div id='help'>
<p>
Quickly fuzzy find classes, mixins, methods, file:
</p>
<ul>
<li>
<span>Ctrl-T</span>
Open fuzzy finder dialog
</li>
</ul>
<p>
In frame mode you can toggle the list naviation frame on the left side:
</p>
<ul>
<li>
<span>Ctrl-L</span>
Toggle list view
</li>
</ul>
<p>
You can focus a list in frame mode or toggle a tab in frameless mode:
</p>
<ul>
<li>
<span>Ctrl-C</span>
Class list
</li>
<li>
<span>Ctrl-I</span>
Mixin list
</li>
<li>
<span>Ctrl-F</span>
File list
</li>
<li>
<span>Ctrl-M</span>
Method list
</li>
<li>
<span>Ctrl-E</span>
Extras list
</li>
</ul>
<p>
You can focus and blur the search input:
</p>
<ul>
<li>
<span>Ctrl-S</span>
Focus search input
</li>
<li>
<span>Esc</span>
Blur search input
</li>
</ul>
<p>
In frameless mode you can close the list tab:
</p>
<ul>
<li>
<span>Esc</span>
Close list tab
</li>
</ul>
</div>
</div>
<div id='content'>
<h1 class='noborder title'>JSON API Schema Documentation</h1>
<div id='listing'>
<h1 class='alphaindex'>Alphabetic Index</h1>
<h2>Extra File Listing</h2>
<ul id='files'>
<li>
<a href='README.md.html' title='README.md'>README.md</a>
</li>
<li>
<a href='LICENSE.html' title='LICENSE'>LICENSE</a>
</li>
</ul>
<h2>Class Listing A-Z</h2>
<div class='index'>
<ul>
<li class='letter'>a</li>
<ul>
<li>
<a href='classes/Action.html'>Action</a>
</li>
<li>
<a href='classes/Api.html'>Api</a>
</li>
<li>
<a href='classes/ArrayIterator.html'>ArrayIterator</a>
</li>
</ul>
</ul>
<ul>
<li class='letter'>e</li>
<ul>
<li>
<a href='classes/Entity.html'>Entity</a>
</li>
<li>
<a href='classes/Event.html'>Event</a>
</li>
<li>
<a href='classes/EntityIterator.html'>EntityIterator</a>
</li>
<li>
<a href='classes/EntityParser.html'>EntityParser</a>
</li>
</ul>
</ul>
<ul>
<li class='letter'>i</li>
<ul>
<li>
<a href='classes/Interaction.html'>Interaction</a>
</li>
<li>
<a href='classes/IteratorsIterator.html'>IteratorsIterator</a>
</li>
</ul>
</ul>
<ul>
<li class='letter'>j</li>
<ul>
<li>
<a href='classes/JASParser.html'>JASParser</a>
</li>
</ul>
</ul>
<ul>
<li class='letter'>n</li>
<ul>
<li>
<a href='classes/NullIterator.html'>NullIterator</a>
</li>
</ul>
</ul>
<ul>
<li class='letter'>o</li>
<ul>
<li>
<a href='classes/ObjectIterator.html'>ObjectIterator</a>
</li>
</ul>
</ul>
<ul>
<li class='letter'>r</li>
<ul>
<li>
<a href='classes/Resource.html'>Resource</a>
</li>
</ul>
</ul>
<ul>
<li class='letter'>s</li>
<ul>
<li>
<a href='classes/Schema.html'>Schema</a>
</li>
<li>
<a href='classes/Scope.html'>Scope</a>
</li>
</ul>
</ul>
<ul>
<li class='letter'>t</li>
<ul>
<li>
<a href='classes/Type.html'>Type</a>
</li>
</ul>
</ul>
</div>
<h2>File Listing A-Z</h2>
<div class='index'>
<ul>
<li class='letter'>a</li>
<ul>
<li>
<a href='files/model/action.coffee.html'>action.coffee</a>
<small>
(model)
</small>
</li>
<li>
<a href='files/model/api.coffee.html'>api.coffee</a>
<small>
(model)
</small>
</li>
<li>
<a href='files/model/iterators/array_iterator.coffee.html'>array_iterator.coffee</a>
<small>
(model/iterator)
</small>
</li>
</ul>
</ul>
<ul>
<li class='letter'>e</li>
<ul>
<li>
<a href='files/model/entity.coffee.html'>entity.coffee</a>
<small>
(model)
</small>
</li>
<li>
<a href='files/model/event.coffee.html'>event.coffee</a>
<small>
(model)
</small>
</li>
<li>
<a href='files/model/iterators/entity_iterator.coffee.html'>entity_iterator.coffee</a>
<small>
(model/iterator)
</small>
</li>
<li>
<a href='files/parser/entity_parser.coffee.html'>entity_parser.coffee</a>
<small>
(parser)
</small>
</li>
</ul>
</ul>
<ul>
<li class='letter'>i</li>
<ul>
<li>
<a href='files/model/interaction.coffee.html'>interaction.coffee</a>
<small>
(model)
</small>
</li>
<li>
<a href='files/model/iterators/iterators_iterator.coffee.html'>iterators_iterator.coffee</a>
<small>
(model/iterator)
</small>
</li>
</ul>
</ul>
<ul>
<li class='letter'>n</li>
<ul>
<li>
<a href='files/model/iterators/null_iterator.coffee.html'>null_iterator.coffee</a>
<small>
(model/iterator)
</small>
</li>
</ul>
</ul>
<ul>
<li class='letter'>o</li>
<ul>
<li>
<a href='files/model/iterators/object_iterator.coffee.html'>object_iterator.coffee</a>
<small>
(model/iterator)
</small>
</li>
</ul>
</ul>
<ul>
<li class='letter'>p</li>
<ul>
<li>
<a href='files/parser/parser.coffee.html'>parser.coffee</a>
<small>
(parser)
</small>
</li>
</ul>
</ul>
<ul>
<li class='letter'>r</li>
<ul>
<li>
<a href='files/model/resource.coffee.html'>resource.coffee</a>
<small>
(model)
</small>
</li>
</ul>
</ul>
<ul>
<li class='letter'>s</li>
<ul>
<li>
<a href='files/model/schema.coffee.html'>schema.coffee</a>
<small>
(model)
</small>
</li>
<li>
<a href='files/model/scope.coffee.html'>scope.coffee</a>
<small>
(model)
</small>
</li>
</ul>
</ul>
<ul>
<li class='letter'>t</li>
<ul>
<li>
<a href='files/model/type.coffee.html'>type.coffee</a>
<small>
(model)
</small>
</li>
</ul>
</ul>
</div>
</div>
</div>
<div id='footer'>
Generated on
Fri Sep 20 2013 14:12:12 GMT+0200 (CEST)
by
<a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
v1.7.2
(Node.js v0.10.15).
✲
Press Ctrl-h to see the keyboard shortcuts
✲
<a href='http://twitter.com/#!/netzpirat'>@netzpirat</a>
✲
<a href='https://mksoft.ch'>mksoft.ch</a>
</div>
</body>
</html>