Skip to content

Commit ba70b74

Browse files
authored
docs(account): reworked account api doc (#88)
1 parent 4719d56 commit ba70b74

File tree

4 files changed

+96
-96
lines changed

4 files changed

+96
-96
lines changed

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

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ async def create_project(
3838
description: Optional[str] = None,
3939
) -> Project:
4040
"""
41-
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.
41+
Generate a new Project for an Organization, specifying its configuration including name and description.
42+
:param name: Name of the Project.
43+
:param organization_id: Organization ID of the Project.
44+
:param description: Description of the Project.
4545
:return: :class:`Project <Project>`
4646
4747
Usage:
@@ -77,13 +77,13 @@ async def list_projects(
7777
project_ids: Optional[List[str]] = None,
7878
) -> ListProjectsResponse:
7979
"""
80-
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.
80+
List all Projects of an Organization. The response will include the total number of Projects as well as their associated Organizations, names and IDs. Other information include the creation and update date of the Project.
81+
:param organization_id: Organization ID of the Project.
82+
:param name: Name of the Project.
83+
:param page: Page number for the returned Projects.
84+
:param page_size: Maximum number of Project per page.
85+
:param order_by: Sort order of the returned Projects.
86+
:param project_ids: Project IDs to filter for. The results will be limited to any Projects with an ID in this array.
8787
:return: :class:`ListProjectsResponse <ListProjectsResponse>`
8888
8989
Usage:
@@ -120,13 +120,13 @@ async def list_projects_all(
120120
project_ids: Optional[List[str]] = None,
121121
) -> List[Project]:
122122
"""
123-
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.
123+
List all Projects of an Organization. The response will include the total number of Projects as well as their associated Organizations, names and IDs. Other information include the creation and update date of the Project.
124+
:param organization_id: Organization ID of the Project.
125+
:param name: Name of the Project.
126+
:param page: Page number for the returned Projects.
127+
:param page_size: Maximum number of Project per page.
128+
:param order_by: Sort order of the returned Projects.
129+
:param project_ids: Project IDs to filter for. The results will be limited to any Projects with an ID in this array.
130130
:return: :class:`List[ListProjectsResponse] <List[ListProjectsResponse]>`
131131
132132
Usage:
@@ -155,8 +155,8 @@ async def get_project(
155155
project_id: Optional[str] = None,
156156
) -> Project:
157157
"""
158-
Get project
159-
:param project_id: The project ID of the project.
158+
Retrieve information about an existing Project, specified by its Project ID. Its full details, including ID, name and description, are returned in the response object.
159+
:param project_id: Project ID of the Project.
160160
:return: :class:`Project <Project>`
161161
162162
Usage:
@@ -183,8 +183,8 @@ async def delete_project(
183183
project_id: Optional[str] = None,
184184
) -> Optional[None]:
185185
"""
186-
Delete project
187-
:param project_id: The project ID of the project.
186+
Delete an existing Project, specified by its Project ID. The Project needs to be empty (meaning there are no resources left in it) to be deleted effectively. Note that deleting a Project is permanent, and cannot be undone.
187+
:param project_id: Project ID of the Project.
188188
189189
Usage:
190190
::
@@ -212,10 +212,10 @@ async def update_project(
212212
description: Optional[str] = None,
213213
) -> Project:
214214
"""
215-
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.
215+
Update the parameters of an existing Project, specified by its Project ID. These parameters include the name and description.
216+
:param project_id: Project ID of the Project.
217+
:param name: Name of the Project.
218+
:param description: Description of the Project.
219219
:return: :class:`Project <Project>`
220220
221221
Usage:

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

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,12 @@ class ListProjectsResponse:
2626

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

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

3737

@@ -43,115 +43,115 @@ class Project:
4343

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

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

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

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

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

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

7474

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

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

8787
description: Optional[str]
8888
"""
89-
The description of the project.
89+
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+
Organization ID of the Project.
9898
"""
9999

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

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

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

115115
order_by: Optional[ListProjectsRequestOrderBy]
116116
"""
117-
The sort order of the returned projects.
117+
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+
Project IDs to filter for. The results will be limited to any Projects with an ID in this array.
123123
"""
124124

125125

126126
@dataclass
127127
class GetProjectRequest:
128128
project_id: Optional[str]
129129
"""
130-
The project ID of the project.
130+
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+
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+
Project ID of the Project.
147147
"""
148148

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

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

scaleway/scaleway/account/v2/api.py

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ def create_project(
3838
description: Optional[str] = None,
3939
) -> Project:
4040
"""
41-
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.
41+
Generate a new Project for an Organization, specifying its configuration including name and description.
42+
:param name: Name of the Project.
43+
:param organization_id: Organization ID of the Project.
44+
:param description: Description of the Project.
4545
:return: :class:`Project <Project>`
4646
4747
Usage:
@@ -77,13 +77,13 @@ def list_projects(
7777
project_ids: Optional[List[str]] = None,
7878
) -> ListProjectsResponse:
7979
"""
80-
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.
80+
List all Projects of an Organization. The response will include the total number of Projects as well as their associated Organizations, names and IDs. Other information include the creation and update date of the Project.
81+
:param organization_id: Organization ID of the Project.
82+
:param name: Name of the Project.
83+
:param page: Page number for the returned Projects.
84+
:param page_size: Maximum number of Project per page.
85+
:param order_by: Sort order of the returned Projects.
86+
:param project_ids: Project IDs to filter for. The results will be limited to any Projects with an ID in this array.
8787
:return: :class:`ListProjectsResponse <ListProjectsResponse>`
8888
8989
Usage:
@@ -120,13 +120,13 @@ def list_projects_all(
120120
project_ids: Optional[List[str]] = None,
121121
) -> List[Project]:
122122
"""
123-
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.
123+
List all Projects of an Organization. The response will include the total number of Projects as well as their associated Organizations, names and IDs. Other information include the creation and update date of the Project.
124+
:param organization_id: Organization ID of the Project.
125+
:param name: Name of the Project.
126+
:param page: Page number for the returned Projects.
127+
:param page_size: Maximum number of Project per page.
128+
:param order_by: Sort order of the returned Projects.
129+
:param project_ids: Project IDs to filter for. The results will be limited to any Projects with an ID in this array.
130130
:return: :class:`List[ListProjectsResponse] <List[ListProjectsResponse]>`
131131
132132
Usage:
@@ -155,8 +155,8 @@ def get_project(
155155
project_id: Optional[str] = None,
156156
) -> Project:
157157
"""
158-
Get project
159-
:param project_id: The project ID of the project.
158+
Retrieve information about an existing Project, specified by its Project ID. Its full details, including ID, name and description, are returned in the response object.
159+
:param project_id: Project ID of the Project.
160160
:return: :class:`Project <Project>`
161161
162162
Usage:
@@ -183,8 +183,8 @@ def delete_project(
183183
project_id: Optional[str] = None,
184184
) -> Optional[None]:
185185
"""
186-
Delete project
187-
:param project_id: The project ID of the project.
186+
Delete an existing Project, specified by its Project ID. The Project needs to be empty (meaning there are no resources left in it) to be deleted effectively. Note that deleting a Project is permanent, and cannot be undone.
187+
:param project_id: Project ID of the Project.
188188
189189
Usage:
190190
::
@@ -212,10 +212,10 @@ def update_project(
212212
description: Optional[str] = None,
213213
) -> Project:
214214
"""
215-
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.
215+
Update the parameters of an existing Project, specified by its Project ID. These parameters include the name and description.
216+
:param project_id: Project ID of the Project.
217+
:param name: Name of the Project.
218+
:param description: Description of the Project.
219219
:return: :class:`Project <Project>`
220220
221221
Usage:

0 commit comments

Comments
 (0)