Browse Source

Update search docs

Jordi Boggiano 8 years ago
parent
commit
e3c6d570e8
1 changed files with 29 additions and 0 deletions
  1. 29 0
      src/Packagist/WebBundle/Resources/views/ApiDoc/index.html.twig

+ 29 - 0
src/Packagist/WebBundle/Resources/views/ApiDoc/index.html.twig

@@ -8,6 +8,7 @@
   <li><a href="#list-packages-by-organization">List packages by organization</a></li>
   <li><a href="#list-packages-by-organization">List packages by organization</a></li>
   <li><a href="#search-packages-by-tag">Search packages by tag</a></li>
   <li><a href="#search-packages-by-tag">Search packages by tag</a></li>
   <li><a href="#search-packages-by-name">Search packages by name</a></li>
   <li><a href="#search-packages-by-name">Search packages by name</a></li>
+  <li><a href="#search-packages-by-type">Search packages by type</a></li>
   <li><a href="#get-package-by-name">Get a package by name</a></li>
   <li><a href="#get-package-by-name">Get a package by name</a></li>
 </ul>
 </ul>
 
 
@@ -25,6 +26,11 @@ GET https://packagist.org/packages/list.json?vendor=[vendor]
 </code></pre>
 </code></pre>
 </section>
 </section>
 
 
+<h3>Search</h3>
+
+<p>Search results are paginated and you can change the pagination step by using the per_page parameter. For example <code>https://packagist.org/search.json?q=[query]&amp;per_page=5</code></p>
+
+
 <section class="col-d-12">
 <section class="col-d-12">
 <h3 id="search-packages-by-tag">Search packages by tag</h3>
 <h3 id="search-packages-by-tag">Search packages by tag</h3>
 <pre>
 <pre>
@@ -71,6 +77,29 @@ GET https://packagist.org/search.json?q=[query]
 </code>
 </code>
 </section>
 </section>
 
 
+<section class="col-d-12">
+<h3 id="search-packages-by-type">Search packages by type </h3>
+<pre>
+GET https://packagist.org/search.json?q=[query]&amp;type=symfony-bundle
+<code>
+{
+  "results" : [
+    {
+      "name": "[vendor]/[package]",
+      "description": "[description]",
+      "url": "https://packagist.org/packages/[vendor]/[package]",
+      "repository": [repository url],
+      "downloads": [number of downloads],
+      "favers": [number of favers]
+    },
+    ...
+  ],
+  "total": [number of results],
+  "next": "https://packagist.org/search.json?q=[query]&amp;page=[next page number]"
+}
+</code>
+</section>
+
 <section class="col-d-12">
 <section class="col-d-12">
 <h3 id="get-package-by-name">Get package by name </h3>
 <h3 id="get-package-by-name">Get package by name </h3>
 <pre>
 <pre>