Skip to content

Commit 9e6dd24

Browse files
committed
Updated docs to show correct response for Get Sync Version.
1 parent 09be000 commit 9e6dd24

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

dist/docs/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"id":"52758cb942814faa9ab255208025ae59",
55
"lastUpdated":"2016-07-06T12:43:16.866Z",
66
"version":"1.0.0"
7-
}</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>{
7+
}</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>{
88
"bookmarks":"DWCx6wR9ggPqPRrhU4O4oLN5P09onApoAULX4Xt+ckxswtFNds...",
99
"lastUpdated":"2016-07-06T12:43:16.866Z",
1010
"version":"1.0.0"
@@ -15,8 +15,8 @@
1515
}</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>{
1616
"lastUpdated":"2016-07-06T12:43:16.866Z"
1717
}</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>{
18-
"lastUpdated":"2016-07-06T12:43:16.866Z"
19-
}</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>{
18+
"version":"1.0.0"
19+
}</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>{
2020
"maxSyncSize":204800,
2121
"message":"",
2222
"status":1,

src/docs/index.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@ <h1>xBrowserSync</h1>
5050
</div>
5151
<div class="col-lg-7">
5252
<h2>API service info</h2>
53+
</div>
5354
</div>
5455
</div>
55-
</div>
5656
</header>
5757

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

@@ -223,11 +223,11 @@ <h4>Get Sync Version</h4>
223223
</ul>
224224
<p>Response example:</p>
225225
<pre><code>{
226-
"lastUpdated":"2016-07-06T12:43:16.866Z"
226+
"version":"1.0.0"
227227
}</code></pre>
228228
<ul>
229229
<li>
230-
<strong>lastUpdated:</strong> Last updated timestamp for corresponding bookmarks.</li>
230+
<strong>version:</strong> Version number of the xBrowserSync client used to create the sync.</li>
231231
</ul>
232232
</div>
233233

0 commit comments

Comments
 (0)