Skip to content

Commit ed9be69

Browse files
authored
chore(tem): document ListDomainsRequest fields (#504)
1 parent dbc41ed commit ed9be69

File tree

4 files changed

+46
-22
lines changed

4 files changed

+46
-22
lines changed

scaleway-async/scaleway_async/tem/v1alpha1/api.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -557,11 +557,11 @@ async def list_domains(
557557
Retrieve domains in a specific Project or in a specific Organization using the `region` parameter.
558558
:param region: Region to target. If none is passed will use default region from the config.
559559
:param page: Requested page number. Value must be greater or equal to 1.
560-
:param page_size: Page size.
561-
:param project_id:
562-
:param status:
563-
:param organization_id:
564-
:param name:
560+
:param page_size: Requested page size. Value must be between 1 and 1000.
561+
:param project_id: (Optional) ID of the Project in which to list the domains.
562+
:param status: (Optional) List domains under specific statuses.
563+
:param organization_id: (Optional) ID of the Organization in which to list the domains.
564+
:param name: (Optional) Names of the domains to list.
565565
:return: :class:`ListDomainsResponse <ListDomainsResponse>`
566566
567567
Usage:
@@ -607,11 +607,11 @@ async def list_domains_all(
607607
Retrieve domains in a specific Project or in a specific Organization using the `region` parameter.
608608
:param region: Region to target. If none is passed will use default region from the config.
609609
:param page: Requested page number. Value must be greater or equal to 1.
610-
:param page_size: Page size.
611-
:param project_id:
612-
:param status:
613-
:param organization_id:
614-
:param name:
610+
:param page_size: Requested page size. Value must be between 1 and 1000.
611+
:param project_id: (Optional) ID of the Project in which to list the domains.
612+
:param status: (Optional) List domains under specific statuses.
613+
:param organization_id: (Optional) ID of the Organization in which to list the domains.
614+
:param name: (Optional) Names of the domains to list.
615615
:return: :class:`List[Domain] <List[Domain]>`
616616
617617
Usage:

scaleway-async/scaleway_async/tem/v1alpha1/types.py

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -679,16 +679,28 @@ class ListDomainsRequest:
679679

680680
page_size: Optional[int]
681681
"""
682-
Page size.
682+
Requested page size. Value must be between 1 and 1000.
683683
"""
684684

685685
project_id: Optional[str]
686+
"""
687+
(Optional) ID of the Project in which to list the domains.
688+
"""
686689

687690
status: Optional[List[DomainStatus]]
691+
"""
692+
(Optional) List domains under specific statuses.
693+
"""
688694

689695
organization_id: Optional[str]
696+
"""
697+
(Optional) ID of the Organization in which to list the domains.
698+
"""
690699

691700
name: Optional[str]
701+
"""
702+
(Optional) Names of the domains to list.
703+
"""
692704

693705

694706
@dataclass

scaleway/scaleway/tem/v1alpha1/api.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -557,11 +557,11 @@ def list_domains(
557557
Retrieve domains in a specific Project or in a specific Organization using the `region` parameter.
558558
:param region: Region to target. If none is passed will use default region from the config.
559559
:param page: Requested page number. Value must be greater or equal to 1.
560-
:param page_size: Page size.
561-
:param project_id:
562-
:param status:
563-
:param organization_id:
564-
:param name:
560+
:param page_size: Requested page size. Value must be between 1 and 1000.
561+
:param project_id: (Optional) ID of the Project in which to list the domains.
562+
:param status: (Optional) List domains under specific statuses.
563+
:param organization_id: (Optional) ID of the Organization in which to list the domains.
564+
:param name: (Optional) Names of the domains to list.
565565
:return: :class:`ListDomainsResponse <ListDomainsResponse>`
566566
567567
Usage:
@@ -607,11 +607,11 @@ def list_domains_all(
607607
Retrieve domains in a specific Project or in a specific Organization using the `region` parameter.
608608
:param region: Region to target. If none is passed will use default region from the config.
609609
:param page: Requested page number. Value must be greater or equal to 1.
610-
:param page_size: Page size.
611-
:param project_id:
612-
:param status:
613-
:param organization_id:
614-
:param name:
610+
:param page_size: Requested page size. Value must be between 1 and 1000.
611+
:param project_id: (Optional) ID of the Project in which to list the domains.
612+
:param status: (Optional) List domains under specific statuses.
613+
:param organization_id: (Optional) ID of the Organization in which to list the domains.
614+
:param name: (Optional) Names of the domains to list.
615615
:return: :class:`List[Domain] <List[Domain]>`
616616
617617
Usage:

scaleway/scaleway/tem/v1alpha1/types.py

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -679,16 +679,28 @@ class ListDomainsRequest:
679679

680680
page_size: Optional[int]
681681
"""
682-
Page size.
682+
Requested page size. Value must be between 1 and 1000.
683683
"""
684684

685685
project_id: Optional[str]
686+
"""
687+
(Optional) ID of the Project in which to list the domains.
688+
"""
686689

687690
status: Optional[List[DomainStatus]]
691+
"""
692+
(Optional) List domains under specific statuses.
693+
"""
688694

689695
organization_id: Optional[str]
696+
"""
697+
(Optional) ID of the Organization in which to list the domains.
698+
"""
690699

691700
name: Optional[str]
701+
"""
702+
(Optional) Names of the domains to list.
703+
"""
692704

693705

694706
@dataclass

0 commit comments

Comments
 (0)