Skip to content

docs(annotations): improve documentation #2101

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

Merged
remyleone merged 1 commit into from
Aug 31, 2026
Merged

docs(annotations): improve documentation #2101

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
24 changes: 12 additions & 12 deletions scaleway-async/scaleway_async/annotations/v1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ async def list_keys(
organization_id: Optional[str] = None,
) -> ListKeysResponse:
"""
List of keys.
List all keys, sorted alphabetically by name.
:param page: Page number.
:param page_size: Maximum number of keys on the page.
:param organization_id: ID of the organization.
Expand Down Expand Up @@ -128,7 +128,7 @@ async def list_keys_all(
organization_id: Optional[str] = None,
) -> list[Key]:
"""
List of keys.
List all keys, sorted alphabetically by name.
:param page: Page number.
:param page_size: Maximum number of keys on the page.
:param organization_id: ID of the organization.
Expand Down Expand Up @@ -294,7 +294,7 @@ async def list_values(
key_id: Optional[str] = None,
) -> ListValuesResponse:
"""
List all values for a key, sorted alphabetically by name.
List all values, sorted alphabetically by name.
:param page: Page number.
:param page_size: Maximum number of values on the page.
:param organization_id: ID of the organization.
Expand Down Expand Up @@ -331,7 +331,7 @@ async def list_values_all(
key_id: Optional[str] = None,
) -> list[Value]:
"""
List all values for a key, sorted alphabetically by name.
List all values, sorted alphabetically by name.
:param page: Page number.
:param page_size: Maximum number of values on the page.
:param organization_id: ID of the organization.
Expand Down Expand Up @@ -392,7 +392,7 @@ async def update_value(
description: Optional[str] = None,
) -> Value:
"""
Update name or description. Global update.
Update name or description.
:param value_id: ID of the value to update.
:param name: New name of the value.
:param description: New description of the value.
Expand Down Expand Up @@ -515,7 +515,7 @@ async def create_binding(
) -> Binding:
"""
Attach a value to a resource. Fails if the resource already has a value for this key.
:param srn: Scaleway Resource Number to associate.
:param srn: Scaleway Resource Name to associate.
:param value_id: ID of the value to associate.
:return: :class:`Binding <Binding>`

Expand Down Expand Up @@ -553,11 +553,11 @@ async def list_bindings(
value_id: Optional[str] = None,
) -> ListBindingsResponse:
"""
List all bindings, or filter by Scaleway Resource Number or value ID. Response order by ID.
List all bindings, or filter by Scaleway Resource Name or value ID. Response order by ID.
:param page: Page number.
:param page_size: Maximum number of bindings on the page.
:param organization_id: ID of the organization.
:param srn: Scaleway Resource Number for which to list all bindings.
:param srn: Scaleway Resource Name for which to list all bindings.
:param value_id: Value ID for which to list all bindings.
:return: :class:`ListBindingsResponse <ListBindingsResponse>`

Expand Down Expand Up @@ -593,11 +593,11 @@ async def list_bindings_all(
value_id: Optional[str] = None,
) -> list[Binding]:
"""
List all bindings, or filter by Scaleway Resource Number or value ID. Response order by ID.
List all bindings, or filter by Scaleway Resource Name or value ID. Response order by ID.
:param page: Page number.
:param page_size: Maximum number of bindings on the page.
:param organization_id: ID of the organization.
:param srn: Scaleway Resource Number for which to list all bindings.
:param srn: Scaleway Resource Name for which to list all bindings.
:param value_id: Value ID for which to list all bindings.
:return: :class:`list[Binding] <list[Binding]>`

Expand Down Expand Up @@ -682,8 +682,8 @@ async def delete_all_bindings_matching_srn(
organization_id: Optional[str] = None,
) -> DeleteAllBindingsMatchingSRNResponse:
"""
Delete ALL bindings associated with a Scaleway Resource Number.
:param srn: Scaleway Resource Number for which all bindings should be deleted.
Delete ALL bindings associated with a Scaleway Resource Name.
:param srn: Scaleway Resource Name for which all bindings should be deleted.
:param organization_id: ID of the organization.
:return: :class:`DeleteAllBindingsMatchingSRNResponse <DeleteAllBindingsMatchingSRNResponse>`

Expand Down
10 changes: 5 additions & 5 deletions scaleway-async/scaleway_async/annotations/v1/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ class Binding:

srn: str
"""
Scaleway Resource Number associated to the binding.
Scaleway Resource Name associated to the binding.
"""

key: Optional[BindingKey] = None
Expand Down Expand Up @@ -141,7 +141,7 @@ class Value:
class CreateBindingRequest:
srn: str
"""
Scaleway Resource Number to associate.
Scaleway Resource Name to associate.
"""

value_id: str
Expand Down Expand Up @@ -190,7 +190,7 @@ class CreateValueRequest:
class DeleteAllBindingsMatchingSRNRequest:
srn: str
"""
Scaleway Resource Number for which all bindings should be deleted.
Scaleway Resource Name for which all bindings should be deleted.
"""

organization_id: Optional[str] = None
Expand Down Expand Up @@ -235,7 +235,7 @@ class DeleteAllValuesMatchingKeyRequest:
class DeleteAllValuesMatchingKeyResponse:
total_deleted: int
"""
Total number of bindings deleted.
Total number of values deleted.
"""


Expand Down Expand Up @@ -314,7 +314,7 @@ class ListBindingsRequest:

srn: Optional[str] = None
"""
Scaleway Resource Number for which to list all bindings.
Scaleway Resource Name for which to list all bindings.
"""

value_id: Optional[str] = None
Expand Down
24 changes: 12 additions & 12 deletions scaleway/scaleway/annotations/v1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ def list_keys(
organization_id: Optional[str] = None,
) -> ListKeysResponse:
"""
List of keys.
List all keys, sorted alphabetically by name.
:param page: Page number.
:param page_size: Maximum number of keys on the page.
:param organization_id: ID of the organization.
Expand Down Expand Up @@ -128,7 +128,7 @@ def list_keys_all(
organization_id: Optional[str] = None,
) -> list[Key]:
"""
List of keys.
List all keys, sorted alphabetically by name.
:param page: Page number.
:param page_size: Maximum number of keys on the page.
:param organization_id: ID of the organization.
Expand Down Expand Up @@ -294,7 +294,7 @@ def list_values(
key_id: Optional[str] = None,
) -> ListValuesResponse:
"""
List all values for a key, sorted alphabetically by name.
List all values, sorted alphabetically by name.
:param page: Page number.
:param page_size: Maximum number of values on the page.
:param organization_id: ID of the organization.
Expand Down Expand Up @@ -331,7 +331,7 @@ def list_values_all(
key_id: Optional[str] = None,
) -> list[Value]:
"""
List all values for a key, sorted alphabetically by name.
List all values, sorted alphabetically by name.
:param page: Page number.
:param page_size: Maximum number of values on the page.
:param organization_id: ID of the organization.
Expand Down Expand Up @@ -392,7 +392,7 @@ def update_value(
description: Optional[str] = None,
) -> Value:
"""
Update name or description. Global update.
Update name or description.
:param value_id: ID of the value to update.
:param name: New name of the value.
:param description: New description of the value.
Expand Down Expand Up @@ -515,7 +515,7 @@ def create_binding(
) -> Binding:
"""
Attach a value to a resource. Fails if the resource already has a value for this key.
:param srn: Scaleway Resource Number to associate.
:param srn: Scaleway Resource Name to associate.
:param value_id: ID of the value to associate.
:return: :class:`Binding <Binding>`

Expand Down Expand Up @@ -553,11 +553,11 @@ def list_bindings(
value_id: Optional[str] = None,
) -> ListBindingsResponse:
"""
List all bindings, or filter by Scaleway Resource Number or value ID. Response order by ID.
List all bindings, or filter by Scaleway Resource Name or value ID. Response order by ID.
:param page: Page number.
:param page_size: Maximum number of bindings on the page.
:param organization_id: ID of the organization.
:param srn: Scaleway Resource Number for which to list all bindings.
:param srn: Scaleway Resource Name for which to list all bindings.
:param value_id: Value ID for which to list all bindings.
:return: :class:`ListBindingsResponse <ListBindingsResponse>`

Expand Down Expand Up @@ -593,11 +593,11 @@ def list_bindings_all(
value_id: Optional[str] = None,
) -> list[Binding]:
"""
List all bindings, or filter by Scaleway Resource Number or value ID. Response order by ID.
List all bindings, or filter by Scaleway Resource Name or value ID. Response order by ID.
:param page: Page number.
:param page_size: Maximum number of bindings on the page.
:param organization_id: ID of the organization.
:param srn: Scaleway Resource Number for which to list all bindings.
:param srn: Scaleway Resource Name for which to list all bindings.
:param value_id: Value ID for which to list all bindings.
:return: :class:`list[Binding] <list[Binding]>`

Expand Down Expand Up @@ -682,8 +682,8 @@ def delete_all_bindings_matching_srn(
organization_id: Optional[str] = None,
) -> DeleteAllBindingsMatchingSRNResponse:
"""
Delete ALL bindings associated with a Scaleway Resource Number.
:param srn: Scaleway Resource Number for which all bindings should be deleted.
Delete ALL bindings associated with a Scaleway Resource Name.
:param srn: Scaleway Resource Name for which all bindings should be deleted.
:param organization_id: ID of the organization.
:return: :class:`DeleteAllBindingsMatchingSRNResponse <DeleteAllBindingsMatchingSRNResponse>`

Expand Down
10 changes: 5 additions & 5 deletions scaleway/scaleway/annotations/v1/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ class Binding:

srn: str
"""
Scaleway Resource Number associated to the binding.
Scaleway Resource Name associated to the binding.
"""

key: Optional[BindingKey] = None
Expand Down Expand Up @@ -141,7 +141,7 @@ class Value:
class CreateBindingRequest:
srn: str
"""
Scaleway Resource Number to associate.
Scaleway Resource Name to associate.
"""

value_id: str
Expand Down Expand Up @@ -190,7 +190,7 @@ class CreateValueRequest:
class DeleteAllBindingsMatchingSRNRequest:
srn: str
"""
Scaleway Resource Number for which all bindings should be deleted.
Scaleway Resource Name for which all bindings should be deleted.
"""

organization_id: Optional[str] = None
Expand Down Expand Up @@ -235,7 +235,7 @@ class DeleteAllValuesMatchingKeyRequest:
class DeleteAllValuesMatchingKeyResponse:
total_deleted: int
"""
Total number of bindings deleted.
Total number of values deleted.
"""


Expand Down Expand Up @@ -314,7 +314,7 @@ class ListBindingsRequest:

srn: Optional[str] = None
"""
Scaleway Resource Number for which to list all bindings.
Scaleway Resource Name for which to list all bindings.
"""

value_id: Optional[str] = None
Expand Down
Loading