Bug 528167 - Add documentation for Mailing Lists resource

Signed-off-by: Eric Poirier <eric.poirier@eclipse-foundation.org>

docs/auth.html

@@ -206,7 +206,7 @@ are used.</p>
 </span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></section></div></div></div><p style="text-align: center;" class="text-muted"> 
 Copyright &copy; 
 2018
-The Eclipse Foundation. All Rights Reserved.</p><p style="text-align: center;" class="text-muted hide">Generated by&nbsp;<a href="https://github.com/danielgtaylor/aglio" class="aglio">aglio</a>&nbsp;on 15 May 2018</p><script>/* eslint-env browser */
+The Eclipse Foundation. All Rights Reserved.</p><p style="text-align: center;" class="text-muted hide">Generated by&nbsp;<a href="https://github.com/danielgtaylor/aglio" class="aglio">aglio</a>&nbsp;on 12 Jun 2018</p><script>/* eslint-env browser */
 /* eslint quotes: [2, "single"] */
 'use strict';
 

docs/index.html

@@ -116,7 +116,7 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
       </div>
     </div>
   </div>
-</header><a href="#top" class="text-muted back-to-top"><i class="fa fa-toggle-up"></i>&nbsp;Back to top</a><div class="container-fluid container-content"><div class="row"><nav><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#top">Overview</a></div><div class="collapse-content"><ul><li><a href="#header-other-related-rest-apis">Other related REST APIs</a></li><li><a href="#header-rate-limit">Rate Limit</a></li><li><a href="#header-pagination">Pagination</a></li><li><a href="#header-caching">Caching</a></li><li><a href="#header-authentication">Authentication</a></li><li><a href="#header-error-states">Error States</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#user-profiles">User Profiles</a></div><div class="collapse-content"><ul><li><a href="#user-profiles-current-user-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Current user</a></li><li><a href="#user-profiles-retrieve-user-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve user</a></li><li><a href="#user-profiles-search-for-a-user-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Search for a user</a></li><li><a href="#user-profiles-forum-posts-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Forum posts</a></li><li><a href="#user-profiles-project-relationship-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Project Relationship</a></li><li><a href="#user-profiles-gerrit-review-count-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gerrit review count</a></li><li><a href="#user-profiles-mailing-list-subscriptions-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Mailing List Subscriptions</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#eclipse-uss">Eclipse USS</a></div><div class="collapse-content"><ul><li><a href="#eclipse-uss-fetch-blobs-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Fetch Blobs</a></li><li><a href="#eclipse-uss-search-blobs-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Search Blobs</a></li><li><a href="#eclipse-uss-delete-blobs-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Delete Blobs</a></li><li><a href="#eclipse-uss-update-create-blobs-put"><span class="badge put"><i class="fa fa-pencil"></i></span>Update/Create Blobs</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#download">Download</a></div><div class="collapse-content"><ul><li><a href="#download-retrieve-file-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve File</a></li><li><a href="#download-release-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Release</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#marketplace-favorites">Marketplace Favorites</a></div><div class="collapse-content"><ul><li><a href="#marketplace-favorites-search-favorites-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Search Favorites</a></li><li><a href="#marketplace-favorites-retrieve-favorites-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve Favorites</a></li><li><a href="#marketplace-favorites-random-favorites-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Random Favorites</a></li><li><a href="#marketplace-favorites-favorite-list">Favorite List</a><ul><li><a href="#marketplace-favorites-favorite-list-post"><span class="badge post"><i class="fa fa-plus"></i></span>Add Favorite</a></li><li><a href="#marketplace-favorites-favorite-list-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Remove Favorite</a></li><li><a href="#marketplace-favorites-favorite-list-post-1"><span class="badge post"><i class="fa fa-plus"></i></span>Rename Favorite List</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#forums">Forums</a></div><div class="collapse-content"><ul><li><a href="#forums-fetch-categories-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Fetch Categories</a></li><li><a href="#forums-retrieve-category-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve Category</a></li><li><a href="#forums-fetch-forums-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Fetch Forums</a></li><li><a href="#forums-retrieve-forum-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve Forum</a></li><li><a href="#forums-fetch-topics-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Fetch Topics</a></li><li><a href="#forums-retrieve-topic-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve Topic</a></li><li><a href="#forums-fetch-posts-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Fetch Posts</a></li><li><a href="#forums-retrieve-post-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve Post</a></li><li><a href="#forums-retrieve-user-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve User</a></li></ul></div></div><p style="text-align: center; word-wrap: break-word;"><a href="https://api.eclipse.org">https://api.eclipse.org</a></p></nav><div class="content"><header><h1 id="top">Eclipse RESTful API</h1></header><p>This describes the resources that make up the official Eclipse Foundation REST API.</p>
+</header><a href="#top" class="text-muted back-to-top"><i class="fa fa-toggle-up"></i>&nbsp;Back to top</a><div class="container-fluid container-content"><div class="row"><nav><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#top">Overview</a></div><div class="collapse-content"><ul><li><a href="#header-other-related-rest-apis">Other related REST APIs</a></li><li><a href="#header-rate-limit">Rate Limit</a></li><li><a href="#header-pagination">Pagination</a></li><li><a href="#header-caching">Caching</a></li><li><a href="#header-authentication">Authentication</a></li><li><a href="#header-error-states">Error States</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#user-profiles">User Profiles</a></div><div class="collapse-content"><ul><li><a href="#user-profiles-current-user-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Current user</a></li><li><a href="#user-profiles-retrieve-user-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve user</a></li><li><a href="#user-profiles-search-for-a-user-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Search for a user</a></li><li><a href="#user-profiles-forum-posts-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Forum posts</a></li><li><a href="#user-profiles-project-relationship-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Project Relationship</a></li><li><a href="#user-profiles-gerrit-review-count-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gerrit review count</a></li><li><a href="#user-profiles-mailing-list-subscriptions-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Mailing List Subscriptions</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#eclipse-uss">Eclipse USS</a></div><div class="collapse-content"><ul><li><a href="#eclipse-uss-fetch-blobs-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Fetch Blobs</a></li><li><a href="#eclipse-uss-search-blobs-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Search Blobs</a></li><li><a href="#eclipse-uss-delete-blobs-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Delete Blobs</a></li><li><a href="#eclipse-uss-update-create-blobs-put"><span class="badge put"><i class="fa fa-pencil"></i></span>Update/Create Blobs</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#download">Download</a></div><div class="collapse-content"><ul><li><a href="#download-retrieve-file-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve File</a></li><li><a href="#download-release-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Release</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#marketplace-favorites">Marketplace Favorites</a></div><div class="collapse-content"><ul><li><a href="#marketplace-favorites-search-favorites-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Search Favorites</a></li><li><a href="#marketplace-favorites-retrieve-favorites-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve Favorites</a></li><li><a href="#marketplace-favorites-random-favorites-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Random Favorites</a></li><li><a href="#marketplace-favorites-favorite-list">Favorite List</a><ul><li><a href="#marketplace-favorites-favorite-list-post"><span class="badge post"><i class="fa fa-plus"></i></span>Add Favorite</a></li><li><a href="#marketplace-favorites-favorite-list-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Remove Favorite</a></li><li><a href="#marketplace-favorites-favorite-list-post-1"><span class="badge post"><i class="fa fa-plus"></i></span>Rename Favorite List</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#forums">Forums</a></div><div class="collapse-content"><ul><li><a href="#forums-fetch-categories-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Fetch Categories</a></li><li><a href="#forums-retrieve-category-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve Category</a></li><li><a href="#forums-fetch-forums-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Fetch Forums</a></li><li><a href="#forums-retrieve-forum-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve Forum</a></li><li><a href="#forums-fetch-topics-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Fetch Topics</a></li><li><a href="#forums-retrieve-topic-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve Topic</a></li><li><a href="#forums-fetch-posts-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Fetch Posts</a></li><li><a href="#forums-retrieve-post-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve Post</a></li><li><a href="#forums-retrieve-user-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve User</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#mailing-lists">Mailing Lists</a></div><div class="collapse-content"><ul><li><a href="#mailing-lists-fetch-mailing-lists-metadata-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Fetch Mailing lists Metadata</a></li></ul></div></div><p style="text-align: center; word-wrap: break-word;"><a href="https://api.eclipse.org">https://api.eclipse.org</a></p></nav><div class="content"><header><h1 id="top">Eclipse RESTful API</h1></header><p>This describes the resources that make up the official Eclipse Foundation REST API.</p>
 <p>You can contribute to this document via our <a href="https://github.com/chrisguindon/api.eclipse.org-docs">git repository</a>.</p>
 <p>If you have any problems or requests please contact <a href="mailto:chris.guindon@eclipse-foundation.org">Christopher Guindon</a>.</p>
 <h3 id="header-other-related-rest-apis">Other related REST APIs <a class="permalink" href="#header-other-related-rest-apis" aria-hidden="true">¶</a></h3>
@@ -2721,10 +2721,41 @@ You can also retrieve posts that have been created between dates using the since
   "<span class="hljs-attribute">html_url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php?t=usrinfo&amp;id=1"</span></span>,
   "<span class="hljs-attribute">account_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/account/profile?mail=test@user.org"</span></span>,
   "<span class="hljs-attribute">posts_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/post?user_id=1"</span>
-</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></section></div></div></div><p style="text-align: center;" class="text-muted"> 
+</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></section><section id="mailing-lists" class="resource-group"><h2 class="group-heading">Mailing Lists <a href="#mailing-lists" class="permalink">&para;</a></h2><p>Eclipse Mailing Lists are available through this resource.</p>
+<div id="mailing-lists-fetch-mailing-lists-metadata" class="resource"><h3 class="resource-heading">Fetch Mailing lists Metadata <a href="#mailing-lists-fetch-mailing-lists-metadata" class="permalink">&nbsp;&para;</a></h3><div id="mailing-lists-fetch-mailing-lists-metadata-get" class="action get"><h4 class="action-heading"><div class="name">Fetch Mailing lists Metadata</div><a href="#mailing-lists-fetch-mailing-lists-metadata-get" class="method get">GET</a><code class="uri">/mailing_lists/metadata{?name,search,page,pagesize,order_by}</code></h4><h3 id="header-overview-9">Overview <a class="permalink" href="#header-overview-9" aria-hidden="true">¶</a></h3>
+<p>Retrieve metadata for all the mailing lists.</p>
+<h3 id="header-result-definition-9">Result definition <a class="permalink" href="#header-result-definition-9" aria-hidden="true">¶</a></h3>
+<ul>
+<li>
+<p><strong>list_name:</strong> name of the mailing list</p>
+</li>
+<li>
+<p><strong>url:</strong> url of the mailing list</p>
+</li>
+<li>
+<p><strong>email:</strong> email of the mailing list</p>
+</li>
+</ul>
+<h4>Example URI</h4><div class="definition"><span class="method get">GET</span>&nbsp;<span class="uri"><span class="hostname">https://api.eclipse.org</span>/mailing_lists/metadata?<span class="hljs-attribute">name=</span><span class="hljs-literal"></span>&<span class="hljs-attribute">search=</span><span class="hljs-literal"></span>&<span class="hljs-attribute">page=</span><span class="hljs-literal"></span>&<span class="hljs-attribute">pagesize=</span><span class="hljs-literal"></span>&<span class="hljs-attribute">order_by=</span><span class="hljs-literal"></span></span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>name</dt><dd><code>string</code>&nbsp;<span>(optional)</span>&nbsp;<p>The name of a specific mailing list</p>
+</dd><dt>search</dt><dd><code>string</code>&nbsp;<span>(optional)</span>&nbsp;<p>A keyword to search for in a mailing list name</p>
+</dd><dt>page</dt><dd><code>integer</code>&nbsp;<span>(optional)</span>&nbsp;<p>The index of the page to get, defaults to 1.</p>
+</dd><dt>pagesize</dt><dd><code>integer</code>&nbsp;<span>(optional)</span>&nbsp;<p>The number of records to get per page, defaults to 20. Maximum value is 100.</p>
+</dd><dt>order_by</dt><dd><code>string</code>&nbsp;<span>(optional)</span>&nbsp;<p>The order by name in which the results will be returned. ASC by default</p>
+</dd></dl></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Link</span>: <span class="hljs-string">&lt;https://api.eclipse.org/mailing_lists/metadata?page=1&amp;amp;pagesize=20&gt;; rel="next", &lt;https://api.eclipse.org/mailing_lists/metadata?page=99&amp;amp;pagesize=5&gt;; rel="last", &lt;https://api.eclipse.org/mailing_lists/metadata?page=1&amp;amp;pagesize=5&gt;; rel="first", &lt;https://api.eclipse.org/mailing_lists/metadata?page=1&amp;amp;pagesize=5&gt;; rel="self"</span><br><span class="hljs-attribute">X-Rate-Limit-Limit</span>: <span class="hljs-string">1000</span><br><span class="hljs-attribute">X-Rate-Limit-Remaining</span>: <span class="hljs-string">964</span><br><span class="hljs-attribute">X-Rate-Limit-Reset</span>: <span class="hljs-string">3553</span><br><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>[
+  {
+    "<span class="hljs-attribute">list_name</span>": <span class="hljs-value"><span class="hljs-string">"example-list1"</span></span>,
+    "<span class="hljs-attribute">url</span>": <span class="hljs-value"><span class="hljs-string">"https://accounts.eclipse.org/mailing-list/example-list1"</span></span>,
+    "<span class="hljs-attribute">email</span>": <span class="hljs-value"><span class="hljs-string">"example-list1@eclipse.org"</span>
+  </span>},
+  {
+    "<span class="hljs-attribute">list_name</span>": <span class="hljs-value"><span class="hljs-string">"example-list2"</span></span>,
+    "<span class="hljs-attribute">url</span>": <span class="hljs-value"><span class="hljs-string">"https://accounts.eclipse.org/mailing-list/example-list2"</span></span>,
+    "<span class="hljs-attribute">email</span>": <span class="hljs-value"><span class="hljs-string">"example-list2@eclipse.org"</span>
+  </span>}
+]</code></pre><div style="height: 1px;"></div></div></div></div></div></section></div></div></div><p style="text-align: center;" class="text-muted"> 
 Copyright &copy; 
 2018
-The Eclipse Foundation. All Rights Reserved.</p><p style="text-align: center;" class="text-muted hide">Generated by&nbsp;<a href="https://github.com/danielgtaylor/aglio" class="aglio">aglio</a>&nbsp;on 15 May 2018</p><script>/* eslint-env browser */
+The Eclipse Foundation. All Rights Reserved.</p><p style="text-align: center;" class="text-muted hide">Generated by&nbsp;<a href="https://github.com/danielgtaylor/aglio" class="aglio">aglio</a>&nbsp;on 12 Jun 2018</p><script>/* eslint-env browser */
 /* eslint quotes: [2, "single"] */
 'use strict';
 

src/index.apib

@@ -71,3 +71,4 @@ are used.
 <!-- include(modules/download.apib) -->
 <!-- include(modules/marketplace_favorites.apib) -->
 <!-- include(modules/forums.apib) -->
+<!-- include(modules/mailing_lists.apib) -->

src/modules/mailing_lists.apib

+# Group Mailing Lists
+
+Eclipse Mailing Lists are available through this resource.
+
+## Fetch Mailing lists Metadata [GET /mailing_lists/metadata{?name,search,page,pagesize,order_by}]
+
+### Overview
+
+Retrieve metadata for all the mailing lists.
+
+### Result definition
+
++ **list_name:** name of the mailing list
++ **url:** url of the mailing list
++ **email:** email of the mailing list
+
++ Parameters
+    + name (string, optional) - The name of a specific mailing list
+    + search (string, optional) - A keyword to search for in a mailing list name
+    + page (integer, optional) - The index of the page to get, defaults to 1.
+    + pagesize (integer, optional) - The number of records to get per page, defaults to 20. Maximum value is 100.
+    + order_by (string, optional) - The order by name in which the results will be returned. ASC by default
+
++ Response 200 (application/json)
+    + Headers
+        Link:<https://api.eclipse.org/mailing_lists/metadata?page=1&amp;pagesize=20>; rel="next", <https://api.eclipse.org/mailing_lists/metadata?page=99&amp;pagesize=5>; rel="last", <https://api.eclipse.org/mailing_lists/metadata?page=1&amp;pagesize=5>; rel="first", <https://api.eclipse.org/mailing_lists/metadata?page=1&amp;pagesize=5>; rel="self"
+        X-Rate-Limit-Limit: 1000
+        X-Rate-Limit-Remaining: 964
+        X-Rate-Limit-Reset: 3553
+        Content-Type: application/json
+        
+    + Body
+        [{"list_name":"example-list1","url":"https://accounts.eclipse.org/mailing-list/example-list1","email":"example-list1@eclipse.org"},{"list_name":"example-list2","url":"https://accounts.eclipse.org/mailing-list/example-list2","email":"example-list2@eclipse.org"}]
+
+