Skip to content

Commit 2460f9f

Browse files
DorthuDorthu
authored
Merge pull request #87 from linode/release/0.16.16
Release/0.16.16
2 parents 163dead + d8054d7 commit 2460f9f

18 files changed

+272
-130
lines changed

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
</h1>
66

77
This is the new Linode developers site. It provides documentation to complement the APIv4.
8-
Currently this software is *early-access* and is available at [developers.linode.com](https://developers.linode.com).
8+
This documentation can be viewed at [developers.linode.com](https://developers.linode.com).
99

1010
## Setup
1111

‎src/App.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ browserHistory.listen(function (location) {
148148

149149
window.setTitle = function (newTitle) {
150150
const title = document.querySelector('title');
151-
title.textContent = 'API v4 Documentation | Linode Developers';
151+
title.textContent = 'API Documentation | Linode Developers';
152152

153153
if (newTitle) {
154154
title.textContent = `${newTitle} | ${title.textContent}`;

‎src/data/endpoints/account.yaml

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ endpoints:
185185
python: |
186186
my_client = linode.OAuthClient(client, 123)
187187
my_client.delete()
188-
/account/oauth-clients/$id/reset_secret:
188+
/account/oauth-clients/$id/reset-secret:
189189
group: OAuth Clients
190190
type: Action
191191
authenticated: true
@@ -200,7 +200,7 @@ endpoints:
200200
curl -H "Content-Type: application/json" \
201201
-H "Authorization: Bearer $TOKEN" \
202202
-X POST \
203-
https://$api_root/$version/account/oauth-clients/$client_id/reset_secret
203+
https://$api_root/$version/account/oauth-clients/$client_id/reset-secret
204204
python: |
205205
my_client = linode.OAuthClient(client, 123)
206206
new_secret = my_client.reset_secret()
@@ -269,10 +269,6 @@ endpoints:
269269
type: String
270270
description: The user's email.
271271
value: [email protected]
272-
password:
273-
type: String
274-
description: The user's password.
275-
value: hunter2
276272
restricted:
277273
optional: true
278274
type: Boolean
@@ -284,7 +280,6 @@ endpoints:
284280
-H "Authorization: Bearer $TOKEN" \
285281
-X POST -d '{
286282
"username": "testguy",
287-
"password": "hunter7",
288283
"email": "[email protected]"
289284
}' \
290285
https://$api_root/$version/account/users
@@ -311,13 +306,13 @@ endpoints:
311306
curl -H "Content-Type: application/json" \
312307
-H "Authorization: Bearer $TOKEN" \
313308
-X PUT -d '{
314-
"email": "[email protected]"
309+
"username": "newusername"
315310
}
316311
}' \
317312
https://$api_root/$version/account/users/testguy
318313
python: |
319314
my_user = linode.User(client, 'username')
320-
my_user.email = '[email protected]'
315+
my_user.username = 'newusername'
321316
my_user.save()
322317
DELETE:
323318
description: >

‎src/data/endpoints/domains.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ endpoints:
264264
The tag attribute for a CAA record. One of "issue", "issuewild",
265265
or "iodef". Ignored on other record types.
266266
type: Enum
267-
ttl:
267+
ttl_sec:
268268
optional: true
269269
description: >
270270
Time interval that the resource record may be cached before

‎src/data/endpoints/linodes.yaml

Lines changed: 34 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -281,18 +281,6 @@ endpoints:
281281
python: |
282282
disk.label = 'New Disk Label'
283283
disk.save()
284-
POST:
285-
oauth: linodes:create
286-
description: >
287-
Duplicates this disk.
288-
examples:
289-
curl: |
290-
curl -H "Content-Type: application/json" \
291-
-H "Authorization: Bearer $TOKEN" \
292-
-X POST \
293-
https://$api_root/$version/linode/instances/$linode_id/disks/$disk_id
294-
python: |
295-
new_disk = disk.duplicate()
296284
DELETE:
297285
oauth: linodes:delete
298286
dangerous: true
@@ -305,6 +293,25 @@ endpoints:
305293
https://$api_root/$version/linode/instances/$linode_id/disks/$disk_id
306294
python: |
307295
disk.delete()
296+
/linode/instances/$id/disks/$id/clone:
297+
group: Disks
298+
type: resource
299+
authenticated: true
300+
description: >
301+
Duplicates a disk.
302+
methods:
303+
POST:
304+
oauth: linodes:create
305+
description: >
306+
Duplicates this disk.
307+
examples:
308+
curl: |
309+
curl -H "Content-Type: application/json" \
310+
-H "Authorization: Bearer $TOKEN" \
311+
-X POST \
312+
https://$api_root/$version/linode/instances/$linode_id/disks/$disk_id/clone
313+
python: |
314+
new_disk = disk.duplicate()
308315
/linode/instances/$id/disks/$id/resize:
309316
group: Disks
310317
type: Strange
@@ -869,23 +876,27 @@ endpoints:
869876
money: true
870877
oauth: linodes:modify
871878
description: >
872-
Allocates a new IP Address for this Linode.
879+
Allocates a new IPv4 Address for this Linode.
873880
params:
874881
type:
875-
description: >
876-
The type of IP Address this is, can be one of "public" or "private".
877-
Public IP Addresses, over and above the one included with each Linode,
878-
incur an additional monthly charge. If you need an additional Public IP Address
879-
you must request one - please open a ticket.
880882
type: String
881-
value: private
883+
description: >
884+
The type of IP to allocate. Currently only "ipv4" is supported.
885+
value: ipv4
886+
public:
887+
type: Boolean
888+
description: >
889+
Whether this is a public or private IP address.
890+
Public IP Addresses, over and above the one included with each
891+
Linode, incur an additional monthly charge. If you need an
892+
additional Public IP Address you must request one - please
893+
open a ticket.
894+
value: true
882895
examples:
883896
curl: |
884897
curl -H "Content-Type: application/json" \
885898
-H "Authorization: Bearer $TOKEN" \
886-
-X POST -d '{
887-
"type": "private"
888-
}' \
899+
-X POST -d '{"type": "ipv4", "public":true}' \
889900
https://$api_root/$version/linode/instances/$linode_id/ips
890901
/linode/instances/$id/ips/$ip_address:
891902
group: IPs
@@ -929,8 +940,7 @@ endpoints:
929940
authenticated: true
930941
description: >
931942
Deletes all Disks and Configs on this Linode, then deploys a new
932-
Distribution or Image to this Linode with the given attributes. Returns
933-
a JSON object representation of the Linode's disks and configs.
943+
Distribution or Image to this Linode with the given attributes.
934944
methods:
935945
POST:
936946
oauth: linodes:modify

‎src/data/endpoints/managed.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -394,7 +394,7 @@ endpoints:
394394
curl -H "Content-Type: application/json" \
395395
-H "Authorization: Bearer $TOKEN" \
396396
https://$api_root/$version/managed/credentials/$credential_id/revoke
397-
/managed/linode_settings:
397+
/managed/linode-settings:
398398
group: Linode Settings
399399
type: resource
400400
authenticated: true
@@ -408,8 +408,8 @@ endpoints:
408408
examples:
409409
curl: |
410410
curl -H "Authorization: Bearer $TOKEN" \
411-
https://$api_root/$version/managed/linode_settings
412-
/managed/linode_settings/$id:
411+
https://$api_root/$version/managed/linode-settings
412+
/managed/linode-settings/$id:
413413
group: Linode Settings
414414
type: resource
415415
authenticated: true
@@ -423,7 +423,7 @@ endpoints:
423423
examples:
424424
curl: |
425425
curl -H "Authorization: Bearer $TOKEN" \
426-
https://$api_root/$version/managed/linode_settings/$linode_settings_id
426+
https://$api_root/$version/managed/linode-settings/$linode_settings_id
427427
PUT:
428428
response: ManagedLinodeSetting
429429
description: >
@@ -440,7 +440,7 @@ endpoints:
440440
"access": true
441441
}
442442
}' \
443-
https://$api_root/$version/managed/linode_settings/$linode_settings_id
443+
https://$api_root/$version/managed/linode-settings/$linode_settings_id
444444
/managed/stats:
445445
group: Stats
446446
type: Action

‎src/data/endpoints/networking.yaml

Lines changed: 22 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -15,30 +15,43 @@ endpoints:
1515
paginationKey: data
1616
oauth: ips:view
1717
description: >
18-
Returns a list of IP Addresses, including v4 and slaac addresses.
18+
Returns a list of IP Addresses, including v4, slaac, and public v6
19+
addresses.
1920
examples:
2021
curl: |
2122
curl -H "Authorization: Bearer $TOKEN" \
2223
https://$api_root/$version/networking/ips
2324
POST:
25+
response: ipaddress
2426
money: true
2527
oauth: ips:create
2628
description: >
27-
Create a new Public IPv4 Address.
29+
Create a new IPv4 Address.
2830
params:
2931
type:
3032
type: String
3133
description: >
32-
The type of IP to allocate. Currently only "ipv4" is supported.
34+
The type of IP to allocate. Currently only "ipv4" is supported.
35+
value: ipv4
36+
public:
37+
type: Boolean
38+
description: >
39+
Whether this is a public or private IP address.
40+
Public IP Addresses, over and above the one included with each
41+
Linode, incur an additional monthly charge. If you need an
42+
additional Public IP Address you must request one - please
43+
open a ticket.
44+
value: true
3345
linode_id:
46+
type: Integer
3447
description: >
3548
The Linode ID to assign this IP to.
36-
type: Integer
49+
value: 123
3750
examples:
3851
curl: |
3952
curl -H "Content-Type: application/json" \
4053
-H "Authorization: Bearer $TOKEN" \
41-
-X POST -d '{"type":"ipv4","linode":123}' \
54+
-X POST -d '{"type":"ipv4", "public":true, "linode":123}' \
4255
https://$api_root/$version/networking/ips
4356
/networking/ips/$address:
4457
group: IPs
@@ -116,39 +129,7 @@ endpoints:
116129
https://$api_root/$version/networking/ipv6/ranges
117130
python: |
118131
my_ipv6s = client.networking.get_ipv6_ranges()
119-
/networking/ipv6/$address:
120-
group: IPv6
121-
type: resource
122-
authenticated: true
123-
description: >
124-
Manage a single IPv6 Address. Address in URL
125-
can be as compressed as you want.
126-
methods:
127-
GET:
128-
response: ipv6-address
129-
oauth: ips:view
130-
description: >
131-
Return a single IPv6 Address.
132-
examples:
133-
curl: |
134-
curl -H "Authorization: Bearer $TOKEN" \
135-
https://$api_root/$version/networking/ipv6/2600:3c01::2:5001
136-
python: |
137-
my_ipv6 = linode.IPv6Address(client, '2600:3c01::2:5001')
138-
PUT:
139-
oauth: ips:modify
140-
description: >
141-
Set RDNS on a single IPv6 Address.
142-
examples:
143-
curl: |
144-
curl -H "Content-Type: application/json" \
145-
-H "Authorization: Bearer $TOKEN" \
146-
-X PUT -d '{"rdns":"example.org"}' \
147-
https://$api_root/$version/networking/ipv6/2600:3c01::2:5001
148-
python: |
149-
my_ipv6.rdns = 'example.org'
150-
my_ipv6.save()
151-
/networking/ip-assign:
132+
/networking/ipv4/assign:
152133
group: IPv4
153134
type: Strange
154135
authenticated: true
@@ -183,7 +164,7 @@ endpoints:
183164
curl -H "Content-Type: application/json" \
184165
-H "Authorization: Bearer $TOKEN" \
185166
-X POST -d '$SUB_SPEC_EXAMPLE' \
186-
https://$api_root/$version/networking/ip-assign
167+
https://$api_root/$version/networking/ipv4/assign
187168
python: |
188169
linode_1 = linode.Linode(client, 134504)
189170
ip1 = linode_1.ips.ipv4.public[0]
@@ -192,7 +173,7 @@ endpoints:
192173
ip2 = linode_2.ips.ipv4.public[0]
193174
194175
client.networking.assign_ips(linode_1.region, ip1.to(linode_2), ip2.to(linode_1))
195-
/networking/ip-sharing:
176+
/networking/ipv4/share:
196177
group: IPv4
197178
type: Strange
198179
authenticated: true
@@ -220,5 +201,5 @@ endpoints:
220201
"linode_id": 12345,
221202
"ips": [ "97.107.143.29", "97.107.143.112" ]
222203
}' \
223-
https://$api_root/$version/networking/ip-sharing
204+
https://$api_root/$version/networking/ipv4/share
224205

‎src/data/endpoints/support.yaml

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -62,22 +62,6 @@ endpoints:
6262
The Block Storage Volume this ticket is regarding, if relevant.
6363
type: Integer
6464
optional: true
65-
managed_issue_type:
66-
description: >
67-
The Managed issue type of this ticket. Do not pass this
68-
unless your account has Managed Services activated.
69-
type: Enum
70-
value: issue
71-
maintenance:
72-
type: String
73-
description: Maintenance
74-
issue:
75-
type: String
76-
description: An issue
77-
request:
78-
type: String
79-
description: Other request
80-
optional: true
8165
curl: |
8266
curl -H "Content-Type: application/json" \
8367
-H "Authorization: Bearer $TOKEN" \

‎src/data/objects/ipaddress.yaml

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: IP Address
22
description: >
3-
An IP Address
3+
An IPv4 Address
44
schema:
55
address:
66
type: String
@@ -26,16 +26,19 @@ schema:
2626
region:
2727
type: String
2828
value: us-east
29-
description: The region this IP is in.
29+
description: The Region this IP is in.
3030
subnet_mask:
3131
type: String
3232
value: 255.255.255.0
3333
description: The subnet mask.
34+
public:
35+
type: Boolean
36+
value: true
37+
description: Whether this is a public or private IP address.
3438
type:
35-
type: Enum
36-
subtype: IPAddressType
37-
value: public
38-
description: The type of IP Address, either public or private.
39+
type: String
40+
description: The type of IP Address.
41+
value: ipv4
3942
enums:
4043
IPAddressType:
4144
public: Public IP Address.

0 commit comments

Comments
 (0)