From 4b095e031a2e03057ed2d5fbb50a9af3dfe78427 Mon Sep 17 00:00:00 2001
From: Alisson Fabiano <afabiano@eshopworld.com>
Date: Fri, 19 Aug 2022 11:57:07 +0100
Subject: [PATCH] docs: add api-reports

Signed-off-by: Alisson Fabiano <afabiano@eshopworld.com>
---
 plugins/azure-devops-backend/api-report.md | 8 +++++---
 plugins/azure-devops-common/api-report.md  | 6 ------
 plugins/azure-devops/api-report.md         | 6 ++----
 3 files changed, 7 insertions(+), 13 deletions(-)

diff --git a/plugins/azure-devops-backend/api-report.md b/plugins/azure-devops-backend/api-report.md
index fc13fcb371..900b3c3d12 100644
--- a/plugins/azure-devops-backend/api-report.md
+++ b/plugins/azure-devops-backend/api-report.md
@@ -74,9 +74,9 @@ export class AzureDevOpsApi {
   // (undocumented)
   getReadme(
     host: string,
-    organization: string,
-    projectName: string,
-    repoName: string,
+    org: string,
+    project: string,
+    repo: string,
   ): Promise<{
     url: string;
     content: string;
@@ -105,6 +105,8 @@ export interface RouterOptions {
   config: Config;
   // (undocumented)
   logger: Logger;
+  // (undocumented)
+  reader: UrlReader;
 }
 
 // (No @packageDocumentation comment for this package)
diff --git a/plugins/azure-devops-common/api-report.md b/plugins/azure-devops-common/api-report.md
index 3dc354b519..ea9f7130c0 100644
--- a/plugins/azure-devops-common/api-report.md
+++ b/plugins/azure-devops-common/api-report.md
@@ -197,8 +197,6 @@ 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)
@@ -207,8 +205,6 @@ export interface Readme {
   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)
@@ -217,8 +213,6 @@ export interface ReadmeConfig {
   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)
 export type RepoBuild = {
   id?: number;
diff --git a/plugins/azure-devops/api-report.md b/plugins/azure-devops/api-report.md
index 2d9405aebe..5d59f263fb 100644
--- a/plugins/azure-devops/api-report.md
+++ b/plugins/azure-devops/api-report.md
@@ -93,7 +93,7 @@ export interface AzureDevOpsApi {
     items: PullRequest[];
   }>;
   // (undocumented)
-  getReadme(opts: ReadmeConfig): Promise<Readme | undefined>;
+  getReadme(opts: ReadmeConfig): Promise<Readme>;
   // (undocumented)
   getRepoBuilds(
     projectName: string,
@@ -146,7 +146,7 @@ export class AzureDevOpsClient implements AzureDevOpsApi {
     items: PullRequest[];
   }>;
   // (undocumented)
-  getReadme: (opts: ReadmeConfig) => Promise<Readme | undefined>;
+  getReadme(opts: ReadmeConfig): Promise<Readme>;
   // (undocumented)
   getRepoBuilds(
     projectName: string,
@@ -242,8 +242,6 @@ 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)
 export type Filter =
   | AssignedToUserFilter