Remove internal things from the jenkins public API
Signed-off-by: Andrew Shirley <andrew.shirley@sainsburys.co.uk> Signed-off-by: blam <ben@blam.sh>
This commit is contained in:
@@ -0,0 +1,69 @@
|
||||
## API Report File for "@backstage/plugin-jenkins-backend"
|
||||
|
||||
> 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';
|
||||
import express from 'express';
|
||||
import { Logger } from 'winston';
|
||||
|
||||
// @public (undocumented)
|
||||
export function createRouter(options: RouterOptions): Promise<express.Router>;
|
||||
|
||||
// @public
|
||||
export class DefaultJenkinsInfoProvider implements JenkinsInfoProvider {
|
||||
constructor(catalog: CatalogClient, config: Config);
|
||||
// (undocumented)
|
||||
getInstance(opt: {
|
||||
entityRef: EntityName;
|
||||
jobName?: string;
|
||||
}): Promise<JenkinsInfo>;
|
||||
// (undocumented)
|
||||
static readonly NEW_JENKINS_ANNOTATION = "jenkins.io/job-slug";
|
||||
// (undocumented)
|
||||
static readonly OLD_JENKINS_ANNOTATION = "jenkins.io/github-folder";
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export class DummyJenkinsInfoProvider implements JenkinsInfoProvider {
|
||||
// (undocumented)
|
||||
getInstance(_: {
|
||||
entityRef: EntityName;
|
||||
jobName?: string;
|
||||
}): Promise<JenkinsInfo>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface JenkinsInfo {
|
||||
// (undocumented)
|
||||
baseUrl: string;
|
||||
// (undocumented)
|
||||
headers?: any;
|
||||
// (undocumented)
|
||||
jobName: string;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface JenkinsInfoProvider {
|
||||
// (undocumented)
|
||||
getInstance(options: {
|
||||
entityRef: EntityName;
|
||||
jobName?: string;
|
||||
}): Promise<JenkinsInfo>;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export interface RouterOptions {
|
||||
// (undocumented)
|
||||
jenkinsInfoProvider: JenkinsInfoProvider;
|
||||
// (undocumented)
|
||||
logger: Logger;
|
||||
}
|
||||
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
@@ -27,4 +27,3 @@ export {
|
||||
isJenkinsAvailable as isPluginApplicableToEntity,
|
||||
} from './components/Router';
|
||||
export { JENKINS_ANNOTATION } from './constants';
|
||||
export * from './api';
|
||||
|
||||
Reference in New Issue
Block a user