diff --git a/docs/index.html b/docs/index.html index bc41e68a3cae3c84db5d023df24320bb2dd82341..58f57986865f76205de41932b5410c4dace8397d 100644 --- a/docs/index.html +++ b/docs/index.html @@ -86,7 +86,7 @@ </div> </div> </div> -</header><a href="#top" class="text-muted back-to-top"><i class="fa fa-toggle-up"></i> 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-supported-rest-apis">Supported 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></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><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> 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-supported-rest-apis">Supported 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><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-supported-rest-apis">Supported REST APIs <a class="permalink" href="#header-supported-rest-apis" aria-hidden="true">¶</a></h3> @@ -372,6 +372,19 @@ is included when authenticated through OAuth with the <code>profile</code> scope <h4>Example URI</h4><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname">https://api.eclipse.org</span>/account/profile/<span class="hljs-attribute" title="name">name</span>/gerrit</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> <span>(optional)</span> <p>A valid Eclipse username.</p> </dd></dl></div><div class="title"><strong>Response <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">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></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ "<span class="hljs-attribute">merged_changes_count</span>": <span class="hljs-value"><span class="hljs-string">"671"</span> +</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="user-profiles-mailing-list-subscriptions" class="resource"><h3 class="resource-heading">Mailing List Subscriptions <a href="#user-profiles-mailing-list-subscriptions" class="permalink"> ¶</a></h3><div id="user-profiles-mailing-list-subscriptions-get" class="action get"><h4 class="action-heading"><div class="name">Mailing List Subscriptions</div><a href="#user-profiles-mailing-list-subscriptions-get" class="method get">GET</a><code class="uri">/account/profile/{name}/mailing-list</code></h4><p>This method returns mailing list subscriptions for a user.</p> +<h4>Example URI</h4><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname">https://api.eclipse.org</span>/account/profile/<span class="hljs-attribute" title="name">name</span>/mailing-list</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> <span class="required">(required)</span> <p>A valid Eclipse username.</p> +</dd></dl></div><div class="title"><strong>Response <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">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></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ + "<span class="hljs-attribute">mailing_list_subscriptions</span>": <span class="hljs-value">[ + { + "<span class="hljs-attribute">list_name</span>": <span class="hljs-value"><span class="hljs-string">"epp-dev"</span></span>, + "<span class="hljs-attribute">list_description</span>": <span class="hljs-value"><span class="hljs-string">"Eclipse Packaging Project"</span> + </span>}, + { + "<span class="hljs-attribute">list_name</span>": <span class="hljs-value"><span class="hljs-string">"eclipse.org-webdev"</span></span>, + "<span class="hljs-attribute">list_description</span>": <span class="hljs-value"><span class="hljs-string">"Eclipse.org Webdev notices and discussions"</span> + </span>} + ] </span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></section><section id="eclipse-uss" class="resource-group"><h2 class="group-heading">Eclipse USS <a href="#eclipse-uss" class="permalink">¶</a></h2><p>The Eclipse User Storage Service (USS) allows Eclipse projects to store user-specific project information on the Eclipse Foundation servers. The goal is to make it easy for our projects to offer a better user experience by storing relevant information in a central location.</p> diff --git a/src/modules/account.apib b/src/modules/account.apib index 224f77d5a6045c67e8efa760f47159f0211e49ac..492638beb428ea76030d5a2db73508f43fbe5702 100644 --- a/src/modules/account.apib +++ b/src/modules/account.apib @@ -90,4 +90,19 @@ This method returns gerrit review count for a user. X-Rate-Limit-Reset: 3553 + Body - {"merged_changes_count":"671"} \ No newline at end of file + {"merged_changes_count":"671"} + +## Mailing List Subscriptions [GET /account/profile/{name}/mailing-list] +This method returns mailing list subscriptions for a user. + ++ Parameters + + name (string) - A valid Eclipse username. + ++ Response 200 (application/json) + + Headers + X-Rate-Limit-Limit: 1000 + X-Rate-Limit-Remaining: 964 + X-Rate-Limit-Reset: 3553 + + + Body + {"mailing_list_subscriptions":[{"list_name":"epp-dev","list_description":"Eclipse Packaging Project"},{"list_name":"eclipse.org-webdev","list_description":"Eclipse.org Webdev notices and discussions"}]} \ No newline at end of file