chat.go/public/index.html

<!DOCTYPE html>
<html>
  <head><title>API Docs</title></head>
  <body>
    <h1>Sample Chat - API Docs</h1>


    <h2>Login</h2>
    <ul>
    <li>
    <h3>POST /api/sessions
    <br>
    <code>{"sub":"<strong><em>&lt;email&gt;</em></strong>"}</code>
    </h3>
    <pre><code># Ask for an auth code (swap sub)

curl -X POST http://localhost:4080/api/sessions \
  -H 'Content-Type: application/json; charset=utf-8' \
  -d '{"sub":"<strong><em>jon@example.com</em></strong>"}'
    </code></pre>
    </li>

    <li>
    <h3>POST /api/sessions/<strong><em>&lt;id&gt;</em></strong>
    <br>
    <code>{"otp":"<strong><em>&lt;auth-code&gt;</em></strong>"}</code>
    </h3>
    <pre><code># Validate auth code (swap session id, sub, and otp)

curl -X POST http://localhost:4080/api/sessions/<strong><em>xyz</em></strong> \
  -H 'Content-Type: application/json; charset=utf-8' \
  -d '{"otp":"<strong><em>secret123</em></strong>"}'
    </code></pre>
    </li>
    </ul>

    <h2>Messages</h2>
    <ul>
    <li>
    <h3>POST /api/rooms/general
    <br>
    <code>Authorization: Bearer <strong><em>&lt;api-token&gt;</em></strong>
    <br>{"message":"<strong><em>&lt;msg&gt;</em></strong>"}</code>
    </h3>
    <pre><code># Post a message (swap api-token)

curl -X POST http://localhost:4080/api/rooms/general \
  -H 'Authorization: Bearer <strong><em>api-token</em></strong>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -d '{"message":"Hello, World!"}'
    </code></pre>
    </li>

    <li>
    <h3>GET /api/rooms/general
    <br>
    <code>Authorization: Bearer <strong><em>&lt;api-token&gt;</em></strong></code>
    </h3>
    <pre><code># Get a room's messages (swap api-token, since unix-epoch)

curl http://localhost:4080/api/rooms/general \
  -H 'Authorization: Bearer <strong><em>api-token</em></strong>'
    </code></pre>
    </li>
    </ul>
  </body>
</html>
go go restful static server, mighty restful static server! 2018-07-31 01:44:45 -06:00			`<!DOCTYPE html>`
			`<html>`
update docs 2018-08-02 11:28:05 -06:00			`<head><title>API Docs</title></head>`
go go restful static server, mighty restful static server! 2018-07-31 01:44:45 -06:00			`<body>`
update docs 2018-08-02 11:28:05 -06:00			`<h1>Sample Chat - API Docs</h1>`


			`<h2>Login</h2>`
			`<ul>`
			`<li>`
			`<h3>POST /api/sessions`
			`<br>`
update docs 2018-08-02 11:33:47 -06:00			`<code>{"sub":"<strong><em><email></em></strong>"}</code>`
update docs 2018-08-02 11:28:05 -06:00			`</h3>`
go go restful static server, mighty restful static server! 2018-07-31 01:44:45 -06:00			`<pre><code># Ask for an auth code (swap sub)`
update docs 2018-08-02 11:28:05 -06:00
feature complete!! (for the time spend I have for now) 2018-08-01 19:13:10 -06:00			`curl -X POST http://localhost:4080/api/sessions \`
go go restful static server, mighty restful static server! 2018-07-31 01:44:45 -06:00			`-H 'Content-Type: application/json; charset=utf-8' \`
even more cleanup 2018-08-02 02:13:56 -06:00			`-d '{"sub":"<strong><em>jon@example.com</em></strong>"}'`
update docs 2018-08-02 11:28:05 -06:00			`</code></pre>`
			`</li>`

			`<li>`
update docs 2018-08-02 11:33:47 -06:00			`<h3>POST /api/sessions/<strong><em><id></em></strong>`
update docs 2018-08-02 11:28:05 -06:00			`<br>`
update docs 2018-08-02 11:33:47 -06:00			`<code>{"otp":"<strong><em><auth-code></em></strong>"}</code>`
update docs 2018-08-02 11:28:05 -06:00			`</h3>`
			`<pre><code># Validate auth code (swap session id, sub, and otp)`
go go restful static server, mighty restful static server! 2018-07-31 01:44:45 -06:00
even more cleanup 2018-08-02 02:13:56 -06:00			`curl -X POST http://localhost:4080/api/sessions/<strong><em>xyz</em></strong> \`
go go restful static server, mighty restful static server! 2018-07-31 01:44:45 -06:00			`-H 'Content-Type: application/json; charset=utf-8' \`
even more cleanup 2018-08-02 02:13:56 -06:00			`-d '{"otp":"<strong><em>secret123</em></strong>"}'`
update docs 2018-08-02 11:28:05 -06:00			`</code></pre>`
			`</li>`
			`</ul>`

			`<h2>Messages</h2>`
			`<ul>`
			`<li>`
			`<h3>POST /api/rooms/general`
			`<br>`
update docs 2018-08-02 11:33:47 -06:00			`<code>Authorization: Bearer <strong><em><api-token></em></strong>`
			`<br>{"message":"<strong><em><msg></em></strong>"}</code>`
update docs 2018-08-02 11:28:05 -06:00			`</h3>`
			`<pre><code># Post a message (swap api-token)`
go go restful static server, mighty restful static server! 2018-07-31 01:44:45 -06:00
feature complete!! (for the time spend I have for now) 2018-08-01 19:13:10 -06:00			`curl -X POST http://localhost:4080/api/rooms/general \`
even more cleanup 2018-08-02 02:13:56 -06:00			`-H 'Authorization: Bearer <strong><em>api-token</em></strong>' \`
go go restful static server, mighty restful static server! 2018-07-31 01:44:45 -06:00			`-H 'Content-Type: application/json; charset=utf-8' \`
even more cleanup 2018-08-02 02:13:56 -06:00			`-d '{"message":"Hello, World!"}'`
update docs 2018-08-02 11:28:05 -06:00			`</code></pre>`
			`</li>`

			`<li>`
			`<h3>GET /api/rooms/general`
			`<br>`
update docs 2018-08-02 11:33:47 -06:00			`<code>Authorization: Bearer <strong><em><api-token></em></strong></code>`
update docs 2018-08-02 11:28:05 -06:00			`</h3>`
			`<pre><code># Get a room's messages (swap api-token, since unix-epoch)`
go go restful static server, mighty restful static server! 2018-07-31 01:44:45 -06:00
update docs 2018-08-02 11:28:05 -06:00			`curl http://localhost:4080/api/rooms/general \`
even more cleanup 2018-08-02 02:13:56 -06:00			`-H 'Authorization: Bearer <strong><em>api-token</em></strong>'`
go go restful static server, mighty restful static server! 2018-07-31 01:44:45 -06:00			`</code></pre>`
update docs 2018-08-02 11:28:05 -06:00			`</li>`
			`</ul>`
go go restful static server, mighty restful static server! 2018-07-31 01:44:45 -06:00			`</body>`
			`</html>`