Add api-reports & include plugin into marketplace

Signed-off-by: ivgo <ivgo@spreadgroup.com>
2022-05-19 11:08:24 +02:00
parent 296bfcb1fd
commit 7b0b852fab
4 changed files with 151 additions and 0 deletions
@@ -0,0 +1,11 @@
+---
+title: Vault
+author: Spread Group
+authorUrl: https://github.com/ivangonzalezacuna
+category: Vault
+description: Visualize a list secrets stored in your vault instance.
+documentation: https://github.com/backstage/backstage/tree/master/plugins/vault
+iconUrl: img/vault.png
+npmPackageName: '@backstage/plugin-vault'
+tags:
+  - vault
@@ -0,0 +1,119 @@
+## API Report File for "@backstage/plugin-vault-backend"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+import { Config } from '@backstage/config';
+import { Duration } from 'luxon';
+import express from 'express';
+import { Logger } from 'winston';
+
+// Warning: (ae-missing-release-tag) "createRouter" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function createRouter(options: RouterOptions): Promise<express.Router>;
+
+// Warning: (ae-missing-release-tag) "RenewTokenResponse" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type RenewTokenResponse = {
+  auth: {
+    client_token: string;
+  };
+};
+
+// Warning: (ae-missing-release-tag) "RouterOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface RouterOptions {
+  // (undocumented)
+  config: Config;
+  // (undocumented)
+  logger: Logger;
+}
+
+// Warning: (ae-missing-release-tag) "Secret" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type Secret = {
+  name: string;
+  showUrl: string;
+  editUrl: string;
+};
+
+// Warning: (ae-missing-release-tag) "VaultApi" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface VaultApi {
+  // (undocumented)
+  getFrontendSecretsUrl(): string;
+  // (undocumented)
+  listSecrets(secretPath: string): Promise<Secret[]>;
+  // (undocumented)
+  renewToken?(): Promise<boolean>;
+}
+
+// Warning: (ae-missing-release-tag) "VaultBuilder" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export class VaultBuilder {
+  constructor(env: VaultEnvironment);
+  // (undocumented)
+  build(): VaultBuilderReturn;
+  // (undocumented)
+  protected buildRouter(vaultClient: VaultClient): express.Router;
+  // (undocumented)
+  static createBuilder(env: VaultEnvironment): VaultBuilder;
+  // (undocumented)
+  enableTokenRenew(): this;
+  // (undocumented)
+  protected readonly env: VaultEnvironment;
+  // (undocumented)
+  protected renewToken(vaultClient: VaultClient): Promise<void>;
+  // (undocumented)
+  setVaultClient(vaultClient: VaultClient): this;
+  // (undocumented)
+  setVaultTokenRefreshInterval(refreshInterval: Duration): this;
+}
+
+// Warning: (ae-missing-release-tag) "VaultBuilderReturn" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type VaultBuilderReturn = Promise<{
+  router: express.Router;
+}>;
+
+// Warning: (ae-missing-release-tag) "VaultClient" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export class VaultClient implements VaultApi {
+  constructor({ config }: { config: Config });
+  // (undocumented)
+  getFrontendSecretsUrl(): string;
+  // (undocumented)
+  listSecrets(secretPath: string): Promise<Secret[]>;
+  // (undocumented)
+  renewToken(): Promise<boolean>;
+}
+
+// Warning: (ae-missing-release-tag) "VaultEnvironment" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface VaultEnvironment {
+  // (undocumented)
+  config: Config;
+  // (undocumented)
+  logger: Logger;
+}
+
+// Warning: (ae-missing-release-tag) "VaultSecretList" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type VaultSecretList = {
+  data: {
+    keys: string[];
+  };
+};
+
+// (No @packageDocumentation comment for this package)
+```
@@ -0,0 +1,21 @@
+## API Report File for "@backstage/plugin-vault"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+/// <reference types="react" />
+
+import { BackstagePlugin } from '@backstage/core-plugin-api';
+
+// Warning: (ae-missing-release-tag) "EntityVaultCard" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const EntityVaultCard: () => JSX.Element;
+
+// Warning: (ae-missing-release-tag) "vaultPlugin" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const vaultPlugin: BackstagePlugin<{}, {}>;
+
+// (No @packageDocumentation comment for this package)
+```