From d18e59e332cc1e43930ba6c9add76ac5b5b20d25 Mon Sep 17 00:00:00 2001
From: Eric Poirier <eric.poirier@eclipse-foundation.org>
Date: Tue, 20 Feb 2018 11:32:41 -0500
Subject: [PATCH] Update Forums documentation
Signed-off-by: Eric Poirier <eric.poirier@eclipse-foundation.org>
---
docs/auth.html | 2 +-
docs/index.html | 2 +-
docs/proposals.html | 320 +++++++++++++++++++++++++++++++++++++---
src/modules/forums.apib | 207 ++++++++++++++++++++++++--
4 files changed, 494 insertions(+), 37 deletions(-)
diff --git a/docs/auth.html b/docs/auth.html
index 28b8df1..21f5868 100644
--- a/docs/auth.html
+++ b/docs/auth.html
@@ -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">
Copyright ©
2018
-The Eclipse Foundation. All Rights Reserved.</p><p style="text-align: center;" class="text-muted hide">Generated by <a href="https://github.com/danielgtaylor/aglio" class="aglio">aglio</a> on 20 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 <a href="https://github.com/danielgtaylor/aglio" class="aglio">aglio</a> on 21 Feb 2018</p><script>/* eslint-env browser */
/* eslint quotes: [2, "single"] */
'use strict';
diff --git a/docs/index.html b/docs/index.html
index d8528d5..dc951fa 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -2194,7 +2194,7 @@ Think of it like an app store for Eclipse solutions.</p>
</span>}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response <code>204</code></strong></div></div></div></section></div></div></div><p style="text-align: center;" class="text-muted">
Copyright ©
2018
-The Eclipse Foundation. All Rights Reserved.</p><p style="text-align: center;" class="text-muted hide">Generated by <a href="https://github.com/danielgtaylor/aglio" class="aglio">aglio</a> on 20 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 <a href="https://github.com/danielgtaylor/aglio" class="aglio">aglio</a> on 21 Feb 2018</p><script>/* eslint-env browser */
/* eslint quotes: [2, "single"] */
'use strict';
diff --git a/docs/proposals.html b/docs/proposals.html
index 6de3652..460e40e 100644
--- a/docs/proposals.html
+++ b/docs/proposals.html
@@ -89,7 +89,29 @@
</header><a href="#top" class="text-muted back-to-top"><i class="fa fa-toggle-up"></i> Back to top</a><div class="container-fluid container-content"><div class="row"><nav><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#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></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>
<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">¶</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"> ¶</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><p>Retrieve a list of all the categories from the Eclipse Forums.</p>
+<div id="forums-fetch-categories" class="resource"><h3 class="resource-heading">Fetch Categories <a href="#forums-fetch-categories" class="permalink"> ¶</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> <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> <span>(optional)</span> <p>The index of the page to get, defaults to 1.</p>
</dd><dt>pagesize</dt><dd><code>integer</code> <span>(optional)</span> <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> <span>(optional)</span> <p>The order by ID in which the results will be returned. DESC by default</p>
@@ -118,7 +140,29 @@
"<span class="hljs-attribute">forums_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/forum?category_id=8"</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"> ¶</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><p>Retrieve a specific category from the Eclipse Forum’s.</p>
+</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"> ¶</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> <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> <span class="required">(required)</span> <p>Unique identifier for category</p>
</dd></dl></div><div class="title"><strong>Response <code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">X-Rate-Limit-Limit</span>: <span class="hljs-string">1000</span><br><span class="hljs-attribute">X-Rate-Limit-Remaining</span>: <span class="hljs-string">964</span><br><span class="hljs-attribute">X-Rate-Limit-Reset</span>: <span class="hljs-string">3553</span><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">"10"</span></span>,
@@ -126,7 +170,49 @@
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">""</span></span>,
"<span class="hljs-attribute">url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php/i/10/"</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=10"</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"> ¶</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><p>Retrieve a list of all the forums from the Eclipse Forums based on a category id if specified.</p>
+</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"> ¶</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> <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> <span>(optional)</span> <p>Unique identifier for a category</p>
</dd><dt>page</dt><dd><code>integer</code> <span>(optional)</span> <p>The index of the page to get, defaults to 1.</p>
</dd><dt>pagesize</dt><dd><code>integer</code> <span>(optional)</span> <p>The number of records to get per page, defaults to 20. Maximum value is 100.</p>
@@ -147,31 +233,110 @@
"<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">"BIRT"</span></span>,
"<span class="hljs-attribute">category_id</span>": <span class="hljs-value"><span class="hljs-string">"1"</span></span>,
- "<span class="hljs-attribute">url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php/f/2"</span></span>,
+ "<span class="hljs-attribute">url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php/f/2/"</span></span>,
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Questions, technical discussions and resources on the Business Intelligence and Reporting Tools (BIRT) Project &#160; &lt;a class='smallLink' href='http://www.eclipse.org/birt/'&gt;[project home]&lt;/a&gt;"</span></span>,
- "<span class="hljs-attribute">date_created</span>": <span class="hljs-value"><span class="hljs-string">"1248706783"</span></span>,
- "<span class="hljs-attribute">thread_count</span>": <span class="hljs-value"><span class="hljs-string">"28740"</span></span>,
+ "<span class="hljs-attribute">created_date</span>": <span class="hljs-value"><span class="hljs-string">"1248706783"</span></span>,
+ "<span class="hljs-attribute">topic_count</span>": <span class="hljs-value"><span class="hljs-string">"28740"</span></span>,
"<span class="hljs-attribute">post_count</span>": <span class="hljs-value"><span class="hljs-string">"93781"</span></span>,
"<span class="hljs-attribute">last_post_id</span>": <span class="hljs-value"><span class="hljs-string">"1780940"</span></span>,
"<span class="hljs-attribute">category_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/category/1"</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=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"> ¶</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><p>Retrieve a specific forum from the Eclipse Forums.</p>
+</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"> ¶</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> <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> <span class="required">(required)</span> <p>Unique identifier for a forum</p>
</dd></dl></div><div class="title"><strong>Response <code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">X-Rate-Limit-Limit</span>: <span class="hljs-string">1000</span><br><span class="hljs-attribute">X-Rate-Limit-Remaining</span>: <span class="hljs-string">964</span><br><span class="hljs-attribute">X-Rate-Limit-Reset</span>: <span class="hljs-string">3553</span><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">"2"</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"BIRT"</span></span>,
"<span class="hljs-attribute">category_id</span>": <span class="hljs-value"><span class="hljs-string">"1"</span></span>,
- "<span class="hljs-attribute">url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php/f/2"</span></span>,
+ "<span class="hljs-attribute">url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php/f/2/"</span></span>,
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Questions, technical discussions and resources on the Business Intelligence and Reporting Tools (BIRT) Project &#160; &lt;a class='smallLink' href='http://www.eclipse.org/birt/'&gt;[project home]&lt;/a&gt;"</span></span>,
- "<span class="hljs-attribute">date_created</span>": <span class="hljs-value"><span class="hljs-string">"1248706783"</span></span>,
- "<span class="hljs-attribute">thread_count</span>": <span class="hljs-value"><span class="hljs-string">"28740"</span></span>,
+ "<span class="hljs-attribute">created_date</span>": <span class="hljs-value"><span class="hljs-string">"1248706783"</span></span>,
+ "<span class="hljs-attribute">topic_count</span>": <span class="hljs-value"><span class="hljs-string">"28740"</span></span>,
"<span class="hljs-attribute">post_count</span>": <span class="hljs-value"><span class="hljs-string">"93781"</span></span>,
"<span class="hljs-attribute">last_post_id</span>": <span class="hljs-value"><span class="hljs-string">"1780940"</span></span>,
"<span class="hljs-attribute">category_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/category/1"</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=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"> ¶</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><p>Retrieve a list of all the topics from the Eclipse Forums based on a forum id if specified.</p>
+</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"> ¶</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> <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> <span>(optional)</span> <p>Unique identifier for a forum</p>
</dd><dt>page</dt><dd><code>integer</code> <span>(optional)</span> <p>The index of the page to get, defaults to 1.</p>
</dd><dt>pagesize</dt><dd><code>integer</code> <span>(optional)</span> <p>The number of records to get per page, defaults to 20. Maximum value is 100.</p>
@@ -192,16 +357,53 @@
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"2"</span></span>,
"<span class="hljs-attribute">forum_id</span>": <span class="hljs-value"><span class="hljs-string">"2"</span></span>,
"<span class="hljs-attribute">last_post_date</span>": <span class="hljs-value"><span class="hljs-string">"1489947260"</span></span>,
- "<span class="hljs-attribute">root_msg_id</span>": <span class="hljs-value"><span class="hljs-string">"2"</span></span>,
+ "<span class="hljs-attribute">root_post_id</span>": <span class="hljs-value"><span class="hljs-string">"2"</span></span>,
"<span class="hljs-attribute">replies</span>": <span class="hljs-value"><span class="hljs-string">"1"</span></span>,
"<span class="hljs-attribute">views</span>": <span class="hljs-value"><span class="hljs-string">"113121"</span></span>,
- "<span class="hljs-attribute">url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php/t/2"</span></span>,
+ "<span class="hljs-attribute">url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php/t/2/"</span></span>,
"<span class="hljs-attribute">last_post_id</span>": <span class="hljs-value"><span class="hljs-string">"1757399"</span></span>,
"<span class="hljs-attribute">forum_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/forum/2"</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=2"</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"> ¶</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><p>Retrieve a specific topic from the Eclipse Forums.</p>
+</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"> ¶</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> <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> <span class="required">(required)</span> <p>Unique identifier for a topic</p>
</dd></dl></div><div class="title"><strong>Response <code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">X-Rate-Limit-Limit</span>: <span class="hljs-string">1000</span><br><span class="hljs-attribute">X-Rate-Limit-Remaining</span>: <span class="hljs-string">964</span><br><span class="hljs-attribute">X-Rate-Limit-Reset</span>: <span class="hljs-string">3553</span><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">"2"</span></span>,
@@ -210,11 +412,50 @@
"<span class="hljs-attribute">root_msg_id</span>": <span class="hljs-value"><span class="hljs-string">"2"</span></span>,
"<span class="hljs-attribute">replies</span>": <span class="hljs-value"><span class="hljs-string">"1"</span></span>,
"<span class="hljs-attribute">views</span>": <span class="hljs-value"><span class="hljs-string">"113121"</span></span>,
- "<span class="hljs-attribute">url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php/t/2"</span></span>,
+ "<span class="hljs-attribute">url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php/t/2/"</span></span>,
"<span class="hljs-attribute">last_post_id</span>": <span class="hljs-value"><span class="hljs-string">"1757399"</span></span>,
"<span class="hljs-attribute">forum_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/forum/2"</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=2"</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"> ¶</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><p>Retrieve a list of all the posts from the Eclipse Forums based on a topic_id if specified.</p>
+</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"> ¶</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> <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> <span>(optional)</span> <p>Unique identifier for a topic</p>
</dd><dt>page</dt><dd><code>integer</code> <span>(optional)</span> <p>The index of the page to get, defaults to 1.</p>
</dd><dt>pagesize</dt><dd><code>integer</code> <span>(optional)</span> <p>The number of records to get per page, defaults to 20. Maximum value is 100.</p>
@@ -234,23 +475,62 @@
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"1779792"</span></span>,
"<span class="hljs-attribute">subject</span>": <span class="hljs-value"><span class="hljs-string">"Subclipse problem"</span></span>,
+ "<span class="hljs-attribute">forum_id</span>": <span class="hljs-value"><span class="hljs-string">"123"</span></span>,
"<span class="hljs-attribute">topic_id</span>": <span class="hljs-value"><span class="hljs-string">"1091069"</span></span>,
"<span class="hljs-attribute">poster_id</span>": <span class="hljs-value"><span class="hljs-string">"106173"</span></span>,
- "<span class="hljs-attribute">created</span>": <span class="hljs-value"><span class="hljs-string">"1515775710"</span></span>,
+ "<span class="hljs-attribute">created_date</span>": <span class="hljs-value"><span class="hljs-string">"1515775710"</span></span>,
"<span class="hljs-attribute">url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php?t=msg&th=1091069&goto=1779792&#msg_1779792"</span></span>,
"<span class="hljs-attribute">body</span>": <span class="hljs-value"><span class="hljs-string">"Hi,&lt;br /&gt;&lt;br /&gt;I was wondering if there is a way to force to redraw the whole Eclipse window. If not, I think it would be beneficial to have one if it's possible to implement, because lately - especially since the GTK2 -&gt; GTK3 transition started - Eclipse became more and more buggy in this area (at least the Linux version).&lt;br /&gt;&lt;br /&gt;I know that it would be only a workaround, and if there's a specific bug then it should be hunted down and corrected instead, but the bug hunting approach of solving the screen update issues works only on the long run. On one hand, many times the bug is in an underlying external component (such as GTK, some font rendering library, Linux video driver), and it's hard to make them correct the bug - that is, if they admit it's a bug and the discussion does not end up in a pointless flamewar instead. On the other hand, even if a bug is corrected, sometimes the correction is only available in the next release of Eclipse/Linux/GTK/whatever, so you end up waiting years to get it in a stable, packaged way, or you have to use experimental stuff which might even need compilation from scratch, etc.&lt;br /&gt;&lt;br /&gt;So, I'd like to ask if anyone knows whether it is technically possible to implement a &quot;forced screen redraw&quot; feature in Eclipse in a general way, so that the notorious screen garbage problems could be mitigated?"</span></span>,
"<span class="hljs-attribute">topic_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/topic/1091069"</span></span>,
"<span class="hljs-attribute">topic_posts_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/post?topic_id=1091069"</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"> ¶</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><p>Retrieve a specific post from the Eclipse Forums.</p>
+</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"> ¶</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> <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> <span>(optional)</span> <p>Unique identifier for a post</p>
</dd></dl></div><div class="title"><strong>Response <code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">X-Rate-Limit-Limit</span>: <span class="hljs-string">1000</span><br><span class="hljs-attribute">X-Rate-Limit-Remaining</span>: <span class="hljs-string">964</span><br><span class="hljs-attribute">X-Rate-Limit-Reset</span>: <span class="hljs-string">3553</span><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">"1779792"</span></span>,
"<span class="hljs-attribute">subject</span>": <span class="hljs-value"><span class="hljs-string">"Subclipse problem"</span></span>,
+ "<span class="hljs-attribute">forum_id</span>": <span class="hljs-value"><span class="hljs-string">"123"</span></span>,
"<span class="hljs-attribute">topic_id</span>": <span class="hljs-value"><span class="hljs-string">"1091069"</span></span>,
"<span class="hljs-attribute">poster_id</span>": <span class="hljs-value"><span class="hljs-string">"106173"</span></span>,
- "<span class="hljs-attribute">created</span>": <span class="hljs-value"><span class="hljs-string">"1515775710"</span></span>,
+ "<span class="hljs-attribute">created_date</span>": <span class="hljs-value"><span class="hljs-string">"1515775710"</span></span>,
"<span class="hljs-attribute">url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php?t=msg&th=1091069&goto=1779792&#msg_1779792"</span></span>,
"<span class="hljs-attribute">body</span>": <span class="hljs-value"><span class="hljs-string">"Hi,&lt;br /&gt;&lt;br /&gt;I was wondering if there is a way to force to redraw the whole Eclipse window. If not, I think it would be beneficial to have one if it's possible to implement, because lately - especially since the GTK2 -&gt; GTK3 transition started - Eclipse became more and more buggy in this area (at least the Linux version).&lt;br /&gt;&lt;br /&gt;I know that it would be only a workaround, and if there's a specific bug then it should be hunted down and corrected instead, but the bug hunting approach of solving the screen update issues works only on the long run. On one hand, many times the bug is in an underlying external component (such as GTK, some font rendering library, Linux video driver), and it's hard to make them correct the bug - that is, if they admit it's a bug and the discussion does not end up in a pointless flamewar instead. On the other hand, even if a bug is corrected, sometimes the correction is only available in the next release of Eclipse/Linux/GTK/whatever, so you end up waiting years to get it in a stable, packaged way, or you have to use experimental stuff which might even need compilation from scratch, etc.&lt;br /&gt;&lt;br /&gt;So, I'd like to ask if anyone knows whether it is technically possible to implement a &quot;forced screen redraw&quot; feature in Eclipse in a general way, so that the notorious screen garbage problems could be mitigated?"</span></span>,
"<span class="hljs-attribute">topic_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/topic/1091069"</span></span>,
@@ -258,7 +538,7 @@
</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 ©
2018
-The Eclipse Foundation. All Rights Reserved.</p><p style="text-align: center;" class="text-muted hide">Generated by <a href="https://github.com/danielgtaylor/aglio" class="aglio">aglio</a> on 20 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 <a href="https://github.com/danielgtaylor/aglio" class="aglio">aglio</a> on 21 Feb 2018</p><script>/* eslint-env browser */
/* eslint quotes: [2, "single"] */
'use strict';
diff --git a/src/modules/forums.apib b/src/modules/forums.apib
index 567a960..1e79c1a 100644
--- a/src/modules/forums.apib
+++ b/src/modules/forums.apib
@@ -1,10 +1,27 @@
# Group Forums
-Eclipse Forums are available through this resource.
+Eclipse Forums are available through this resource.
## Fetch Categories [GET /forums/category{?page,pagesize,order_by}]
-Retrieve a list of all the categories from the Eclipse Forums.
+
+### Overview
+
+Retrieve information for **all the categories** from the Eclipse Forums website.
+
+### What is a category?
+
+A category is a group of forums.
+
+Forums are associated to a category by category id.
+
+### Result definition
+
++ **id:** id of the category
++ **name:** name of the category
++ **description:** description of the category
++ **url:** url that will return information of a specific category on the Eclipse Forums website *(Note: the trailing slash is important)*
++ **forum_url:** url that will return information for all the forums associated with a specific category id
+ Parameters
+ page (integer, optional) - The index of the page to get, defaults to 1.
@@ -25,7 +42,24 @@ Retrieve a list of all the categories from the Eclipse Forums.
## Retrieve Category [GET /forums/category/{category_id}]
-Retrieve a specific category from the Eclipse Forum's.
+
+### Overview
+
+Retrieve information for **a specific category** from the Eclipse Forums website.
+
+### What is a category?
+
+A category is a group of forums.
+
+Forums are associated to a category by category id.
+
+### Result definition
+
++ **id:** id of the category
++ **name:** name of the category
++ **description:** description of the category
++ **url:** url that will return information of a specific category on the Eclipse Forums website *(Note: the trailing slash is important)*
++ **forum_url:** url that will return information for all the forums associated with a specific category id
+ Parameters
+ category_id (integer) - Unique identifier for category
@@ -43,7 +77,33 @@ Retrieve a specific category from the Eclipse Forum's.
## Fetch Forums [GET /forums/forum{?category_id,page,pagesize,order_by,since,until}]
-Retrieve a list of all the forums from the Eclipse Forums based on a category id if specified.
+
+### Overview
+
+Retrieve information for **all the forums** from the Eclipse Forums website.
+
+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.
+
+### What is a forum?
+
+A forum is a group of topics.
+
+Topics are associated to a forum by forum id.
+
+### Result definition
+
++ **id:** id of the forum
++ **name:** name of the forum
++ **category_id:** id of the category associated to this forum
++ **url:** url of a specific forum on the Eclipse Forums website *(Note: the trailing slash is important)*
++ **description:** description of the forum
++ **created_date:** date when the forum has been created (timestamp)
++ **topic_count:** number of topics in this forum
++ **post_count:** number of posts in this forum
++ **last_post_id:** id of the last post in this forum
++ **category_url:** url that will return information about a category
++ **topics_url:** url that will return all the topics associated with a specific forum id
+ Parameters
+ category_id (integer, optional) - Unique identifier for a category
@@ -62,12 +122,35 @@ Retrieve a list of all the forums from the Eclipse Forums based on a category id
Content-Type: application/json
+ Body
- {"pagination":{"page":1,"pagesize":1,"result_start":1,"result_end":1,"result_size":1,"total_result_size":391},"result":[{"id":"2","name":"BIRT","category_id":"1","url":"https://www.eclipse.org/forums/index.php/f/2","description":"Questions, technical discussions and resources on the Business Intelligence and Reporting Tools (BIRT) Project   <a class='smallLink' href='http://www.eclipse.org/birt/'>[project home]</a>","date_created":"1248706783","thread_count":"28740","post_count":"93781","last_post_id":"1780940","category_url":"https://api.eclipse.org/forums/category/1","topics_url":"https://api.eclipse.org/forums/topic?forum_id=2"}]}
+ {"pagination":{"page":1,"pagesize":1,"result_start":1,"result_end":1,"result_size":1,"total_result_size":391},"result":[{"id":"2","name":"BIRT","category_id":"1","url":"https://www.eclipse.org/forums/index.php/f/2/","description":"Questions, technical discussions and resources on the Business Intelligence and Reporting Tools (BIRT) Project   <a class='smallLink' href='http://www.eclipse.org/birt/'>[project home]</a>","created_date":"1248706783","topic_count":"28740","post_count":"93781","last_post_id":"1780940","category_url":"https://api.eclipse.org/forums/category/1","topics_url":"https://api.eclipse.org/forums/topic?forum_id=2"}]}
## Retrieve Forum [GET /forums/forum/{forum_id}]
-Retrieve a specific forum from the Eclipse Forums.
+
+### Overview
+
+Retrieve information for **a specific forum** from the Eclipse Forums website.
+
+### What is a forum?
+
+A forum is a group of topics.
+
+Topics are associated to a forum by forum id.
+
+### Result definition
+
++ **id:** id of the forum
++ **name:** name of the forum
++ **category_id:** id of the category associated to this forum
++ **url:** url of a specific forum on the Eclipse Forums website *(Note: the trailing slash is important)*
++ **description:** description of the forum
++ **created_date:** date when the forum has been created (timestamp)
++ **topic_count:** number of topics in this forum
++ **post_count:** number of posts in this forum
++ **last_post_id:** id of the last post in this forum
++ **category_url:** url that will return information about a category
++ **topics_url:** url that will return all the topics associated with a specific forum id
+ Parameters
+ forum_id (integer) - Unique identifier for a forum
@@ -80,12 +163,37 @@ Retrieve a specific forum from the Eclipse Forums.
Content-Type: application/json
+ Body
- {"id":"2","name":"BIRT","category_id":"1","url":"https://www.eclipse.org/forums/index.php/f/2","description":"Questions, technical discussions and resources on the Business Intelligence and Reporting Tools (BIRT) Project   <a class='smallLink' href='http://www.eclipse.org/birt/'>[project home]</a>","date_created":"1248706783","thread_count":"28740","post_count":"93781","last_post_id":"1780940","category_url":"https://api.eclipse.org/forums/category/1","topics_url":"https://api.eclipse.org/forums/topic?forum_id=2"}
+ {"id":"2","name":"BIRT","category_id":"1","url":"https://www.eclipse.org/forums/index.php/f/2/","description":"Questions, technical discussions and resources on the Business Intelligence and Reporting Tools (BIRT) Project   <a class='smallLink' href='http://www.eclipse.org/birt/'>[project home]</a>","created_date":"1248706783","topic_count":"28740","post_count":"93781","last_post_id":"1780940","category_url":"https://api.eclipse.org/forums/category/1","topics_url":"https://api.eclipse.org/forums/topic?forum_id=2"}
## Fetch Topics [GET /forums/topic{?forum_id,page,pagesize,order_by,since,until}]
-Retrieve a list of all the topics from the Eclipse Forums based on a forum id if specified.
+
+### Overview
+
+Retrieve information for **all the topics** from the Eclipse Forums website.
+
+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.
+
+### What is a topic?
+
+A topic is a group of posts.
+
+Posts are associated to a topic by topic id.
+
+### Result definition
+
++ **id:** id of the topic
++ **forum_id:** id of the forum associated to this topic
++ **last_post_id:** id of the last post in this forum
++ **last_post_date:** date of the last post in this topic (timestamp)
++ **root_post_id:** id of the root post of this topic
++ **replies:** number of replies for this topic
++ **views:** number of views for this topic
++ **url:** url of a specific topic on the Eclipse Forums website *(Note: the trailing slash is important)*
++ **forum_url:** url that will return information about the forum associated to this topic
++ **posts_url:** url that will return information about for all the posts associated with a specific topic id
+ Parameters
+ forum_id (integer, optional) - Unique identifier for a forum
@@ -104,12 +212,34 @@ Retrieve a list of all the topics from the Eclipse Forums based on a forum id if
Content-Type: application/json
+ Body
- {"pagination":{"page":1,"pagesize":1,"result_start":1,"result_end":1,"result_size":1,"total_result_size":892958},"result":[{"id":"2","forum_id":"2","last_post_date":"1489947260","root_msg_id":"2","replies":"1","views":"113121","url":"https://www.eclipse.org/forums/index.php/t/2","last_post_id":"1757399","forum_url":"https://api.eclipse.org/forums/forum/2","posts_url":"https://api.eclipse.org/forums/post?topic_id=2"}]}
+ {"pagination":{"page":1,"pagesize":1,"result_start":1,"result_end":1,"result_size":1,"total_result_size":892958},"result":[{"id":"2","forum_id":"2","last_post_date":"1489947260","root_post_id":"2","replies":"1","views":"113121","url":"https://www.eclipse.org/forums/index.php/t/2/","last_post_id":"1757399","forum_url":"https://api.eclipse.org/forums/forum/2","posts_url":"https://api.eclipse.org/forums/post?topic_id=2"}]}
## Retrieve Topic [GET /forums/topic/{topic_id}]
-Retrieve a specific topic from the Eclipse Forums.
+
+### Overview
+
+Retrieve information for **a specific topic** from the Eclipse Forums website.
+
+### What is a topic?
+
+A topic is a group of posts.
+
+Posts are associated to a topic by topic id.
+
+### Result definition
+
++ **id:** id of the topic
++ **forum_id:** id of the forum associated to this topic
++ **last_post_id:** id of the last post in this forum
++ **last_post_date:** date of the last post in this topic (timestamp)
++ **root_post_id:** id of the root post of this topic
++ **replies:** number of replies for this topic
++ **views:** number of views for this topic
++ **url:** url of a specific topic on the Eclipse Forums website *(Note: the trailing slash is important)*
++ **forum_url:** url that will return information about the forum associated to this topic
++ **posts_url:** url that will return information about all the posts associated with a specific topic id
+ Parameters
+ topic_id (integer) - Unique identifier for a topic
@@ -122,12 +252,37 @@ Retrieve a specific topic from the Eclipse Forums.
Content-Type: application/json
+ Body
- {"id":"2","forum_id":"2","last_post_date":"1489947260","root_msg_id":"2","replies":"1","views":"113121","url":"https://www.eclipse.org/forums/index.php/t/2","last_post_id":"1757399","forum_url":"https://api.eclipse.org/forums/forum/2","posts_url":"https://api.eclipse.org/forums/post?topic_id=2"}
+ {"id":"2","forum_id":"2","last_post_date":"1489947260","root_msg_id":"2","replies":"1","views":"113121","url":"https://www.eclipse.org/forums/index.php/t/2/","last_post_id":"1757399","forum_url":"https://api.eclipse.org/forums/forum/2","posts_url":"https://api.eclipse.org/forums/post?topic_id=2"}
## Fetch Posts [GET /forums/post{?topic_id,page,pagesize,order_by,since,until}]
-Retrieve a list of all the posts from the Eclipse Forums based on a topic_id if specified.
+
+### Overview
+
+Retrieve information for **all the posts** from the Eclipse Forums website.
+
+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.
+
+### What is a post?
+
+A post is a message attached to a specific topic
+
+Posts are associated to a topic by topic id.
+
+### Result definition
+
++ **id:** id of the post
++ **subject:** subject of the post
++ **forum_id:** id of the forum associated to this post
++ **topic_id:** id of the topic associated to this post
++ **poster_id:** id of the user that submitted this post
++ **created_date:** date that this post has been created (timestamp)
++ **url:** url of a specific post on the Eclipse Forums website
++ **body:** body content of this post
++ **topic_url:** url that will return information about the topic associated to this post
++ **topic_posts_url:** url that will return all the posts from the topic associated to this post
+ Parameters
+ topic_id (integer, optional) - Unique identifier for a topic
@@ -146,12 +301,34 @@ Retrieve a list of all the posts from the Eclipse Forums based on a topic_id if
Content-Type: application/json
+ Body
- {"pagination":{"page":1,"pagesize":1,"result_start":1,"result_end":1,"result_size":1,"total_result_size":1645105},"result":[{"id":"1779792","subject":"Subclipse problem","topic_id":"1091069","poster_id":"106173","created":"1515775710","url":"https://www.eclipse.org/forums/index.php?t=msg&th=1091069&goto=1779792&#msg_1779792","body":"Hi,<br /><br />I was wondering if there is a way to force to redraw the whole Eclipse window. If not, I think it would be beneficial to have one if it's possible to implement, because lately - especially since the GTK2 -> GTK3 transition started - Eclipse became more and more buggy in this area (at least the Linux version).<br /><br />I know that it would be only a workaround, and if there's a specific bug then it should be hunted down and corrected instead, but the bug hunting approach of solving the screen update issues works only on the long run. On one hand, many times the bug is in an underlying external component (such as GTK, some font rendering library, Linux video driver), and it's hard to make them correct the bug - that is, if they admit it's a bug and the discussion does not end up in a pointless flamewar instead. On the other hand, even if a bug is corrected, sometimes the correction is only available in the next release of Eclipse/Linux/GTK/whatever, so you end up waiting years to get it in a stable, packaged way, or you have to use experimental stuff which might even need compilation from scratch, etc.<br /><br />So, I'd like to ask if anyone knows whether it is technically possible to implement a "forced screen redraw" feature in Eclipse in a general way, so that the notorious screen garbage problems could be mitigated?","topic_url":"https://api.eclipse.org/forums/topic/1091069","topic_posts_url":"https://api.eclipse.org/forums/post?topic_id=1091069"}]}
+ {"pagination":{"page":1,"pagesize":1,"result_start":1,"result_end":1,"result_size":1,"total_result_size":1645105},"result":[{"id":"1779792","subject":"Subclipse problem","forum_id":"123","topic_id":"1091069","poster_id":"106173","created_date":"1515775710","url":"https://www.eclipse.org/forums/index.php?t=msg&th=1091069&goto=1779792&#msg_1779792","body":"Hi,<br /><br />I was wondering if there is a way to force to redraw the whole Eclipse window. If not, I think it would be beneficial to have one if it's possible to implement, because lately - especially since the GTK2 -> GTK3 transition started - Eclipse became more and more buggy in this area (at least the Linux version).<br /><br />I know that it would be only a workaround, and if there's a specific bug then it should be hunted down and corrected instead, but the bug hunting approach of solving the screen update issues works only on the long run. On one hand, many times the bug is in an underlying external component (such as GTK, some font rendering library, Linux video driver), and it's hard to make them correct the bug - that is, if they admit it's a bug and the discussion does not end up in a pointless flamewar instead. On the other hand, even if a bug is corrected, sometimes the correction is only available in the next release of Eclipse/Linux/GTK/whatever, so you end up waiting years to get it in a stable, packaged way, or you have to use experimental stuff which might even need compilation from scratch, etc.<br /><br />So, I'd like to ask if anyone knows whether it is technically possible to implement a "forced screen redraw" feature in Eclipse in a general way, so that the notorious screen garbage problems could be mitigated?","topic_url":"https://api.eclipse.org/forums/topic/1091069","topic_posts_url":"https://api.eclipse.org/forums/post?topic_id=1091069"}]}
## Retrieve Post [GET /forums/post/{post_id}]
-Retrieve a specific post from the Eclipse Forums.
+
+### Overview
+
+Retrieve information for **a specific post** from the Eclipse Forums website.
+
+### What is a post?
+
+A post is a message attached to a specific topic
+
+Posts are associated to a topic by topic id.
+
+### Result definition
+
++ **id:** id of the post
++ **subject:** subject of the post
++ **forum_id:** id of the forum associated to this post
++ **topic_id:** id of the topic associated to this post
++ **poster_id:** id of the user that submitted this post
++ **created_date:** date that this post has been created (timestamp)
++ **url:** url of a specific post on the Eclipse Forums website
++ **body:** body content of this post
++ **topic_url:** url that will return information about the topic associated to this post
++ **topic_posts_url:** url that will return all the posts from the topic associated to this post
+ Parameters
+ post_id (integer, optional) - Unique identifier for a post
@@ -164,7 +341,7 @@ Retrieve a specific post from the Eclipse Forums.
Content-Type: application/json
+ Body
- {"id":"1779792","subject":"Subclipse problem","topic_id":"1091069","poster_id":"106173","created":"1515775710","url":"https://www.eclipse.org/forums/index.php?t=msg&th=1091069&goto=1779792&#msg_1779792","body":"Hi,<br /><br />I was wondering if there is a way to force to redraw the whole Eclipse window. If not, I think it would be beneficial to have one if it's possible to implement, because lately - especially since the GTK2 -> GTK3 transition started - Eclipse became more and more buggy in this area (at least the Linux version).<br /><br />I know that it would be only a workaround, and if there's a specific bug then it should be hunted down and corrected instead, but the bug hunting approach of solving the screen update issues works only on the long run. On one hand, many times the bug is in an underlying external component (such as GTK, some font rendering library, Linux video driver), and it's hard to make them correct the bug - that is, if they admit it's a bug and the discussion does not end up in a pointless flamewar instead. On the other hand, even if a bug is corrected, sometimes the correction is only available in the next release of Eclipse/Linux/GTK/whatever, so you end up waiting years to get it in a stable, packaged way, or you have to use experimental stuff which might even need compilation from scratch, etc.<br /><br />So, I'd like to ask if anyone knows whether it is technically possible to implement a "forced screen redraw" feature in Eclipse in a general way, so that the notorious screen garbage problems could be mitigated?","topic_url":"https://api.eclipse.org/forums/topic/1091069","topic_posts_url":"https://api.eclipse.org/forums/post?topic_id=1091069"}
+ {"id":"1779792","subject":"Subclipse problem","forum_id":"123","topic_id":"1091069","poster_id":"106173","created_date":"1515775710","url":"https://www.eclipse.org/forums/index.php?t=msg&th=1091069&goto=1779792&#msg_1779792","body":"Hi,<br /><br />I was wondering if there is a way to force to redraw the whole Eclipse window. If not, I think it would be beneficial to have one if it's possible to implement, because lately - especially since the GTK2 -> GTK3 transition started - Eclipse became more and more buggy in this area (at least the Linux version).<br /><br />I know that it would be only a workaround, and if there's a specific bug then it should be hunted down and corrected instead, but the bug hunting approach of solving the screen update issues works only on the long run. On one hand, many times the bug is in an underlying external component (such as GTK, some font rendering library, Linux video driver), and it's hard to make them correct the bug - that is, if they admit it's a bug and the discussion does not end up in a pointless flamewar instead. On the other hand, even if a bug is corrected, sometimes the correction is only available in the next release of Eclipse/Linux/GTK/whatever, so you end up waiting years to get it in a stable, packaged way, or you have to use experimental stuff which might even need compilation from scratch, etc.<br /><br />So, I'd like to ask if anyone knows whether it is technically possible to implement a "forced screen redraw" feature in Eclipse in a general way, so that the notorious screen garbage problems could be mitigated?","topic_url":"https://api.eclipse.org/forums/topic/1091069","topic_posts_url":"https://api.eclipse.org/forums/post?topic_id=1091069"}
--
GitLab