From 2ab316ac7cf52e32f5ac972d0ef9150853931c80 Mon Sep 17 00:00:00 2001 From: Ilya Katlinski Date: Sun, 10 Sep 2023 07:43:48 +0200 Subject: [PATCH] doc: generate api reports for vault plugins Signed-off-by: Ilya Katlinski --- plugins/vault-backend/api-report.md | 8 ++++++-- plugins/vault/api-report.md | 4 +++- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/plugins/vault-backend/api-report.md b/plugins/vault-backend/api-report.md index 47275693ec..ebf9057b98 100644 --- a/plugins/vault-backend/api-report.md +++ b/plugins/vault-backend/api-report.md @@ -27,7 +27,9 @@ export interface VaultApi { getFrontendSecretsUrl(): string; listSecrets( secretPath: string, - secretMount?: string | undefined, + options?: { + secretEngine?: string; + }, ): Promise; renewToken?(): Promise; } @@ -54,7 +56,9 @@ export class VaultClient implements VaultApi { // (undocumented) listSecrets( secretPath: string, - secretEngine?: string | undefined, + options?: { + secretEngine?: string; + }, ): Promise; // (undocumented) renewToken(): Promise; diff --git a/plugins/vault/api-report.md b/plugins/vault/api-report.md index 8afa6285f4..da13e2092d 100644 --- a/plugins/vault/api-report.md +++ b/plugins/vault/api-report.md @@ -23,7 +23,9 @@ export const VAULT_SECRET_PATH_ANNOTATION = 'vault.io/secrets-path'; export interface VaultApi { listSecrets( secretPath: string, - secretMount?: string | undefined, + options?: { + secretEngine?: string; + }, ): Promise; }