api-docs/roadmap.html at gh-pages · itsbspoke/api-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
---
layout: default
section: roadmap
---

<header class="jumbotron subhead" id="overview">
    <h1>Roadmap</h1>
    <p class="lead">What to expect in the future.</p>
    <!-- Instrument this in analytics -->
    <div class="subnav">
      <ul class="nav nav-pills">
        <li><a href="#todo">To-Do List</a></li>
      </ul>
    </div>

</header>

<section id="todo">
  <div class="page-header">
    <h1>To-Do List  <small>to consider API documentation and attendant services complete.</small></h1>
  </div>
  <div class="row">
    <div class="span12">
      <ul>
        <li>For post endpoints, include a helper that indicates when they did not actually post anything. (two tokens, one for dev?)</li>
        <li>Require SSL for the create and email auth endpoints</li>
        <li>Ensure we disallow inappropriate Pusher connections (e.g. you are not in the group, demo event)</li>
        <li>Ensure preroll presence means "run it"</li>
        <li>Move 'mandatory' to item-by-item basis in preroll instead of all or nothing.</li>
        <li>Get DJ Mute reflected in event message data so that it can be removed from history</li>
      </ul>
      <h3>Far future</h3>
      <ul>
        <li>Add API tokens</li>
        <li>Ensure API token mechanism provides actual security</li>
        <li>Replace Jim Van Fleet with a non-admin in the examples.</li>
        <li>Speak XML</li>
        <li>Speak other languages in error messages</li>
        <li>Live event listing into favorites (broadcasters), featured (customers + OS), and local (based on user input)</li>
        <li>Replace event messages with a version that includes announcement history-- expandable to images, poll results, etc. -- scaling chat prelude</li>
      </ul>
    <div><!-- /.span -->
  </div><!-- /.row -->
</section>

<section id="coming-soon">
  <div class="page-header">
    <h1>Coming soon  <small>endpoints that will not be a part of 1.0.</small></h1>
  </div>
  <div class="row">
    <div class="span12">
      <table class="table table-bordered table-striped">
        <thead>
          <tr>
            <th>API Call</th>
            <th>Documentation stub</th>
            <th>Implementation stub</th>
            <th>JSON finalized</th>
            <th>Implementation finalized/tested</th>
            <th>Documentation complete</th>
            <th>Added to glossary</th>
          </tr>
         </thead>
         <tbody>
           <tr>
             <td><a href="reference/authentication.html#twitter">Login with Twitter</a></td>
            <td>✔</td>
            <td>✘</td>
            <td>✘</td>
            <td>✘</td>
            <td>✘</td>
            <td>✘</td>
           </tr>
           <tr>
             <td><a href="reference/live-events.html#tweet-chat">Tweet a chat</a></td>
            <td>✔</td>
            <td>✘</td>
            <td>✘</td>
            <td>✘</td>
            <td>✘</td>
            <td>✘</td>
           </tr>
           <tr>
            <td><a href="reference/users.html#facebook-invite">Invite a new user via Facebook</a></td>
            <td>✘</td>
            <td>✔</td>
            <td>✘</td>
            <td>✘</td>
            <td>✘</td>
            <td>✘</td>
           </tr>
           <tr>
            <td><a href="reference/users.html#twitter-invite">Invite a new user via Twitter</a></td>
            <td>✘</td>
            <td>✔</td>
            <td>✘</td>
            <td>✘</td>
            <td>✘</td>
            <td>✘</td>
           </tr>
         </tbody>
      </table>
    </div><!-- /.span -->
  </div><!-- /.row -->

</section>