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

Commit 2f46954

Browse files
committed
reelase v0.1.5
1 parent 182cd12 commit 2f46954

32 files changed

+122
-48
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Paperspace API (v0.1.4)
1+
# Paperspace API (v0.1.5)
22

33
![image](https://user-images.githubusercontent.com/585865/27562775-26b8acc6-5a9c-11e7-8270-2b80ca895bc5.png)
44

@@ -15,6 +15,15 @@ The **Paperspace API** is the official devkit for automating your [Paperspace](h
1515
* [API documentation](https://paperspace.github.io/paperspace-node)
1616
* [Script Guide](scripts.md) for creating and using startup scripts
1717

18+
## Release Notes for v0.1.5
19+
20+
#### New features
21+
* New method: machines update
22+
* machines show method now includes last 10 events associated with the machine
23+
24+
#### Fixes
25+
* Minor doc fixes
26+
1827
## Release Notes for v0.1.4
1928

2029
#### New features

docs/index.html

Lines changed: 9 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="machin
4646

4747

4848
<section class="readme">
49-
<article><h1>Paperspace API (v0.1.4)</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.5)</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,13 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="machin
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.5</h2><h4>New features</h4><ul>
61+
<li>New method: machines update</li>
62+
<li>machines show method now includes last 10 events associated with the machine</li>
63+
</ul>
64+
<h4>Fixes</h4><ul>
65+
<li>Minor doc fixes</li>
66+
</ul>
6067
<h2>Release Notes for v0.1.4</h2><h4>New features</h4><ul>
6168
<li>New method: machines availability</li>
6269
</ul>
@@ -138,7 +145,7 @@ <h2>Copyright</h2><p>Copyright :copyright: 2017 Paperspace - All Rights Reserved
138145
<br class="clear">
139146

140147
<footer>
141-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Nov 28 2017 19:10:39 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
148+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Wed Nov 29 2017 00:24:45 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
142149
</footer>
143150

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

docs/machines.html

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2662,7 +2662,7 @@ <h6>Properties</h6>
26622662

26632663

26642664

2665-
<td class="description last"><p>Id of the machine to shut down</p></td>
2665+
<td class="description last"><p>Id of the machine to restart</p></td>
26662666
</tr>
26672667

26682668

@@ -2826,6 +2826,35 @@ <h5>Examples</h5>
28262826
"teamId": "te456def"
28272827
"scriptId": "sc123abc"
28282828
"dtLastRun": "2017-06-30T07:22:49.763Z"
2829+
"events": [
2830+
{
2831+
"name": "start",
2832+
"state": "done",
2833+
"errorMsg": "",
2834+
"handle": "8ebe43dd-57c8-4bd4-b770-86b7fd0202e4",
2835+
"dtModified": "2017-08-16T14:36:24.802Z",
2836+
"dtFinished": null,
2837+
"dtCreated": "2017-08-16T14:36:18.373Z"
2838+
},
2839+
{
2840+
"name": "start",
2841+
"state": "error",
2842+
"errorMsg": "Uh oh. This machine type can't start due to insufficient capacity or higher than normal demand. Please try again later.",
2843+
"handle": "f6adb486-f5ae-4ab3-9a1a-51c19df5b337",
2844+
"dtModified": "2017-06-09T15:32:38.115Z",
2845+
"dtFinished": "2017-06-09T15:32:38.115Z",
2846+
"dtCreated": "2017-06-09T15:32:37.019Z"
2847+
},
2848+
{
2849+
"name": "stop",
2850+
"state": "done",
2851+
"errorMsg": "",
2852+
"handle": "e352ad96-734f-4a26-8829-007c2f1d89f2",
2853+
"dtModified": "2017-06-03T04:14:01.327Z",
2854+
"dtFinished": null,
2855+
"dtCreated": "2017-06-03T04:13:47.885Z"
2856+
}
2857+
]
28292858
}</code></pre>
28302859

28312860

@@ -3160,7 +3189,7 @@ <h6>Properties</h6>
31603189

31613190

31623191

3163-
<td class="description last"><p>Id of the machine to shut down</p></td>
3192+
<td class="description last"><p>Id of the machine to start</p></td>
31643193
</tr>
31653194

31663195

@@ -3629,7 +3658,7 @@ <h6>Properties</h6>
36293658

36303659

36313660

3632-
<td class="description last"><p>Id of the machine to shut down</p></td>
3661+
<td class="description last"><p>Id of the machine to update</p></td>
36333662
</tr>
36343663

36353664

@@ -4488,7 +4517,7 @@ <h5>Returns:</h5>
44884517
<br class="clear">
44894518

44904519
<footer>
4491-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Nov 28 2017 19:10:39 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
4520+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Wed Nov 29 2017 00:24:45 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
44924521
</footer>
44934522

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

docs/machines_availability.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ <h1 class="page-title">machines/availability.js</h1>
105105
<br class="clear">
106106

107107
<footer>
108-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Nov 28 2017 19:10:39 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
108+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Wed Nov 29 2017 00:24:45 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
109109
</footer>
110110

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

docs/machines_create.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ <h1 class="page-title">machines/create.js</h1>
183183
<br class="clear">
184184

185185
<footer>
186-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Nov 28 2017 19:10:39 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
186+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Wed Nov 29 2017 00:24:45 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
187187
</footer>
188188

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

docs/machines_destroy.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ <h1 class="page-title">machines/destroy.js</h1>
9999
<br class="clear">
100100

101101
<footer>
102-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Nov 28 2017 19:10:39 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
102+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Wed Nov 29 2017 00:24:45 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
103103
</footer>
104104

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

docs/machines_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">machines/index.js</h1>
6868
<br class="clear">
6969

7070
<footer>
71-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Nov 28 2017 19:10:39 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.4.3</a> on Wed Nov 29 2017 00:24:45 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
7272
</footer>
7373

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

docs/machines_list.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ <h1 class="page-title">machines/list.js</h1>
147147
<br class="clear">
148148

149149
<footer>
150-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Nov 28 2017 19:10:39 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
150+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Wed Nov 29 2017 00:24:45 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
151151
</footer>
152152

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

docs/machines_restart.js.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,15 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="machin
2626
</nav>
2727

2828
<div id="main">
29-
29+
3030
<h1 class="page-title">machines/restart.js</h1>
31+
3132

33+
3234

3335

3436

35-
36-
37-
37+
3838
<section>
3939
<article>
4040
<pre class="prettyprint source linenums"><code>'use strict';
@@ -96,7 +96,7 @@ <h1 class="page-title">machines/restart.js</h1>
9696
<br class="clear">
9797

9898
<footer>
99-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Nov 28 2017 19:10:39 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
99+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Wed Nov 29 2017 00:24:45 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
100100
</footer>
101101

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

docs/machines_show.js.html

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,35 @@ <h1 class="page-title">machines/show.js</h1>
9595
* "teamId": "te456def"
9696
* "scriptId": "sc123abc"
9797
* "dtLastRun": "2017-06-30T07:22:49.763Z"
98+
* "events": [
99+
* {
100+
* "name": "start",
101+
* "state": "done",
102+
* "errorMsg": "",
103+
* "handle": "8ebe43dd-57c8-4bd4-b770-86b7fd0202e4",
104+
* "dtModified": "2017-08-16T14:36:24.802Z",
105+
* "dtFinished": null,
106+
* "dtCreated": "2017-08-16T14:36:18.373Z"
107+
* },
108+
* {
109+
* "name": "start",
110+
* "state": "error",
111+
* "errorMsg": "Uh oh. This machine type can't start due to insufficient capacity or higher than normal demand. Please try again later.",
112+
* "handle": "f6adb486-f5ae-4ab3-9a1a-51c19df5b337",
113+
* "dtModified": "2017-06-09T15:32:38.115Z",
114+
* "dtFinished": "2017-06-09T15:32:38.115Z",
115+
* "dtCreated": "2017-06-09T15:32:37.019Z"
116+
* },
117+
* {
118+
* "name": "stop",
119+
* "state": "done",
120+
* "errorMsg": "",
121+
* "handle": "e352ad96-734f-4a26-8829-007c2f1d89f2",
122+
* "dtModified": "2017-06-03T04:14:01.327Z",
123+
* "dtFinished": null,
124+
* "dtCreated": "2017-06-03T04:13:47.885Z"
125+
* }
126+
* ]
98127
* }
99128
*/
100129

@@ -127,7 +156,7 @@ <h1 class="page-title">machines/show.js</h1>
127156
<br class="clear">
128157

129158
<footer>
130-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Nov 28 2017 19:10:39 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
159+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Wed Nov 29 2017 00:24:45 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
131160
</footer>
132161

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

0 commit comments

Comments
 (0)