Skip to content

Commit

Permalink
Updated docs to show correct response for Get Sync Version.
Browse files Browse the repository at this point in the history
  • Loading branch information
nero120 committed Oct 29, 2018
1 parent 09be000 commit 9e6dd24
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions dist/docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"id":"52758cb942814faa9ab255208025ae59",
"lastUpdated":"2016-07-06T12:43:16.866Z",
"version":"1.0.0"
}</code></pre> <ul> <li> <strong>id:</strong> 32 character alphanumeric sync ID.</li> <li> <strong>lastUpdated:</strong> Last updated timestamp for created bookmarks.</li> <li> <strong>version:</strong> Version number of the xBrowserSync client used to create the sync.</li> </ul> </div> <div class=header> <h4>Get Bookmarks</h4> <div> <span class="label label-success">Get</span> <code>/bookmarks/{id}</code> </div> </div> <p>Retrieves the bookmark sync corresponding to the provided sync ID.</p> <div class=example> <p>Query params:</p> <ul> <li> <strong>id:</strong> 32 character alphanumeric sync ID.</li> </ul> <p>Response example:</p> <pre><code>{
}</code></pre> <ul> <li> <strong>id:</strong> 32 character alphanumeric sync ID.</li> <li> <strong>lastUpdated:</strong> Last updated timestamp for created bookmarks.</li> <li> <strong>version:</strong>Version number of the xBrowserSync client used to create the sync.</li> </ul> </div> <div class=header> <h4>Get Bookmarks</h4> <div> <span class="label label-success">Get</span> <code>/bookmarks/{id}</code> </div> </div> <p>Retrieves the bookmark sync corresponding to the provided sync ID.</p> <div class=example> <p>Query params:</p> <ul> <li> <strong>id:</strong> 32 character alphanumeric sync ID.</li> </ul> <p>Response example:</p> <pre><code>{
"bookmarks":"DWCx6wR9ggPqPRrhU4O4oLN5P09onApoAULX4Xt+ckxswtFNds...",
"lastUpdated":"2016-07-06T12:43:16.866Z",
"version":"1.0.0"
Expand All @@ -15,8 +15,8 @@
}</code></pre> <ul> <li> <strong>lastUpdated:</strong> Last updated timestamp for updated bookmarks.</li> </ul> </div> <div class=header> <h4>Get Last Updated</h4> <div> <span class="label label-success">Get</span> <code>/bookmarks/{id}/lastUpdated</code> </div> </div> <p>Retrieves the bookmark sync last updated time stamp corresponding to the provided sync ID.</p> <div class=example> <p>Query params:</p> <ul> <li> <strong>id:</strong> 32 character alphanumeric sync ID.</li> </ul> <p>Response example:</p> <pre><code>{
"lastUpdated":"2016-07-06T12:43:16.866Z"
}</code></pre> <ul> <li> <strong>lastUpdated:</strong> Last updated timestamp for corresponding bookmarks.</li> </ul> </div> <div class=header> <h4>Get Sync Version</h4> <div> <span class="label label-success">Get</span> <code>/bookmarks/{id}/version</code> </div> </div> <p>Retrieves the bookmark sync version number of the xBrowserSync client used to create the bookmarks sync corresponding to the provided sync ID.</p> <div class=example> <p>Query params:</p> <ul> <li> <strong>id:</strong> 32 character alphanumeric sync ID.</li> </ul> <p>Response example:</p> <pre><code>{
"lastUpdated":"2016-07-06T12:43:16.866Z"
}</code></pre> <ul> <li> <strong>lastUpdated:</strong> Last updated timestamp for corresponding bookmarks.</li> </ul> </div> </div> </div> </section> <section id=serviceinfo> <div class=container> <div class=panel> <h3>Service Information</h3> <div class=header> <h4>Get Service Information</h4> <div> <span class="label label-success">Get</span> <code>/info</code> </div> </div> <p>Retrieves information describing the xBrowserSync service.</p> <div class=example> <p>Response example:</p> <pre><code>{
"version":"1.0.0"
}</code></pre> <ul> <li> <strong>version:</strong> Version number of the xBrowserSync client used to create the sync.</li> </ul> </div> </div> </div> </section> <section id=serviceinfo> <div class=container> <div class=panel> <h3>Service Information</h3> <div class=header> <h4>Get Service Information</h4> <div> <span class="label label-success">Get</span> <code>/info</code> </div> </div> <p>Retrieves information describing the xBrowserSync service.</p> <div class=example> <p>Response example:</p> <pre><code>{
"maxSyncSize":204800,
"message":"",
"status":1,
Expand Down
12 changes: 6 additions & 6 deletions src/docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ <h1>xBrowserSync</h1>
</div>
<div class="col-lg-7">
<h2>API service info</h2>
</div>
</div>
</div>
</div>
</header>

<section id="status" class="dark">
Expand All @@ -73,8 +73,8 @@ <h2>API service info</h2>
</div>
<div class="row">
<div class="col-lg-8 col-lg-offset-2">
<p>This xBrowserSync service provides a REST API that xBrowserSync clients can sync to.
The available API methods are listed below.</p>
<p>This xBrowserSync service provides a REST API that xBrowserSync clients can sync to. The available API methods
are listed below.</p>
<p>For more information visit the
<a href="https://www.xbrowsersync.org/">xBrowserSync website</a> or check out the
<a href="https://github.com/xBrowserSync/API">API GitHub repo</a>.</p>
Expand Down Expand Up @@ -116,7 +116,7 @@ <h4>Create Bookmarks</h4>
<li>
<strong>lastUpdated:</strong> Last updated timestamp for created bookmarks.</li>
<li>
<strong>version:</strong> Version number of the xBrowserSync client used to create the sync.</li>
<strong>version:</strong>Version number of the xBrowserSync client used to create the sync.</li>
</ul>
</div>

Expand Down Expand Up @@ -223,11 +223,11 @@ <h4>Get Sync Version</h4>
</ul>
<p>Response example:</p>
<pre><code>{
"lastUpdated":"2016-07-06T12:43:16.866Z"
"version":"1.0.0"
}</code></pre>
<ul>
<li>
<strong>lastUpdated:</strong> Last updated timestamp for corresponding bookmarks.</li>
<strong>version:</strong> Version number of the xBrowserSync client used to create the sync.</li>
</ul>
</div>

Expand Down

0 comments on commit 9e6dd24

Please # to comment.