Browse Source

Added API docs.

Frank de Jonge 6 years ago
parent
commit
f59891e80b
1 changed files with 21 additions and 0 deletions
  1. 21 0
      src/Packagist/WebBundle/Resources/views/api_doc/index.html.twig

+ 21 - 0
src/Packagist/WebBundle/Resources/views/api_doc/index.html.twig

@@ -19,6 +19,7 @@
     </ul>
     </ul>
   </li>
   </li>
   <li><a href="#get-package-data">{{ 'api_doc.get_package_data'|trans }}</a></li>
   <li><a href="#get-package-data">{{ 'api_doc.get_package_data'|trans }}</a></li>
+  <li><a href="#get-statistics">{{ 'api_doc.get_statistics'|trans }}</a></li>
 </ul>
 </ul>
 
 
 
 
@@ -205,5 +206,25 @@ GET https://{{ packagist_host }}/packages/[vendor]/[package].json
 
 
 </section>
 </section>
 
 
+<section class="col-d-12">
+<h3 id="get-statistics">{{ 'api_doc.get_statistics'|trans }}</h3>
+
+<h4 id="get-package-by-name">{{ 'api_doc.get_statistics'|trans }}</h4>
+
+<p>This endpoint provides basic some statistics.</p>
+
+<pre>
+GET https://{{ packagist_host }}/statistics.json
+<code>
+{
+  "totals": {
+    "downloads": [numbers of download]
+  }
+}
+</code></pre>
+<p>Working example: <code><a href="https://{{ packagist_host }}/statistics.json">https://{{ packagist_host }}/statistics.json</a></code></p>
+
+</section>
+
 
 
 {% endblock %}
 {% endblock %}