From 5af6a5d78c3e66a92c9417488606ee78ce80bdc9 Mon Sep 17 00:00:00 2001
From: Christopher Guindon <chris.guindon@eclipse-foundation.org>
Date: Mon, 11 Dec 2017 14:29:45 -0500
Subject: [PATCH] Re-build /docs with latest contributions
Signed-off-by: Christopher Guindon <chris.guindon@eclipse-foundation.org>
---
docs/auth.html | 5 ++---
docs/index.html | 11 ++++++-----
2 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/docs/auth.html b/docs/auth.html
index 8905f18..caa6976 100644
--- a/docs/auth.html
+++ b/docs/auth.html
@@ -97,8 +97,7 @@
are used.</p>
<p>FORMAT: 1A</p>
<section id="authorization" class="resource-group"><h2 class="group-heading">Authorization <a href="#authorization" class="permalink">¶</a></h2><p><em>Eclipse Api RESTful API</em> uses OAuth2 Authorization for protected resources.</p>
-<div id="authorization-oauth2-authorization" class="resource"><h3 class="resource-heading">OAuth2 Authorization <a href="#authorization-oauth2-authorization" class="permalink"> ¶</a></h3><div id="authorization-oauth2-authorization-get" class="action get"><h4 class="action-heading"><div class="name">OAuth2 Authorization</div><a href="#authorization-oauth2-authorization-get" class="method get">GET</a><code class="uri">/oauth2/authorize{?response_type,client_id,redirect_uri,scope}</code></h4><p>The client must redirect to authorization server to gain an <code>authorization_code</code> which can be exchange
-for an <code>access_token</code>.</p>
+<div id="authorization-oauth2-authorization" class="resource"><h3 class="resource-heading">OAuth2 Authorization <a href="#authorization-oauth2-authorization" class="permalink"> ¶</a></h3><div id="authorization-oauth2-authorization-get" class="action get"><h4 class="action-heading"><div class="name">OAuth2 Authorization</div><a href="#authorization-oauth2-authorization-get" class="method get">GET</a><code class="uri">/oauth2/authorize{?response_type,client_id,redirect_uri,scope}</code></h4><p>The client must redirect to authorization server to gain an <code>authorization_code</code> which can be exchanged for an <code>access_token</code>.</p>
<h4>Example URI</h4><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname">https://accounts.eclipse.org</span>/oauth2/authorize?<span class="hljs-attribute">response_type=</span><span class="hljs-literal"></span>&<span class="hljs-attribute">client_id=</span><span class="hljs-literal"></span>&<span class="hljs-attribute">redirect_uri=</span><span class="hljs-literal"></span>&<span class="hljs-attribute">scope=</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>response_type</dt><dd><code>string</code> <span class="required">(required)</span> <p>Indicates that your server expects to receive an authorization code.</p>
</dd><dt>client_id</dt><dd><code>string</code> <span class="required">(required)</span> <p>The client ID you received when you first created the application.</p>
</dd><dt>redirect_uri</dt><dd><code>string</code> <span class="required">(required)</span> <p>Indicates the URI to return the user to after authorization is complete.</p>
@@ -177,7 +176,7 @@ for an <code>access_token</code>.</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 ©
2017
-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 30 Nov 2017</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 11 Dec 2017</p><script>/* eslint-env browser */
/* eslint quotes: [2, "single"] */
'use strict';
diff --git a/docs/index.html b/docs/index.html
index 58f5798..73a44f0 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -86,10 +86,11 @@
</div>
</div>
</div>
-</header><a href="#top" class="text-muted back-to-top"><i class="fa fa-toggle-up"></i> Back to top</a><div class="container-fluid container-content"><div class="row"><nav><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#top">Overview</a></div><div class="collapse-content"><ul><li><a href="#header-supported-rest-apis">Supported REST APIs</a></li><li><a href="#header-rate-limit">Rate Limit</a></li><li><a href="#header-pagination">Pagination</a></li><li><a href="#header-caching">Caching</a></li><li><a href="#header-authentication">Authentication</a></li><li><a href="#header-error-states">Error States</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#user-profiles">User Profiles</a></div><div class="collapse-content"><ul><li><a href="#user-profiles-current-user-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Current user</a></li><li><a href="#user-profiles-retrieve-user-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve user</a></li><li><a href="#user-profiles-search-for-a-user-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Search for a user</a></li><li><a href="#user-profiles-forum-posts-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Forum posts</a></li><li><a href="#user-profiles-project-relationship-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Project Relationship</a></li><li><a href="#user-profiles-gerrit-review-count-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gerrit review count</a></li><li><a href="#user-profiles-mailing-list-subscriptions-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Mailing List Subscriptions</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#eclipse-uss">Eclipse USS</a></div><div class="collapse-content"><ul><li><a href="#eclipse-uss-fetch-blobs-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Fetch Blobs</a></li><li><a href="#eclipse-uss-search-blobs-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Search Blobs</a></li><li><a href="#eclipse-uss-delete-blobs-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Delete Blobs</a></li><li><a href="#eclipse-uss-update-create-blobs-put"><span class="badge put"><i class="fa fa-pencil"></i></span>Update/Create Blobs</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#download">Download</a></div><div class="collapse-content"><ul><li><a href="#download-retrieve-file-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve File</a></li><li><a href="#download-release-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Release</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#marketplace-favorites">Marketplace Favorites</a></div><div class="collapse-content"><ul><li><a href="#marketplace-favorites-search-favorites-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Search Favorites</a></li><li><a href="#marketplace-favorites-retrieve-favorites-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve Favorites</a></li><li><a href="#marketplace-favorites-random-favorites-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Random Favorites</a></li><li><a href="#marketplace-favorites-favorite-list">Favorite List</a><ul><li><a href="#marketplace-favorites-favorite-list-post"><span class="badge post"><i class="fa fa-plus"></i></span>Add Favorite</a></li><li><a href="#marketplace-favorites-favorite-list-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Remove Favorite</a></li><li><a href="#marketplace-favorites-favorite-list-post-1"><span class="badge post"><i class="fa fa-plus"></i></span>Rename Favorite List</a></li></ul></li></ul></div></div><p style="text-align: center; word-wrap: break-word;"><a href="https://api.eclipse.org">https://api.eclipse.org</a></p></nav><div class="content"><header><h1 id="top">Eclipse RESTful API</h1></header><p>This describes the resources that make up the official Eclipse Foundation REST API.</p>
+</header><a href="#top" class="text-muted back-to-top"><i class="fa fa-toggle-up"></i> Back to top</a><div class="container-fluid container-content"><div class="row"><nav><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#top">Overview</a></div><div class="collapse-content"><ul><li><a href="#header-other-related-rest-apis">Other related REST APIs</a></li><li><a href="#header-rate-limit">Rate Limit</a></li><li><a href="#header-pagination">Pagination</a></li><li><a href="#header-caching">Caching</a></li><li><a href="#header-authentication">Authentication</a></li><li><a href="#header-error-states">Error States</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#user-profiles">User Profiles</a></div><div class="collapse-content"><ul><li><a href="#user-profiles-current-user-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Current user</a></li><li><a href="#user-profiles-retrieve-user-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve user</a></li><li><a href="#user-profiles-search-for-a-user-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Search for a user</a></li><li><a href="#user-profiles-forum-posts-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Forum posts</a></li><li><a href="#user-profiles-project-relationship-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Project Relationship</a></li><li><a href="#user-profiles-gerrit-review-count-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gerrit review count</a></li><li><a href="#user-profiles-mailing-list-subscriptions-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Mailing List Subscriptions</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#eclipse-uss">Eclipse USS</a></div><div class="collapse-content"><ul><li><a href="#eclipse-uss-fetch-blobs-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Fetch Blobs</a></li><li><a href="#eclipse-uss-search-blobs-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Search Blobs</a></li><li><a href="#eclipse-uss-delete-blobs-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Delete Blobs</a></li><li><a href="#eclipse-uss-update-create-blobs-put"><span class="badge put"><i class="fa fa-pencil"></i></span>Update/Create Blobs</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#download">Download</a></div><div class="collapse-content"><ul><li><a href="#download-retrieve-file-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve File</a></li><li><a href="#download-release-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Release</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#marketplace-favorites">Marketplace Favorites</a></div><div class="collapse-content"><ul><li><a href="#marketplace-favorites-search-favorites-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Search Favorites</a></li><li><a href="#marketplace-favorites-retrieve-favorites-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve Favorites</a></li><li><a href="#marketplace-favorites-random-favorites-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Random Favorites</a></li><li><a href="#marketplace-favorites-favorite-list">Favorite List</a><ul><li><a href="#marketplace-favorites-favorite-list-post"><span class="badge post"><i class="fa fa-plus"></i></span>Add Favorite</a></li><li><a href="#marketplace-favorites-favorite-list-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Remove Favorite</a></li><li><a href="#marketplace-favorites-favorite-list-post-1"><span class="badge post"><i class="fa fa-plus"></i></span>Rename Favorite List</a></li></ul></li></ul></div></div><p style="text-align: center; word-wrap: break-word;"><a href="https://api.eclipse.org">https://api.eclipse.org</a></p></nav><div class="content"><header><h1 id="top">Eclipse RESTful API</h1></header><p>This describes the resources that make up the official Eclipse Foundation REST API.</p>
<p>You can contribute to this document via our <a href="https://github.com/chrisguindon/api.eclipse.org-docs">git repository</a>.</p>
<p>If you have any problems or requests please contact <a href="mailto:chris.guindon@eclipse-foundation.org">Christopher Guindon</a>.</p>
-<h3 id="header-supported-rest-apis">Supported REST APIs <a class="permalink" href="#header-supported-rest-apis" aria-hidden="true">¶</a></h3>
+<h3 id="header-other-related-rest-apis">Other related REST APIs <a class="permalink" href="#header-other-related-rest-apis" aria-hidden="true">¶</a></h3>
+<p>Althought they are not directly related to this API, the Eclipse forge proposes several other access points and APIs for specific tools and purposes. Please see the following resources for more details:</p>
<ul>
<li>
<p><a href="https://bugs.eclipse.org/bugs">Eclipse Bugzilla</a> <strong>(<a href="https://wiki.mozilla.org/Bugzilla:REST_API">Documentation</a>)</strong></p>
@@ -120,7 +121,7 @@ all paginated queries start at page 1. rel=“last†provides some more informa
<p>Most responses return an ETag header. You can use the values of these headers to make subsequent
requests to those resources using the If-None-Match or if-Match header. For example, if the resource
has not changed on a GET, the server will return a 304 Not Modified.</p>
-<p>The Etag for a blob resource is predictable. This is how were are currently generating them:</p>
+<p>The Etag for a blob resource is predictable. This is how we are currently generating them:</p>
<pre><code><span class="hljs-keyword">function</span> _generate_etag(<span class="hljs-variable">$value</span>, <span class="hljs-variable">$application</span>_token, <span class="hljs-variable">$key</span>) {
<span class="hljs-variable">$string</span> = <span class="hljs-variable">$value</span> . <span class="hljs-variable">$application</span>_token . <span class="hljs-variable">$key</span>;
return hash(<span class="hljs-string">'sha256'</span>, <span class="hljs-variable">$string</span>, FALSE);
@@ -164,7 +165,7 @@ is included when authenticated through OAuth with the <code>profile</code> scope
<span class="hljs-string">"Drums"</span>
]
</span>}
-]</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="user-profiles-retrieve-user" class="resource"><h3 class="resource-heading">Retrieve user <a href="#user-profiles-retrieve-user" class="permalink"> ¶</a></h3><div id="user-profiles-retrieve-user-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve user</div><a href="#user-profiles-retrieve-user-get" class="method get">GET</a><code class="uri">/account/profile/{name}</code></h4><p>Retrieve profile information about current user.</p>
+]</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="user-profiles-retrieve-user" class="resource"><h3 class="resource-heading">Retrieve user <a href="#user-profiles-retrieve-user" class="permalink"> ¶</a></h3><div id="user-profiles-retrieve-user-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve user</div><a href="#user-profiles-retrieve-user-get" class="method get">GET</a><code class="uri">/account/profile/{name}</code></h4><p>Retrieve profile information about a specified user.</p>
<h4>Example URI</h4><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname">https://api.eclipse.org</span>/account/profile/<span class="hljs-attribute" title="name">name</span></span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>name</dt><dd><code>string</code> <span>(optional)</span> <p>A valid Eclipse username.</p>
</dd></dl></div><div class="title"><strong>Response <code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">X-Rate-Limit-Limit</span>: <span class="hljs-string">1000</span><br><span class="hljs-attribute">X-Rate-Limit-Remaining</span>: <span class="hljs-string">964</span><br><span class="hljs-attribute">X-Rate-Limit-Reset</span>: <span class="hljs-string">3553</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">uid</span>": <span class="hljs-value"><span class="hljs-string">"9"</span></span>,
@@ -2193,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 ©
2017
-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 30 Nov 2017</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 11 Dec 2017</p><script>/* eslint-env browser */
/* eslint quotes: [2, "single"] */
'use strict';
--
GitLab