Skip to content

Commit 494064a

Browse files
authored
Revert "feat(secret-manager): add endpoints for using name to retrieve secrets" (#58)
1 parent 5dfa973 commit 494064a

File tree

4 files changed

+46
-210
lines changed

4 files changed

+46
-210
lines changed

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

Lines changed: 18 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@
88
Region,
99
)
1010
from scaleway_core.utils import (
11-
OneOfPossibility,
1211
fetch_all_pages_async,
13-
resolve_one_of,
1412
validate_path_param,
1513
)
1614
from .types import (
@@ -95,23 +93,19 @@ async def create_secret(
9593
async def get_secret(
9694
self,
9795
*,
96+
secret_id: str,
9897
region: Optional[Region] = None,
99-
secret_id: Optional[str] = None,
100-
secret_name: Optional[str] = None,
10198
) -> Secret:
10299
"""
103100
Get metadata of a Secret
104101
:param region: Region to target. If none is passed will use default region from the config
105102
:param secret_id: ID of the Secret
106-
:param secret_name: Name of the Secret (alternative to secret_id).
107-
108-
One-of ('secret_ref'): at most one of 'secret_name' could be set.
109103
:return: :class:`Secret <Secret>`
110104
111105
Usage:
112106
::
113107
114-
result = await api.get_secret()
108+
result = await api.get_secret(secret_id="example")
115109
"""
116110

117111
param_region = validate_path_param(
@@ -122,13 +116,6 @@ async def get_secret(
122116
res = self._request(
123117
"GET",
124118
f"/secret-manager/v1alpha1/regions/{param_region}/secrets/{param_secret_id}",
125-
params={
126-
**resolve_one_of(
127-
[
128-
OneOfPossibility("secret_name", secret_name),
129-
]
130-
),
131-
},
132119
)
133120

134121
self._throw_on_error(res)
@@ -188,7 +175,6 @@ async def list_secrets(
188175
organization_id: Optional[str] = None,
189176
project_id: Optional[str] = None,
190177
tags: Optional[List[str]] = None,
191-
name: Optional[str] = None,
192178
order_by: ListSecretsRequestOrderBy = ListSecretsRequestOrderBy.NAME_ASC,
193179
page: Optional[int] = None,
194180
page_size: Optional[int] = None,
@@ -199,7 +185,6 @@ async def list_secrets(
199185
:param organization_id: ID of an organization to filter on (optional)
200186
:param project_id: ID of a project to filter on (optional)
201187
:param tags: List of tags to filter on (optional)
202-
:param name: Name of the secrets (optional)
203188
:param order_by:
204189
:param page:
205190
:param page_size:
@@ -219,7 +204,6 @@ async def list_secrets(
219204
"GET",
220205
f"/secret-manager/v1alpha1/regions/{param_region}/secrets",
221206
params={
222-
"name": name,
223207
"order_by": order_by,
224208
"organization_id": organization_id
225209
or self.client.default_organization_id,
@@ -240,7 +224,6 @@ async def list_secrets_all(
240224
organization_id: Optional[str] = None,
241225
project_id: Optional[str] = None,
242226
tags: Optional[List[str]] = None,
243-
name: Optional[str] = None,
244227
order_by: Optional[ListSecretsRequestOrderBy] = None,
245228
page: Optional[int] = None,
246229
page_size: Optional[int] = None,
@@ -251,7 +234,6 @@ async def list_secrets_all(
251234
:param organization_id: ID of an organization to filter on (optional)
252235
:param project_id: ID of a project to filter on (optional)
253236
:param tags: List of tags to filter on (optional)
254-
:param name: Name of the secrets (optional)
255237
:param order_by:
256238
:param page:
257239
:param page_size:
@@ -272,7 +254,6 @@ async def list_secrets_all(
272254
"organization_id": organization_id,
273255
"project_id": project_id,
274256
"tags": tags,
275-
"name": name,
276257
"order_by": order_by,
277258
"page": page,
278259
"page_size": page_size,
@@ -359,25 +340,24 @@ async def create_secret_version(
359340
async def get_secret_version(
360341
self,
361342
*,
343+
secret_id: str,
362344
revision: str,
363345
region: Optional[Region] = None,
364-
secret_id: Optional[str] = None,
365-
secret_name: Optional[str] = None,
366346
) -> SecretVersion:
367347
"""
368348
Get metadata of a SecretVersion
369349
:param region: Region to target. If none is passed will use default region from the config
370350
:param secret_id: ID of the Secret
371351
:param revision: Revision of the SecretVersion (may be a number or "latest")
372-
:param secret_name: Name of the Secret (alternative to secret_id).
373-
374-
One-of ('secret_ref'): at most one of 'secret_name' could be set.
375352
:return: :class:`SecretVersion <SecretVersion>`
376353
377354
Usage:
378355
::
379356
380-
result = await api.get_secret_version(revision="example")
357+
result = await api.get_secret_version(
358+
secret_id="example",
359+
revision="example",
360+
)
381361
"""
382362

383363
param_region = validate_path_param(
@@ -389,13 +369,6 @@ async def get_secret_version(
389369
res = self._request(
390370
"GET",
391371
f"/secret-manager/v1alpha1/regions/{param_region}/secrets/{param_secret_id}/versions/{param_revision}",
392-
params={
393-
**resolve_one_of(
394-
[
395-
OneOfPossibility("secret_name", secret_name),
396-
]
397-
),
398-
},
399372
)
400373

401374
self._throw_on_error(res)
@@ -452,9 +425,8 @@ async def update_secret_version(
452425
async def list_secret_versions(
453426
self,
454427
*,
428+
secret_id: str,
455429
region: Optional[Region] = None,
456-
secret_id: Optional[str] = None,
457-
secret_name: Optional[str] = None,
458430
page: Optional[int] = None,
459431
page_size: Optional[int] = None,
460432
status: Optional[List[SecretVersionStatus]] = None,
@@ -463,9 +435,6 @@ async def list_secret_versions(
463435
List versions of a secret, not returning any sensitive data
464436
:param region: Region to target. If none is passed will use default region from the config
465437
:param secret_id: ID of the Secret
466-
:param secret_name: Name of the Secret (alternative to secret_id).
467-
468-
One-of ('secret_ref'): at most one of 'secret_name' could be set.
469438
:param page:
470439
:param page_size:
471440
:param status: Filter results by status
@@ -474,7 +443,7 @@ async def list_secret_versions(
474443
Usage:
475444
::
476445
477-
result = await api.list_secret_versions()
446+
result = await api.list_secret_versions(secret_id="example")
478447
"""
479448

480449
param_region = validate_path_param(
@@ -489,11 +458,6 @@ async def list_secret_versions(
489458
"page": page,
490459
"page_size": page_size or self.client.default_page_size,
491460
"status": status,
492-
**resolve_one_of(
493-
[
494-
OneOfPossibility("secret_name", secret_name),
495-
]
496-
),
497461
},
498462
)
499463

@@ -503,9 +467,8 @@ async def list_secret_versions(
503467
async def list_secret_versions_all(
504468
self,
505469
*,
470+
secret_id: str,
506471
region: Optional[Region] = None,
507-
secret_id: Optional[str] = None,
508-
secret_name: Optional[str] = None,
509472
page: Optional[int] = None,
510473
page_size: Optional[int] = None,
511474
status: Optional[List[SecretVersionStatus]] = None,
@@ -514,9 +477,6 @@ async def list_secret_versions_all(
514477
List versions of a secret, not returning any sensitive data
515478
:param region: Region to target. If none is passed will use default region from the config
516479
:param secret_id: ID of the Secret
517-
:param secret_name: Name of the Secret (alternative to secret_id).
518-
519-
One-of ('secret_ref'): at most one of 'secret_name' could be set.
520480
:param page:
521481
:param page_size:
522482
:param status: Filter results by status
@@ -525,17 +485,16 @@ async def list_secret_versions_all(
525485
Usage:
526486
::
527487
528-
result = await api.list_secret_versions_all()
488+
result = await api.list_secret_versions_all(secret_id="example")
529489
"""
530490

531491
return await fetch_all_pages_async(
532492
type=ListSecretVersionsResponse,
533493
key="versions",
534494
fetcher=self.list_secret_versions,
535495
args={
536-
"region": region,
537496
"secret_id": secret_id,
538-
"secret_name": secret_name,
497+
"region": region,
539498
"page": page,
540499
"page_size": page_size,
541500
"status": status,
@@ -656,25 +615,24 @@ async def disable_secret_version(
656615
async def access_secret_version(
657616
self,
658617
*,
618+
secret_id: str,
659619
revision: str,
660620
region: Optional[Region] = None,
661-
secret_id: Optional[str] = None,
662-
secret_name: Optional[str] = None,
663621
) -> AccessSecretVersionResponse:
664622
"""
665623
Access a SecretVersion, returning the sensitive data
666624
:param region: Region to target. If none is passed will use default region from the config
667625
:param secret_id: ID of the Secret
668-
:param revision: Revision of the SecretVersion (may be a number, "latest" or "latest_enabled")
669-
:param secret_name: Name of the Secret (alternative to secret_id).
670-
671-
One-of ('secret_ref'): at most one of 'secret_name' could be set.
626+
:param revision: Revision of the SecretVersion (may be a number or "latest")
672627
:return: :class:`AccessSecretVersionResponse <AccessSecretVersionResponse>`
673628
674629
Usage:
675630
::
676631
677-
result = await api.access_secret_version(revision="example")
632+
result = await api.access_secret_version(
633+
secret_id="example",
634+
revision="example",
635+
)
678636
"""
679637

680638
param_region = validate_path_param(
@@ -686,13 +644,6 @@ async def access_secret_version(
686644
res = self._request(
687645
"GET",
688646
f"/secret-manager/v1alpha1/regions/{param_region}/secrets/{param_secret_id}/versions/{param_revision}/access",
689-
params={
690-
**resolve_one_of(
691-
[
692-
OneOfPossibility("secret_name", secret_name),
693-
]
694-
),
695-
},
696647
)
697648

698649
self._throw_on_error(res)

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

Lines changed: 5 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -233,18 +233,11 @@ class GetSecretRequest:
233233
Region to target. If none is passed will use default region from the config
234234
"""
235235

236-
secret_id: Optional[str]
236+
secret_id: str
237237
"""
238238
ID of the Secret
239239
"""
240240

241-
secret_name: Optional[str]
242-
"""
243-
Name of the Secret (alternative to secret_id).
244-
245-
One-of ('secret_ref'): at most one of 'secret_name' could be set.
246-
"""
247-
248241

249242
@dataclass
250243
class UpdateSecretRequest:
@@ -296,11 +289,6 @@ class ListSecretsRequest:
296289
List of tags to filter on (optional)
297290
"""
298291

299-
name: Optional[str]
300-
"""
301-
Name of the secrets (optional)
302-
"""
303-
304292
order_by: Optional[ListSecretsRequestOrderBy]
305293

306294
page: Optional[int]
@@ -351,7 +339,7 @@ class GetSecretVersionRequest:
351339
Region to target. If none is passed will use default region from the config
352340
"""
353341

354-
secret_id: Optional[str]
342+
secret_id: str
355343
"""
356344
ID of the Secret
357345
"""
@@ -361,13 +349,6 @@ class GetSecretVersionRequest:
361349
Revision of the SecretVersion (may be a number or "latest")
362350
"""
363351

364-
secret_name: Optional[str]
365-
"""
366-
Name of the Secret (alternative to secret_id).
367-
368-
One-of ('secret_ref'): at most one of 'secret_name' could be set.
369-
"""
370-
371352

372353
@dataclass
373354
class UpdateSecretVersionRequest:
@@ -399,18 +380,11 @@ class ListSecretVersionsRequest:
399380
Region to target. If none is passed will use default region from the config
400381
"""
401382

402-
secret_id: Optional[str]
383+
secret_id: str
403384
"""
404385
ID of the Secret
405386
"""
406387

407-
secret_name: Optional[str]
408-
"""
409-
Name of the Secret (alternative to secret_id).
410-
411-
One-of ('secret_ref'): at most one of 'secret_name' could be set.
412-
"""
413-
414388
page: Optional[int]
415389

416390
page_size: Optional[int]
@@ -482,19 +456,12 @@ class AccessSecretVersionRequest:
482456
Region to target. If none is passed will use default region from the config
483457
"""
484458

485-
secret_id: Optional[str]
459+
secret_id: str
486460
"""
487461
ID of the Secret
488462
"""
489463

490464
revision: str
491465
"""
492-
Revision of the SecretVersion (may be a number, "latest" or "latest_enabled")
493-
"""
494-
495-
secret_name: Optional[str]
496-
"""
497-
Name of the Secret (alternative to secret_id).
498-
499-
One-of ('secret_ref'): at most one of 'secret_name' could be set.
466+
Revision of the SecretVersion (may be a number or "latest")
500467
"""

0 commit comments

Comments
 (0)