Add api-report.md for plugin sonarqube-backend

Signed-off-by: Neemys <36508659+Neemys@users.noreply.github.com>
2022-07-22 14:37:50 +02:00
parent e9dcea3c92
commit 035ea31f2c
1 changed files with 67 additions and 0 deletions
@@ -0,0 +1,67 @@
+## API Report File for "@backstage/plugin-sonarqube-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 express from 'express';
+import { Logger } from 'winston';
+
+// @public
+export function createRouter(options: RouterOptions): Promise<express.Router>;
+
+// @public
+export class DefaultSonarqubeInfoProvider implements SonarqubeInfoProvider {
+  static fromConfig(config: Config): DefaultSonarqubeInfoProvider;
+  getBaseUrl(instanceName: string): string;
+  getFindings(
+    componentKey: string,
+    instanceName: string,
+  ): Promise<SonarqubeFindings | undefined>;
+}
+
+// @public
+export interface Measure {
+  metric: string;
+  value: string;
+}
+
+// @public
+export interface RouterOptions {
+  logger: Logger;
+  sonarqubeInfoProvider: SonarqubeInfoProvider;
+}
+
+// @public
+export class SonarqubeConfig {
+  constructor(instances: SonarqubeInstanceConfig[]);
+  static fromConfig(config: Config): SonarqubeConfig;
+  getInstanceConfig(sonarqubeName?: string): SonarqubeInstanceConfig;
+  // (undocumented)
+  readonly instances: SonarqubeInstanceConfig[];
+}
+
+// @public
+export interface SonarqubeFindings {
+  analysisDate: string;
+  measures: Measure[];
+}
+
+// @public
+export interface SonarqubeInfoProvider {
+  getBaseUrl(instanceName: string): string;
+  getFindings(
+    componentKey: string,
+    instanceName: string,
+  ): Promise<SonarqubeFindings | undefined>;
+}
+
+// @public
+export interface SonarqubeInstanceConfig {
+  apiKey: string;
+  baseUrl: string;
+  name: string;
+}
+
+// (No @packageDocumentation comment for this package)
+```