From ca875e665881dec30c2b192e5172e3bb6fc7afd8 Mon Sep 17 00:00:00 2001
From: Johan Haals <johan.haals@gmail.com>
Date: Thu, 14 Jan 2021 10:44:52 +0100
Subject: [PATCH] Add docs for GithubAppConfig

---
 packages/integration/src/github/config.ts | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/packages/integration/src/github/config.ts b/packages/integration/src/github/config.ts
index 607033739f..94ed00731e 100644
--- a/packages/integration/src/github/config.ts
+++ b/packages/integration/src/github/config.ts
@@ -67,13 +67,34 @@ export type GitHubIntegrationConfig = {
   apps?: GithubAppConfig[];
 };
 
+/**
+ * The configuration parameters for authenticating a GitHub Application.
+ * A Github Apps configuration can be generated using the `backstage-cli create-github-app` command.
+ */
 export type GithubAppConfig = {
+  /**
+   * Unique app identifier, found at https://github.com/organizations/$org/settings/apps/$AppName
+   */
   appId: number;
+  /**
+   * The private key is used by the GitHub App integration to authenticate the app.
+   * A private key can be generated from the app at https://github.com/organizations/$org/settings/apps/$AppName
+   */
   privateKey: string;
+  /**
+   * Webhook secret can be configured at https://github.com/organizations/$org/settings/apps/$AppName
+   */
   webhookSecret: string;
+  /**
+   * Found at https://github.com/organizations/$org/settings/apps/$AppName
+   */
   clientId: string;
+  /**
+   * Client secrets can be generated at https://github.com/organizations/$org/settings/apps/$AppName
+   */
   clientSecret: string;
 };
+
 /**
  * Reads a single GitHub integration config.
  *