aboutsummaryrefslogtreecommitdiffstats
path: root/3rd_party/static/swagger/endpoint.html
blob: 8f3c43a90e277b2e177709b82753da32a7b46cb0 (plain)
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
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Api Docs for {{path}}</title>
    <link rel="stylesheet" href="//netdna.bootstrapcdn.com/bootstrap/3.0.3/css/bootstrap.min.css">
    <style>
      body {margin-top: 60px;}
    </style>
  </head>
  <body>
    <nav class="navbar navbar-inverse navbar-fixed-top" role="navigation">
      <div class="container">
        <div class="navbar-header">
          <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-ex1-collapse">
            <span class="sr-only">Toggle navigation</span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
          </button>
        </div>
        <!-- Collect the nav links, forms, and other content for toggling -->
        <div class="collapse navbar-collapse navbar-ex1-collapse">
          <ul class="nav navbar-nav">
            {% for operation in operations %}
              <li><a href="#{{operation.method}}">{{operation.method}}</a></li>
            {% endfor %}
          </ul>
        </div><!-- /.navbar-collapse -->
      </div><!-- /.container -->
    </nav>
    <div class="container">
      <div class="row">
        <div class="col-lg-12">
          <h1>{{path}}</h1>
          <p class='lead'>{{description if description != None}}</p>
        </div>
        <div class="col-lg-12">
        {% for operation in operations %}
          <div class="panel panel-success" id='{{operation.method}}'>
            <div class="panel-heading">
              <h3 class="panel-title">{{operation.method}}</h3>
              <p>{{operation.summary if operation.summary != None}}</p>
            </div>
            <div class="panel-body">
              {% if operation.parameters %}
                <h4>Parameters</h4>
                <dl>
                  {% for parameter in operation.parameters %}
                    <dt>
                      {{parameter.name}}
                      {% if parameter.description %}
                        - {{parameter.description}}
                      {% endif %}
                    </dt>
                    <dd>Type: {{parameter.dataType}}</dd>
                    <dd>Allow Multiple: {{parameter.allowMultiple}}</dd>
                    <dd>Required: {{parameter.required}}</dd>
                  {% endfor %}
                </dl>
              {% endif %}
              {% if operation.notes %}
                <p><strong>Implementation notes</strong>: {{operation.notes}}</p>
              {% endif %}
              {% if operation.responseClass %}
                <p><strong>Response Class</strong>: {{operation.responseClass}}</p>
              {% endif %}
            </div>
          </div>
        {% endfor %}
      </div>
      </div>
    </div><!-- /.container -->
    <script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.0.3/jquery.min.js"></script>
    <script src="//netdna.bootstrapcdn.com/bootstrap/3.0.3/js/bootstrap.min.js"></script>
  </body>
</html>