bountysource.github.io/index.html at master · bountysource/bountysource.github.io · 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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
<!DOCTYPE html>
<html lang="en" xmlns:ng="http://angularjs.org">
  <head>
    <meta charset=utf-8 />
    <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1" />
    <link rel="stylesheet" href="components/bootstrap/dist/css/bootstrap.min.css" />
    <link rel="stylesheet" href="components/highlightjs/styles/github.css" />
    <link rel="stylesheet" href="style.css" />

    <title>Bountysource API documentation</title>
  </head>

  <body ng-controller="RamlViewCtrl" class="container">

    <!-- Navbar -->
    <div class="navbar navbar-default navbar-fixed-top">
      <div class="container">
        <div class="navbar-header">
          <a class="navbar-brand" href="/">Bountysource API</a>
        </div>

        <div class="collapse navbar-collapse">
          <ul class="nav navbar-nav">
            <li>
              <a class="dropdown-toggle" href="#">Methods <b class="caret"></b></a>
              <ul class="dropdown-menu">
                <li ng-repeat="(path, data) in api.routes" ng-if="data.displayName">
                  <a ng-click="scrollTo(data.displayName)">{{data.displayName}}</a>
                </li>
              </ul>
            </li>
            <li><a ng-click="scrollTo('overview')" style="cursor: pointer;">Overview</a></li>
            <li><a ng-click="scrollTo('contributing')" style="cursor: pointer;">Contributing</a></li>
          </ul>
        </div>
      </div>
    </div>

    <!-- Fork on GitHub button -->
    <a href="https://github.com/bountysource/bountysource.github.io" class="hidden-xs">
      <img style="position: absolute; right: 0; border: 0;" src="https://github-camo.global.ssl.fastly.net/e7bbb0521b397edbd5fe43e7f760759336b5e05f/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f677265656e5f3030373230302e706e67" alt="Fork me on GitHub" data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_green_007200.png">
    </a>

    <div class="page-header">
      <h1>
        <img class="img-responsive img-thumbnail hidden-xs" src="logo.png" />
        Bountysource API Docs
        <small ng-if="api.version">{{api.version}}</small>
      </h1>
    </div>

    <section id="overview">
      <h2>Overview</h2>
      <hr />
      <p><a href="{{api.baseUri">{{api.baseUri}}</a></p>

      <p>This API allows you to interact with bounties for
      issues on open source projects as well as open source
      fundraisers. Routes can have the following traits. Here
      is more information about what information the traits
      provide and how to use them.</p>
    </section>

    <br />

    <section id="contributing">
      <h2>Contributing</h2>
      <hr />
      <p>This documentation is generated from a <a
      href="http://raml.org">RAML</a> definition.  If you would
      like to propose an API change, update
      <a href="https://github.com/bountysource/bountysource.github.io/blob/master/bountysource.raml"
      >the spec</a> and submit a pull request.</p>
    </section>

    <br />

    <section id="traits">
      <!--<pre>{{api.traits | json}}</pre>-->

      <!--<ul ng-repeat="(name, t) in traits">-->
        <!--<li>-->
          <!--<h3 id="{{name}}">{{name}}</h3>-->
          <!--<parameters-->
            <!--title="'Query Parameters'"-->
            <!--params="t.queryParameters"-->
            <!--ng-if="t.queryParameters"></parameters>-->
          <!--<parameters-->
            <!--title="'Request Headers'"-->
            <!--params="t.headers"-->
            <!--ng-if="t.headers"></parameters>-->

          <!--<div class="responses" ng-if="t.responses">-->
            <!--<div ng-repeat="(code, resp) in t.responses">-->
              <!--<parameters-->
                <!--title="'Response Headers'"-->
                <!--params="resp.headers"-->
                <!--ng-if="resp.headers"></parameters>-->
            <!--</div>-->
          <!--</div>-->
        <!--</li>-->
      <!--</ul>-->
    </section>

    <section id="routes">
      <div ng-repeat="(path, data) in api.routes" id="{{data.displayName}}">
        <h2>{{data.displayName}}</h2>

        <p class="lead">{{data.description}}</p>

        <!-- HTTP Methods, request params -->
        <div ng-repeat="(requestMethod, requestData) in data" ng-if="httpMethods.indexOf(requestMethod.toLowerCase()) >= 0">
          <pre>{{requestMethod.toUpperCase()}} {{path}}</pre>

          <ul class="list-inline">
            <li ng-repeat="trait in data.is">
              <span class="label label-info">{{trait}}</span>
            </li>
          </ul>

          <br />

          <div ng-if="requestData.queryParameters">
            <h5>Parameters</h5>
            <table class="table table-condensed table-bordered">
              <thead>
              <tr>
                <th>Name</th>
                <th>Type</th>
                <th>Description</th>
              </tr>
              </thead>

              <tbody>
              <tr ng-repeat="(paramName, paramData) in requestData.queryParameters">
                <td>{{paramName}}</td>
                <td>{{paramData.type}}</td>
                <td>{{paramData.description}}</td>
              </tr>
              </tbody>
            </table>
          </div>

          <!-- Possible values for params, if they have an enum set -->
          <div ng-repeat="(paramName, paramData) in requestData.queryParameters" ng-if="paramData.enum">
            <strong>Values for {{paramName}}:</strong>
            <ul class="list-unstyled">
              <li ng-repeat="paramValue in paramData.enum">
                <code>{{paramValue}}</code>
              </li>
            </ul>
          </div>

          <!-- Responses -->
          <div ng-show="requestData.responses">
            <div ng-repeat="(responseCode, responseData) in requestData.responses">
              <div class="panel panel-default">
                <div class="panel-heading">
                  <span class="code">Status: {{responseCode}}</span>
                </div>
                <div hljs source="'{{responseData.body.example}}'" language="json"></div>
              </div>

            </div>
          </div>
        </div>

        <br ng-if="!$last" />
      </div>
    </section>

    <script data-main="main" src="components/requirejs/require.js"></script>
  </body>
</html>