Skip to content
This repository was archived by the owner on Jun 6, 2023. It is now read-only.

Commit 849ab90

Browse files
sanfilipsanfilip
committed
doc update
1 parent 02d5dec commit 849ab90

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+78
-50
lines changed

‎docs/index.html‎

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="jobs.h
4646

4747

4848
<section class="readme">
49-
<article><h1>Paperspace API (v0.1.5)</h1><p><img src="https://user-images.githubusercontent.com/585865/27562775-26b8acc6-5a9c-11e7-8270-2b80ca895bc5.png" alt="image"></p>
49+
<article><h1>Paperspace API (v0.1.6)</h1><p><img src="https://user-images.githubusercontent.com/585865/27562775-26b8acc6-5a9c-11e7-8270-2b80ca895bc5.png" alt="image"></p>
5050
<hr>
5151
<p><strong>Heads up! This project is under construction!</strong> We're offering this early, unstable, pre-alpha release to get early feedback and to see how it might get used in the wild. Use caution: Until we ship a release &gt;= v1.0, expect to encounter bugs, and expect our documentation to be missing or inaccurate in places. We welcome your bug reports and suggestions via GitHub Issues!</p>
5252
<hr>
@@ -57,6 +57,29 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="jobs.h
5757
<li><a href="https://paperspace.github.io/paperspace-node">API documentation</a></li>
5858
<li><a href="scripts.md">Script Guide</a> for creating and using startup scripts</li>
5959
</ul>
60+
<h2>Release Notes for v0.1.6</h2><h4>New Features</h4><ul>
61+
<li>Pre-built binaries are now available for <a href="https://s3.amazonaws.com/paperspace-node/v0.1.6/win/paperspace.exe">Windows</a>, <a href="https://s3.amazonaws.com/paperspace-node/v0.1.6/mac/paperspace">Mac</a>, and <a href="https://s3.amazonaws.com/paperspace-node/v0.1.6/linux/paperspace">Linux</a>. These binaries enable you to run the paperspace-node command line tool without having to install Nodejs or any additional node modules.</li>
62+
<li>New methods for early access to jobs. Please contact hello@paperspace.com for more information.</li>
63+
</ul>
64+
<h4>Breaking Changes</h4><p><em>BREAKING CHANGE #1</em> (for Nodejs apps which use the paperspace-node module):</p>
65+
<p>In previous versions (up to 0.1.5) paperspace-node methods returned an HTTP response object on success, and application code needed
66+
to dereference through the HTTP response body object to get attributes of the returned object.
67+
For example, when getting the name of a machine you would have code like this:</p>
68+
<pre class="prettyprint source"><code>paperspace.machines.show({ machineId: 'ps123abc' }, function callback(err, resp) {
69+
if (err) return err;
70+
console.log(resp.body.id);
71+
});</code></pre><p>The new convention is to return the 'body' object directly in the second callback parameter, e.g.:</p>
72+
<pre class="prettyprint source"><code>paperspace.machines.show({ machineId: 'ps123abc' }, function callback(err, resp) {
73+
if (err) return err;
74+
console.log(resp.id);
75+
});</code></pre><p>This change simplifies code that works with the returned objects, and provides better encapsulation. The command line version of the api already followed this convention.</p>
76+
<p><em>BREAKING CHANGE #2</em> (if building the command line app or a custom Nodejs app using the source):</p>
77+
<p>paperspace-node now requires Nodejs 8.9.3 or later. This Node version is specified in the package.json file in the root of the repository.
78+
This change is to support stand-alone binaries of the paperspace-node command line tool that don't require a separate installation of Node.
79+
Previously Node 4.2.3 or later was required, but that version of Node will soon no longer be maintained (after April 2018). You can read more about Node's support cycle here: <a href="https://github.com/nodejs/Release">Node Releases</a></p>
80+
<h4>Fixes</h4><ul>
81+
<li>Minor doc fixes</li>
82+
</ul>
6083
<h2>Release Notes for v0.1.5</h2><h4>New features</h4><ul>
6184
<li>New method: machines update</li>
6285
<li>machines show method now includes last 10 events associated with the machine</li>
@@ -145,7 +168,7 @@ <h2>Copyright</h2><p>Copyright :copyright: 2017 Paperspace - All Rights Reserved
145168
<br class="clear">
146169

147170
<footer>
148-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Dec 14 2017 12:04:22 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
171+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Dec 19 2017 23:31:24 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
149172
</footer>
150173

151174
<script>prettyPrint();</script>

‎docs/jobs.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3775,7 +3775,7 @@ <h5>Returns:</h5>
37753775
<br class="clear">
37763776

37773777
<footer>
3778-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Dec 14 2017 12:04:22 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
3778+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Dec 19 2017 23:31:24 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
37793779
</footer>
37803780

37813781
<script>prettyPrint();</script>

‎docs/jobs_artifactsDestroy.js.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ <h1 class="page-title">jobs/artifactsDestroy.js</h1>
102102
<br class="clear">
103103

104104
<footer>
105-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Dec 14 2017 12:04:22 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
105+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Dec 19 2017 23:31:24 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
106106
</footer>
107107

108108
<script>prettyPrint();</script>

‎docs/jobs_artifactsGet.js.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ <h1 class="page-title">jobs/artifactsGet.js</h1>
277277
<br class="clear">
278278

279279
<footer>
280-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Dec 14 2017 12:04:22 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
280+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Dec 19 2017 23:31:24 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
281281
</footer>
282282

283283
<script>prettyPrint();</script>

‎docs/jobs_artifactsList.js.html‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ <h1 class="page-title">jobs/artifactsList.js</h1>
7979
params.jobId = projectConfig.getLastJobId(null, params.jobId);
8080
return method(artifactsList, params, function artifactsListCb(err, data) {
8181
if (global.paperspace_cli &amp;&amp; !json) {
82+
if (err) return cb(err);
8283
if (data &amp;&amp; data.length) {
8384
data.forEach(function itemFunc(item) {
8485
if (item.file) {
@@ -89,7 +90,8 @@ <h1 class="page-title">jobs/artifactsList.js</h1>
8990
}
9091
});
9192
}
92-
} else return cb(null, data);
93+
return cb();
94+
} else return cb(err, data);
9395
});
9496
}
9597

@@ -118,7 +120,7 @@ <h1 class="page-title">jobs/artifactsList.js</h1>
118120
<br class="clear">
119121

120122
<footer>
121-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Dec 14 2017 12:04:22 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
123+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Dec 19 2017 23:31:24 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
122124
</footer>
123125

124126
<script>prettyPrint();</script>

‎docs/jobs_clone.js.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ <h1 class="page-title">jobs/clone.js</h1>
107107
<br class="clear">
108108

109109
<footer>
110-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Dec 14 2017 12:04:22 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
110+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Dec 19 2017 23:31:24 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
111111
</footer>
112112

113113
<script>prettyPrint();</script>

‎docs/jobs_create.js.html‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,9 @@ <h1 class="page-title">jobs/create.js</h1>
222222
}
223223
}
224224

225+
if (params.container &amp;&amp; typeof params.container !== 'string') return ifCliPrintErrorOnly(new Error('Parameter `container` expected to be a string'));
226+
if (params.workspace &amp;&amp; typeof params.workspace !== 'string') return ifCliPrintErrorOnly(new Error('Parameter `workspace` expected to be a string'));
227+
225228
if (params.machineType) projectConfig.setMachineType(params.project, params.machineType);
226229
else params.machineType = projectConfig.getMachineType();
227230

@@ -460,7 +463,7 @@ <h1 class="page-title">jobs/create.js</h1>
460463
<br class="clear">
461464

462465
<footer>
463-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Dec 14 2017 12:04:22 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
466+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Dec 19 2017 23:31:24 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
464467
</footer>
465468

466469
<script>prettyPrint();</script>

‎docs/jobs_destroy.js.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ <h1 class="page-title">jobs/destroy.js</h1>
103103
<br class="clear">
104104

105105
<footer>
106-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Dec 14 2017 12:04:22 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
106+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Dec 19 2017 23:31:24 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
107107
</footer>
108108

109109
<script>prettyPrint();</script>

‎docs/jobs_index.js.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ <h1 class="page-title">jobs/index.js</h1>
6868
<br class="clear">
6969

7070
<footer>
71-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Dec 14 2017 12:04:22 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
71+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Dec 19 2017 23:31:24 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
7272
</footer>
7373

7474
<script>prettyPrint();</script>

‎docs/jobs_list.js.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ <h1 class="page-title">jobs/list.js</h1>
130130
<br class="clear">
131131

132132
<footer>
133-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Dec 14 2017 12:04:22 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
133+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Dec 19 2017 23:31:24 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
134134
</footer>
135135

136136
<script>prettyPrint();</script>

0 commit comments

Comments
 (0)