api_docs.html

{% extends "layouts/public_base.html" %}

{% block page_title %}API{% endblock %}

{% block extra_stylesheets %}
<!-- get Swagger UI css -->
    <link href='/static/vendor/swagger-ui/src/main/html/css/reset.css' media='screen' rel='stylesheet' type='text/css'/>
    <link href='/static/vendor/swagger-ui/src/main/html/css/screen.css' media='screen' rel='stylesheet' type='text/css'/>
    <link href='/static/vendor/swagger-ui/src/main/html/css/reset.css' media='print' rel='stylesheet' type='text/css'/>
    <link href='/static/vendor/swagger-ui/src/main/html/css/print.css' media='print' rel='stylesheet' type='text/css'/>

<!-- get DOAJ swagger overrides -->
    <link href='/static/doaj/css/doaj_api.css' media='screen' rel='stylesheet' type='text/css' />
{% endblock %}

{% block content %}
    <div class="container page-content">
        <div class="row">
            <div class="col-md-4 col-md-push-8">
                {# todo: this nav was bumping into swagger
              <nav class="page-nav" data-spy="affix">

                <h2 class="page-nav__heading">Jump to:</h2>
                <ul class="page-nav__list">
                    <li class="page-nav__item item-h2"><a href="#intro_auth">Using this live documentation page</a></li>
                    <li class="page-nav__item item-h2"><a href="#intro_help">Help and support</a></li>
                    <li class="page-nav__item item-h2"><a href='#swagger-section'>Try it out!</a></li>
                    <li class="page-nav__item item-h2"><a href="#search_api">Search API</a></li>
                    <ul class="page-nav__sublist">
                        <li class="page-nav__item item-h3"><a href="#query_syntax">Query string syntax</a></li>
                        <li class="page-nav__item item-h3"><a href="#default_query_operator">Default handling of phrases</a></li>
                        <li class="page-nav__item item-h3"><a href="#specific_field_search">Searching inside a specific field</a></li>
                        <li class="page-nav__item item-h3"><a href="#special_characters">Special characters</a></li>
                        <li class="page-nav__item item-h3"><a href="#short_field_names">Short field names</a></li>
                        <li class="page-nav__item item-h3"><a href="#sorting">Sorting of results</a></li>
                        <li class="page-nav__item item-h3"><a href="#query_string_advanced_usage">The query string - advanced usage</a></li>
                    </ul>
                    <li class="page-nav__item item-h2"><a href="#crud_api">CRUD API</a></li>
                    <ul class="page-nav__sublist">
                        <li class="page-nav__item item-h3"><a href="#creating_articles">Creating articles</a></li>
                        <li class="page-nav__item item-h3"><a href="#update_requests">Applications - Update Requests</a></li>
                    </ul>

                </ul>
              </nav>
                #}
            </div>

            <div class="col-md-8 col-md-pull-4">
                <section>
                    <p class="label">Docs</p>
                    <h1>API </h1>
                    {% include "api/current/swagger_description.html" %}
                    <div id="swagger-section" class="swagger-section">
                        <div id="swagger-ui-container" class="swagger-ui-wrap"></div>
                    </div>
                    {% include "api/current/extra_docs.html" %}
                </section>
            </div>
        </div>
    </div>
{% endblock %}

{% block extra_js_bottom %}
<!--get Swagger UI's javascripts -->
<script src='/static/vendor/swagger-ui/lib/jquery-1.8.0.min.js' type='text/javascript'></script>
<script src='/static/vendor/swagger-ui/lib/jquery.slideto.min.js' type='text/javascript'></script>
<script src='/static/vendor/swagger-ui/lib/jquery.wiggle.min.js' type='text/javascript'></script>
<script src='/static/vendor/swagger-ui/lib/jquery.ba-bbq.min.js' type='text/javascript'></script>
<script src='/static/vendor/swagger-ui/lib/handlebars-2.0.0.js' type='text/javascript'></script>
<script src='/static/vendor/swagger-ui/lib/underscore-min.js' type='text/javascript'></script>
<script src='/static/vendor/swagger-ui/lib/backbone-min.js' type='text/javascript'></script>
<script src='/static/vendor/swagger-ui/dist/swagger-ui.js' type='text/javascript'></script>
<script src='/static/vendor/swagger-ui/lib/highlight.7.3.pack.js' type='text/javascript'></script>
<script src='/static/vendor/swagger-ui/lib/marked.js' type='text/javascript'></script>
<script src='/static/vendor/swagger-ui/lib/swagger-oauth.js' type='text/javascript'></script>

<script type="text/javascript">
    $(function () {
      var url = current_scheme + '//' + current_domain + "/api/swagger.json";
      console.log(url);
      window.swaggerUi = new SwaggerUi({
        url: url,
        validatorUrl: null,
        docExpansion: 'list',
        dom_id: "swagger-ui-container",
        supportedSubmitMethods: ['get', 'post', 'put', 'delete'],
        onComplete: function(swaggerApi, swaggerUi){
          $('pre code').each(function(i, e) {
            hljs.highlightBlock(e)
          });
        },
        onFailure: function(data) {
          log("Unable to Load SwaggerUI");
        },
        apisSorter: "alpha",
        showRequestHeaders: false
      });

      window.swaggerUi.load();

      function log() {
        if ('console' in window) {
          console.log.apply(console, arguments);
        }
      }
  });
  </script>
{% endblock %}