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

Commit 94e6f53

Browse files
sanfilipsanfilip
committed
doc refresh
1 parent d4868d0 commit 94e6f53

27 files changed

+69
-31
lines changed

‎docs/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ <h2>Copyright</h2><p>Copyright :copyright: 2017 Paperspace - All Rights Reserved
110110
<br class="clear">
111111

112112
<footer>
113-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Jul 11 2017 15:51:00 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
113+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Jul 13 2017 22:32:57 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
114114
</footer>
115115

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

‎docs/machines.html‎

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,7 @@ <h5>Examples</h5>
197197
billingType: 'hourly',
198198
machineName: 'My Machine 1',
199199
templateId: 't123abc',
200+
assignPublicIp: true, // optional - assign a new public ip address
200201
networkId: 'n123abc', // optional - only if creating on a specific network
201202
teamId: 'te456def', // optional - required if creating this machine for a team
202203
userId: 'u123abc', // optional - required if assigning to an existing user other than yourself
@@ -217,6 +218,7 @@ <h5>Examples</h5>
217218
--billingType "hourly" \
218219
--machineName "My Machine 1" \
219220
--templateId "t123abc" \
221+
--assignPublicIp true \
220222
--networkId "n123abc" \
221223
--teamId "te456def" \
222224
--userId "u123abc" \
@@ -229,7 +231,7 @@ <h5>Examples</h5>
229231

230232
<pre class="prettyprint"><code># HTTP request:
231233
https://api.paperspace.io
232-
POST /machines/createSingleMachinePublic {"region": "East Coast (NY2)", "machineType": "Air", "size": 50, "billingType": "monthly", "machineName": "My Machine 1", "templateId": "t123abc", "networkId": "n123abc", "teamId": "te456def", "userId": "u123abc", "email": "example@example.com", "password": "secret123", "firstName": "Jon", "lastName": "Snow", "notificationEmail": "example@example.com"}
234+
POST /machines/createSingleMachinePublic {"region": "East Coast (NY2)", "machineType": "Air", "size": 50, "billingType": "monthly", "machineName": "My Machine 1", "templateId": "t123abc", "assignPublicIp": true, "networkId": "n123abc", "teamId": "te456def", "userId": "u123abc", "email": "example@example.com", "password": "secret123", "firstName": "Jon", "lastName": "Snow", "notificationEmail": "example@example.com"}
233235
x-api-key: 1ba4f98e7c0...
234236
# Returns 201 on success</code></pre>
235237

@@ -254,7 +256,7 @@ <h5>Examples</h5>
254256
"state": "provisioning",
255257
"networkId": null,
256258
"privateIpAddress": null,
257-
"publicIpAddress": null,
259+
"publicIpAddress": "169.255.255.254",
258260
"region": null,
259261
"userId": "u123abc",
260262
"teamId": "te456def"
@@ -521,6 +523,39 @@ <h6>Properties</h6>
521523

522524

523525

526+
<tr>
527+
528+
<td class="name"><code>assignPublicIp</code></td>
529+
530+
531+
<td class="type">
532+
533+
534+
<span class="param-type">boolean</span>
535+
536+
537+
538+
</td>
539+
540+
541+
<td class="attributes">
542+
543+
&lt;optional><br>
544+
545+
546+
547+
548+
549+
</td>
550+
551+
552+
553+
554+
<td class="description last"><p>Assign a new public ip address on machine creation</p></td>
555+
</tr>
556+
557+
558+
524559
<tr>
525560

526561
<td class="name"><code>networkId</code></td>
@@ -3449,7 +3484,7 @@ <h5>Returns:</h5>
34493484
<br class="clear">
34503485

34513486
<footer>
3452-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Jul 11 2017 15:51:00 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
3487+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Jul 13 2017 22:32:57 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
34533488
</footer>
34543489

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

‎docs/machines_create.js.html‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ <h1 class="page-title">machines/create.js</h1>
6161
* @param {string} params.billingType - Either 'monthly' or 'hourly' billing
6262
* @param {string} params.machineName - A memorable name for this machine
6363
* @param {string} params.templateId - Template id of the template to use for creating this machine
64+
* @param {boolean} [params.assignPublicIp] - Assign a new public ip address on machine creation
6465
* @param {string} [params.networkId] - If creating on a specific network, specify its id
6566
* @param {string} [params.teamId] - If creating the machine for a team, specify the team id
6667
* @param {string} [params.userId] - If assigning to an existing user other than yourself, specify the user id
@@ -80,6 +81,7 @@ <h1 class="page-title">machines/create.js</h1>
8081
* billingType: 'hourly',
8182
* machineName: 'My Machine 1',
8283
* templateId: 't123abc',
84+
* assignPublicIp: true, // optional - assign a new public ip address
8385
* networkId: 'n123abc', // optional - only if creating on a specific network
8486
* teamId: 'te456def', // optional - required if creating this machine for a team
8587
* userId: 'u123abc', // optional - required if assigning to an existing user other than yourself
@@ -100,6 +102,7 @@ <h1 class="page-title">machines/create.js</h1>
100102
* --billingType "hourly" \
101103
* --machineName "My Machine 1" \
102104
* --templateId "t123abc" \
105+
* --assignPublicIp true \
103106
* --networkId "n123abc" \
104107
* --teamId "te456def" \
105108
* --userId "u123abc" \
@@ -112,7 +115,7 @@ <h1 class="page-title">machines/create.js</h1>
112115
* @example
113116
* # HTTP request:
114117
* https://api.paperspace.io
115-
* POST /machines/createSingleMachinePublic {"region": "East Coast (NY2)", "machineType": "Air", "size": 50, "billingType": "monthly", "machineName": "My Machine 1", "templateId": "t123abc", "networkId": "n123abc", "teamId": "te456def", "userId": "u123abc", "email": "example@example.com", "password": "secret123", "firstName": "Jon", "lastName": "Snow", "notificationEmail": "example@example.com"}
118+
* POST /machines/createSingleMachinePublic {"region": "East Coast (NY2)", "machineType": "Air", "size": 50, "billingType": "monthly", "machineName": "My Machine 1", "templateId": "t123abc", "assignPublicIp": true, "networkId": "n123abc", "teamId": "te456def", "userId": "u123abc", "email": "example@example.com", "password": "secret123", "firstName": "Jon", "lastName": "Snow", "notificationEmail": "example@example.com"}
116119
* x-api-key: 1ba4f98e7c0...
117120
* # Returns 201 on success
118121
* @example
@@ -137,7 +140,7 @@ <h1 class="page-title">machines/create.js</h1>
137140
* "state": "provisioning",
138141
* "networkId": null,
139142
* "privateIpAddress": null,
140-
* "publicIpAddress": null,
143+
* "publicIpAddress": "169.255.255.254",
141144
* "region": null,
142145
* "userId": "u123abc",
143146
* "teamId": "te456def"
@@ -180,7 +183,7 @@ <h1 class="page-title">machines/create.js</h1>
180183
<br class="clear">
181184

182185
<footer>
183-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Jul 11 2017 15:51:00 GMT-0400 (EDT) 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 Thu Jul 13 2017 22:32:57 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
184187
</footer>
185188

186189
<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 Jul 11 2017 15:51:00 GMT-0400 (EDT) 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 Thu Jul 13 2017 22:32:57 GMT-0400 (EDT) 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
@@ -65,7 +65,7 @@ <h1 class="page-title">machines/index.js</h1>
6565
<br class="clear">
6666

6767
<footer>
68-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Jul 11 2017 15:51:00 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
68+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Jul 13 2017 22:32:57 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
6969
</footer>
7070

7171
<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 Jul 11 2017 15:51:00 GMT-0400 (EDT) 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 Thu Jul 13 2017 22:32:57 GMT-0400 (EDT) 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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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 Jul 11 2017 15:51:00 GMT-0400 (EDT) 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 Thu Jul 13 2017 22:32:57 GMT-0400 (EDT) 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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ <h1 class="page-title">machines/show.js</h1>
127127
<br class="clear">
128128

129129
<footer>
130-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Jul 11 2017 15:51:00 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
130+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Jul 13 2017 22:32:57 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
131131
</footer>
132132

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

‎docs/machines_start.js.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ <h1 class="page-title">machines/start.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 Jul 11 2017 15:51:00 GMT-0400 (EDT) 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 Thu Jul 13 2017 22:32:57 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
100100
</footer>
101101

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

‎docs/machines_stop.js.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ <h1 class="page-title">machines/stop.js</h1>
9797
<br class="clear">
9898

9999
<footer>
100-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Jul 11 2017 15:51:00 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
100+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Jul 13 2017 22:32:57 GMT-0400 (EDT) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
101101
</footer>
102102

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

0 commit comments

Comments
 (0)