RESTful API for interacting with IRC
Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.

index.html 40KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244
  1. <!DOCTYPE html><html><head><meta charset="utf-8"><title>IRC API</title><link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css"><style>@import url('https://fonts.googleapis.com/css?family=Roboto:400,700|Inconsolata|Raleway:200');.hljs-comment,.hljs-title{color:#8e908c}.hljs-variable,.hljs-attribute,.hljs-tag,.hljs-regexp,.ruby .hljs-constant,.xml .hljs-tag .hljs-title,.xml .hljs-pi,.xml .hljs-doctype,.html .hljs-doctype,.css .hljs-id,.css .hljs-class,.css .hljs-pseudo{color:#c82829}.hljs-number,.hljs-preprocessor,.hljs-pragma,.hljs-built_in,.hljs-literal,.hljs-params,.hljs-constant{color:#f5871f}.ruby .hljs-class .hljs-title,.css .hljs-rules .hljs-attribute{color:#eab700}.hljs-string,.hljs-value,.hljs-inheritance,.hljs-header,.ruby .hljs-symbol,.xml .hljs-cdata{color:#718c00}.css .hljs-hexcolor{color:#3e999f}.hljs-function,.python .hljs-decorator,.python .hljs-title,.ruby .hljs-function .hljs-title,.ruby .hljs-title .hljs-keyword,.perl .hljs-sub,.javascript .hljs-title,.coffeescript .hljs-title{color:#4271ae}.hljs-keyword,.javascript .hljs-function{color:#8959a8}.hljs{display:block;background:white;color:#4d4d4c;padding:.5em}.coffeescript .javascript,.javascript .xml,.tex .hljs-formula,.xml .javascript,.xml .vbscript,.xml .css,.xml .hljs-cdata{opacity:.5}.right .hljs-comment{color:#969896}.right .css .hljs-class,.right .css .hljs-id,.right .css .hljs-pseudo,.right .hljs-attribute,.right .hljs-regexp,.right .hljs-tag,.right .hljs-variable,.right .html .hljs-doctype,.right .ruby .hljs-constant,.right .xml .hljs-doctype,.right .xml .hljs-pi,.right .xml .hljs-tag .hljs-title{color:#c66}.right .hljs-built_in,.right .hljs-constant,.right .hljs-literal,.right .hljs-number,.right .hljs-params,.right .hljs-pragma,.right .hljs-preprocessor{color:#de935f}.right .css .hljs-rule .hljs-attribute,.right .ruby .hljs-class .hljs-title{color:#f0c674}.right .hljs-header,.right .hljs-inheritance,.right .hljs-name,.right .hljs-string,.right .hljs-value,.right .ruby .hljs-symbol,.right .xml .hljs-cdata{color:#b5bd68}.right .css .hljs-hexcolor,.right .hljs-title{color:#8abeb7}.right .coffeescript .hljs-title,.right .hljs-function,.right .javascript .hljs-title,.right .perl .hljs-sub,.right .python .hljs-decorator,.right .python .hljs-title,.right .ruby .hljs-function .hljs-title,.right .ruby .hljs-title .hljs-keyword{color:#81a2be}.right .hljs-keyword,.right .javascript .hljs-function{color:#b294bb}.right .hljs{display:block;overflow-x:auto;background:#1d1f21;color:#c5c8c6;padding:.5em;-webkit-text-size-adjust:none}.right .coffeescript .javascript,.right .javascript .xml,.right .tex .hljs-formula,.right .xml .css,.right .xml .hljs-cdata,.right .xml .javascript,.right .xml .vbscript{opacity:.5}body{color:black;background:white;font:400 14px / 1.42 'Roboto',Helvetica,sans-serif}header{border-bottom:1px solid #f2f2f2;margin-bottom:12px}h1,h2,h3,h4,h5{color:black;margin:12px 0}h1 .permalink,h2 .permalink,h3 .permalink,h4 .permalink,h5 .permalink{margin-left:0;opacity:0;transition:opacity .25s ease}h1:hover .permalink,h2:hover .permalink,h3:hover .permalink,h4:hover .permalink,h5:hover .permalink{opacity:1}.triple h1 .permalink,.triple h2 .permalink,.triple h3 .permalink,.triple h4 .permalink,.triple h5 .permalink{opacity:.15}.triple h1:hover .permalink,.triple h2:hover .permalink,.triple h3:hover .permalink,.triple h4:hover .permalink,.triple h5:hover .permalink{opacity:.15}h1{font:200 36px 'Raleway',Helvetica,sans-serif;font-size:36px}h2{font:200 36px 'Raleway',Helvetica,sans-serif;font-size:30px}h3{font-size:100%;text-transform:uppercase}h5{font-size:100%;font-weight:normal}p{margin:0 0 10px}p.choices{line-height:1.6}a{color:#428bca;text-decoration:none}li p{margin:0}hr.split{border:0;height:1px;width:100%;padding-left:6px;margin:12px auto;background-image:linear-gradient(to right, rgba(0,0,0,0) 20%, rgba(0,0,0,0.2) 51.4%, rgba(255,255,255,0.2) 51.4%, rgba(255,255,255,0) 80%)}dl dt{float:left;width:130px;clear:left;text-align:right;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;font-weight:700}dl dd{margin-left:150px}blockquote{color:rgba(0,0,0,0.5);font-size:15.5px;padding:10px 20px;margin:12px 0;border-left:5px solid #e8e8e8}blockquote p:last-child{margin-bottom:0}pre{background-color:#f5f5f5;padding:12px;border:1px solid #cfcfcf;border-radius:6px;overflow:auto}pre code{color:black;background-color:transparent;padding:0;border:none}code{color:#444;background-color:#f5f5f5;font:'Inconsolata',monospace;padding:1px 4px;border:1px solid #cfcfcf;border-radius:3px}ul,ol{padding-left:2em}table{border-collapse:collapse;border-spacing:0;margin-bottom:12px}table tr:nth-child(2n){background-color:#fafafa}table th,table td{padding:6px 12px;border:1px solid #e6e6e6}.text-muted{opacity:.5}.note,.warning{padding:.3em 1em;margin:1em 0;border-radius:2px;font-size:90%}.note h1,.warning h1,.note h2,.warning h2,.note h3,.warning h3,.note h4,.warning h4,.note h5,.warning h5,.note h6,.warning h6{font-family:200 36px 'Raleway',Helvetica,sans-serif;font-size:135%;font-weight:500}.note p,.warning p{margin:.5em 0}.note{color:black;background-color:#f0f6fb;border-left:4px solid #428bca}.note h1,.note h2,.note h3,.note h4,.note h5,.note h6{color:#428bca}.warning{color:black;background-color:#fbf1f0;border-left:4px solid #c9302c}.warning h1,.warning h2,.warning h3,.warning h4,.warning h5,.warning h6{color:#c9302c}header{margin-top:24px}nav{position:fixed;top:24px;bottom:0;overflow-y:auto}nav .resource-group{padding:0}nav .resource-group .heading{position:relative}nav .resource-group .heading .chevron{position:absolute;top:12px;right:12px;opacity:.5}nav .resource-group .heading a{display:block;color:black;opacity:.7;border-left:2px solid transparent;margin:0}nav .resource-group .heading a:hover{text-decoration:none;background-color:bad-color;border-left:2px solid black}nav ul{list-style-type:none;padding-left:0}nav ul a{display:block;font-size:13px;color:rgba(0,0,0,0.7);padding:8px 12px;border-top:1px solid #d9d9d9;border-left:2px solid transparent;overflow:hidden;text-overflow:ellipsis;white-space:nowrap}nav ul a:hover{text-decoration:none;background-color:bad-color;border-left:2px solid black}nav ul>li{margin:0}nav ul>li:first-child{margin-top:-12px}nav ul>li:last-child{margin-bottom:-12px}nav ul ul a{padding-left:24px}nav ul ul li{margin:0}nav ul ul li:first-child{margin-top:0}nav ul ul li:last-child{margin-bottom:0}nav>div>div>ul>li:first-child>a{border-top:none}.preload *{transition:none !important}.pull-left{float:left}.pull-right{float:right}.badge{display:inline-block;float:right;min-width:10px;min-height:14px;padding:3px 7px;font-size:12px;color:#000;background-color:#f2f2f2;border-radius:10px;margin:-2px 0}.badge.get{color:#70bbe1;background-color:#d9edf7}.badge.head{color:#70bbe1;background-color:#d9edf7}.badge.options{color:#70bbe1;background-color:#d9edf7}.badge.put{color:#f0db70;background-color:#fcf8e3}.badge.patch{color:#f0db70;background-color:#fcf8e3}.badge.post{color:#93cd7c;background-color:#dff0d8}.badge.delete{color:#ce8383;background-color:#f2dede}.collapse-button{float:right}.collapse-button .close{display:none;color:#428bca;cursor:pointer}.collapse-button .open{color:#428bca;cursor:pointer}.collapse-button.show .close{display:inline}.collapse-button.show .open{display:none}.collapse-content{max-height:0;overflow:hidden;transition:max-height .3s ease-in-out}nav{width:220px}.container{max-width:940px;margin-left:auto;margin-right:auto}.container .row .content{margin-left:244px;width:696px}.container .row:after{content:'';display:block;clear:both}.container-fluid nav{width:22%}.container-fluid .row .content{margin-left:24%}.container-fluid.triple nav{width:16.5%;padding-right:1px}.container-fluid.triple .row .content{position:relative;margin-left:16.5%;padding-left:24px}.middle:before,.middle:after{content:'';display:table}.middle:after{clear:both}.middle{box-sizing:border-box;width:51.5%;padding-right:12px}.right{box-sizing:border-box;float:right;width:48.5%;padding-left:12px}.right a{color:#428bca}.right h1,.right h2,.right h3,.right h4,.right h5,.right p,.right div{color:white}.right pre{background-color:#1d1f21;border:1px solid #1d1f21}.right pre code{color:#c5c8c6}.right .description{margin-top:12px}.triple .resource-heading{font-size:125%}.definition{margin-top:12px;margin-bottom:12px}.definition .method{font-weight:bold}.definition .method.get{color:#2e8ab8}.definition .method.head{color:#2e8ab8}.definition .method.options{color:#2e8ab8}.definition .method.post{color:#56b82e}.definition .method.put{color:#b8a22e}.definition .method.patch{color:#b8a22e}.definition .method.delete{color:#b82e2e}.definition .uri{word-break:break-all;word-wrap:break-word}.definition .hostname{opacity:.5}.example-names{background-color:#eee;padding:12px;border-radius:6px}.example-names .tab-button{cursor:pointer;color:black;border:1px solid #ddd;padding:6px;margin-left:12px}.example-names .tab-button.active{background-color:#d5d5d5}.right .example-names{background-color:#444}.right .example-names .tab-button{color:white;border:1px solid #666;border-radius:6px}.right .example-names .tab-button.active{background-color:#5e5e5e}#nav-background{position:fixed;left:0;top:0;bottom:0;width:16.5%;padding-right:14.4px;background-color:#fbfbfb;border-right:1px solid #f0f0f0;z-index:-1}#right-panel-background{position:absolute;right:-12px;top:-12px;bottom:-12px;width:48.6%;background-color:#333;z-index:-1}@media (max-width:1200px){nav{width:198px}.container{max-width:840px}.container .row .content{margin-left:224px;width:606px}}@media (max-width:992px){nav{width:169.4px}.container{max-width:720px}.container .row .content{margin-left:194px;width:526px}}@media (max-width:768px){nav{display:none}.container{width:95%;max-width:none}.container .row .content,.container-fluid .row .content,.container-fluid.triple .row .content{margin-left:auto;margin-right:auto;width:95%}#nav-background{display:none}#right-panel-background{width:48.6%}}.back-to-top{position:fixed;z-index:1;bottom:0;right:24px;padding:4px 8px;color:rgba(0,0,0,0.5);background-color:#f2f2f2;text-decoration:none !important;border-top:1px solid #d9d9d9;border-left:1px solid #d9d9d9;border-right:1px solid #d9d9d9;border-top-left-radius:3px;border-top-right-radius:3px}.resource-group{padding:12px;margin-bottom:12px;background-color:white;border:1px solid #d9d9d9;border-radius:6px}.resource-group h2.group-heading,.resource-group .heading a{padding:12px;margin:-12px -12px 12px -12px;background-color:#f2f2f2;border-bottom:1px solid #d9d9d9;border-top-left-radius:6px;border-top-right-radius:6px;white-space:nowrap;text-overflow:ellipsis;overflow:hidden}.triple .content .resource-group{padding:0;border:none}.triple .content .resource-group h2.group-heading,.triple .content .resource-group .heading a{margin:0 0 12px 0;border:1px solid #d9d9d9}nav .resource-group .heading a{padding:12px;margin-bottom:0}nav .resource-group .collapse-content{padding:0}.action{margin-bottom:12px;padding:12px 12px 0 12px;overflow:hidden;border:1px solid transparent;border-radius:6px}.action h4.action-heading{padding:6px 12px;margin:-12px -12px 12px -12px;border-bottom:1px solid transparent;border-top-left-radius:6px;border-top-right-radius:6px;overflow:hidden}.action h4.action-heading .name{float:right;font-weight:normal;padding:6px 0}.action h4.action-heading .method{padding:6px 12px;margin-right:12px;border-radius:3px;display:inline-block}.action h4.action-heading .method.get{color:#fff;background-color:#337ab7}.action h4.action-heading .method.head{color:#fff;background-color:#337ab7}.action h4.action-heading .method.options{color:#fff;background-color:#337ab7}.action h4.action-heading .method.put{color:#fff;background-color:#ed9c28}.action h4.action-heading .method.patch{color:#fff;background-color:#ed9c28}.action h4.action-heading .method.post{color:#fff;background-color:#5cb85c}.action h4.action-heading .method.delete{color:#fff;background-color:#d9534f}.action h4.action-heading code{color:#444;background-color:#f5f5f5;border-color:#cfcfcf;font-weight:normal;word-break:break-all;display:inline-block;margin-top:2px}.action dl.inner{padding-bottom:2px}.action .title{border-bottom:1px solid white;margin:0 -12px -1px -12px;padding:12px}.action.get{border-color:#bce8f1}.action.get h4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.head{border-color:#bce8f1}.action.head h4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.options{border-color:#bce8f1}.action.options h4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.post{border-color:#d6e9c6}.action.post h4.action-heading{color:#5cb85c;background:#dff0d8;border-bottom-color:#d6e9c6}.action.put{border-color:#faebcc}.action.put h4.action-heading{color:#ed9c28;background:#fcf8e3;border-bottom-color:#faebcc}.action.patch{border-color:#faebcc}.action.patch h4.action-heading{color:#ed9c28;background:#fcf8e3;border-bottom-color:#faebcc}.action.delete{border-color:#ebccd1}.action.delete h4.action-heading{color:#d9534f;background:#f2dede;border-bottom-color:#ebccd1}</style></head><body class="preload"><a href="#top" class="text-muted back-to-top"><i class="fa fa-toggle-up"></i>&nbsp;Back to top</a><div class="container"><div class="row"><nav><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#networks">Networks</a></div><div class="collapse-content"><ul><li><a href="#networks-networks-collection">Networks collection</a><ul><li><a href="#networks-networks-collection-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>List existing networks</a></li><li><a href="#networks-networks-collection-post"><span class="badge post"><i class="fa fa-plus"></i></span>Add a new network</a></li></ul></li><li><a href="#networks-network-information">Network information</a><ul><li><a href="#networks-network-information-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get network information</a></li><li><a href="#networks-network-information-post"><span class="badge post"><i class="fa fa-plus"></i></span>Update network information</a></li><li><a href="#networks-network-information-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Delete network</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#chats">Chats</a></div><div class="collapse-content"><ul><li><a href="#chats-chats-collection">Chats collection</a><ul><li><a href="#chats-chats-collection-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>List existing chats</a></li><li><a href="#chats-chats-collection-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create new chat</a></li></ul></li><li><a href="#chats-chat-information">Chat information</a><ul><li><a href="#chats-chat-information-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get chat information</a></li><li><a href="#chats-chat-information-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Delete chat</a></li></ul></li><li><a href="#chats-chat-messages">Chat messages</a><ul><li><a href="#chats-chat-messages-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get chat messages</a></li><li><a href="#chats-chat-messages-post"><span class="badge post"><i class="fa fa-plus"></i></span>Send chat message</a></li></ul></li><li><a href="#chats-chat-users-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>List chat users</a></li></ul></div></div></nav><div class="content"><header><h1 id="top">IRC API</h1></header><p>A simplified RESTful API for interacting with persistent Internet Relay Chat connections.</p>
  2. <section id="networks" class="resource-group"><h2 class="group-heading">Networks <a href="#networks" class="permalink">&para;</a></h2><p>A “network” represents a user-defined connection to IRC. Each network has one or more IRC
  3. servers to which the API will connect.</p>
  4. <div id="networks-networks-collection" class="resource"><h3 class="resource-heading">Networks collection <a href="#networks-networks-collection" class="permalink">&nbsp;&para;</a></h3><div id="networks-networks-collection-get" class="action get"><h4 class="action-heading"><div class="name">List existing networks</div><a href="#networks-networks-collection-get" class="method get">GET</a><code class="uri">/networks</code></h4><h4>Example URI</h4><div class="definition"><span class="method get">GET</span>&nbsp;<span class="uri"><span class="hostname"></span>/networks</span></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div></div></div></div><div id="networks-networks-collection-post" class="action post"><h4 class="action-heading"><div class="name">Add a new network</div><a href="#networks-networks-collection-post" class="method post">POST</a><code class="uri">/networks</code></h4><h4>Example URI</h4><div class="definition"><span class="method post">POST</span>&nbsp;<span class="uri"><span class="hostname"></span>/networks</span></div><div class="title"><strong>Response&nbsp;&nbsp;<code>204</code></strong></div><div class="title"><strong>Response&nbsp;&nbsp;<code>400</code></strong></div></div></div><div id="networks-network-information" class="resource"><h3 class="resource-heading">Network information <a href="#networks-network-information" class="permalink">&nbsp;&para;</a></h3><div id="networks-network-information-get" class="action get"><h4 class="action-heading"><div class="name">Get network information</div><a href="#networks-network-information-get" class="method get">GET</a><code class="uri">/networks/{network}</code></h4><h4>Example URI</h4><div class="definition"><span class="method get">GET</span>&nbsp;<span class="uri"><span class="hostname"></span>/networks/<span class="hljs-attribute" title="network">quakenet</span></span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>network</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>quakenet</span></span><p>The name of the network.</p>
  5. </dd></dl></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>404</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><div class="description"><p>If the specified network doesn’t exist</p>
  6. </div></div></div></div><div id="networks-network-information-post" class="action post"><h4 class="action-heading"><div class="name">Update network information</div><a href="#networks-network-information-post" class="method post">POST</a><code class="uri">/networks/{network}</code></h4><h4>Example URI</h4><div class="definition"><span class="method post">POST</span>&nbsp;<span class="uri"><span class="hostname"></span>/networks/<span class="hljs-attribute" title="network">quakenet</span></span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>network</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>quakenet</span></span><p>The name of the network.</p>
  7. </dd></dl></div><div class="title"><strong>Response&nbsp;&nbsp;<code>204</code></strong></div><div class="title"><strong>Response&nbsp;&nbsp;<code>400</code></strong></div><div class="title"><strong>Response&nbsp;&nbsp;<code>404</code></strong></div></div><div id="networks-network-information-delete" class="action delete"><h4 class="action-heading"><div class="name">Delete network</div><a href="#networks-network-information-delete" class="method delete">DELETE</a><code class="uri">/networks/{network}</code></h4><h4>Example URI</h4><div class="definition"><span class="method delete">DELETE</span>&nbsp;<span class="uri"><span class="hostname"></span>/networks/<span class="hljs-attribute" title="network">quakenet</span></span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>network</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>quakenet</span></span><p>The name of the network.</p>
  8. </dd></dl></div><div class="title"><strong>Response&nbsp;&nbsp;<code>204</code></strong></div><div class="title"><strong>Response&nbsp;&nbsp;<code>404</code></strong></div></div></div></section><section id="chats" class="resource-group"><h2 class="group-heading">Chats <a href="#chats" class="permalink">&para;</a></h2><p>A chat represents either an IRC channel or a private message with another IRC user.</p>
  9. <div id="chats-chats-collection" class="resource"><h3 class="resource-heading">Chats collection <a href="#chats-chats-collection" class="permalink">&nbsp;&para;</a></h3><div id="chats-chats-collection-get" class="action get"><h4 class="action-heading"><div class="name">List existing chats</div><a href="#chats-chats-collection-get" class="method get">GET</a><code class="uri">/networks/{network}/chats</code></h4><h4>Example URI</h4><div class="definition"><span class="method get">GET</span>&nbsp;<span class="uri"><span class="hostname"></span>/networks/<span class="hljs-attribute" title="network">quakenet</span>/chats</span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>network</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>quakenet</span></span><p>The name of the network.</p>
  10. </dd></dl></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>404</code></strong></div></div><div id="chats-chats-collection-post" class="action post"><h4 class="action-heading"><div class="name">Create new chat</div><a href="#chats-chats-collection-post" class="method post">POST</a><code class="uri">/networks/{network}/chats</code></h4><h4>Example URI</h4><div class="definition"><span class="method post">POST</span>&nbsp;<span class="uri"><span class="hostname"></span>/networks/<span class="hljs-attribute" title="network">quakenet</span>/chats</span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>network</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>quakenet</span></span><p>The name of the network.</p>
  11. </dd></dl></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>400</code></strong></div><div class="title"><strong>Response&nbsp;&nbsp;<code>404</code></strong></div></div></div><div id="chats-chat-information" class="resource"><h3 class="resource-heading">Chat information <a href="#chats-chat-information" class="permalink">&nbsp;&para;</a></h3><div id="chats-chat-information-get" class="action get"><h4 class="action-heading"><div class="name">Get chat information</div><a href="#chats-chat-information-get" class="method get">GET</a><code class="uri">/networks/{network}/chats/{chat}</code></h4><h4>Example URI</h4><div class="definition"><span class="method get">GET</span>&nbsp;<span class="uri"><span class="hostname"></span>/networks/<span class="hljs-attribute" title="network">quakenet</span>/chats/<span class="hljs-attribute" title="chat">dmdirc</span></span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>network</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>quakenet</span></span><p>The name of the network.</p>
  12. </dd><dt>chat</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>dmdirc</span></span><p>The name of the chat.</p>
  13. </dd></dl></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>404</code></strong></div></div><div id="chats-chat-information-delete" class="action delete"><h4 class="action-heading"><div class="name">Delete chat</div><a href="#chats-chat-information-delete" class="method delete">DELETE</a><code class="uri">/networks/{network}/chats/{chat}</code></h4><h4>Example URI</h4><div class="definition"><span class="method delete">DELETE</span>&nbsp;<span class="uri"><span class="hostname"></span>/networks/<span class="hljs-attribute" title="network">quakenet</span>/chats/<span class="hljs-attribute" title="chat">dmdirc</span></span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>network</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>quakenet</span></span><p>The name of the network.</p>
  14. </dd><dt>chat</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>dmdirc</span></span><p>The name of the chat.</p>
  15. </dd></dl></div><div class="title"><strong>Response&nbsp;&nbsp;<code>204</code></strong></div><div class="title"><strong>Response&nbsp;&nbsp;<code>404</code></strong></div></div></div><div id="chats-chat-messages" class="resource"><h3 class="resource-heading">Chat messages <a href="#chats-chat-messages" class="permalink">&nbsp;&para;</a></h3><div id="chats-chat-messages-get" class="action get"><h4 class="action-heading"><div class="name">Get chat messages</div><a href="#chats-chat-messages-get" class="method get">GET</a><code class="uri">/networks/{network}/chats/{chat}/messages</code></h4><h4>Example URI</h4><div class="definition"><span class="method get">GET</span>&nbsp;<span class="uri"><span class="hostname"></span>/networks/<span class="hljs-attribute" title="network">quakenet</span>/chats/<span class="hljs-attribute" title="chat">dmdirc</span>/messages</span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>network</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>quakenet</span></span><p>The name of the network.</p>
  16. </dd><dt>chat</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>dmdirc</span></span><p>The name of the chat.</p>
  17. </dd></dl></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>404</code></strong></div></div><div id="chats-chat-messages-post" class="action post"><h4 class="action-heading"><div class="name">Send chat message</div><a href="#chats-chat-messages-post" class="method post">POST</a><code class="uri">/networks/{network}/chats/{chat}/messages</code></h4><h4>Example URI</h4><div class="definition"><span class="method post">POST</span>&nbsp;<span class="uri"><span class="hostname"></span>/networks/<span class="hljs-attribute" title="network">quakenet</span>/chats/<span class="hljs-attribute" title="chat">dmdirc</span>/messages</span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>network</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>quakenet</span></span><p>The name of the network.</p>
  18. </dd><dt>chat</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>dmdirc</span></span><p>The name of the chat.</p>
  19. </dd></dl></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>400</code></strong></div><div class="title"><strong>Response&nbsp;&nbsp;<code>404</code></strong></div></div></div><div id="chats-chat-users" class="resource"><h3 class="resource-heading">Chat users <a href="#chats-chat-users" class="permalink">&nbsp;&para;</a></h3><div id="chats-chat-users-get" class="action get"><h4 class="action-heading"><div class="name">List chat users</div><a href="#chats-chat-users-get" class="method get">GET</a><code class="uri">/networks/{network}/chats/{chat}/users</code></h4><h4>Example URI</h4><div class="definition"><span class="method get">GET</span>&nbsp;<span class="uri"><span class="hostname"></span>/networks/<span class="hljs-attribute" title="network">quakenet</span>/chats/<span class="hljs-attribute" title="chat">dmdirc</span>/users</span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>network</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>quakenet</span></span><p>The name of the network.</p>
  20. </dd><dt>chat</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>dmdirc</span></span><p>The name of the chat.</p>
  21. </dd></dl></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>404</code></strong></div></div></div></section></div></div></div><p style="text-align: center;" class="text-muted">Generated by&nbsp;<a href="https://github.com/danielgtaylor/aglio" class="aglio">aglio</a>&nbsp;on 07 May 2018</p><script>/* eslint-env browser */
  22. /* eslint quotes: [2, "single"] */
  23. 'use strict';
  24. /*
  25. Determine if a string ends with another string.
  26. */
  27. function endsWith(str, suffix) {
  28. return str.indexOf(suffix, str.length - suffix.length) !== -1;
  29. }
  30. /*
  31. Get a list of direct child elements by class name.
  32. */
  33. function childrenByClass(element, name) {
  34. var filtered = [];
  35. for (var i = 0; i < element.children.length; i++) {
  36. var child = element.children[i];
  37. var classNames = child.className.split(' ');
  38. if (classNames.indexOf(name) !== -1) {
  39. filtered.push(child);
  40. }
  41. }
  42. return filtered;
  43. }
  44. /*
  45. Get an array [width, height] of the window.
  46. */
  47. function getWindowDimensions() {
  48. var w = window,
  49. d = document,
  50. e = d.documentElement,
  51. g = d.body,
  52. x = w.innerWidth || e.clientWidth || g.clientWidth,
  53. y = w.innerHeight || e.clientHeight || g.clientHeight;
  54. return [x, y];
  55. }
  56. /*
  57. Collapse or show a request/response example.
  58. */
  59. function toggleCollapseButton(event) {
  60. var button = event.target.parentNode;
  61. var content = button.parentNode.nextSibling;
  62. var inner = content.children[0];
  63. if (button.className.indexOf('collapse-button') === -1) {
  64. // Clicked without hitting the right element?
  65. return;
  66. }
  67. if (content.style.maxHeight && content.style.maxHeight !== '0px') {
  68. // Currently showing, so let's hide it
  69. button.className = 'collapse-button';
  70. content.style.maxHeight = '0px';
  71. } else {
  72. // Currently hidden, so let's show it
  73. button.className = 'collapse-button show';
  74. content.style.maxHeight = inner.offsetHeight + 12 + 'px';
  75. }
  76. }
  77. function toggleTabButton(event) {
  78. var i, index;
  79. var button = event.target;
  80. // Get index of the current button.
  81. var buttons = childrenByClass(button.parentNode, 'tab-button');
  82. for (i = 0; i < buttons.length; i++) {
  83. if (buttons[i] === button) {
  84. index = i;
  85. button.className = 'tab-button active';
  86. } else {
  87. buttons[i].className = 'tab-button';
  88. }
  89. }
  90. // Hide other tabs and show this one.
  91. var tabs = childrenByClass(button.parentNode.parentNode, 'tab');
  92. for (i = 0; i < tabs.length; i++) {
  93. if (i === index) {
  94. tabs[i].style.display = 'block';
  95. } else {
  96. tabs[i].style.display = 'none';
  97. }
  98. }
  99. }
  100. /*
  101. Collapse or show a navigation menu. It will not be hidden unless it
  102. is currently selected or `force` has been passed.
  103. */
  104. function toggleCollapseNav(event, force) {
  105. var heading = event.target.parentNode;
  106. var content = heading.nextSibling;
  107. var inner = content.children[0];
  108. if (heading.className.indexOf('heading') === -1) {
  109. // Clicked without hitting the right element?
  110. return;
  111. }
  112. if (content.style.maxHeight && content.style.maxHeight !== '0px') {
  113. // Currently showing, so let's hide it, but only if this nav item
  114. // is already selected. This prevents newly selected items from
  115. // collapsing in an annoying fashion.
  116. if (force || window.location.hash && endsWith(event.target.href, window.location.hash)) {
  117. content.style.maxHeight = '0px';
  118. }
  119. } else {
  120. // Currently hidden, so let's show it
  121. content.style.maxHeight = inner.offsetHeight + 12 + 'px';
  122. }
  123. }
  124. /*
  125. Refresh the page after a live update from the server. This only
  126. works in live preview mode (using the `--server` parameter).
  127. */
  128. function refresh(body) {
  129. document.querySelector('body').className = 'preload';
  130. document.body.innerHTML = body;
  131. // Re-initialize the page
  132. init();
  133. autoCollapse();
  134. document.querySelector('body').className = '';
  135. }
  136. /*
  137. Determine which navigation items should be auto-collapsed to show as many
  138. as possible on the screen, based on the current window height. This also
  139. collapses them.
  140. */
  141. function autoCollapse() {
  142. var windowHeight = getWindowDimensions()[1];
  143. var itemsHeight = 64; /* Account for some padding */
  144. var itemsArray = Array.prototype.slice.call(
  145. document.querySelectorAll('nav .resource-group .heading'));
  146. // Get the total height of the navigation items
  147. itemsArray.forEach(function (item) {
  148. itemsHeight += item.parentNode.offsetHeight;
  149. });
  150. // Should we auto-collapse any nav items? Try to find the smallest item
  151. // that can be collapsed to show all items on the screen. If not possible,
  152. // then collapse the largest item and do it again. First, sort the items
  153. // by height from smallest to largest.
  154. var sortedItems = itemsArray.sort(function (a, b) {
  155. return a.parentNode.offsetHeight - b.parentNode.offsetHeight;
  156. });
  157. while (sortedItems.length && itemsHeight > windowHeight) {
  158. for (var i = 0; i < sortedItems.length; i++) {
  159. // Will collapsing this item help?
  160. var itemHeight = sortedItems[i].nextSibling.offsetHeight;
  161. if ((itemsHeight - itemHeight <= windowHeight) || i === sortedItems.length - 1) {
  162. // It will, so let's collapse it, remove its content height from
  163. // our total and then remove it from our list of candidates
  164. // that can be collapsed.
  165. itemsHeight -= itemHeight;
  166. toggleCollapseNav({target: sortedItems[i].children[0]}, true);
  167. sortedItems.splice(i, 1);
  168. break;
  169. }
  170. }
  171. }
  172. }
  173. /*
  174. Initialize the interactive functionality of the page.
  175. */
  176. function init() {
  177. var i, j;
  178. // Make collapse buttons clickable
  179. var buttons = document.querySelectorAll('.collapse-button');
  180. for (i = 0; i < buttons.length; i++) {
  181. buttons[i].onclick = toggleCollapseButton;
  182. // Show by default? Then toggle now.
  183. if (buttons[i].className.indexOf('show') !== -1) {
  184. toggleCollapseButton({target: buttons[i].children[0]});
  185. }
  186. }
  187. var responseCodes = document.querySelectorAll('.example-names');
  188. for (i = 0; i < responseCodes.length; i++) {
  189. var tabButtons = childrenByClass(responseCodes[i], 'tab-button');
  190. for (j = 0; j < tabButtons.length; j++) {
  191. tabButtons[j].onclick = toggleTabButton;
  192. // Show by default?
  193. if (j === 0) {
  194. toggleTabButton({target: tabButtons[j]});
  195. }
  196. }
  197. }
  198. // Make nav items clickable to collapse/expand their content.
  199. var navItems = document.querySelectorAll('nav .resource-group .heading');
  200. for (i = 0; i < navItems.length; i++) {
  201. navItems[i].onclick = toggleCollapseNav;
  202. // Show all by default
  203. toggleCollapseNav({target: navItems[i].children[0]});
  204. }
  205. }
  206. // Initial call to set up buttons
  207. init();
  208. window.onload = function () {
  209. autoCollapse();
  210. // Remove the `preload` class to enable animations
  211. document.querySelector('body').className = '';
  212. };
  213. </script></body></html>