Skip to content
Snippets Groups Projects
Commit cf805027 authored by Eric Poirier's avatar Eric Poirier Committed by Christopher Guindon
Browse files

Remove forums from proposals and add it to the main page 


Signed-off-by: default avatarEric Poirier <eric.poirier@eclipse-foundation.org>
parent d9d2ec74
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
docs/auth.html
+ 1
− 1
View file @ cf805027
...@@ -176,7 +176,7 @@ are used.</p> ...@@ -176,7 +176,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"> </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; Copyright &copy;
2018 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 26 Feb 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 Mar 2018</p><script>/* eslint-env browser */
/* eslint quotes: [2, "single"] */ /* eslint quotes: [2, "single"] */
'use strict'; 'use strict';
......
docs/index.html
+ 500
− 3
View file @ cf805027
...@@ -86,7 +86,7 @@ ...@@ -86,7 +86,7 @@
</div> </div>
</div> </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><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><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>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> <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> <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>
...@@ -2191,10 +2191,507 @@ Think of it like an app store for Eclipse solutions.</p> ...@@ -2191,10 +2191,507 @@ Think of it like an app store for Eclipse solutions.</p>
</dd></dl></div><div class="title"><strong>Request</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">Authorization</span>: <span class="hljs-string">Bearer XXXX</span></code></pre><div style="height: 1px;"></div></div></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/marketplace/favorites/3274405?page=1&amp;amp;pagesize=100&gt;; rel="last", &lt;https://api.eclipse.org/marketplace/favorites/3274405?page=1&amp;amp;pagesize=100&gt;; rel="first", &lt;https://api.eclipse.org/marketplace/favorites/3274405?page=1&amp;amp;pagesize=100&gt;; rel="self"</span><br><span class="hljs-attribute">Etag</span>: <span class="hljs-string">"9f76b4dde4cb5146daa5686a7f4376084dbe41bf9c9d4a12b722fe1062eb48eb"</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">961</span><br><span class="hljs-attribute">X-Rate-Limit-Reset</span>: <span class="hljs-string">3463</span><br><span class="hljs-attribute">Last-Modified</span>: <span class="hljs-string">Fri, 09 Jun 2017 17:41:33 GMT</span></code></pre><div style="height: 1px;"></div></div></div></div><div id="marketplace-favorites-favorite-list-post-1" class="action post"><h4 class="action-heading"><div class="name">Rename Favorite List</div><a href="#marketplace-favorites-favorite-list-post-1" class="method post">POST</a><code class="uri">/marketplace/favorites/rename_list</code></h4><p>Create a custom name for the user favorite list.</p> </dd></dl></div><div class="title"><strong>Request</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">Authorization</span>: <span class="hljs-string">Bearer XXXX</span></code></pre><div style="height: 1px;"></div></div></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/marketplace/favorites/3274405?page=1&amp;amp;pagesize=100&gt;; rel="last", &lt;https://api.eclipse.org/marketplace/favorites/3274405?page=1&amp;amp;pagesize=100&gt;; rel="first", &lt;https://api.eclipse.org/marketplace/favorites/3274405?page=1&amp;amp;pagesize=100&gt;; rel="self"</span><br><span class="hljs-attribute">Etag</span>: <span class="hljs-string">"9f76b4dde4cb5146daa5686a7f4376084dbe41bf9c9d4a12b722fe1062eb48eb"</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">961</span><br><span class="hljs-attribute">X-Rate-Limit-Reset</span>: <span class="hljs-string">3463</span><br><span class="hljs-attribute">Last-Modified</span>: <span class="hljs-string">Fri, 09 Jun 2017 17:41:33 GMT</span></code></pre><div style="height: 1px;"></div></div></div></div><div id="marketplace-favorites-favorite-list-post-1" class="action post"><h4 class="action-heading"><div class="name">Rename Favorite List</div><a href="#marketplace-favorites-favorite-list-post-1" class="method post">POST</a><code class="uri">/marketplace/favorites/rename_list</code></h4><p>Create a custom name for the user favorite list.</p>
<h4>Example URI</h4><div class="definition"><span class="method post">POST</span>&nbsp;<span class="uri"><span class="hostname">https://api.eclipse.org</span>/marketplace/favorites/rename_list</span></div><div class="title"><strong>Request</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">Authorization</span>: <span class="hljs-string">Bearer XXXX</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ <h4>Example URI</h4><div class="definition"><span class="method post">POST</span>&nbsp;<span class="uri"><span class="hostname">https://api.eclipse.org</span>/marketplace/favorites/rename_list</span></div><div class="title"><strong>Request</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">Authorization</span>: <span class="hljs-string">Bearer XXXX</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">"New list name"</span> "<span class="hljs-attribute">list_name</span>": <span class="hljs-value"><span class="hljs-string">"New list name"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>204</code></strong></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 class="title"><strong>Response&nbsp;&nbsp;<code>204</code></strong></div></div></div></section><section id="forums" class="resource-group"><h2 class="group-heading">Forums <a href="#forums" class="permalink">&para;</a></h2><p>Eclipse Forums are available through this resource.</p>
<div id="forums-fetch-categories" class="resource"><h3 class="resource-heading">Fetch Categories <a href="#forums-fetch-categories" class="permalink">&nbsp;&para;</a></h3><div id="forums-fetch-categories-get" class="action get"><h4 class="action-heading"><div class="name">Fetch Categories</div><a href="#forums-fetch-categories-get" class="method get">GET</a><code class="uri">/forums/category{?page,pagesize,order_by}</code></h4><h3 id="header-overview">Overview <a class="permalink" href="#header-overview" aria-hidden="true"></a></h3>
<p>Retrieve information for <strong>all the categories</strong> from the Eclipse Forums website.</p>
<h3 id="header-what-is-a-category?">What is a category? <a class="permalink" href="#header-what-is-a-category?" aria-hidden="true"></a></h3>
<p>A category is a group of forums.</p>
<p>Forums are associated to a category by category id.</p>
<h3 id="header-result-definition">Result definition <a class="permalink" href="#header-result-definition" aria-hidden="true"></a></h3>
<ul>
<li>
<p><strong>id:</strong> id of the category</p>
</li>
<li>
<p><strong>name:</strong> name of the category</p>
</li>
<li>
<p><strong>description:</strong> description of the category</p>
</li>
<li>
<p><strong>url:</strong> url that will return information of a specific category on the Eclipse Forums website <em>(Note: the trailing slash is important)</em></p>
</li>
<li>
<p><strong>forum_url:</strong> url that will return information for all the forums associated with a specific category id</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>/forums/category?<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>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 ID in which the results will be returned. DESC 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/forums/category?page=1&amp;amp;pagesize=20&gt;; rel="next", &lt;https://api.eclipse.org/forums/category?page=99&amp;amp;pagesize=5&gt;; rel="last", &lt;https://api.eclipse.org/forums/category?page=1&amp;amp;pagesize=5&gt;; rel="first", &lt;https://api.eclipse.org/forums/category?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">pagination</span>": <span class="hljs-value">{
"<span class="hljs-attribute">page</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">pagesize</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">result_start</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">result_end</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">result_size</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">total_result_size</span>": <span class="hljs-value"><span class="hljs-number">9</span>
</span>}</span>,
"<span class="hljs-attribute">result</span>": <span class="hljs-value">[
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"1"</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Eclipse Projects"</span></span>,
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">" - Eclipse Project Forums - click +/- to expand/collapse"</span></span>,
"<span class="hljs-attribute">html_url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php/i/1/"</span></span>,
"<span class="hljs-attribute">forums_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/forum?category_id=1"</span>
</span>},
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"2"</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Newcomers"</span></span>,
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">" - General Newcomer discussions"</span></span>,
"<span class="hljs-attribute">html_url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php/i/2/"</span></span>,
"<span class="hljs-attribute">forums_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/forum?category_id=2"</span>
</span>}
]
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="forums-retrieve-category" class="resource"><h3 class="resource-heading">Retrieve Category <a href="#forums-retrieve-category" class="permalink">&nbsp;&para;</a></h3><div id="forums-retrieve-category-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve Category</div><a href="#forums-retrieve-category-get" class="method get">GET</a><code class="uri">/forums/category/{category_id}</code></h4><h3 id="header-overview-1">Overview <a class="permalink" href="#header-overview-1" aria-hidden="true"></a></h3>
<p>Retrieve information for <strong>a specific category</strong> from the Eclipse Forums website.</p>
<h3 id="header-what-is-a-category?-1">What is a category? <a class="permalink" href="#header-what-is-a-category?-1" aria-hidden="true"></a></h3>
<p>A category is a group of forums.</p>
<p>Forums are associated to a category by category id.</p>
<h3 id="header-result-definition-1">Result definition <a class="permalink" href="#header-result-definition-1" aria-hidden="true"></a></h3>
<ul>
<li>
<p><strong>id:</strong> id of the category</p>
</li>
<li>
<p><strong>name:</strong> name of the category</p>
</li>
<li>
<p><strong>description:</strong> description of the category</p>
</li>
<li>
<p><strong>url:</strong> url that will return information of a specific category on the Eclipse Forums website <em>(Note: the trailing slash is important)</em></p>
</li>
<li>
<p><strong>forum_url:</strong> url that will return information for all the forums associated with a specific category id</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>/forums/category/<span class="hljs-attribute" title="category_id">category_id</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>category_id</dt><dd><code>integer</code>&nbsp;<span class="required">(required)</span>&nbsp;<p>Unique identifier for category</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">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">id</span>": <span class="hljs-value"><span class="hljs-string">"1"</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Eclipse Projects"</span></span>,
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">" - Eclipse Project Forums - click +/- to expand/collapse"</span></span>,
"<span class="hljs-attribute">html_url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php/i/1/"</span></span>,
"<span class="hljs-attribute">forums_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/forum?category_id=1"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="forums-fetch-forums" class="resource"><h3 class="resource-heading">Fetch Forums <a href="#forums-fetch-forums" class="permalink">&nbsp;&para;</a></h3><div id="forums-fetch-forums-get" class="action get"><h4 class="action-heading"><div class="name">Fetch Forums</div><a href="#forums-fetch-forums-get" class="method get">GET</a><code class="uri">/forums/forum{?category_id,page,pagesize,order_by,since,until}</code></h4><h3 id="header-overview-2">Overview <a class="permalink" href="#header-overview-2" aria-hidden="true"></a></h3>
<p>Retrieve information for <strong>all the forums</strong> from the Eclipse Forums website.</p>
<p>Optionally, you can retrieve information for all the forums associated to a specific category by using the category_id parameter.
You can also retrieve forums that have been created between dates using the since and until parameters.</p>
<h3 id="header-what-is-a-forum?">What is a forum? <a class="permalink" href="#header-what-is-a-forum?" aria-hidden="true"></a></h3>
<p>A forum is a group of topics.</p>
<p>Topics are associated to a forum by forum id.</p>
<h3 id="header-result-definition-2">Result definition <a class="permalink" href="#header-result-definition-2" aria-hidden="true"></a></h3>
<ul>
<li>
<p><strong>id:</strong> id of the forum</p>
</li>
<li>
<p><strong>name:</strong> name of the forum</p>
</li>
<li>
<p><strong>category_id:</strong> id of the category associated to this forum</p>
</li>
<li>
<p><strong>url:</strong> url of a specific forum on the Eclipse Forums website <em>(Note: the trailing slash is important)</em></p>
</li>
<li>
<p><strong>description:</strong> description of the forum</p>
</li>
<li>
<p><strong>created_date:</strong> date when the forum has been created (timestamp)</p>
</li>
<li>
<p><strong>topic_count:</strong> number of topics in this forum</p>
</li>
<li>
<p><strong>post_count:</strong> number of posts in this forum</p>
</li>
<li>
<p><strong>last_post_id:</strong> id of the last post in this forum</p>
</li>
<li>
<p><strong>category_url:</strong> url that will return information about a category</p>
</li>
<li>
<p><strong>topics_url:</strong> url that will return all the topics associated with a specific forum id</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>/forums/forum?<span class="hljs-attribute">category_id=</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 class="hljs-attribute">since=</span><span class="hljs-literal"></span>&<span class="hljs-attribute">until=</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>category_id</dt><dd><code>integer</code>&nbsp;<span>(optional)</span>&nbsp;<p>Unique identifier for a category</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 created date in which the results will be returned. DESC by default</p>
</dd><dt>since</dt><dd><code>integer</code>&nbsp;<span>(optional)</span>&nbsp;<p>The results since a timestamp onward</p>
</dd><dt>until</dt><dd><code>integer</code>&nbsp;<span>(optional)</span>&nbsp;<p>The results until a timestamp</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/forums/forum?category_id=1&amp;amp;page=1&amp;amp;pagesize=20&gt;; rel="last", &lt;https://api.eclipse.org/forums/forum?category_id=1&amp;amp;page=99&amp;amp;pagesize=20&gt;; rel="first", &lt;https://api.eclipse.org/forums/forum?category_id=1&amp;amp;page=1&amp;amp;pagesize=20&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">pagination</span>": <span class="hljs-value">{
"<span class="hljs-attribute">page</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">pagesize</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">result_start</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">result_end</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">result_size</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">total_result_size</span>": <span class="hljs-value"><span class="hljs-number">391</span>
</span>}</span>,
"<span class="hljs-attribute">result</span>": <span class="hljs-value">[
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"89"</span></span>,
"<span class="hljs-attribute">category_id</span>": <span class="hljs-value"><span class="hljs-string">"2"</span></span>,
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Eclipse forum for newcomers"</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Newcomers"</span></span>,
"<span class="hljs-attribute">created_date</span>": <span class="hljs-value"><span class="hljs-string">"1248707078"</span></span>,
"<span class="hljs-attribute">topic_count</span>": <span class="hljs-value"><span class="hljs-string">"22344"</span></span>,
"<span class="hljs-attribute">post_count</span>": <span class="hljs-value"><span class="hljs-string">"62843"</span></span>,
"<span class="hljs-attribute">last_post_id</span>": <span class="hljs-value"><span class="hljs-string">"1780973"</span></span>,
"<span class="hljs-attribute">html_url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php/f/89/"</span></span>,
"<span class="hljs-attribute">topics_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/topic?forum_id=89"</span></span>,
"<span class="hljs-attribute">category_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/category/2"</span>
</span>}
]
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="forums-retrieve-forum" class="resource"><h3 class="resource-heading">Retrieve Forum <a href="#forums-retrieve-forum" class="permalink">&nbsp;&para;</a></h3><div id="forums-retrieve-forum-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve Forum</div><a href="#forums-retrieve-forum-get" class="method get">GET</a><code class="uri">/forums/forum/{forum_id}</code></h4><h3 id="header-overview-3">Overview <a class="permalink" href="#header-overview-3" aria-hidden="true"></a></h3>
<p>Retrieve information for <strong>a specific forum</strong> from the Eclipse Forums website.</p>
<h3 id="header-what-is-a-forum?-1">What is a forum? <a class="permalink" href="#header-what-is-a-forum?-1" aria-hidden="true"></a></h3>
<p>A forum is a group of topics.</p>
<p>Topics are associated to a forum by forum id.</p>
<h3 id="header-result-definition-3">Result definition <a class="permalink" href="#header-result-definition-3" aria-hidden="true"></a></h3>
<ul>
<li>
<p><strong>id:</strong> id of the forum</p>
</li>
<li>
<p><strong>name:</strong> name of the forum</p>
</li>
<li>
<p><strong>category_id:</strong> id of the category associated to this forum</p>
</li>
<li>
<p><strong>url:</strong> url of a specific forum on the Eclipse Forums website <em>(Note: the trailing slash is important)</em></p>
</li>
<li>
<p><strong>description:</strong> description of the forum</p>
</li>
<li>
<p><strong>created_date:</strong> date when the forum has been created (timestamp)</p>
</li>
<li>
<p><strong>topic_count:</strong> number of topics in this forum</p>
</li>
<li>
<p><strong>post_count:</strong> number of posts in this forum</p>
</li>
<li>
<p><strong>last_post_id:</strong> id of the last post in this forum</p>
</li>
<li>
<p><strong>category_url:</strong> url that will return information about a category</p>
</li>
<li>
<p><strong>topics_url:</strong> url that will return all the topics associated with a specific forum id</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>/forums/forum/<span class="hljs-attribute" title="forum_id">forum_id</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>forum_id</dt><dd><code>integer</code>&nbsp;<span class="required">(required)</span>&nbsp;<p>Unique identifier for a forum</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">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">id</span>": <span class="hljs-value"><span class="hljs-string">"89"</span></span>,
"<span class="hljs-attribute">category_id</span>": <span class="hljs-value"><span class="hljs-string">"2"</span></span>,
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Eclipse forum for newcomers"</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Newcomers"</span></span>,
"<span class="hljs-attribute">created_date</span>": <span class="hljs-value"><span class="hljs-string">"1248707078"</span></span>,
"<span class="hljs-attribute">topic_count</span>": <span class="hljs-value"><span class="hljs-string">"22344"</span></span>,
"<span class="hljs-attribute">post_count</span>": <span class="hljs-value"><span class="hljs-string">"62843"</span></span>,
"<span class="hljs-attribute">last_post_id</span>": <span class="hljs-value"><span class="hljs-string">"1780973"</span></span>,
"<span class="hljs-attribute">html_url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php/f/89/"</span></span>,
"<span class="hljs-attribute">topics_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/topic?forum_id=89"</span></span>,
"<span class="hljs-attribute">category_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/category/2"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="forums-fetch-topics" class="resource"><h3 class="resource-heading">Fetch Topics <a href="#forums-fetch-topics" class="permalink">&nbsp;&para;</a></h3><div id="forums-fetch-topics-get" class="action get"><h4 class="action-heading"><div class="name">Fetch Topics</div><a href="#forums-fetch-topics-get" class="method get">GET</a><code class="uri">/forums/topic{?forum_id,page,pagesize,order_by,since,until}</code></h4><h3 id="header-overview-4">Overview <a class="permalink" href="#header-overview-4" aria-hidden="true"></a></h3>
<p>Retrieve information for <strong>all the topics</strong> from the Eclipse Forums website.</p>
<p>Optionally, you can retrieve information for all the topics associated to a specific forum by using the forum_id parameter.
You can also retrieve topics that have been created between dates using the since and until parameters.</p>
<h3 id="header-what-is-a-topic?">What is a topic? <a class="permalink" href="#header-what-is-a-topic?" aria-hidden="true"></a></h3>
<p>A topic is a group of posts.</p>
<p>Posts are associated to a topic by topic id.</p>
<h3 id="header-result-definition-4">Result definition <a class="permalink" href="#header-result-definition-4" aria-hidden="true"></a></h3>
<ul>
<li>
<p><strong>id:</strong> id of the topic</p>
</li>
<li>
<p><strong>forum_id:</strong> id of the forum associated to this topic</p>
</li>
<li>
<p><strong>last_post_id:</strong> id of the last post in this forum</p>
</li>
<li>
<p><strong>last_post_date:</strong> date of the last post in this topic (timestamp)</p>
</li>
<li>
<p><strong>root_post_id:</strong> id of the root post of this topic</p>
</li>
<li>
<p><strong>replies:</strong> number of replies for this topic</p>
</li>
<li>
<p><strong>views:</strong> number of views for this topic</p>
</li>
<li>
<p><strong>url:</strong> url of a specific topic on the Eclipse Forums website <em>(Note: the trailing slash is important)</em></p>
</li>
<li>
<p><strong>forum_url:</strong> url that will return information about the forum associated to this topic</p>
</li>
<li>
<p><strong>posts_url:</strong> url that will return information about for all the posts associated with a specific topic id</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>/forums/topic?<span class="hljs-attribute">forum_id=</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 class="hljs-attribute">since=</span><span class="hljs-literal"></span>&<span class="hljs-attribute">until=</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>forum_id</dt><dd><code>integer</code>&nbsp;<span>(optional)</span>&nbsp;<p>Unique identifier for a forum</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 created date in which the results will be returned. DESC by default</p>
</dd><dt>since</dt><dd><code>integer</code>&nbsp;<span>(optional)</span>&nbsp;<p>The results since a timestamp onward</p>
</dd><dt>until</dt><dd><code>integer</code>&nbsp;<span>(optional)</span>&nbsp;<p>The results until a timestamp</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/forums/topic?forum_id=1&amp;amp;page=1&amp;amp;pagesize=20&gt;; rel="last", &lt;https://api.eclipse.org/forums/topic?forum_id=1&amp;amp;page=99&amp;amp;pagesize=20&gt;; rel="first", &lt;https://api.eclipse.org/forums/topic?forum_id=1&amp;amp;page=1&amp;amp;pagesize=20&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">pagination</span>": <span class="hljs-value">{
"<span class="hljs-attribute">page</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">pagesize</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">result_start</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">result_end</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">result_size</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">total_result_size</span>": <span class="hljs-value"><span class="hljs-number">892958</span>
</span>}</span>,
"<span class="hljs-attribute">result</span>": <span class="hljs-value">[
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"1091418"</span></span>,
"<span class="hljs-attribute">forum_id</span>": <span class="hljs-value"><span class="hljs-string">"89"</span></span>,
"<span class="hljs-attribute">last_post_id</span>": <span class="hljs-value"><span class="hljs-string">"1780973"</span></span>,
"<span class="hljs-attribute">last_post_date</span>": <span class="hljs-value"><span class="hljs-string">"1517333817"</span></span>,
"<span class="hljs-attribute">root_post_id</span>": <span class="hljs-value"><span class="hljs-string">"1780971"</span></span>,
"<span class="hljs-attribute">replies</span>": <span class="hljs-value"><span class="hljs-string">"2"</span></span>,
"<span class="hljs-attribute">views</span>": <span class="hljs-value"><span class="hljs-string">"52"</span></span>,
"<span class="hljs-attribute">subject</span>": <span class="hljs-value"><span class="hljs-string">"keep the parameter value selected"</span></span>,
"<span class="hljs-attribute">html_url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php/t/1091418/"</span></span>,
"<span class="hljs-attribute">posts_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/post?topic_id=1091418"</span></span>,
"<span class="hljs-attribute">forum_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/forum/89"</span>
</span>}
]
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="forums-retrieve-topic" class="resource"><h3 class="resource-heading">Retrieve Topic <a href="#forums-retrieve-topic" class="permalink">&nbsp;&para;</a></h3><div id="forums-retrieve-topic-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve Topic</div><a href="#forums-retrieve-topic-get" class="method get">GET</a><code class="uri">/forums/topic/{topic_id}</code></h4><h3 id="header-overview-5">Overview <a class="permalink" href="#header-overview-5" aria-hidden="true"></a></h3>
<p>Retrieve information for <strong>a specific topic</strong> from the Eclipse Forums website.</p>
<h3 id="header-what-is-a-topic?-1">What is a topic? <a class="permalink" href="#header-what-is-a-topic?-1" aria-hidden="true"></a></h3>
<p>A topic is a group of posts.</p>
<p>Posts are associated to a topic by topic id.</p>
<h3 id="header-result-definition-5">Result definition <a class="permalink" href="#header-result-definition-5" aria-hidden="true"></a></h3>
<ul>
<li>
<p><strong>id:</strong> id of the topic</p>
</li>
<li>
<p><strong>forum_id:</strong> id of the forum associated to this topic</p>
</li>
<li>
<p><strong>last_post_id:</strong> id of the last post in this forum</p>
</li>
<li>
<p><strong>last_post_date:</strong> date of the last post in this topic (timestamp)</p>
</li>
<li>
<p><strong>root_post_id:</strong> id of the root post of this topic</p>
</li>
<li>
<p><strong>replies:</strong> number of replies for this topic</p>
</li>
<li>
<p><strong>views:</strong> number of views for this topic</p>
</li>
<li>
<p><strong>url:</strong> url of a specific topic on the Eclipse Forums website <em>(Note: the trailing slash is important)</em></p>
</li>
<li>
<p><strong>forum_url:</strong> url that will return information about the forum associated to this topic</p>
</li>
<li>
<p><strong>posts_url:</strong> url that will return information about all the posts associated with a specific topic id</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>/forums/topic/<span class="hljs-attribute" title="topic_id">topic_id</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>topic_id</dt><dd><code>integer</code>&nbsp;<span class="required">(required)</span>&nbsp;<p>Unique identifier for a topic</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">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">id</span>": <span class="hljs-value"><span class="hljs-string">"1091418"</span></span>,
"<span class="hljs-attribute">forum_id</span>": <span class="hljs-value"><span class="hljs-string">"89"</span></span>,
"<span class="hljs-attribute">last_post_id</span>": <span class="hljs-value"><span class="hljs-string">"1780973"</span></span>,
"<span class="hljs-attribute">last_post_date</span>": <span class="hljs-value"><span class="hljs-string">"1517333817"</span></span>,
"<span class="hljs-attribute">root_post_id</span>": <span class="hljs-value"><span class="hljs-string">"1780971"</span></span>,
"<span class="hljs-attribute">replies</span>": <span class="hljs-value"><span class="hljs-string">"2"</span></span>,
"<span class="hljs-attribute">views</span>": <span class="hljs-value"><span class="hljs-string">"52"</span></span>,
"<span class="hljs-attribute">subject</span>": <span class="hljs-value"><span class="hljs-string">"keep the parameter value selected"</span></span>,
"<span class="hljs-attribute">html_url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php/t/1091418/"</span></span>,
"<span class="hljs-attribute">posts_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/post?topic_id=1091418"</span></span>,
"<span class="hljs-attribute">forum_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/forum/89"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="forums-fetch-posts" class="resource"><h3 class="resource-heading">Fetch Posts <a href="#forums-fetch-posts" class="permalink">&nbsp;&para;</a></h3><div id="forums-fetch-posts-get" class="action get"><h4 class="action-heading"><div class="name">Fetch Posts</div><a href="#forums-fetch-posts-get" class="method get">GET</a><code class="uri">/forums/post{?topic_id,page,pagesize,order_by,since,until}</code></h4><h3 id="header-overview-6">Overview <a class="permalink" href="#header-overview-6" aria-hidden="true"></a></h3>
<p>Retrieve information for <strong>all the posts</strong> from the Eclipse Forums website.</p>
<p>Optionally, you can retrieve information for all the posts associated to a specific topic by using the topic_id parameter.
You can also retrieve posts that have been created between dates using the since and until parameters.</p>
<h3 id="header-what-is-a-post?">What is a post? <a class="permalink" href="#header-what-is-a-post?" aria-hidden="true"></a></h3>
<p>A post is a message attached to a specific topic</p>
<p>Posts are associated to a topic by topic id.</p>
<h3 id="header-result-definition-6">Result definition <a class="permalink" href="#header-result-definition-6" aria-hidden="true"></a></h3>
<ul>
<li>
<p><strong>id:</strong> id of the post</p>
</li>
<li>
<p><strong>subject:</strong> subject of the post</p>
</li>
<li>
<p><strong>forum_id:</strong> id of the forum associated to this post</p>
</li>
<li>
<p><strong>topic_id:</strong> id of the topic associated to this post</p>
</li>
<li>
<p><strong>poster_id:</strong> id of the user that submitted this post</p>
</li>
<li>
<p><strong>created_date:</strong> date that this post has been created (timestamp)</p>
</li>
<li>
<p><strong>url:</strong> url of a specific post on the Eclipse Forums website</p>
</li>
<li>
<p><strong>body:</strong> body content of this post</p>
</li>
<li>
<p><strong>topic_url:</strong> url that will return information about the topic associated to this post</p>
</li>
<li>
<p><strong>topic_posts_url:</strong> url that will return all the posts from the topic associated to this post</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>/forums/post?<span class="hljs-attribute">topic_id=</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 class="hljs-attribute">since=</span><span class="hljs-literal"></span>&<span class="hljs-attribute">until=</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>topic_id</dt><dd><code>integer</code>&nbsp;<span>(optional)</span>&nbsp;<p>Unique identifier for a topic</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 created date in which the results will be returned. DESC by default</p>
</dd><dt>since</dt><dd><code>integer</code>&nbsp;<span>(optional)</span>&nbsp;<p>The results since a timestamp onward</p>
</dd><dt>until</dt><dd><code>integer</code>&nbsp;<span>(optional)</span>&nbsp;<p>The results until a timestamp</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/forums/post?topic_id=1&amp;amp;page=1&amp;amp;pagesize=20&gt;; rel="last", &lt;https://api.eclipse.org/forums/post?topic_id=1&amp;amp;page=99&amp;amp;pagesize=20&gt;; rel="first", &lt;https://api.eclipse.org/forums/post?topic_id=1&amp;amp;page=1&amp;amp;pagesize=20&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">pagination</span>": <span class="hljs-value">{
"<span class="hljs-attribute">page</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">pagesize</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">result_start</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">result_end</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">result_size</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">total_result_size</span>": <span class="hljs-value"><span class="hljs-number">1645105</span>
</span>}</span>,
"<span class="hljs-attribute">result</span>": <span class="hljs-value">[
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"1780973"</span></span>,
"<span class="hljs-attribute">subject</span>": <span class="hljs-value"><span class="hljs-string">"Re: keep the parameter value selected"</span></span>,
"<span class="hljs-attribute">topic_id</span>": <span class="hljs-value"><span class="hljs-string">"1091418"</span></span>,
"<span class="hljs-attribute">poster_id</span>": <span class="hljs-value"><span class="hljs-string">"219149"</span></span>,
"<span class="hljs-attribute">created_date</span>": <span class="hljs-value"><span class="hljs-string">"1517333817"</span></span>,
"<span class="hljs-attribute">forum_id</span>": <span class="hljs-value"><span class="hljs-string">"89"</span></span>,
"<span class="hljs-attribute">body</span>": <span class="hljs-value"><span class="hljs-string">"This is the body"</span></span>,
"<span class="hljs-attribute">html_url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php?t=msg&amp;th=1091418&amp;goto=1780973&amp;#msg_1780973"</span></span>,
"<span class="hljs-attribute">topic_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/topic/1091418"</span></span>,
"<span class="hljs-attribute">forum_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/forum/89"</span></span>,
"<span class="hljs-attribute">user_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/user/219149"</span>
</span>}
]
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="forums-retrieve-post" class="resource"><h3 class="resource-heading">Retrieve Post <a href="#forums-retrieve-post" class="permalink">&nbsp;&para;</a></h3><div id="forums-retrieve-post-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve Post</div><a href="#forums-retrieve-post-get" class="method get">GET</a><code class="uri">/forums/post/{post_id}</code></h4><h3 id="header-overview-7">Overview <a class="permalink" href="#header-overview-7" aria-hidden="true"></a></h3>
<p>Retrieve information for <strong>a specific post</strong> from the Eclipse Forums website.</p>
<h3 id="header-what-is-a-post?-1">What is a post? <a class="permalink" href="#header-what-is-a-post?-1" aria-hidden="true"></a></h3>
<p>A post is a message attached to a specific topic</p>
<p>Posts are associated to a topic by topic id.</p>
<h3 id="header-result-definition-7">Result definition <a class="permalink" href="#header-result-definition-7" aria-hidden="true"></a></h3>
<ul>
<li>
<p><strong>id:</strong> id of the post</p>
</li>
<li>
<p><strong>subject:</strong> subject of the post</p>
</li>
<li>
<p><strong>forum_id:</strong> id of the forum associated to this post</p>
</li>
<li>
<p><strong>topic_id:</strong> id of the topic associated to this post</p>
</li>
<li>
<p><strong>poster_id:</strong> id of the user that submitted this post</p>
</li>
<li>
<p><strong>created_date:</strong> date that this post has been created (timestamp)</p>
</li>
<li>
<p><strong>url:</strong> url of a specific post on the Eclipse Forums website</p>
</li>
<li>
<p><strong>body:</strong> body content of this post</p>
</li>
<li>
<p><strong>topic_url:</strong> url that will return information about the topic associated to this post</p>
</li>
<li>
<p><strong>topic_posts_url:</strong> url that will return all the posts from the topic associated to this post</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>/forums/post/<span class="hljs-attribute" title="post_id">post_id</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>post_id</dt><dd><code>integer</code>&nbsp;<span>(optional)</span>&nbsp;<p>Unique identifier for a post</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">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">id</span>": <span class="hljs-value"><span class="hljs-string">"1780973"</span></span>,
"<span class="hljs-attribute">subject</span>": <span class="hljs-value"><span class="hljs-string">"Re: keep the parameter value selected"</span></span>,
"<span class="hljs-attribute">topic_id</span>": <span class="hljs-value"><span class="hljs-string">"1091418"</span></span>,
"<span class="hljs-attribute">poster_id</span>": <span class="hljs-value"><span class="hljs-string">"219149"</span></span>,
"<span class="hljs-attribute">created_date</span>": <span class="hljs-value"><span class="hljs-string">"1517333817"</span></span>,
"<span class="hljs-attribute">forum_id</span>": <span class="hljs-value"><span class="hljs-string">"89"</span></span>,
"<span class="hljs-attribute">body</span>": <span class="hljs-value"><span class="hljs-string">"This is the body"</span></span>,
"<span class="hljs-attribute">html_url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php?t=msg&amp;th=1091418&amp;goto=1780973&amp;#msg_1780973"</span></span>,
"<span class="hljs-attribute">topic_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/topic/1091418"</span></span>,
"<span class="hljs-attribute">forum_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/forum/89"</span></span>,
"<span class="hljs-attribute">user_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/user/219149"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="forums-retrieve-user" class="resource"><h3 class="resource-heading">Retrieve User <a href="#forums-retrieve-user" class="permalink">&nbsp;&para;</a></h3><div id="forums-retrieve-user-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve User</div><a href="#forums-retrieve-user-get" class="method get">GET</a><code class="uri">/forums/user/{user_id}</code></h4><h3 id="header-overview-8">Overview <a class="permalink" href="#header-overview-8" aria-hidden="true"></a></h3>
<p>Retrieve information for <strong>a specific user</strong> from the Eclipse Forums website.</p>
<h3 id="header-what-is-a-user?">What is a user? <a class="permalink" href="#header-what-is-a-user?" aria-hidden="true"></a></h3>
<p>A user is the author of a post</p>
<h3 id="header-result-definition-8">Result definition <a class="permalink" href="#header-result-definition-8" aria-hidden="true"></a></h3>
<ul>
<li>
<p><strong>id:</strong> id of the user</p>
</li>
<li>
<p><strong>alias:</strong> alias of the user</p>
</li>
<li>
<p><strong>email:</strong> email of the user</p>
</li>
<li>
<p><strong>posted_msg_count:</strong> number of posts the user created</p>
</li>
<li>
<p><strong>join_date:</strong> timestamp of the date the user joined the Eclipse Forums</p>
</li>
<li>
<p><strong>last_visit:</strong> timestamp of the date the user last visited the Eclipse Forums website</p>
</li>
<li>
<p><strong>level_name:</strong> level of the user</p>
</li>
<li>
<p><strong>url:</strong> url of the user on the Eclipse Forums website</p>
</li>
<li>
<p><strong>account_url:</strong> url of the user’s account on <a href="http://accounts.eclipse.org">accounts.eclipse.org</a></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>/forums/user/<span class="hljs-attribute" title="user_id">user_id</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>user_id</dt><dd><code>integer</code>&nbsp;<span>(optional)</span>&nbsp;<p>Unique identifier for a user</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">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">id</span>": <span class="hljs-value"><span class="hljs-string">"1"</span></span>,
"<span class="hljs-attribute">alias</span>": <span class="hljs-value"><span class="hljs-string">"Test user"</span></span>,
"<span class="hljs-attribute">email</span>": <span class="hljs-value"><span class="hljs-string">"test@user.org"</span></span>,
"<span class="hljs-attribute">post_count</span>": <span class="hljs-value"><span class="hljs-string">"4"</span></span>,
"<span class="hljs-attribute">join_date</span>": <span class="hljs-value"><span class="hljs-string">"1510351551"</span></span>,
"<span class="hljs-attribute">last_visit</span>": <span class="hljs-value"><span class="hljs-string">"1517333991"</span></span>,
"<span class="hljs-attribute">level_name</span>": <span class="hljs-value"><span class="hljs-string">"Junior Member"</span></span>,
"<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">
Copyright &copy; Copyright &copy;
2018 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 26 Feb 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 Mar 2018</p><script>/* eslint-env browser */
/* eslint quotes: [2, "single"] */ /* eslint quotes: [2, "single"] */
'use strict'; 'use strict';
......
docs/proposals.html
+ 3
− 500
View file @ cf805027
...@@ -86,509 +86,12 @@ ...@@ -86,509 +86,12 @@
</div> </div>
</div> </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="#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 Proposals</h1></header><p>This page lists endpoint proposals for Eclipse 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><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 Proposals</h1></header><p>This page lists endpoint proposals for Eclipse API.</p>
<p>Please note that these are not on production and ready to use.</p> <p>Please note that these are not on production and ready to use.</p>
<section id="forums" class="resource-group"><h2 class="group-heading">Forums <a href="#forums" class="permalink">&para;</a></h2><p>Eclipse Forums are available through this resource.</p> </div></div></div><p style="text-align: center;" class="text-muted">
<div id="forums-fetch-categories" class="resource"><h3 class="resource-heading">Fetch Categories <a href="#forums-fetch-categories" class="permalink">&nbsp;&para;</a></h3><div id="forums-fetch-categories-get" class="action get"><h4 class="action-heading"><div class="name">Fetch Categories</div><a href="#forums-fetch-categories-get" class="method get">GET</a><code class="uri">/forums/category{?page,pagesize,order_by}</code></h4><h3 id="header-overview">Overview <a class="permalink" href="#header-overview" aria-hidden="true"></a></h3>
<p>Retrieve information for <strong>all the categories</strong> from the Eclipse Forums website.</p>
<h3 id="header-what-is-a-category?">What is a category? <a class="permalink" href="#header-what-is-a-category?" aria-hidden="true"></a></h3>
<p>A category is a group of forums.</p>
<p>Forums are associated to a category by category id.</p>
<h3 id="header-result-definition">Result definition <a class="permalink" href="#header-result-definition" aria-hidden="true"></a></h3>
<ul>
<li>
<p><strong>id:</strong> id of the category</p>
</li>
<li>
<p><strong>name:</strong> name of the category</p>
</li>
<li>
<p><strong>description:</strong> description of the category</p>
</li>
<li>
<p><strong>url:</strong> url that will return information of a specific category on the Eclipse Forums website <em>(Note: the trailing slash is important)</em></p>
</li>
<li>
<p><strong>forum_url:</strong> url that will return information for all the forums associated with a specific category id</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>/forums/category?<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>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 ID in which the results will be returned. DESC 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/forums/category?page=1&amp;amp;pagesize=20&gt;; rel="next", &lt;https://api.eclipse.org/forums/category?page=99&amp;amp;pagesize=5&gt;; rel="last", &lt;https://api.eclipse.org/forums/category?page=1&amp;amp;pagesize=5&gt;; rel="first", &lt;https://api.eclipse.org/forums/category?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">pagination</span>": <span class="hljs-value">{
"<span class="hljs-attribute">page</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">pagesize</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">result_start</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">result_end</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">result_size</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">total_result_size</span>": <span class="hljs-value"><span class="hljs-number">9</span>
</span>}</span>,
"<span class="hljs-attribute">result</span>": <span class="hljs-value">[
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"1"</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Eclipse Projects"</span></span>,
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">" - Eclipse Project Forums - click +/- to expand/collapse"</span></span>,
"<span class="hljs-attribute">html_url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php/i/1/"</span></span>,
"<span class="hljs-attribute">forums_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/forum?category_id=1"</span>
</span>},
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"2"</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Newcomers"</span></span>,
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">" - General Newcomer discussions"</span></span>,
"<span class="hljs-attribute">html_url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php/i/2/"</span></span>,
"<span class="hljs-attribute">forums_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/forum?category_id=2"</span>
</span>}
]
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="forums-retrieve-category" class="resource"><h3 class="resource-heading">Retrieve Category <a href="#forums-retrieve-category" class="permalink">&nbsp;&para;</a></h3><div id="forums-retrieve-category-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve Category</div><a href="#forums-retrieve-category-get" class="method get">GET</a><code class="uri">/forums/category/{category_id}</code></h4><h3 id="header-overview-1">Overview <a class="permalink" href="#header-overview-1" aria-hidden="true"></a></h3>
<p>Retrieve information for <strong>a specific category</strong> from the Eclipse Forums website.</p>
<h3 id="header-what-is-a-category?-1">What is a category? <a class="permalink" href="#header-what-is-a-category?-1" aria-hidden="true"></a></h3>
<p>A category is a group of forums.</p>
<p>Forums are associated to a category by category id.</p>
<h3 id="header-result-definition-1">Result definition <a class="permalink" href="#header-result-definition-1" aria-hidden="true"></a></h3>
<ul>
<li>
<p><strong>id:</strong> id of the category</p>
</li>
<li>
<p><strong>name:</strong> name of the category</p>
</li>
<li>
<p><strong>description:</strong> description of the category</p>
</li>
<li>
<p><strong>url:</strong> url that will return information of a specific category on the Eclipse Forums website <em>(Note: the trailing slash is important)</em></p>
</li>
<li>
<p><strong>forum_url:</strong> url that will return information for all the forums associated with a specific category id</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>/forums/category/<span class="hljs-attribute" title="category_id">category_id</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>category_id</dt><dd><code>integer</code>&nbsp;<span class="required">(required)</span>&nbsp;<p>Unique identifier for category</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">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">id</span>": <span class="hljs-value"><span class="hljs-string">"1"</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Eclipse Projects"</span></span>,
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">" - Eclipse Project Forums - click +/- to expand/collapse"</span></span>,
"<span class="hljs-attribute">html_url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php/i/1/"</span></span>,
"<span class="hljs-attribute">forums_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/forum?category_id=1"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="forums-fetch-forums" class="resource"><h3 class="resource-heading">Fetch Forums <a href="#forums-fetch-forums" class="permalink">&nbsp;&para;</a></h3><div id="forums-fetch-forums-get" class="action get"><h4 class="action-heading"><div class="name">Fetch Forums</div><a href="#forums-fetch-forums-get" class="method get">GET</a><code class="uri">/forums/forum{?category_id,page,pagesize,order_by,since,until}</code></h4><h3 id="header-overview-2">Overview <a class="permalink" href="#header-overview-2" aria-hidden="true"></a></h3>
<p>Retrieve information for <strong>all the forums</strong> from the Eclipse Forums website.</p>
<p>Optionally, you can retrieve information for all the forums associated to a specific category by using the category_id parameter.
You can also retrieve forums that have been created between dates using the since and until parameters.</p>
<h3 id="header-what-is-a-forum?">What is a forum? <a class="permalink" href="#header-what-is-a-forum?" aria-hidden="true"></a></h3>
<p>A forum is a group of topics.</p>
<p>Topics are associated to a forum by forum id.</p>
<h3 id="header-result-definition-2">Result definition <a class="permalink" href="#header-result-definition-2" aria-hidden="true"></a></h3>
<ul>
<li>
<p><strong>id:</strong> id of the forum</p>
</li>
<li>
<p><strong>name:</strong> name of the forum</p>
</li>
<li>
<p><strong>category_id:</strong> id of the category associated to this forum</p>
</li>
<li>
<p><strong>url:</strong> url of a specific forum on the Eclipse Forums website <em>(Note: the trailing slash is important)</em></p>
</li>
<li>
<p><strong>description:</strong> description of the forum</p>
</li>
<li>
<p><strong>created_date:</strong> date when the forum has been created (timestamp)</p>
</li>
<li>
<p><strong>topic_count:</strong> number of topics in this forum</p>
</li>
<li>
<p><strong>post_count:</strong> number of posts in this forum</p>
</li>
<li>
<p><strong>last_post_id:</strong> id of the last post in this forum</p>
</li>
<li>
<p><strong>category_url:</strong> url that will return information about a category</p>
</li>
<li>
<p><strong>topics_url:</strong> url that will return all the topics associated with a specific forum id</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>/forums/forum?<span class="hljs-attribute">category_id=</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 class="hljs-attribute">since=</span><span class="hljs-literal"></span>&<span class="hljs-attribute">until=</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>category_id</dt><dd><code>integer</code>&nbsp;<span>(optional)</span>&nbsp;<p>Unique identifier for a category</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 created date in which the results will be returned. DESC by default</p>
</dd><dt>since</dt><dd><code>integer</code>&nbsp;<span>(optional)</span>&nbsp;<p>The results since a timestamp onward</p>
</dd><dt>until</dt><dd><code>integer</code>&nbsp;<span>(optional)</span>&nbsp;<p>The results until a timestamp</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/forums/forum?category_id=1&amp;amp;page=1&amp;amp;pagesize=20&gt;; rel="last", &lt;https://api.eclipse.org/forums/forum?category_id=1&amp;amp;page=99&amp;amp;pagesize=20&gt;; rel="first", &lt;https://api.eclipse.org/forums/forum?category_id=1&amp;amp;page=1&amp;amp;pagesize=20&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">pagination</span>": <span class="hljs-value">{
"<span class="hljs-attribute">page</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">pagesize</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">result_start</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">result_end</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">result_size</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">total_result_size</span>": <span class="hljs-value"><span class="hljs-number">391</span>
</span>}</span>,
"<span class="hljs-attribute">result</span>": <span class="hljs-value">[
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"89"</span></span>,
"<span class="hljs-attribute">category_id</span>": <span class="hljs-value"><span class="hljs-string">"2"</span></span>,
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Eclipse forum for newcomers"</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Newcomers"</span></span>,
"<span class="hljs-attribute">created_date</span>": <span class="hljs-value"><span class="hljs-string">"1248707078"</span></span>,
"<span class="hljs-attribute">topic_count</span>": <span class="hljs-value"><span class="hljs-string">"22344"</span></span>,
"<span class="hljs-attribute">post_count</span>": <span class="hljs-value"><span class="hljs-string">"62843"</span></span>,
"<span class="hljs-attribute">last_post_id</span>": <span class="hljs-value"><span class="hljs-string">"1780973"</span></span>,
"<span class="hljs-attribute">html_url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php/f/89/"</span></span>,
"<span class="hljs-attribute">topics_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/topic?forum_id=89"</span></span>,
"<span class="hljs-attribute">category_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/category/2"</span>
</span>}
]
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="forums-retrieve-forum" class="resource"><h3 class="resource-heading">Retrieve Forum <a href="#forums-retrieve-forum" class="permalink">&nbsp;&para;</a></h3><div id="forums-retrieve-forum-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve Forum</div><a href="#forums-retrieve-forum-get" class="method get">GET</a><code class="uri">/forums/forum/{forum_id}</code></h4><h3 id="header-overview-3">Overview <a class="permalink" href="#header-overview-3" aria-hidden="true"></a></h3>
<p>Retrieve information for <strong>a specific forum</strong> from the Eclipse Forums website.</p>
<h3 id="header-what-is-a-forum?-1">What is a forum? <a class="permalink" href="#header-what-is-a-forum?-1" aria-hidden="true"></a></h3>
<p>A forum is a group of topics.</p>
<p>Topics are associated to a forum by forum id.</p>
<h3 id="header-result-definition-3">Result definition <a class="permalink" href="#header-result-definition-3" aria-hidden="true"></a></h3>
<ul>
<li>
<p><strong>id:</strong> id of the forum</p>
</li>
<li>
<p><strong>name:</strong> name of the forum</p>
</li>
<li>
<p><strong>category_id:</strong> id of the category associated to this forum</p>
</li>
<li>
<p><strong>url:</strong> url of a specific forum on the Eclipse Forums website <em>(Note: the trailing slash is important)</em></p>
</li>
<li>
<p><strong>description:</strong> description of the forum</p>
</li>
<li>
<p><strong>created_date:</strong> date when the forum has been created (timestamp)</p>
</li>
<li>
<p><strong>topic_count:</strong> number of topics in this forum</p>
</li>
<li>
<p><strong>post_count:</strong> number of posts in this forum</p>
</li>
<li>
<p><strong>last_post_id:</strong> id of the last post in this forum</p>
</li>
<li>
<p><strong>category_url:</strong> url that will return information about a category</p>
</li>
<li>
<p><strong>topics_url:</strong> url that will return all the topics associated with a specific forum id</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>/forums/forum/<span class="hljs-attribute" title="forum_id">forum_id</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>forum_id</dt><dd><code>integer</code>&nbsp;<span class="required">(required)</span>&nbsp;<p>Unique identifier for a forum</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">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">id</span>": <span class="hljs-value"><span class="hljs-string">"89"</span></span>,
"<span class="hljs-attribute">category_id</span>": <span class="hljs-value"><span class="hljs-string">"2"</span></span>,
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Eclipse forum for newcomers"</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Newcomers"</span></span>,
"<span class="hljs-attribute">created_date</span>": <span class="hljs-value"><span class="hljs-string">"1248707078"</span></span>,
"<span class="hljs-attribute">topic_count</span>": <span class="hljs-value"><span class="hljs-string">"22344"</span></span>,
"<span class="hljs-attribute">post_count</span>": <span class="hljs-value"><span class="hljs-string">"62843"</span></span>,
"<span class="hljs-attribute">last_post_id</span>": <span class="hljs-value"><span class="hljs-string">"1780973"</span></span>,
"<span class="hljs-attribute">html_url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php/f/89/"</span></span>,
"<span class="hljs-attribute">topics_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/topic?forum_id=89"</span></span>,
"<span class="hljs-attribute">category_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/category/2"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="forums-fetch-topics" class="resource"><h3 class="resource-heading">Fetch Topics <a href="#forums-fetch-topics" class="permalink">&nbsp;&para;</a></h3><div id="forums-fetch-topics-get" class="action get"><h4 class="action-heading"><div class="name">Fetch Topics</div><a href="#forums-fetch-topics-get" class="method get">GET</a><code class="uri">/forums/topic{?forum_id,page,pagesize,order_by,since,until}</code></h4><h3 id="header-overview-4">Overview <a class="permalink" href="#header-overview-4" aria-hidden="true"></a></h3>
<p>Retrieve information for <strong>all the topics</strong> from the Eclipse Forums website.</p>
<p>Optionally, you can retrieve information for all the topics associated to a specific forum by using the forum_id parameter.
You can also retrieve topics that have been created between dates using the since and until parameters.</p>
<h3 id="header-what-is-a-topic?">What is a topic? <a class="permalink" href="#header-what-is-a-topic?" aria-hidden="true"></a></h3>
<p>A topic is a group of posts.</p>
<p>Posts are associated to a topic by topic id.</p>
<h3 id="header-result-definition-4">Result definition <a class="permalink" href="#header-result-definition-4" aria-hidden="true"></a></h3>
<ul>
<li>
<p><strong>id:</strong> id of the topic</p>
</li>
<li>
<p><strong>forum_id:</strong> id of the forum associated to this topic</p>
</li>
<li>
<p><strong>last_post_id:</strong> id of the last post in this forum</p>
</li>
<li>
<p><strong>last_post_date:</strong> date of the last post in this topic (timestamp)</p>
</li>
<li>
<p><strong>root_post_id:</strong> id of the root post of this topic</p>
</li>
<li>
<p><strong>replies:</strong> number of replies for this topic</p>
</li>
<li>
<p><strong>views:</strong> number of views for this topic</p>
</li>
<li>
<p><strong>url:</strong> url of a specific topic on the Eclipse Forums website <em>(Note: the trailing slash is important)</em></p>
</li>
<li>
<p><strong>forum_url:</strong> url that will return information about the forum associated to this topic</p>
</li>
<li>
<p><strong>posts_url:</strong> url that will return information about for all the posts associated with a specific topic id</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>/forums/topic?<span class="hljs-attribute">forum_id=</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 class="hljs-attribute">since=</span><span class="hljs-literal"></span>&<span class="hljs-attribute">until=</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>forum_id</dt><dd><code>integer</code>&nbsp;<span>(optional)</span>&nbsp;<p>Unique identifier for a forum</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 created date in which the results will be returned. DESC by default</p>
</dd><dt>since</dt><dd><code>integer</code>&nbsp;<span>(optional)</span>&nbsp;<p>The results since a timestamp onward</p>
</dd><dt>until</dt><dd><code>integer</code>&nbsp;<span>(optional)</span>&nbsp;<p>The results until a timestamp</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/forums/topic?forum_id=1&amp;amp;page=1&amp;amp;pagesize=20&gt;; rel="last", &lt;https://api.eclipse.org/forums/topic?forum_id=1&amp;amp;page=99&amp;amp;pagesize=20&gt;; rel="first", &lt;https://api.eclipse.org/forums/topic?forum_id=1&amp;amp;page=1&amp;amp;pagesize=20&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">pagination</span>": <span class="hljs-value">{
"<span class="hljs-attribute">page</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">pagesize</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">result_start</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">result_end</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">result_size</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">total_result_size</span>": <span class="hljs-value"><span class="hljs-number">892958</span>
</span>}</span>,
"<span class="hljs-attribute">result</span>": <span class="hljs-value">[
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"1091418"</span></span>,
"<span class="hljs-attribute">forum_id</span>": <span class="hljs-value"><span class="hljs-string">"89"</span></span>,
"<span class="hljs-attribute">last_post_id</span>": <span class="hljs-value"><span class="hljs-string">"1780973"</span></span>,
"<span class="hljs-attribute">last_post_date</span>": <span class="hljs-value"><span class="hljs-string">"1517333817"</span></span>,
"<span class="hljs-attribute">root_post_id</span>": <span class="hljs-value"><span class="hljs-string">"1780971"</span></span>,
"<span class="hljs-attribute">replies</span>": <span class="hljs-value"><span class="hljs-string">"2"</span></span>,
"<span class="hljs-attribute">views</span>": <span class="hljs-value"><span class="hljs-string">"52"</span></span>,
"<span class="hljs-attribute">subject</span>": <span class="hljs-value"><span class="hljs-string">"keep the parameter value selected"</span></span>,
"<span class="hljs-attribute">html_url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php/t/1091418/"</span></span>,
"<span class="hljs-attribute">posts_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/post?topic_id=1091418"</span></span>,
"<span class="hljs-attribute">forum_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/forum/89"</span>
</span>}
]
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="forums-retrieve-topic" class="resource"><h3 class="resource-heading">Retrieve Topic <a href="#forums-retrieve-topic" class="permalink">&nbsp;&para;</a></h3><div id="forums-retrieve-topic-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve Topic</div><a href="#forums-retrieve-topic-get" class="method get">GET</a><code class="uri">/forums/topic/{topic_id}</code></h4><h3 id="header-overview-5">Overview <a class="permalink" href="#header-overview-5" aria-hidden="true"></a></h3>
<p>Retrieve information for <strong>a specific topic</strong> from the Eclipse Forums website.</p>
<h3 id="header-what-is-a-topic?-1">What is a topic? <a class="permalink" href="#header-what-is-a-topic?-1" aria-hidden="true"></a></h3>
<p>A topic is a group of posts.</p>
<p>Posts are associated to a topic by topic id.</p>
<h3 id="header-result-definition-5">Result definition <a class="permalink" href="#header-result-definition-5" aria-hidden="true"></a></h3>
<ul>
<li>
<p><strong>id:</strong> id of the topic</p>
</li>
<li>
<p><strong>forum_id:</strong> id of the forum associated to this topic</p>
</li>
<li>
<p><strong>last_post_id:</strong> id of the last post in this forum</p>
</li>
<li>
<p><strong>last_post_date:</strong> date of the last post in this topic (timestamp)</p>
</li>
<li>
<p><strong>root_post_id:</strong> id of the root post of this topic</p>
</li>
<li>
<p><strong>replies:</strong> number of replies for this topic</p>
</li>
<li>
<p><strong>views:</strong> number of views for this topic</p>
</li>
<li>
<p><strong>url:</strong> url of a specific topic on the Eclipse Forums website <em>(Note: the trailing slash is important)</em></p>
</li>
<li>
<p><strong>forum_url:</strong> url that will return information about the forum associated to this topic</p>
</li>
<li>
<p><strong>posts_url:</strong> url that will return information about all the posts associated with a specific topic id</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>/forums/topic/<span class="hljs-attribute" title="topic_id">topic_id</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>topic_id</dt><dd><code>integer</code>&nbsp;<span class="required">(required)</span>&nbsp;<p>Unique identifier for a topic</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">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">id</span>": <span class="hljs-value"><span class="hljs-string">"1091418"</span></span>,
"<span class="hljs-attribute">forum_id</span>": <span class="hljs-value"><span class="hljs-string">"89"</span></span>,
"<span class="hljs-attribute">last_post_id</span>": <span class="hljs-value"><span class="hljs-string">"1780973"</span></span>,
"<span class="hljs-attribute">last_post_date</span>": <span class="hljs-value"><span class="hljs-string">"1517333817"</span></span>,
"<span class="hljs-attribute">root_post_id</span>": <span class="hljs-value"><span class="hljs-string">"1780971"</span></span>,
"<span class="hljs-attribute">replies</span>": <span class="hljs-value"><span class="hljs-string">"2"</span></span>,
"<span class="hljs-attribute">views</span>": <span class="hljs-value"><span class="hljs-string">"52"</span></span>,
"<span class="hljs-attribute">subject</span>": <span class="hljs-value"><span class="hljs-string">"keep the parameter value selected"</span></span>,
"<span class="hljs-attribute">html_url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php/t/1091418/"</span></span>,
"<span class="hljs-attribute">posts_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/post?topic_id=1091418"</span></span>,
"<span class="hljs-attribute">forum_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/forum/89"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="forums-fetch-posts" class="resource"><h3 class="resource-heading">Fetch Posts <a href="#forums-fetch-posts" class="permalink">&nbsp;&para;</a></h3><div id="forums-fetch-posts-get" class="action get"><h4 class="action-heading"><div class="name">Fetch Posts</div><a href="#forums-fetch-posts-get" class="method get">GET</a><code class="uri">/forums/post{?topic_id,page,pagesize,order_by,since,until}</code></h4><h3 id="header-overview-6">Overview <a class="permalink" href="#header-overview-6" aria-hidden="true"></a></h3>
<p>Retrieve information for <strong>all the posts</strong> from the Eclipse Forums website.</p>
<p>Optionally, you can retrieve information for all the posts associated to a specific topic by using the topic_id parameter.
You can also retrieve posts that have been created between dates using the since and until parameters.</p>
<h3 id="header-what-is-a-post?">What is a post? <a class="permalink" href="#header-what-is-a-post?" aria-hidden="true"></a></h3>
<p>A post is a message attached to a specific topic</p>
<p>Posts are associated to a topic by topic id.</p>
<h3 id="header-result-definition-6">Result definition <a class="permalink" href="#header-result-definition-6" aria-hidden="true"></a></h3>
<ul>
<li>
<p><strong>id:</strong> id of the post</p>
</li>
<li>
<p><strong>subject:</strong> subject of the post</p>
</li>
<li>
<p><strong>forum_id:</strong> id of the forum associated to this post</p>
</li>
<li>
<p><strong>topic_id:</strong> id of the topic associated to this post</p>
</li>
<li>
<p><strong>poster_id:</strong> id of the user that submitted this post</p>
</li>
<li>
<p><strong>created_date:</strong> date that this post has been created (timestamp)</p>
</li>
<li>
<p><strong>url:</strong> url of a specific post on the Eclipse Forums website</p>
</li>
<li>
<p><strong>body:</strong> body content of this post</p>
</li>
<li>
<p><strong>topic_url:</strong> url that will return information about the topic associated to this post</p>
</li>
<li>
<p><strong>topic_posts_url:</strong> url that will return all the posts from the topic associated to this post</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>/forums/post?<span class="hljs-attribute">topic_id=</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 class="hljs-attribute">since=</span><span class="hljs-literal"></span>&<span class="hljs-attribute">until=</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>topic_id</dt><dd><code>integer</code>&nbsp;<span>(optional)</span>&nbsp;<p>Unique identifier for a topic</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 created date in which the results will be returned. DESC by default</p>
</dd><dt>since</dt><dd><code>integer</code>&nbsp;<span>(optional)</span>&nbsp;<p>The results since a timestamp onward</p>
</dd><dt>until</dt><dd><code>integer</code>&nbsp;<span>(optional)</span>&nbsp;<p>The results until a timestamp</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/forums/post?topic_id=1&amp;amp;page=1&amp;amp;pagesize=20&gt;; rel="last", &lt;https://api.eclipse.org/forums/post?topic_id=1&amp;amp;page=99&amp;amp;pagesize=20&gt;; rel="first", &lt;https://api.eclipse.org/forums/post?topic_id=1&amp;amp;page=1&amp;amp;pagesize=20&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">pagination</span>": <span class="hljs-value">{
"<span class="hljs-attribute">page</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">pagesize</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">result_start</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">result_end</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">result_size</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">total_result_size</span>": <span class="hljs-value"><span class="hljs-number">1645105</span>
</span>}</span>,
"<span class="hljs-attribute">result</span>": <span class="hljs-value">[
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"1780973"</span></span>,
"<span class="hljs-attribute">subject</span>": <span class="hljs-value"><span class="hljs-string">"Re: keep the parameter value selected"</span></span>,
"<span class="hljs-attribute">topic_id</span>": <span class="hljs-value"><span class="hljs-string">"1091418"</span></span>,
"<span class="hljs-attribute">poster_id</span>": <span class="hljs-value"><span class="hljs-string">"219149"</span></span>,
"<span class="hljs-attribute">created_date</span>": <span class="hljs-value"><span class="hljs-string">"1517333817"</span></span>,
"<span class="hljs-attribute">forum_id</span>": <span class="hljs-value"><span class="hljs-string">"89"</span></span>,
"<span class="hljs-attribute">body</span>": <span class="hljs-value"><span class="hljs-string">"This is the body"</span></span>,
"<span class="hljs-attribute">html_url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php?t=msg&amp;th=1091418&amp;goto=1780973&amp;#msg_1780973"</span></span>,
"<span class="hljs-attribute">topic_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/topic/1091418"</span></span>,
"<span class="hljs-attribute">forum_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/forum/89"</span></span>,
"<span class="hljs-attribute">user_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/user/219149"</span>
</span>}
]
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="forums-retrieve-post" class="resource"><h3 class="resource-heading">Retrieve Post <a href="#forums-retrieve-post" class="permalink">&nbsp;&para;</a></h3><div id="forums-retrieve-post-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve Post</div><a href="#forums-retrieve-post-get" class="method get">GET</a><code class="uri">/forums/post/{post_id}</code></h4><h3 id="header-overview-7">Overview <a class="permalink" href="#header-overview-7" aria-hidden="true"></a></h3>
<p>Retrieve information for <strong>a specific post</strong> from the Eclipse Forums website.</p>
<h3 id="header-what-is-a-post?-1">What is a post? <a class="permalink" href="#header-what-is-a-post?-1" aria-hidden="true"></a></h3>
<p>A post is a message attached to a specific topic</p>
<p>Posts are associated to a topic by topic id.</p>
<h3 id="header-result-definition-7">Result definition <a class="permalink" href="#header-result-definition-7" aria-hidden="true"></a></h3>
<ul>
<li>
<p><strong>id:</strong> id of the post</p>
</li>
<li>
<p><strong>subject:</strong> subject of the post</p>
</li>
<li>
<p><strong>forum_id:</strong> id of the forum associated to this post</p>
</li>
<li>
<p><strong>topic_id:</strong> id of the topic associated to this post</p>
</li>
<li>
<p><strong>poster_id:</strong> id of the user that submitted this post</p>
</li>
<li>
<p><strong>created_date:</strong> date that this post has been created (timestamp)</p>
</li>
<li>
<p><strong>url:</strong> url of a specific post on the Eclipse Forums website</p>
</li>
<li>
<p><strong>body:</strong> body content of this post</p>
</li>
<li>
<p><strong>topic_url:</strong> url that will return information about the topic associated to this post</p>
</li>
<li>
<p><strong>topic_posts_url:</strong> url that will return all the posts from the topic associated to this post</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>/forums/post/<span class="hljs-attribute" title="post_id">post_id</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>post_id</dt><dd><code>integer</code>&nbsp;<span>(optional)</span>&nbsp;<p>Unique identifier for a post</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">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">id</span>": <span class="hljs-value"><span class="hljs-string">"1780973"</span></span>,
"<span class="hljs-attribute">subject</span>": <span class="hljs-value"><span class="hljs-string">"Re: keep the parameter value selected"</span></span>,
"<span class="hljs-attribute">topic_id</span>": <span class="hljs-value"><span class="hljs-string">"1091418"</span></span>,
"<span class="hljs-attribute">poster_id</span>": <span class="hljs-value"><span class="hljs-string">"219149"</span></span>,
"<span class="hljs-attribute">created_date</span>": <span class="hljs-value"><span class="hljs-string">"1517333817"</span></span>,
"<span class="hljs-attribute">forum_id</span>": <span class="hljs-value"><span class="hljs-string">"89"</span></span>,
"<span class="hljs-attribute">body</span>": <span class="hljs-value"><span class="hljs-string">"This is the body"</span></span>,
"<span class="hljs-attribute">html_url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php?t=msg&amp;th=1091418&amp;goto=1780973&amp;#msg_1780973"</span></span>,
"<span class="hljs-attribute">topic_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/topic/1091418"</span></span>,
"<span class="hljs-attribute">forum_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/forum/89"</span></span>,
"<span class="hljs-attribute">user_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/user/219149"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="forums-retrieve-user" class="resource"><h3 class="resource-heading">Retrieve User <a href="#forums-retrieve-user" class="permalink">&nbsp;&para;</a></h3><div id="forums-retrieve-user-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve User</div><a href="#forums-retrieve-user-get" class="method get">GET</a><code class="uri">/forums/user/{user_id}</code></h4><h3 id="header-overview-8">Overview <a class="permalink" href="#header-overview-8" aria-hidden="true"></a></h3>
<p>Retrieve information for <strong>a specific user</strong> from the Eclipse Forums website.</p>
<h3 id="header-what-is-a-user?">What is a user? <a class="permalink" href="#header-what-is-a-user?" aria-hidden="true"></a></h3>
<p>A user is the author of a post</p>
<h3 id="header-result-definition-8">Result definition <a class="permalink" href="#header-result-definition-8" aria-hidden="true"></a></h3>
<ul>
<li>
<p><strong>id:</strong> id of the user</p>
</li>
<li>
<p><strong>alias:</strong> alias of the user</p>
</li>
<li>
<p><strong>email:</strong> email of the user</p>
</li>
<li>
<p><strong>posted_msg_count:</strong> number of posts the user created</p>
</li>
<li>
<p><strong>join_date:</strong> timestamp of the date the user joined the Eclipse Forums</p>
</li>
<li>
<p><strong>last_visit:</strong> timestamp of the date the user last visited the Eclipse Forums website</p>
</li>
<li>
<p><strong>level_name:</strong> level of the user</p>
</li>
<li>
<p><strong>url:</strong> url of the user on the Eclipse Forums website</p>
</li>
<li>
<p><strong>account_url:</strong> url of the user’s account on <a href="http://accounts.eclipse.org">accounts.eclipse.org</a></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>/forums/user/<span class="hljs-attribute" title="user_id">user_id</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>user_id</dt><dd><code>integer</code>&nbsp;<span>(optional)</span>&nbsp;<p>Unique identifier for a user</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">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">id</span>": <span class="hljs-value"><span class="hljs-string">"1"</span></span>,
"<span class="hljs-attribute">alias</span>": <span class="hljs-value"><span class="hljs-string">"Test user"</span></span>,
"<span class="hljs-attribute">email</span>": <span class="hljs-value"><span class="hljs-string">"test@user.org"</span></span>,
"<span class="hljs-attribute">post_count</span>": <span class="hljs-value"><span class="hljs-string">"4"</span></span>,
"<span class="hljs-attribute">join_date</span>": <span class="hljs-value"><span class="hljs-string">"1510351551"</span></span>,
"<span class="hljs-attribute">last_visit</span>": <span class="hljs-value"><span class="hljs-string">"1517333991"</span></span>,
"<span class="hljs-attribute">level_name</span>": <span class="hljs-value"><span class="hljs-string">"Junior Member"</span></span>,
"<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">
Copyright &copy; Copyright &copy;
2018 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 26 Feb 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 Mar 2018</p><script>/* eslint-env browser */
/* eslint quotes: [2, "single"] */ /* eslint quotes: [2, "single"] */
'use strict'; 'use strict';
......
src/index.apib
+ 1
− 0
View file @ cf805027
...@@ -69,3 +69,4 @@ are used. ...@@ -69,3 +69,4 @@ are used.
<!-- include(modules/uss.apib) --> <!-- include(modules/uss.apib) -->
<!-- include(modules/download.apib) --> <!-- include(modules/download.apib) -->
<!-- include(modules/marketplace_favorites.apib) --> <!-- include(modules/marketplace_favorites.apib) -->
<!-- include(modules/forums.apib) -->
src/proposals.apib
+ 0
− 2
View file @ cf805027
...@@ -6,5 +6,3 @@ HOST: https://api.eclipse.org ...@@ -6,5 +6,3 @@ HOST: https://api.eclipse.org
This page lists endpoint proposals for Eclipse API. This page lists endpoint proposals for Eclipse API.
Please note that these are not on production and ready to use. Please note that these are not on production and ready to use.
<!-- include(modules/forums.apib) -->
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

Copyright © Eclipse Foundation, Inc. All Rights Reserved.     Privacy Policy | Terms of Use | Copyright Agent