Skip to content

Commit ebf5cdd

Browse files
doc: Replace outdated API documentation TODOs with URLs (#447)
* Replace outdated documentation TODOs * Apply to child accounts
1 parent 72e6de4 commit ebf5cdd

File tree

7 files changed

+20
-22
lines changed

7 files changed

+20
-22
lines changed

linode_api4/groups/account.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -504,7 +504,7 @@ def child_accounts(self, *filters):
504504
505505
NOTE: Parent/Child related features may not be generally available.
506506
507-
API doc: TBD
507+
API Documentation: https://techdocs.akamai.com/linode-api/reference/get-child-accounts
508508
509509
:returns: a list of all child accounts.
510510
:rtype: PaginatedList of ChildAccount

linode_api4/groups/placement.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ def groups(self, *filters):
2020
2121
groups = client.placement.groups(PlacementGroup.label == "test")
2222
23-
API Documentation: TODO
23+
API Documentation: https://techdocs.akamai.com/linode-api/reference/get-placement-groups
2424
2525
:param filters: Any number of filters to apply to this query.
2626
See :doc:`Filtering Collections</linode_api4/objects/filtering>`

linode_api4/groups/vpc.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ def __call__(self, *filters) -> PaginatedList:
1616
1717
vpcs = client.vpcs()
1818
19-
API Documentation: TODO
19+
API Documentation: https://techdocs.akamai.com/linode-api/reference/get-vpcs
2020
2121
:param filters: Any number of filters to apply to this query.
2222
See :doc:`Filtering Collections</linode_api4/objects/filtering>`
@@ -38,7 +38,7 @@ def create(
3838
"""
3939
Creates a new VPC under your Linode account.
4040
41-
API Documentation: TODO
41+
API Documentation: https://techdocs.akamai.com/linode-api/reference/post-vpc
4242
4343
:param label: The label of the newly created VPC.
4444
:type label: str
@@ -90,7 +90,7 @@ def ips(self, *filters) -> PaginatedList:
9090
9191
vpc_ips = client.vpcs.ips()
9292
93-
API Documentation: TODO
93+
API Documentation: https://techdocs.akamai.com/linode-api/reference/get-vpcs-ips
9494
9595
:param filters: Any number of filters to apply to this query.
9696
See :doc:`Filtering Collections</linode_api4/objects/filtering>`

linode_api4/objects/account.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -62,17 +62,17 @@ class ChildAccount(Account):
6262
6363
NOTE: Parent/Child related features may not be generally available.
6464
65-
API Documentation: TBD
65+
API Documentation: https://techdocs.akamai.com/linode-api/reference/get-child-account
6666
"""
6767

6868
api_endpoint = "/account/child-accounts/{euuid}"
6969
id_attribute = "euuid"
7070

7171
def create_token(self, **kwargs):
7272
"""
73-
Create a ephemeral token for accessing the child account.
73+
Create an ephemeral token for accessing the child account.
7474
75-
API Documentation: TBD
75+
API Documentation: https://techdocs.akamai.com/linode-api/reference/post-child-account-token
7676
"""
7777
resp = self._client.post(
7878
"{}/token".format(self.api_endpoint),

linode_api4/objects/linode.py

+7-7
Original file line numberDiff line numberDiff line change
@@ -294,7 +294,7 @@ class NetworkInterface(DerivedBase):
294294
NOTE: This class cannot be used for the `interfaces` attribute on Config
295295
POST and PUT requests.
296296
297-
API Documentation: TODO
297+
API Documentation: https://techdocs.akamai.com/linode-api/reference/get-linode-config-interface
298298
"""
299299

300300
api_endpoint = (
@@ -369,7 +369,7 @@ class ConfigInterface(JSONObject):
369369
If you would like to access a config interface directly,
370370
consider using :any:`NetworkInterface`.
371371
372-
API Documentation: TODO
372+
API Documentation: https://techdocs.akamai.com/linode-api/reference/get-linode-config-interface
373373
"""
374374

375375
purpose: str = "public"
@@ -462,7 +462,7 @@ def network_interfaces(self):
462462
This differs from the `interfaces` field as each NetworkInterface
463463
object is treated as its own API object.
464464
465-
API Documentation: TODO
465+
API Documentation: https://techdocs.akamai.com/linode-api/reference/get-linode-config-interfaces
466466
"""
467467

468468
return [
@@ -523,7 +523,7 @@ def interface_create_public(self, primary=False) -> NetworkInterface:
523523
"""
524524
Creates a public interface for this Configuration Profile.
525525
526-
API Documentation: TODO
526+
API Documentation: https://techdocs.akamai.com/linode-api/reference/post-linode-config-interface
527527
528528
:param primary: Whether this interface is a primary interface.
529529
:type primary: bool
@@ -540,7 +540,7 @@ def interface_create_vlan(
540540
"""
541541
Creates a VLAN interface for this Configuration Profile.
542542
543-
API Documentation: TODO
543+
API Documentation: https://techdocs.akamai.com/linode-api/reference/post-linode-config-interface
544544
545545
:param label: The label of the VLAN to associate this interface with.
546546
:type label: str
@@ -569,7 +569,7 @@ def interface_create_vpc(
569569
"""
570570
Creates a VPC interface for this Configuration Profile.
571571
572-
API Documentation: TODO
572+
API Documentation: https://techdocs.akamai.com/linode-api/reference/post-linode-config-interface
573573
574574
:param subnet: The VPC subnet to associate this interface with.
575575
:type subnet: int or VPCSubnet
@@ -605,7 +605,7 @@ def interface_reorder(self, interfaces: List[Union[int, NetworkInterface]]):
605605
"""
606606
Change the order of the interfaces for this Configuration Profile.
607607
608-
API Documentation: TODO
608+
API Documentation: https://techdocs.akamai.com/linode-api/reference/post-linode-config-interfaces
609609
610610
:param interfaces: A list of interfaces in the desired order.
611611
:type interfaces: List of str or NetworkInterface

linode_api4/objects/placement.py

+1-3
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ class PlacementGroup(Base):
4141
A VM Placement Group, defining the affinity policy for Linodes
4242
created in a region.
4343
44-
API Documentation: TODO
44+
API Documentation: https://techdocs.akamai.com/linode-api/reference/get-placement-group
4545
"""
4646

4747
api_endpoint = "/placement/groups/{id}"
@@ -66,8 +66,6 @@ def assign(
6666
6767
:param linodes: A list of Linodes to assign to the Placement Group.
6868
:type linodes: List[Union[Instance, int]]
69-
:param compliant_only: TODO
70-
:type compliant_only: bool
7169
"""
7270
params = {
7371
"linodes": [

linode_api4/objects/vpc.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ class VPCSubnet(DerivedBase):
2323
"""
2424
An instance of a VPC subnet.
2525
26-
API Documentation: TODO
26+
API Documentation: https://techdocs.akamai.com/linode-api/reference/get-vpc-subnet
2727
"""
2828

2929
api_endpoint = "/vpcs/{vpc_id}/subnets/{id}"
@@ -44,7 +44,7 @@ class VPC(Base):
4444
"""
4545
An instance of a VPC.
4646
47-
API Documentation: TODO
47+
API Documentation: https://techdocs.akamai.com/linode-api/reference/get-vpc
4848
"""
4949

5050
api_endpoint = "/vpcs/{id}"
@@ -68,7 +68,7 @@ def subnet_create(
6868
"""
6969
Creates a new Subnet object under this VPC.
7070
71-
API Documentation: TODO
71+
API Documentation: https://techdocs.akamai.com/linode-api/reference/post-vpc-subnet
7272
7373
:param label: The label of this subnet.
7474
:type label: str
@@ -104,7 +104,7 @@ def ips(self) -> PaginatedList:
104104
"""
105105
Get all the IP addresses under this VPC.
106106
107-
API Documentation: TODO
107+
API Documentation: https://techdocs.akamai.com/linode-api/reference/get-vpc-ips
108108
109109
:returns: A list of VPCIPAddresses the acting user can access.
110110
:rtype: PaginatedList of VPCIPAddress

0 commit comments

Comments
 (0)