diff --git a/plugins/cicd-statistics-module-gitlab/api-report.md b/plugins/cicd-statistics-module-gitlab/api-report.md new file mode 100644 index 0000000000..c9e1e19016 --- /dev/null +++ b/plugins/cicd-statistics-module-gitlab/api-report.md @@ -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; + // (undocumented) + fetchBuilds(options: FetchBuildsOptions): Promise; + // (undocumented) + getConfiguration(): Promise>; +} + +// (No @packageDocumentation comment for this package) +``` diff --git a/plugins/cicd-statistics-module-gitlab/src/api/gitlab.ts b/plugins/cicd-statistics-module-gitlab/src/api/gitlab.ts index a28ce612d5..45b682302b 100644 --- a/plugins/cicd-statistics-module-gitlab/src/api/gitlab.ts +++ b/plugins/cicd-statistics-module-gitlab/src/api/gitlab.ts @@ -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;