docs: add api-reports

Signed-off-by: Alisson Fabiano <afabiano@eshopworld.com>
This commit is contained in:
Alisson Fabiano
2022-08-19 11:57:07 +01:00
parent 5e918f43e6
commit 4b095e031a
3 changed files with 7 additions and 13 deletions
+5 -3
View File
@@ -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)
@@ -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;
+2 -4
View File
@@ -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