Skip to content

TPT-4394: update API documentation links in Lock classes #679

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zliang-akamai wants to merge 1 commit into
base: dev
Choose a base branch
from
+5 −5
Open

TPT-4394: update API documentation links in Lock classes #679

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions linode_api4/groups/lock.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ def __call__(self, *filters):
locks = client.locks()
API Documentation: TBD
API Documentation: https://techdocs.akamai.com/linode-api/reference/get-resource-locks
:param filters: Any number of filters to apply to this query.
See :doc:`Filtering Collections</linode_api4/objects/filtering>`
Expand All @@ -44,7 +44,7 @@ def create(
"""
Creates a new Resource Lock for the specified entity.
API Documentation: TBD
API Documentation: https://techdocs.akamai.com/linode-api/reference/post-resource-lock
:param entity_type: The type of entity to lock (e.g., "linode").
:type entity_type: str
Expand Down
6 changes: 3 additions & 3 deletions linode_api4/objects/lock.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ class LockType(StrEnum):
"""
LockType defines valid values for resource lock types.

API Documentation: TBD
API Documentation: https://techdocs.akamai.com/linode-api/reference/get-resource-lock
"""

cannot_delete = "cannot_delete"
Expand All @@ -22,7 +22,7 @@ class LockEntity(JSONObject):
"""
Represents the entity that is locked.

API Documentation: TBD
API Documentation: https://techdocs.akamai.com/linode-api/reference/get-resource-lock
"""

id: int = 0
Expand All @@ -35,7 +35,7 @@ class Lock(Base):
"""
A resource lock that prevents deletion or modification of a resource.

API Documentation: TBD
API Documentation: https://techdocs.akamai.com/linode-api/reference/get-resource-lock
"""

api_endpoint = "/locks/{id}"
Expand Down
Loading