chore: add API report

Signed-off-by: djamaile <rdjamaile@gmail.com>
This commit is contained in:
djamaile
2022-03-12 20:05:28 +01:00
committed by Fredrik Adelöw
parent f65495894e
commit 9e4937dd83
2 changed files with 33 additions and 0 deletions
@@ -0,0 +1,28 @@
## API Report File for "@backstage/plugin-cicd-statistics-module-gitlab"
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { CicdConfiguration } from '@backstage/plugin-cicd-statistics';
import { CicdState } from '@backstage/plugin-cicd-statistics';
import { CicdStatisticsApi } from '@backstage/plugin-cicd-statistics';
import { Entity } from '@backstage/catalog-model';
import { FetchBuildsOptions } from '@backstage/plugin-cicd-statistics';
import { Gitlab } from '@gitbeaker/browser';
import { OAuthApi } from '@backstage/core-plugin-api';
// @public
export class CicdStatisticsApiGitlab implements CicdStatisticsApi {
constructor(gitLabAuthApi: OAuthApi);
// Warning: (ae-forgotten-export) The symbol "GitlabClient" needs to be exported by the entry point index.d.ts
//
// (undocumented)
createGitlabApi(entity: Entity, scopes: string[]): Promise<GitlabClient>;
// (undocumented)
fetchBuilds(options: FetchBuildsOptions): Promise<CicdState>;
// (undocumented)
getConfiguration(): Promise<Partial<CicdConfiguration>>;
}
// (No @packageDocumentation comment for this package)
```
@@ -73,6 +73,11 @@ type GitlabClient = {
owner: string;
};
/**
* Extracts the CI/CD statistics from a Gitlab repository
*
* @public
*/
export class CicdStatisticsApiGitlab implements CicdStatisticsApi {
readonly #gitLabAuthApi: OAuthApi;