Fix API report

Signed-off-by: Scott Guymer <[email protected]>
backstage · Sep 19, 2024 · 3e41595 · 3e41595
1 parent 91c9210
commit 3e41595
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 1 deletion.
diff --git a/workspaces/copilot/plugins/copilot-backend/api-report.md b/workspaces/copilot/plugins/copilot-backend/api-report.md
@@ -7,10 +7,26 @@ import { BackendFeatureCompat } from '@backstage/backend-plugin-api';
 import { Config } from '@backstage/config';
 import { DatabaseService } from '@backstage/backend-plugin-api';
 import express from 'express';
+import { ExtensionPoint } from '@backstage/backend-plugin-api';
+import { GithubCredentials } from '@backstage/integration';
 import { LoggerService } from '@backstage/backend-plugin-api';
 import { SchedulerService } from '@backstage/backend-plugin-api';
 import { SchedulerServiceTaskScheduleDefinition } from '@backstage/backend-plugin-api';
 
+// @public
+export interface CopilotCredentialsProvider {
+  getCredentials(): Promise<GithubInfo>;
+}
+
+// @public
+export interface CopilotExtensionPoint {
+  // (undocumented)
+  useCredentialsProvider(provider: CopilotCredentialsProvider): void;
+}
+
+// @public
+export const copilotExtensionPoint: ExtensionPoint<CopilotExtensionPoint>;
+
 // @public
 const copilotPlugin: BackendFeatureCompat;
 export default copilotPlugin;
@@ -20,6 +36,13 @@ export function createRouterFromConfig(
   routerOptions: RouterOptions,
 ): Promise<express.Router>;
 
+// @public
+export type GithubInfo = {
+  credentials: GithubCredentials;
+  apiBaseUrl: string;
+  enterprise: string;
+};
+
 // @public
 export interface PluginOptions {
   schedule?: SchedulerServiceTaskScheduleDefinition;
@@ -28,6 +51,7 @@ export interface PluginOptions {
 // @public
 export interface RouterOptions {
   config: Config;
+  credentialsProvider: CopilotCredentialsProvider;
   database: DatabaseService;
   logger: LoggerService;
   scheduler: SchedulerService;

diff --git a/workspaces/copilot/plugins/copilot-backend/src/index.ts b/workspaces/copilot/plugins/copilot-backend/src/index.ts
@@ -21,7 +21,11 @@
  */
 
 export * from './service/router';
-export { copilotPlugin as default, copilotExtensionPoint } from './plugin';
+export {
+  copilotPlugin as default,
+  copilotExtensionPoint,
+  type CopilotExtensionPoint,
+} from './plugin';
 export {
   type CopilotCredentialsProvider,
   type GithubInfo,

diff --git a/workspaces/copilot/plugins/copilot-backend/src/plugin.ts b/workspaces/copilot/plugins/copilot-backend/src/plugin.ts
@@ -24,10 +24,20 @@ import {
   DefaultCopilotCredentialsProvider,
 } from './utils/CopilotCredentialsProvider';
 
+/**
+ * Interface for providing credentials for accessing the Copilot API.
+ *
+ * @public
+ */
 export interface CopilotExtensionPoint {
   useCredentialsProvider(provider: CopilotCredentialsProvider): void;
 }
 
+/**
+ * Extension point for providing credentials for accessing the Copilot API.
+ *
+ * @public
+ */
 export const copilotExtensionPoint =
   createExtensionPoint<CopilotExtensionPoint>({
     id: 'copliot.credentials',

diff --git a/workspaces/copilot/plugins/copilot-backend/src/utils/CopilotCredentialsProvider.ts b/workspaces/copilot/plugins/copilot-backend/src/utils/CopilotCredentialsProvider.ts
@@ -21,13 +21,28 @@ import {
   ScmIntegrations,
 } from '@backstage/integration';
 
+/**
+ * Information required to access the GitHub API
+ *
+ * @public
+ */
 export type GithubInfo = {
   credentials: GithubCredentials;
   apiBaseUrl: string;
   enterprise: string;
 };
 
+/**
+ * Interface for providing credentials for accessing the copilot API
+ *
+ * @public
+ */
 export interface CopilotCredentialsProvider {
+  /**
+   * Retrieve the credentials required to access the copilot API
+   *
+   * @public
+   */
   getCredentials(): Promise<GithubInfo>;
 }