diff --git a/plugins/github-issues/api-report.md b/plugins/github-issues/api-report.md index 9852ec80c9..eb69fc8e8e 100644 --- a/plugins/github-issues/api-report.md +++ b/plugins/github-issues/api-report.md @@ -5,49 +5,9 @@ ```ts /// -import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; -import { ConfigApi } from '@backstage/core-plugin-api'; -import { ErrorApi } from '@backstage/core-plugin-api'; -import { OAuthApi } from '@backstage/core-plugin-api'; import { RouteRef } from '@backstage/core-plugin-api'; -// @public (undocumented) -export type Assignee = { - avatarUrl: string; - login: string; -}; - -// @public (undocumented) -export type EdgesWithNodes = { - edges: Array<{ - node: T; - }>; -}; - -// @public (undocumented) -export type GitHubIssuesApi = ReturnType; - -// @public (undocumented) -export const gitHubIssuesApi: ( - githubAuthApi: OAuthApi, - configApi: ConfigApi, - errorApi: ErrorApi, -) => { - fetchIssuesByRepoFromGitHub: ( - repos: Array, - itemsPerRepo: number, - ) => Promise; -}; - -// @public (undocumented) -export const gitHubIssuesApiRef: ApiRef<{ - fetchIssuesByRepoFromGitHub: ( - repos: Array, - itemsPerRepo: number, - ) => Promise; -}>; - // @public (undocumented) export const GitHubIssuesCard: (props: GitHubIssuesProps) => JSX.Element; @@ -69,39 +29,5 @@ export type GitHubIssuesProps = { itemsPerRepo?: number; }; -// @public (undocumented) -export type Issue = { - assignees: EdgesWithNodes; - author: IssueAuthor; - repository: { - nameWithOwner: string; - }; - title: string; - url: string; - participants: { - totalCount: number; - }; - createdAt: string; - updatedAt: string; - comments: { - totalCount: number; - }; -}; - -// @public (undocumented) -export type IssueAuthor = { - login: string; -}; - -// @public (undocumented) -export type IssuesByRepo = Record; - -// @public (undocumented) -export type RepoIssues = { - issues: { - totalCount: number; - } & EdgesWithNodes; -}; - // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/github-issues/src/api/gitHubIssuesApi.ts b/plugins/github-issues/src/api/gitHubIssuesApi.ts index 2fea0dd759..816345940c 100644 --- a/plugins/github-issues/src/api/gitHubIssuesApi.ts +++ b/plugins/github-issues/src/api/gitHubIssuesApi.ts @@ -23,25 +23,25 @@ import { import { readGitHubIntegrationConfigs } from '@backstage/integration'; import { ForwardedError } from '@backstage/errors'; -/** @public */ +/** @internal */ export type Assignee = { avatarUrl: string; login: string; }; -/** @public */ +/** @internal */ export type EdgesWithNodes = { edges: Array<{ node: T; }>; }; -/** @public */ +/** @internal */ export type IssueAuthor = { login: string; }; -/** @public */ +/** @internal */ export type Issue = { assignees: EdgesWithNodes; author: IssueAuthor; @@ -60,25 +60,25 @@ export type Issue = { }; }; -/** @public */ +/** @internal */ export type RepoIssues = { issues: { totalCount: number; } & EdgesWithNodes; }; -/** @public */ +/** @internal */ export type IssuesByRepo = Record; -/** @public */ +/** @internal */ export type GitHubIssuesApi = ReturnType; -/** @public */ +/** @internal */ export const gitHubIssuesApiRef = createApiRef({ id: 'plugin.githubissues.service', }); -/** @public */ +/** @internal */ export const gitHubIssuesApi = ( githubAuthApi: OAuthApi, configApi: ConfigApi,