From cd43895668ec17b617c66ad6520400d68bd781f4 Mon Sep 17 00:00:00 2001 From: blam Date: Wed, 14 Jul 2021 20:44:48 +0200 Subject: [PATCH] chore: make the api-docs pretty again Signed-off-by: blam --- plugins/jenkins-backend/api-report.md | 61 ++++++++++---------- plugins/jenkins/api-report.md | 83 +++++++++++++++++++-------- 2 files changed, 87 insertions(+), 57 deletions(-) diff --git a/plugins/jenkins-backend/api-report.md b/plugins/jenkins-backend/api-report.md index 7d4ffe27c0..faa1d56c4e 100644 --- a/plugins/jenkins-backend/api-report.md +++ b/plugins/jenkins-backend/api-report.md @@ -3,7 +3,6 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts - import { CatalogClient } from '@backstage/catalog-client'; import { Config } from '@backstage/config'; import { EntityName } from '@backstage/catalog-model'; @@ -15,50 +14,48 @@ export function createRouter(options: RouterOptions): Promise; // @public export class DefaultJenkinsInfoProvider implements JenkinsInfoProvider { - // (undocumented) - static fromConfig(options: { - config: Config; - catalog: CatalogClient; - }): DefaultJenkinsInfoProvider; - // (undocumented) - getInstance(opt: { - entityRef: EntityName; - jobFullName?: string; - }): Promise; - // (undocumented) - static readonly NEW_JENKINS_ANNOTATION = "jenkins.io/job-full-name"; - // (undocumented) - static readonly OLD_JENKINS_ANNOTATION = "jenkins.io/github-folder"; + // (undocumented) + static fromConfig(options: { + config: Config; + catalog: CatalogClient; + }): DefaultJenkinsInfoProvider; + // (undocumented) + getInstance(opt: { + entityRef: EntityName; + jobFullName?: string; + }): Promise; + // (undocumented) + static readonly NEW_JENKINS_ANNOTATION = 'jenkins.io/job-full-name'; + // (undocumented) + static readonly OLD_JENKINS_ANNOTATION = 'jenkins.io/github-folder'; } // @public (undocumented) export interface JenkinsInfo { - // (undocumented) - baseUrl: string; - // (undocumented) - headers?: Record; - // (undocumented) - jobFullName: string; + // (undocumented) + baseUrl: string; + // (undocumented) + headers?: Record; + // (undocumented) + jobFullName: string; } // @public (undocumented) export interface JenkinsInfoProvider { - // (undocumented) - getInstance(options: { - entityRef: EntityName; - jobFullName?: string; - }): Promise; + // (undocumented) + getInstance(options: { + entityRef: EntityName; + jobFullName?: string; + }): Promise; } // @public (undocumented) export interface RouterOptions { - // (undocumented) - jenkinsInfoProvider: JenkinsInfoProvider; - // (undocumented) - logger: Logger_2; + // (undocumented) + jenkinsInfoProvider: JenkinsInfoProvider; + // (undocumented) + logger: Logger_2; } - // (No @packageDocumentation comment for this package) - ``` diff --git a/plugins/jenkins/api-report.md b/plugins/jenkins/api-report.md index 47ec8d655f..3a51f348b9 100644 --- a/plugins/jenkins/api-report.md +++ b/plugins/jenkins/api-report.md @@ -9,6 +9,9 @@ import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { DiscoveryApi } from '@backstage/core-plugin-api'; import { Entity } from '@backstage/catalog-model'; +import { EntityName } from '@backstage/catalog-model'; +import { EntityRef } from '@backstage/catalog-model'; +import { IdentityApi } from '@backstage/core-plugin-api'; import { InfoCardVariants } from '@backstage/core-components'; import { RouteRef } from '@backstage/core-plugin-api'; @@ -35,37 +38,67 @@ export { isJenkinsAvailable as isPluginApplicableToEntity }; export const JENKINS_ANNOTATION = 'jenkins.io/github-folder'; // @public (undocumented) -export class JenkinsApi { - constructor(options: Options); +export interface JenkinsApi { + getBuild(options: { + entity: EntityName; + jobFullName: string; + buildNumber: string; + }): Promise; + getProjects(options: { + entity: EntityRef; + filter: { + branch?: string; + }; + }): Promise; // (undocumented) - extractJobDetailsFromBuildName( - buildName: string, - ): { - jobName: string; - buildNumber: number; - }; - // (undocumented) - extractScmDetailsFromJob(jobDetails: any): any | undefined; - // (undocumented) - getBuild(buildName: string): Promise; - // (undocumented) - getFolder(folderName: string): Promise; - // (undocumented) - getJob(jobName: string): Promise; - // (undocumented) - getLastBuild(jobName: string): Promise; - // (undocumented) - mapJenkinsBuildToCITable( - jenkinsResult: any, - jobScmInfo?: any, - ): CITableBuildInfo; - // (undocumented) - retry(buildName: string): Promise; + retry(options: { + entity: EntityName; + jobFullName: string; + buildNumber: string; + }): Promise; } // @public (undocumented) export const jenkinsApiRef: ApiRef; +// @public (undocumented) +export class JenkinsClient implements JenkinsApi { + constructor(options: { + discoveryApi: DiscoveryApi; + identityApi: IdentityApi; + }); + // (undocumented) + getBuild({ + entity, + jobFullName, + buildNumber, + }: { + entity: EntityName; + jobFullName: string; + buildNumber: string; + }): Promise; + // (undocumented) + getProjects({ + entity, + filter, + }: { + entity: EntityName; + filter: { + branch?: string; + }; + }): Promise; + // (undocumented) + retry({ + entity, + jobFullName, + buildNumber, + }: { + entity: EntityName; + jobFullName: string; + buildNumber: string; + }): Promise; +} + // @public (undocumented) const jenkinsPlugin: BackstagePlugin< {