Skip to content

Commit 9437de8

Browse files
scaleway-botscaleway-bot
authored
docs(account_v3): update documentation (#78)
1 parent 7f75fbf commit 9437de8

File tree

4 files changed

+88
-88
lines changed

4 files changed

+88
-88
lines changed

‎scaleway-async/scaleway_async/account/v2/api.py‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@ async def create_project(
3939
) -> Project:
4040
"""
4141
Create project
42-
:param name: The name of the project
43-
:param organization_id: The organization ID of the project
44-
:param description: The description of the project
42+
:param name: The name of the project.
43+
:param organization_id: The organization ID of the project.
44+
:param description: The description of the project.
4545
:return: :class:`Project <Project>`
4646
4747
Usage:
@@ -78,12 +78,12 @@ async def list_projects(
7878
) -> ListProjectsResponse:
7979
"""
8080
List projects
81-
:param organization_id: The organization ID of the project
82-
:param name: The name of the project
83-
:param page: The page number for the returned projects
84-
:param page_size: The maximum number of project per page
85-
:param order_by: The sort order of the returned projects
86-
:param project_ids: Filter out by a list of project ID
81+
:param organization_id: The organization ID of the project.
82+
:param name: The name of the project.
83+
:param page: The page number for the returned projects.
84+
:param page_size: The maximum number of project per page.
85+
:param order_by: The sort order of the returned projects.
86+
:param project_ids: Filter out by a list of project ID.
8787
:return: :class:`ListProjectsResponse <ListProjectsResponse>`
8888
8989
Usage:
@@ -121,12 +121,12 @@ async def list_projects_all(
121121
) -> List[Project]:
122122
"""
123123
List projects
124-
:param organization_id: The organization ID of the project
125-
:param name: The name of the project
126-
:param page: The page number for the returned projects
127-
:param page_size: The maximum number of project per page
128-
:param order_by: The sort order of the returned projects
129-
:param project_ids: Filter out by a list of project ID
124+
:param organization_id: The organization ID of the project.
125+
:param name: The name of the project.
126+
:param page: The page number for the returned projects.
127+
:param page_size: The maximum number of project per page.
128+
:param order_by: The sort order of the returned projects.
129+
:param project_ids: Filter out by a list of project ID.
130130
:return: :class:`List[ListProjectsResponse] <List[ListProjectsResponse]>`
131131
132132
Usage:
@@ -156,7 +156,7 @@ async def get_project(
156156
) -> Project:
157157
"""
158158
Get project
159-
:param project_id: The project ID of the project
159+
:param project_id: The project ID of the project.
160160
:return: :class:`Project <Project>`
161161
162162
Usage:
@@ -184,7 +184,7 @@ async def delete_project(
184184
) -> Optional[None]:
185185
"""
186186
Delete project
187-
:param project_id: The project ID of the project
187+
:param project_id: The project ID of the project.
188188
189189
Usage:
190190
::
@@ -213,9 +213,9 @@ async def update_project(
213213
) -> Project:
214214
"""
215215
Update project
216-
:param project_id: The project ID of the project
217-
:param name: The name of the project
218-
:param description: The description of the project
216+
:param project_id: The project ID of the project.
217+
:param name: The name of the project.
218+
:param description: The description of the project.
219219
:return: :class:`Project <Project>`
220220
221221
Usage:

‎scaleway-async/scaleway_async/account/v2/types.py‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -21,137 +21,137 @@ def __str__(self) -> str:
2121
@dataclass
2222
class ListProjectsResponse:
2323
"""
24-
List projects response
24+
List projects response.
2525
"""
2626

2727
total_count: int
2828
"""
29-
The total number of projects
29+
The total number of projects.
3030
"""
3131

3232
projects: List[Project]
3333
"""
34-
The paginated returned projects
34+
The paginated returned projects.
3535
"""
3636

3737

3838
@dataclass
3939
class Project:
4040
"""
41-
Project
41+
Project.
4242
"""
4343

4444
id: str
4545
"""
46-
The ID of the project
46+
The ID of the project.
4747
"""
4848

4949
name: str
5050
"""
51-
The name of the project
51+
The name of the project.
5252
"""
5353

5454
organization_id: str
5555
"""
56-
The organization ID of the project
56+
The organization ID of the project.
5757
"""
5858

5959
created_at: Optional[datetime]
6060
"""
61-
The creation date of the project
61+
The creation date of the project.
6262
"""
6363

6464
updated_at: Optional[datetime]
6565
"""
66-
The update date of the project
66+
The update date of the project.
6767
"""
6868

6969
description: str
7070
"""
71-
The description of the project
71+
The description of the project.
7272
"""
7373

7474

7575
@dataclass
7676
class CreateProjectRequest:
7777
name: str
7878
"""
79-
The name of the project
79+
The name of the project.
8080
"""
8181

8282
organization_id: Optional[str]
8383
"""
84-
The organization ID of the project
84+
The organization ID of the project.
8585
"""
8686

8787
description: Optional[str]
8888
"""
89-
The description of the project
89+
The description of the project.
9090
"""
9191

9292

9393
@dataclass
9494
class ListProjectsRequest:
9595
organization_id: Optional[str]
9696
"""
97-
The organization ID of the project
97+
The organization ID of the project.
9898
"""
9999

100100
name: Optional[str]
101101
"""
102-
The name of the project
102+
The name of the project.
103103
"""
104104

105105
page: Optional[int]
106106
"""
107-
The page number for the returned projects
107+
The page number for the returned projects.
108108
"""
109109

110110
page_size: Optional[int]
111111
"""
112-
The maximum number of project per page
112+
The maximum number of project per page.
113113
"""
114114

115115
order_by: Optional[ListProjectsRequestOrderBy]
116116
"""
117-
The sort order of the returned projects
117+
The sort order of the returned projects.
118118
"""
119119

120120
project_ids: Optional[List[str]]
121121
"""
122-
Filter out by a list of project ID
122+
Filter out by a list of project ID.
123123
"""
124124

125125

126126
@dataclass
127127
class GetProjectRequest:
128128
project_id: Optional[str]
129129
"""
130-
The project ID of the project
130+
The project ID of the project.
131131
"""
132132

133133

134134
@dataclass
135135
class DeleteProjectRequest:
136136
project_id: Optional[str]
137137
"""
138-
The project ID of the project
138+
The project ID of the project.
139139
"""
140140

141141

142142
@dataclass
143143
class UpdateProjectRequest:
144144
project_id: Optional[str]
145145
"""
146-
The project ID of the project
146+
The project ID of the project.
147147
"""
148148

149149
name: Optional[str]
150150
"""
151-
The name of the project
151+
The name of the project.
152152
"""
153153

154154
description: Optional[str]
155155
"""
156-
The description of the project
156+
The description of the project.
157157
"""

‎scaleway/scaleway/account/v2/api.py‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@ def create_project(
3939
) -> Project:
4040
"""
4141
Create project
42-
:param name: The name of the project
43-
:param organization_id: The organization ID of the project
44-
:param description: The description of the project
42+
:param name: The name of the project.
43+
:param organization_id: The organization ID of the project.
44+
:param description: The description of the project.
4545
:return: :class:`Project <Project>`
4646
4747
Usage:
@@ -78,12 +78,12 @@ def list_projects(
7878
) -> ListProjectsResponse:
7979
"""
8080
List projects
81-
:param organization_id: The organization ID of the project
82-
:param name: The name of the project
83-
:param page: The page number for the returned projects
84-
:param page_size: The maximum number of project per page
85-
:param order_by: The sort order of the returned projects
86-
:param project_ids: Filter out by a list of project ID
81+
:param organization_id: The organization ID of the project.
82+
:param name: The name of the project.
83+
:param page: The page number for the returned projects.
84+
:param page_size: The maximum number of project per page.
85+
:param order_by: The sort order of the returned projects.
86+
:param project_ids: Filter out by a list of project ID.
8787
:return: :class:`ListProjectsResponse <ListProjectsResponse>`
8888
8989
Usage:
@@ -121,12 +121,12 @@ def list_projects_all(
121121
) -> List[Project]:
122122
"""
123123
List projects
124-
:param organization_id: The organization ID of the project
125-
:param name: The name of the project
126-
:param page: The page number for the returned projects
127-
:param page_size: The maximum number of project per page
128-
:param order_by: The sort order of the returned projects
129-
:param project_ids: Filter out by a list of project ID
124+
:param organization_id: The organization ID of the project.
125+
:param name: The name of the project.
126+
:param page: The page number for the returned projects.
127+
:param page_size: The maximum number of project per page.
128+
:param order_by: The sort order of the returned projects.
129+
:param project_ids: Filter out by a list of project ID.
130130
:return: :class:`List[ListProjectsResponse] <List[ListProjectsResponse]>`
131131
132132
Usage:
@@ -156,7 +156,7 @@ def get_project(
156156
) -> Project:
157157
"""
158158
Get project
159-
:param project_id: The project ID of the project
159+
:param project_id: The project ID of the project.
160160
:return: :class:`Project <Project>`
161161
162162
Usage:
@@ -184,7 +184,7 @@ def delete_project(
184184
) -> Optional[None]:
185185
"""
186186
Delete project
187-
:param project_id: The project ID of the project
187+
:param project_id: The project ID of the project.
188188
189189
Usage:
190190
::
@@ -213,9 +213,9 @@ def update_project(
213213
) -> Project:
214214
"""
215215
Update project
216-
:param project_id: The project ID of the project
217-
:param name: The name of the project
218-
:param description: The description of the project
216+
:param project_id: The project ID of the project.
217+
:param name: The name of the project.
218+
:param description: The description of the project.
219219
:return: :class:`Project <Project>`
220220
221221
Usage:

0 commit comments

Comments
 (0)