From 5692b7e9245ee0b568a1c5645c0eea42d438705d Mon Sep 17 00:00:00 2001
From: Pierre-Yves Chibon <pingou@pingoured.fr>
Date: Jan 26 2016 14:01:08 +0000
Subject: [PATCH 1/5] Include the API version in the API documentation


---

diff --git a/pagure/api/__init__.py b/pagure/api/__init__.py
index 01fd81b..90fd90c 100644
--- a/pagure/api/__init__.py
+++ b/pagure/api/__init__.py
@@ -449,6 +449,7 @@ def api():
 
     return flask.render_template(
         'api.html',
+        version=__api_version__,
         api_doc=APIDOC,
         projects=[
             api_git_tags_doc,

From 93dd141d19ba84dee970841e212d6e162899aba4 Mon Sep 17 00:00:00 2001
From: Pierre-Yves Chibon <pingou@pingoured.fr>
Date: Jan 26 2016 14:01:51 +0000
Subject: [PATCH 2/5] Give some space to some of the values in the API documentation


---

diff --git a/pagure/doc/api.rst b/pagure/doc/api.rst
index 39db019..f4fe072 100644
--- a/pagure/doc/api.rst
+++ b/pagure/doc/api.rst
@@ -23,11 +23,15 @@ Request Encoding
 ~~~~~~~~~~~~~~~~
 
 The payload of POST and GET requests is encoded as
+
 ``application/x-www-form-urlencoded``.
 
+
 This is an example URL of a GET request:
+
 ``https://pagure.io/api/0/test/issues?status=Open&tags=Pagure&tags=Enhancement``
 
+
 Return Encoding
 ~~~~~~~~~~~~~~~
 

From 562e035d0d39b599ebc385abd7febf1bd0373e2f Mon Sep 17 00:00:00 2001
From: Pierre-Yves Chibon <pingou@pingoured.fr>
Date: Jan 26 2016 14:01:59 +0000
Subject: [PATCH 3/5] Add the collapse-down glyph to the title in the API doc


This to highlight that the title are clickable and provide more info

---

diff --git a/pagure/ui/filters.py b/pagure/ui/filters.py
index 2db2fce..cd3ef51 100644
--- a/pagure/ui/filters.py
+++ b/pagure/ui/filters.py
@@ -345,6 +345,12 @@ def insert_div(content):
     for row in content:
         if row.startswith('<div class="document" id='):
             continue
+        if '<h1 class="title">' in row:
+            row = str(row).replace(
+                '<h1 class="title">',
+                '<h1 class="title">'
+                '<span class="oi" data-glyph="collapse-down"></span> &nbsp;'
+            )
         output.append(row)
     output = "\n".join(output)
     output = output.replace('</h1>', '</h1>\n<div>', 1)

From 85af2ef5d5bb39309c40f09d93947c178ec82136 Mon Sep 17 00:00:00 2001
From: Pierre-Yves Chibon <pingou@pingoured.fr>
Date: Jan 26 2016 14:02:32 +0000
Subject: [PATCH 4/5] Rework the API documentation page to port it to the new UI


---

diff --git a/pagure/static/pagure.css b/pagure/static/pagure.css
index 36eb6c2..73d9e5d 100644
--- a/pagure/static/pagure.css
+++ b/pagure/static/pagure.css
@@ -384,3 +384,11 @@ color:#aaa;
   background:#eee;
   border:1px solid #ccc;
 }
+
+.api code {
+  padding: 0rem 0.4rem;
+}
+
+.api h3 {
+  padding-left: 1em;
+}
diff --git a/pagure/templates/api.html b/pagure/templates/api.html
index 629e5c2..f7a8206 100644
--- a/pagure/templates/api.html
+++ b/pagure/templates/api.html
@@ -5,117 +5,134 @@
 {% set tag = "index" %}
 
 {% block content %}
-
-<h1 class="title">Pagure API Reference</h1>
-<p>This documentation describes the Pagure API v0.</p>
-
-{{ api_doc |replace('h1', 'h2') }}
-
-<h1>List of the API endpoints:</h1>
-
-<h2>
-    Projects
-    <a name="projects" title="Permalink to this headline" href="#projects">
-    <img src="{{ url_for('static', filename='images/link.png') }}" />
-    </a>
-</h2>
-<div class="accordion">
-{% for html in projects %}
-{{ html | InsertDiv | safe }}
-{% endfor %}
-</div>
-
-{% if issues %}
-<h2>
-    Issues
-    <a name="users" title="Permalink to this headline" href="#users">
-    <img src="{{ url_for('static', filename='images/link.png') }}" />
-    </a>
-</h2>
-<div class="accordion">
-{% for html in issues %}
-{{ html | InsertDiv | safe }}
-{% endfor %}
-</div>
-{% endif %}
-
-<h2>
-    Pull-requests
-    <a name="users"title="Permalink to this headline" href="#users">
-    <img src="{{ url_for('static', filename='images/link.png') }}" />
-    </a>
-</h2>
-<div class="accordion">
-{% for html in requests %}
-{{ html | InsertDiv | safe }}
-{% endfor %}
+<div class="p-t-2 api">
+  <div class="container">
+    <header>
+        <h2 class="repo-name m-b-0">
+            <span class="oi" data-glyph="grid-three-up"></span>
+            &nbsp; Pagure API Reference
+        </h2>
+        <div class="m-t-0">
+          This documentation describes the Pagure API v{{ version[0] }}
+          revision {{ version[2] }}.
+        </div>
+        <div class="projectinfo m-t-1">
+        </div>
+    </header>
+    <div class="row">
+      <div class="col-md-10">
+
+        {{ api_doc |replace('h1', 'h2') }}
+
+        <h1>List of the API endpoints:</h1>
+
+        <h2>
+            Projects
+            <a name="projects" title="Permalink to this headline" href="#projects">
+              <span class="oi" data-glyph="link-intact"></span>
+            </a>
+        </h2>
+        <div class="accordion">
+        {% for html in projects %}
+        {{ html | InsertDiv | safe }}
+        {% endfor %}
+        </div>
+
+        {% if issues %}
+        <h2>
+            Issues
+            <a name="users" title="Permalink to this headline" href="#issues">
+              <span class="oi" data-glyph="link-intact"></span>
+            </a>
+        </h2>
+        <div class="accordion">
+        {% for html in issues %}
+        {{ html | InsertDiv | safe }}
+        {% endfor %}
+        </div>
+        {% endif %}
+
+        <h2>
+            Pull-requests
+            <a name="users"title="Permalink to this headline" href="#pull-requests">
+              <span class="oi" data-glyph="link-intact"></span>
+            </a>
+        </h2>
+        <div class="accordion">
+        {% for html in requests %}
+        {{ html | InsertDiv | safe }}
+        {% endfor %}
+        </div>
+
+        <h2>
+            Users
+            <a name="users" title="Permalink to this headline" href="#users">
+              <span class="oi" data-glyph="link-intact"></span>
+            </a>
+        </h2>
+        <div class="accordion">
+        {% for html in users %}
+        {{ html | InsertDiv | safe }}
+        {% endfor %}
+        </div>
+
+        <h2>
+            Extras
+            <a name="extras" title="Permalink to this headline" href="#extras">
+              <span class="oi" data-glyph="link-intact"></span>
+            </a>
+        </h2>
+
+        <div class="accordion">
+        {% for html in extras %}
+        {{ html | InsertDiv |safe }}
+        {% endfor %}
+        </div>
+
+      </div>
+    </div>
+  </div>
 </div>
-
-<h2>
-    Users
-    <a name="users" title="Permalink to this headline" href="#users">
-    <img src="{{ url_for('static', filename='images/link.png') }}" />
-    </a>
-</h2>
-<div class="accordion">
-{% for html in users %}
-{{ html | InsertDiv | safe }}
-{% endfor %}
-</div>
-
-<h2>
-    Extras
-    <a name="extras" title="Permalink to this headline" href="#extras">
-    <img src="{{ url_for('static', filename='images/link.png') }}" />
-    </a>
-</h2>
-
-<div class="accordion">
-{% for html in extras %}
-{{ html | InsertDiv |safe }}
-{% endfor %}
-</div>
-
 {% endblock %}
 
 {% block jscripts %}
 {{ super() }}
 <script type="text/javascript">
 
-    $(function(){
-        $('.accordion').accordion({
-            active: false,
-            collapsible: true,
-            heightStyle: "content",
-            create: function (event, ui) {
-                $(this).children('h3').each(function (i) {
-                    // set id here because jQuery UI sets them as "ui-accordion-#-header-#"
-                    this.id = this.textContent.toLowerCase().replace(/\s+/g, '_');
-                    // add the anchor
-                    $(this).before('<a class="accordion-link link" data-index="' + i +
-                     '" href="#' + this.id + '"></a>');
-                });
-                $(this).find('.accordion-link').click(function () {
-                    // the active option requires a numeric value (not a string, e.g. "1")
-                    this.accordion( "option", "active", $(this).data('index') );
-                    // uncomment out the return false below to prevent the header jump
-                    return false;
-                });
-            }
-        });
-
-        if (window.location.hash) {
-            $('.accordion').each(function(){
-                var hashId = null;
-                $(this).children('h3').each(function (i) {
-                    var txt = this.textContent.toLowerCase().replace(/\s+/g, '_');
-                    if ( txt === window.location.hash.slice(1) ) {
-                        hashId = i;
-                    }
-                });
-                $(this).accordion( "option", "active", hashId );
-            });
+$(function(){
+  $('.accordion').accordion({
+    active: false,
+    collapsible: true,
+    heightStyle: "content",
+    create: function (event, ui) {
+      $(this).children('h3').each(function (i) {
+        // set id here because jQuery UI sets them as "ui-accordion-#-header-#"
+        this.id = this.textContent.toLowerCase().replace(/\s+/g, '_');
+        // add the anchor
+        $(this).before('<a class="accordion-link link" data-index="' + i +
+         '" href="#' + this.id + '"></a>');
+      });
+      $(this).find('.accordion-link').click(function () {
+        // the active option requires a numeric value (not a string, e.g. "1")
+        this.accordion( "option", "active", $(this).data('index') );
+        // uncomment out the return false below to prevent the header jump
+        return false;
+      });
+    }
+  });
+
+  if (window.location.hash) {
+    $('.accordion').each(function(){
+      var hashId = null;
+      $(this).children('h3').each(function (i) {
+        var txt = this.textContent.toLowerCase().replace(/\s+/g, '_');
+        if ( txt === window.location.hash.slice(1) ) {
+            hashId = i;
         }
+      });
+      $(this).accordion( "option", "active", hashId );
     });
+  }
+});
 </script>
 {% endblock %}

From d3ab0ca228fc19a4ccf94efa32908fcb64bf17db Mon Sep 17 00:00:00 2001
From: Pierre-Yves Chibon <pingou@pingoured.fr>
Date: Jan 26 2016 15:29:13 +0000
Subject: [PATCH 5/5] Split the API version by '.' so that we can reach 0.10 or 10.5


---

diff --git a/pagure/api/__init__.py b/pagure/api/__init__.py
index 90fd90c..d3294e7 100644
--- a/pagure/api/__init__.py
+++ b/pagure/api/__init__.py
@@ -449,7 +449,7 @@ def api():
 
     return flask.render_template(
         'api.html',
-        version=__api_version__,
+        version=__api_version__.split('.'),
         api_doc=APIDOC,
         projects=[
             api_git_tags_doc,
diff --git a/pagure/templates/api.html b/pagure/templates/api.html
index f7a8206..b035f06 100644
--- a/pagure/templates/api.html
+++ b/pagure/templates/api.html
@@ -14,7 +14,7 @@
         </h2>
         <div class="m-t-0">
           This documentation describes the Pagure API v{{ version[0] }}
-          revision {{ version[2] }}.
+          revision {{ version[1] }}.
         </div>
         <div class="projectinfo m-t-1">
         </div>