docs: add api-reports

Signed-off-by: Alisson Fabiano <afabiano@eshopworld.com>

plugins/azure-devops-backend/api-report.md

@@ -18,13 +18,14 @@ import { PullRequestOptions } from '@backstage/plugin-azure-devops-common';
 import { RepoBuild } from '@backstage/plugin-azure-devops-common';
 import { Team } from '@backstage/plugin-azure-devops-common';
 import { TeamMember } from '@backstage/plugin-azure-devops-common';
+import { UrlReader } from '@backstage/backend-common';
 import { WebApi } from 'azure-devops-node-api';
 
 // Warning: (ae-missing-release-tag) "AzureDevOpsApi" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
 export class AzureDevOpsApi {
-  constructor(logger: Logger, webApi: WebApi);
+  constructor(logger: Logger, webApi: WebApi, urlReader: UrlReader);
   // (undocumented)
   getAllTeams(): Promise<Team[]>;
   // (undocumented)
@@ -73,6 +74,16 @@ export class AzureDevOpsApi {
     options: PullRequestOptions,
   ): Promise<PullRequest[]>;
   // (undocumented)
+  getReadme(
+    host: string,
+    organization: string,
+    projectName: string,
+    repoName: string,
+  ): Promise<{
+    url: string;
+    content: string;
+  }>;
+  // (undocumented)
   getRepoBuilds(
     projectName: string,
     repoName: string,

plugins/azure-devops-common/api-report.md

@@ -229,6 +229,26 @@ export enum PullRequestVoteStatus {
   WaitingForAuthor = -5,
 }
 
+// Warning: (ae-missing-release-tag) "Readme" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface Readme {
+  // (undocumented)
+  content: string;
+  // (undocumented)
+  url: string;
+}
+
+// Warning: (ae-missing-release-tag) "ReadmeConfig" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ReadmeConfig {
+  // (undocumented)
+  project: string;
+  // (undocumented)
+  repo: string;
+}
+
 // Warning: (ae-missing-release-tag) "RepoBuild" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)

plugins/azure-devops/api-report.md

@@ -16,6 +16,8 @@ import { GitTag } from '@backstage/plugin-azure-devops-common';
 import { IdentityApi } from '@backstage/core-plugin-api';
 import { PullRequest } from '@backstage/plugin-azure-devops-common';
 import { PullRequestOptions } from '@backstage/plugin-azure-devops-common';
+import { Readme } from '@backstage/plugin-azure-devops-common';
+import { ReadmeConfig } from '@backstage/plugin-azure-devops-common';
 import { RepoBuild } from '@backstage/plugin-azure-devops-common';
 import { RepoBuildOptions } from '@backstage/plugin-azure-devops-common';
 import { SvgIconProps } from '@material-ui/core';
@@ -101,6 +103,8 @@ export interface AzureDevOpsApi {
     items: PullRequest[];
   }>;
   // (undocumented)
+  getReadme(opts: ReadmeConfig): Promise<Readme | undefined>;
+  // (undocumented)
   getRepoBuilds(
     projectName: string,
     repoName: string,
@@ -156,6 +160,8 @@ export class AzureDevOpsClient implements AzureDevOpsApi {
     items: PullRequest[];
   }>;
   // (undocumented)
+  getReadme: (opts: ReadmeConfig) => Promise<Readme | undefined>;
+  // (undocumented)
   getRepoBuilds(
     projectName: string,
     repoName: string,
@@ -271,6 +277,13 @@ export const EntityAzurePullRequestsContent: ({
   defaultLimit?: number | undefined;
 }) => JSX.Element;
 
+// Warning: (ae-missing-release-tag) "EntityAzureReadmeCard" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const EntityAzureReadmeCard: (props: {
+  maxHeight?: number | undefined;
+}) => JSX.Element;
+
 // Warning: (ae-missing-release-tag) "Filter" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)