feat(secret): retrieve secrets by name (#447)

Author: scaleway-bot

packages/clients/src/api/secret/v1alpha1/api.gen.ts

@@ -3,6 +3,7 @@
 import {
   API as ParentAPI,
   enrichForPagination,
+  resolveOneOf,
   urlParams,
   validatePathParam,
 } from '../../../bridge'
@@ -80,14 +81,24 @@ export class API extends ParentAPI {
    * @param request - The request {@link GetSecretRequest}
    * @returns A Promise of Secret
    */
-  getSecret = (request: Readonly<GetSecretRequest>) =>
+  getSecret = (request: Readonly<GetSecretRequest> = {}) =>
     this.client.fetch<Secret>(
       {
         method: 'GET',
         path: `/secret-manager/v1alpha1/regions/${validatePathParam(
           'region',
           request.region ?? this.client.settings.defaultRegion,
         )}/secrets/${validatePathParam('secretId', request.secretId)}`,
+        urlParams: urlParams(
+          ...Object.entries(
+            resolveOneOf([
+              {
+                param: 'secret_name',
+                value: request.secretName,
+              },
+            ]),
+          ),
+        ),
       },
       unmarshalSecret,
     )
@@ -123,6 +134,7 @@ export class API extends ParentAPI {
           request.region ?? this.client.settings.defaultRegion,
         )}/secrets`,
         urlParams: urlParams(
+          ['name', request.name],
           ['order_by', request.orderBy ?? 'name_asc'],
           [
             'organization_id',
@@ -206,6 +218,16 @@ export class API extends ParentAPI {
           'secretId',
           request.secretId,
         )}/versions/${validatePathParam('revision', request.revision)}`,
+        urlParams: urlParams(
+          ...Object.entries(
+            resolveOneOf([
+              {
+                param: 'secret_name',
+                value: request.secretName,
+              },
+            ]),
+          ),
+        ),
       },
       unmarshalSecretVersion,
     )
@@ -236,7 +258,7 @@ export class API extends ParentAPI {
     )
 
   protected pageOfListSecretVersions = (
-    request: Readonly<ListSecretVersionsRequest>,
+    request: Readonly<ListSecretVersionsRequest> = {},
   ) =>
     this.client.fetch<ListSecretVersionsResponse>(
       {
@@ -252,6 +274,14 @@ export class API extends ParentAPI {
             request.pageSize ?? this.client.settings.defaultPageSize,
           ],
           ['status', request.status],
+          ...Object.entries(
+            resolveOneOf([
+              {
+                param: 'secret_name',
+                value: request.secretName,
+              },
+            ]),
+          ),
         ),
       },
       unmarshalListSecretVersionsResponse,
@@ -263,7 +293,7 @@ export class API extends ParentAPI {
    * @param request - The request {@link ListSecretVersionsRequest}
    * @returns A Promise of ListSecretVersionsResponse
    */
-  listSecretVersions = (request: Readonly<ListSecretVersionsRequest>) =>
+  listSecretVersions = (request: Readonly<ListSecretVersionsRequest> = {}) =>
     enrichForPagination('versions', this.pageOfListSecretVersions, request)
 
   /**
@@ -352,6 +382,16 @@ export class API extends ParentAPI {
           'secretId',
           request.secretId,
         )}/versions/${validatePathParam('revision', request.revision)}/access`,
+        urlParams: urlParams(
+          ...Object.entries(
+            resolveOneOf([
+              {
+                param: 'secret_name',
+                value: request.secretName,
+              },
+            ]),
+          ),
+        ),
       },
       unmarshalAccessSecretVersionResponse,
     )

packages/clients/src/api/secret/v1alpha1/types.gen.ts

@@ -106,7 +106,13 @@ export type GetSecretRequest = {
   /** Region to target. If none is passed will use default region from the config */
   region?: Region
   /** ID of the Secret */
-  secretId: string
+  secretId?: string
+  /**
+   * Name of the Secret (alternative to secret_id).
+   *
+   * One-of ('secretRef'): at most one of 'secretName' could be set.
+   */
+  secretName?: string
 }
 
 export type UpdateSecretRequest = {
@@ -131,6 +137,8 @@ export type ListSecretsRequest = {
   projectId?: string
   /** List of tags to filter on (optional) */
   tags?: string[]
+  /** Name of the secrets (optional) */
+  name?: string
   orderBy?: ListSecretsRequestOrderBy
   page?: number
   pageSize?: number
@@ -158,9 +166,15 @@ export type GetSecretVersionRequest = {
   /** Region to target. If none is passed will use default region from the config */
   region?: Region
   /** ID of the Secret */
-  secretId: string
+  secretId?: string
   /** Revision of the SecretVersion (may be a number or "latest") */
   revision: string
+  /**
+   * Name of the Secret (alternative to secret_id).
+   *
+   * One-of ('secretRef'): at most one of 'secretName' could be set.
+   */
+  secretName?: string
 }
 
 export type UpdateSecretVersionRequest = {
@@ -178,7 +192,13 @@ export type ListSecretVersionsRequest = {
   /** Region to target. If none is passed will use default region from the config */
   region?: Region
   /** ID of the Secret */
-  secretId: string
+  secretId?: string
+  /**
+   * Name of the Secret (alternative to secret_id).
+   *
+   * One-of ('secretRef'): at most one of 'secretName' could be set.
+   */
+  secretName?: string
   page?: number
   pageSize?: number
   /** Filter results by status */
@@ -216,7 +236,16 @@ export type AccessSecretVersionRequest = {
   /** Region to target. If none is passed will use default region from the config */
   region?: Region
   /** ID of the Secret */
-  secretId: string
-  /** Revision of the SecretVersion (may be a number or "latest") */
+  secretId?: string
+  /**
+   * Revision of the SecretVersion (may be a number, "latest" or
+   * "latest_enabled")
+   */
   revision: string
+  /**
+   * Name of the Secret (alternative to secret_id).
+   *
+   * One-of ('secretRef'): at most one of 'secretName' could be set.
+   */
+  secretName?: string
 }