Skip to content

Commit 456d122

Browse files
authored
docs(account): bump message deprecating account v2 on async lib (#257)
1 parent b08a755 commit 456d122

File tree

2 files changed

+24
-0
lines changed
  • scaleway-async/scaleway_async/account/v2
  • scaleway/scaleway/account/v2

2 files changed

+24
-0
lines changed

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,13 @@ async def create_project(
4141
) -> Project:
4242
"""
4343
Create a new Project for an Organization.
44+
Deprecated in favor of Account API v3.
4445
Generate a new Project for an Organization, specifying its configuration including name and description.
4546
:param name: Name of the Project.
4647
:param organization_id: Organization ID of the Project.
4748
:param description: Description of the Project.
4849
:return: :class:`Project <Project>`
50+
:deprecated
4951
5052
Usage:
5153
::
@@ -81,6 +83,7 @@ async def list_projects(
8183
) -> ListProjectsResponse:
8284
"""
8385
List all Projects of an Organization.
86+
Deprecated in favor of Account API v3.
8487
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.
8588
:param organization_id: Organization ID of the Project.
8689
:param name: Name of the Project.
@@ -89,6 +92,7 @@ async def list_projects(
8992
:param order_by: Sort order of the returned Projects.
9093
:param project_ids: Project IDs to filter for. The results will be limited to any Projects with an ID in this array.
9194
:return: :class:`ListProjectsResponse <ListProjectsResponse>`
95+
:deprecated
9296
9397
Usage:
9498
::
@@ -125,6 +129,7 @@ async def list_projects_all(
125129
) -> List[Project]:
126130
"""
127131
List all Projects of an Organization.
132+
Deprecated in favor of Account API v3.
128133
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.
129134
:param organization_id: Organization ID of the Project.
130135
:param name: Name of the Project.
@@ -133,6 +138,7 @@ async def list_projects_all(
133138
:param order_by: Sort order of the returned Projects.
134139
:param project_ids: Project IDs to filter for. The results will be limited to any Projects with an ID in this array.
135140
:return: :class:`List[ListProjectsResponse] <List[ListProjectsResponse]>`
141+
:deprecated
136142
137143
Usage:
138144
::
@@ -161,9 +167,11 @@ async def get_project(
161167
) -> Project:
162168
"""
163169
Get an existing Project.
170+
Deprecated in favor of Account API v3.
164171
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.
165172
:param project_id: Project ID of the Project.
166173
:return: :class:`Project <Project>`
174+
:deprecated
167175
168176
Usage:
169177
::
@@ -190,8 +198,10 @@ async def delete_project(
190198
) -> Optional[None]:
191199
"""
192200
Delete an existing Project.
201+
Deprecated in favor of Account API v3.
193202
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.
194203
:param project_id: Project ID of the Project.
204+
:deprecated
195205
196206
Usage:
197207
::
@@ -220,11 +230,13 @@ async def update_project(
220230
) -> Project:
221231
"""
222232
Update Project.
233+
Deprecated in favor of Account API v3.
223234
Update the parameters of an existing Project, specified by its Project ID. These parameters include the name and description.
224235
:param project_id: Project ID of the Project.
225236
:param name: Name of the Project.
226237
:param description: Description of the Project.
227238
:return: :class:`Project <Project>`
239+
:deprecated
228240
229241
Usage:
230242
::

scaleway/scaleway/account/v2/api.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,13 @@ def create_project(
4141
) -> Project:
4242
"""
4343
Create a new Project for an Organization.
44+
Deprecated in favor of Account API v3.
4445
Generate a new Project for an Organization, specifying its configuration including name and description.
4546
:param name: Name of the Project.
4647
:param organization_id: Organization ID of the Project.
4748
:param description: Description of the Project.
4849
:return: :class:`Project <Project>`
50+
:deprecated
4951
5052
Usage:
5153
::
@@ -81,6 +83,7 @@ def list_projects(
8183
) -> ListProjectsResponse:
8284
"""
8385
List all Projects of an Organization.
86+
Deprecated in favor of Account API v3.
8487
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.
8588
:param organization_id: Organization ID of the Project.
8689
:param name: Name of the Project.
@@ -89,6 +92,7 @@ def list_projects(
8992
:param order_by: Sort order of the returned Projects.
9093
:param project_ids: Project IDs to filter for. The results will be limited to any Projects with an ID in this array.
9194
:return: :class:`ListProjectsResponse <ListProjectsResponse>`
95+
:deprecated
9296
9397
Usage:
9498
::
@@ -125,6 +129,7 @@ def list_projects_all(
125129
) -> List[Project]:
126130
"""
127131
List all Projects of an Organization.
132+
Deprecated in favor of Account API v3.
128133
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.
129134
:param organization_id: Organization ID of the Project.
130135
:param name: Name of the Project.
@@ -133,6 +138,7 @@ def list_projects_all(
133138
:param order_by: Sort order of the returned Projects.
134139
:param project_ids: Project IDs to filter for. The results will be limited to any Projects with an ID in this array.
135140
:return: :class:`List[ListProjectsResponse] <List[ListProjectsResponse]>`
141+
:deprecated
136142
137143
Usage:
138144
::
@@ -161,9 +167,11 @@ def get_project(
161167
) -> Project:
162168
"""
163169
Get an existing Project.
170+
Deprecated in favor of Account API v3.
164171
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.
165172
:param project_id: Project ID of the Project.
166173
:return: :class:`Project <Project>`
174+
:deprecated
167175
168176
Usage:
169177
::
@@ -190,8 +198,10 @@ def delete_project(
190198
) -> Optional[None]:
191199
"""
192200
Delete an existing Project.
201+
Deprecated in favor of Account API v3.
193202
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.
194203
:param project_id: Project ID of the Project.
204+
:deprecated
195205
196206
Usage:
197207
::
@@ -220,11 +230,13 @@ def update_project(
220230
) -> Project:
221231
"""
222232
Update Project.
233+
Deprecated in favor of Account API v3.
223234
Update the parameters of an existing Project, specified by its Project ID. These parameters include the name and description.
224235
:param project_id: Project ID of the Project.
225236
:param name: Name of the Project.
226237
:param description: Description of the Project.
227238
:return: :class:`Project <Project>`
239+
:deprecated
228240
229241
Usage:
230242
::

0 commit comments

Comments
 (0)