From 829cf353acdc8da188e67dc77629141540e42bae 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/proposals.html | 96 +++++++++++++++++++++++++++++------------
src/modules/forums.apib | 28 ++++++++----
2 files changed, 88 insertions(+), 36 deletions(-)
diff --git a/docs/proposals.html b/docs/proposals.html
index 6d41cfe..6de3652 100644
--- a/docs/proposals.html
+++ b/docs/proposals.html
@@ -89,40 +89,60 @@
</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}</code></h4><p>Retrieve a list of all the categories from the Eclipse Forums.</p>
-<h4>Example URI</h4><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname">https://api.eclipse.org</span>/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></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>
+<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>
+<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>
</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">Link</span>: <span class="hljs-string"><https://api.eclipse.org/forums/category?page=1&amp;pagesize=20>; rel="next", <https://api.eclipse.org/forums/category?page=99&amp;pagesize=5>; rel="last", <https://api.eclipse.org/forums/category?page=1&amp;pagesize=5>; rel="first", <https://api.eclipse.org/forums/category?page=1&amp;pagesize=5>; 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">forums_category</span>": <span class="hljs-value">[
+ "<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">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">description</span>": <span class="hljs-value"><span class="hljs-string">" - Eclipse Project Forums - click +/- to expand/collapse"</span></span>,
- "<span class="hljs-attribute">forum_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/forum?category_id=1"</span>
+ "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"10"</span></span>,
+ "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"ice"</span></span>,
+ "<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>},
{
- "<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">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">description</span>": <span class="hljs-value"><span class="hljs-string">" - General Newcomer discussions"</span></span>,
- "<span class="hljs-attribute">forum_url</span>": <span class="hljs-value"><span class="hljs-string">"https://api.eclipse.org/forums/forum?category_id=2"</span>
+ "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"8"</span></span>,
+ "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"Archived"</span></span>,
+ "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">" - Forums for projects that have been officially archived."</span></span>,
+ "<span class="hljs-attribute">url</span>": <span class="hljs-value"><span class="hljs-string">"https://www.eclipse.org/forums/index.php/i/8/"</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=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>
<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">"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">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">description</span>": <span class="hljs-value"><span class="hljs-string">" - Eclipse Project Forums - click +/- to expand/collapse"</span></span>,
- "<span class="hljs-attribute">forum_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"> ¶</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}</code></h4><p>Retrieve a list of all the forums from the Eclipse Forums based on a category id if specified.</p>
-<h4>Example URI</h4><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname">https://api.eclipse.org</span>/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></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>
+ "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"10"</span></span>,
+ "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"ice"</span></span>,
+ "<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>
+<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>
+</dd><dt>order_by</dt><dd><code>string</code> <span>(optional)</span> <p>The order created date in which the results will be returned. DESC by default</p>
+</dd><dt>since</dt><dd><code>integer</code> <span>(optional)</span> <p>The results since a timestamp onward</p>
+</dd><dt>until</dt><dd><code>integer</code> <span>(optional)</span> <p>The results until a timestamp</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">Link</span>: <span class="hljs-string"><https://api.eclipse.org/forums/forum?category_id=1&amp;page=1&amp;pagesize=20>; rel="last", <https://api.eclipse.org/forums/forum?category_id=1&amp;page=99&amp;pagesize=20>; rel="first", <https://api.eclipse.org/forums/forum?category_id=1&amp;page=1&amp;pagesize=20>; 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">forums_forum</span>": <span class="hljs-value">[
+ "<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">"2"</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"BIRT"</span></span>,
@@ -151,12 +171,23 @@
"<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}</code></h4><p>Retrieve a list of all the topics from the Eclipse Forums based on a forum id if specified.</p>
-<h4>Example URI</h4><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname">https://api.eclipse.org</span>/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></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>
+</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>
+<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>
+</dd><dt>order_by</dt><dd><code>string</code> <span>(optional)</span> <p>The order created date in which the results will be returned. DESC by default</p>
+</dd><dt>since</dt><dd><code>integer</code> <span>(optional)</span> <p>The results since a timestamp onward</p>
+</dd><dt>until</dt><dd><code>integer</code> <span>(optional)</span> <p>The results until a timestamp</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">Link</span>: <span class="hljs-string"><https://api.eclipse.org/forums/topic?forum_id=1&amp;page=1&amp;pagesize=20>; rel="last", <https://api.eclipse.org/forums/topic?forum_id=1&amp;page=99&amp;pagesize=20>; rel="first", <https://api.eclipse.org/forums/topic?forum_id=1&amp;page=1&amp;pagesize=20>; 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">forums_topic</span>": <span class="hljs-value">[
+ "<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">"2"</span></span>,
"<span class="hljs-attribute">forum_id</span>": <span class="hljs-value"><span class="hljs-string">"2"</span></span>,
@@ -183,12 +214,23 @@
"<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}</code></h4><p>Retrieve a list of all the posts from the Eclipse Forums based on a topic_id if specified.</p>
-<h4>Example URI</h4><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname">https://api.eclipse.org</span>/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></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>
+</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>
+<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>
+</dd><dt>order_by</dt><dd><code>string</code> <span>(optional)</span> <p>The order created date in which the results will be returned. DESC by default</p>
+</dd><dt>since</dt><dd><code>integer</code> <span>(optional)</span> <p>The results since a timestamp onward</p>
+</dd><dt>until</dt><dd><code>integer</code> <span>(optional)</span> <p>The results until a timestamp</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">Link</span>: <span class="hljs-string"><https://api.eclipse.org/forums/post?topic_id=1&amp;page=1&amp;pagesize=20>; rel="last", <https://api.eclipse.org/forums/post?topic_id=1&amp;page=99&amp;pagesize=20>; rel="first", <https://api.eclipse.org/forums/post?topic_id=1&amp;page=1&amp;pagesize=20>; 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">forums_post</span>": <span class="hljs-value">[
+ "<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">"1779792"</span></span>,
"<span class="hljs-attribute">subject</span>": <span class="hljs-value"><span class="hljs-string">"Subclipse problem"</span></span>,
diff --git a/src/modules/forums.apib b/src/modules/forums.apib
index 3403922..567a960 100644
--- a/src/modules/forums.apib
+++ b/src/modules/forums.apib
@@ -3,12 +3,13 @@ Eclipse Forums are available through this resource.
-## Fetch Categories [GET /forums/category{?page,pagesize}]
+## Fetch Categories [GET /forums/category{?page,pagesize,order_by}]
Retrieve a list of all the categories from the Eclipse Forums.
+ Parameters
+ page (integer, optional) - The index of the page to get, defaults to 1.
+ pagesize (integer, optional) - The number of records to get per page, defaults to 20. Maximum value is 100.
+ + order_by (string, optional) - The order by ID in which the results will be returned. DESC by default
+ Response 200 (application/json)
+ Headers
@@ -19,7 +20,7 @@ Retrieve a list of all the categories from the Eclipse Forums.
Content-Type: application/json
+ Body
- {"forums_category":[{"id":"1","name":"Eclipse Projects","url":"https://www.eclipse.org/forums/index.php/i/1","description":" - Eclipse Project Forums - click +/- to expand/collapse","forum_url":"https://api.eclipse.org/forums/forum?category_id=1"},{"id":"2","name":"Newcomers","url":"https://www.eclipse.org/forums/index.php/i/2","description":" - General Newcomer discussions","forum_url":"https://api.eclipse.org/forums/forum?category_id=2"}]}
+ {"pagination":{"page":1,"pagesize":2,"result_start":1,"result_end":2,"result_size":2,"total_result_size":9},"result":[{"id":"10","name":"ice","description":"","url":"https://www.eclipse.org/forums/index.php/i/10/","forums_url":"https://api.eclipse.org/forums/forum?category_id=10"},{"id":"8","name":"Archived","description":" - Forums for projects that have been officially archived.","url":"https://www.eclipse.org/forums/index.php/i/8/","forums_url":"https://api.eclipse.org/forums/forum?category_id=8"}]}
@@ -37,17 +38,20 @@ Retrieve a specific category from the Eclipse Forum's.
Content-Type: application/json
+ Body
- {"id":"1","name":"Eclipse Projects","url":"https://www.eclipse.org/forums/index.php/i/1","description":" - Eclipse Project Forums - click +/- to expand/collapse","forum_url":"https://api.eclipse.org/forums/forum?category_id=1"}
+ {"id":"10","name":"ice","description":"","url":"https://www.eclipse.org/forums/index.php/i/10/","forums_url":"https://api.eclipse.org/forums/forum?category_id=10"}
-## Fetch Forums [GET /forums/forum{?category_id,page,pagesize}]
+## 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.
+ Parameters
+ category_id (integer, optional) - Unique identifier for a category
+ page (integer, optional) - The index of the page to get, defaults to 1.
+ pagesize (integer, optional) - The number of records to get per page, defaults to 20. Maximum value is 100.
+ + order_by (string, optional) - The order created date in which the results will be returned. DESC by default
+ + since (integer, optional) - The results since a timestamp onward
+ + until (integer, optional) - The results until a timestamp
+ Response 200 (application/json)
+ Headers
@@ -58,7 +62,7 @@ Retrieve a list of all the forums from the Eclipse Forums based on a category id
Content-Type: application/json
+ Body
- {"forums_forum":[{"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>","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"}]}
@@ -80,13 +84,16 @@ Retrieve a specific forum from the Eclipse Forums.
-## Fetch Topics [GET /forums/topic{?forum_id,page,pagesize}]
+## 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.
+ Parameters
+ forum_id (integer, optional) - Unique identifier for a forum
+ page (integer, optional) - The index of the page to get, defaults to 1.
+ pagesize (integer, optional) - The number of records to get per page, defaults to 20. Maximum value is 100.
+ + order_by (string, optional) - The order created date in which the results will be returned. DESC by default
+ + since (integer, optional) - The results since a timestamp onward
+ + until (integer, optional) - The results until a timestamp
+ Response 200 (application/json)
+ Headers
@@ -97,7 +104,7 @@ Retrieve a list of all the topics from the Eclipse Forums based on a forum id if
Content-Type: application/json
+ Body
- {"forums_topic":[{"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_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"}]}
@@ -119,13 +126,16 @@ Retrieve a specific topic from the Eclipse Forums.
-## Fetch Posts [GET /forums/post{?topic_id,page,pagesize}]
+## 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.
+ Parameters
+ topic_id (integer, optional) - Unique identifier for a topic
+ page (integer, optional) - The index of the page to get, defaults to 1.
+ pagesize (integer, optional) - The number of records to get per page, defaults to 20. Maximum value is 100.
+ + order_by (string, optional) - The order created date in which the results will be returned. DESC by default
+ + since (integer, optional) - The results since a timestamp onward
+ + until (integer, optional) - The results until a timestamp
+ Response 200 (application/json)
+ Headers
@@ -136,7 +146,7 @@ Retrieve a list of all the posts from the Eclipse Forums based on a topic_id if
Content-Type: application/json
+ Body
- {"forums_post":[{"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","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"}]}
--
GitLab