Skip to content

armgit / kaneo

Public Imported from GitHub
0

⚡ Project management that doesn't become the project. Boards, Gantt charts, and GitHub integration. Self-host it or use Kaneo Cloud.

docs: add github integration endpoint documentation

Andrej Acevskic3103dc4f73d
diff --git a/apps/docs/content/docs/api/github-integration/createGitHubIntegration.mdx b/apps/docs/content/docs/api/github-integration/createGitHubIntegration.mdx
new file mode 100644
index 000000000..fc038bfbb
--- /dev/null
+++ b/apps/docs/content/docs/api/github-integration/createGitHubIntegration.mdx
@@ -0,0 +1,17 @@
+---
+title: Create Git Hub Integration
+full: true
+_openapi:
+ method: POST
+ toc: []
+ structuredData:
+ headings: []
+ contents:
+ - content: Create a new GitHub integration for a project
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+Create a new GitHub integration for a project
+
+<APIPage document={"./openapi.json"} operations={[{"path":"/github-integration/project/{projectId}","method":"post"}]} />
\ No newline at end of file
diff --git a/apps/docs/content/docs/api/github-integration/deleteGitHubIntegration.mdx b/apps/docs/content/docs/api/github-integration/deleteGitHubIntegration.mdx
new file mode 100644
index 000000000..ca4f371a4
--- /dev/null
+++ b/apps/docs/content/docs/api/github-integration/deleteGitHubIntegration.mdx
@@ -0,0 +1,17 @@
+---
+title: Delete Git Hub Integration
+full: true
+_openapi:
+ method: DELETE
+ toc: []
+ structuredData:
+ headings: []
+ contents:
+ - content: Delete GitHub integration for a project
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+Delete GitHub integration for a project
+
+<APIPage document={"./openapi.json"} operations={[{"path":"/github-integration/project/{projectId}","method":"delete"}]} />
\ No newline at end of file
diff --git a/apps/docs/content/docs/api/github-integration/getGitHubAppInfo.mdx b/apps/docs/content/docs/api/github-integration/getGitHubAppInfo.mdx
new file mode 100644
index 000000000..89f949d3e
--- /dev/null
+++ b/apps/docs/content/docs/api/github-integration/getGitHubAppInfo.mdx
@@ -0,0 +1,17 @@
+---
+title: Get Git Hub App Info
+full: true
+_openapi:
+ method: GET
+ toc: []
+ structuredData:
+ headings: []
+ contents:
+ - content: Get GitHub app configuration information
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+Get GitHub app configuration information
+
+<APIPage document={"./openapi.json"} operations={[{"path":"/github-integration/app-info","method":"get"}]} />
\ No newline at end of file
diff --git a/apps/docs/content/docs/api/github-integration/getGitHubIntegration.mdx b/apps/docs/content/docs/api/github-integration/getGitHubIntegration.mdx
new file mode 100644
index 000000000..17da86ec0
--- /dev/null
+++ b/apps/docs/content/docs/api/github-integration/getGitHubIntegration.mdx
@@ -0,0 +1,17 @@
+---
+title: Get Git Hub Integration
+full: true
+_openapi:
+ method: GET
+ toc: []
+ structuredData:
+ headings: []
+ contents:
+ - content: Get GitHub integration for a project
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+Get GitHub integration for a project
+
+<APIPage document={"./openapi.json"} operations={[{"path":"/github-integration/project/{projectId}","method":"get"}]} />
\ No newline at end of file
diff --git a/apps/docs/content/docs/api/github-integration/importGitHubIssues.mdx b/apps/docs/content/docs/api/github-integration/importGitHubIssues.mdx
new file mode 100644
index 000000000..2578dbb44
--- /dev/null
+++ b/apps/docs/content/docs/api/github-integration/importGitHubIssues.mdx
@@ -0,0 +1,17 @@
+---
+title: Import Git Hub Issues
+full: true
+_openapi:
+ method: POST
+ toc: []
+ structuredData:
+ headings: []
+ contents:
+ - content: Import GitHub issues as tasks
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+Import GitHub issues as tasks
+
+<APIPage document={"./openapi.json"} operations={[{"path":"/github-integration/import-issues","method":"post"}]} />
\ No newline at end of file
diff --git a/apps/docs/content/docs/api/github-integration/listGitHubRepositories.mdx b/apps/docs/content/docs/api/github-integration/listGitHubRepositories.mdx
new file mode 100644
index 000000000..9b2d17f38
--- /dev/null
+++ b/apps/docs/content/docs/api/github-integration/listGitHubRepositories.mdx
@@ -0,0 +1,17 @@
+---
+title: List Git Hub Repositories
+full: true
+_openapi:
+ method: GET
+ toc: []
+ structuredData:
+ headings: []
+ contents:
+ - content: List all accessible GitHub repositories
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+List all accessible GitHub repositories
+
+<APIPage document={"./openapi.json"} operations={[{"path":"/github-integration/repositories","method":"get"}]} />
\ No newline at end of file
diff --git a/apps/docs/content/docs/api/github-integration/meta.json b/apps/docs/content/docs/api/github-integration/meta.json
new file mode 100644
index 000000000..a646b9ae8
--- /dev/null
+++ b/apps/docs/content/docs/api/github-integration/meta.json
@@ -0,0 +1,14 @@
+{
+ "title": "GitHub Integration",
+ "pages": [
+ "createGitHubIntegration",
+ "getGitHubIntegration",
+ "updateGitHubIntegration",
+ "deleteGitHubIntegration",
+ "getGitHubAppInfo",
+ "listGitHubRepositories",
+ "importGitHubIssues",
+ "verifyGitHubInstallation"
+ ],
+ "defaultOpen": true
+}
diff --git a/apps/docs/content/docs/api/github-integration/updateGitHubIntegration.mdx b/apps/docs/content/docs/api/github-integration/updateGitHubIntegration.mdx
new file mode 100644
index 000000000..fb713ef8e
--- /dev/null
+++ b/apps/docs/content/docs/api/github-integration/updateGitHubIntegration.mdx
@@ -0,0 +1,17 @@
+---
+title: Update Git Hub Integration
+full: true
+_openapi:
+ method: PATCH
+ toc: []
+ structuredData:
+ headings: []
+ contents:
+ - content: Update GitHub integration settings
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+Update GitHub integration settings
+
+<APIPage document={"./openapi.json"} operations={[{"path":"/github-integration/project/{projectId}","method":"patch"}]} />
\ No newline at end of file
diff --git a/apps/docs/content/docs/api/github-integration/verifyGitHubInstallation.mdx b/apps/docs/content/docs/api/github-integration/verifyGitHubInstallation.mdx
new file mode 100644
index 000000000..24a02d01d
--- /dev/null
+++ b/apps/docs/content/docs/api/github-integration/verifyGitHubInstallation.mdx
@@ -0,0 +1,17 @@
+---
+title: Verify Git Hub Installation
+full: true
+_openapi:
+ method: POST
+ toc: []
+ structuredData:
+ headings: []
+ contents:
+ - content: Verify GitHub app installation for a repository
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+Verify GitHub app installation for a repository
+
+<APIPage document={"./openapi.json"} operations={[{"path":"/github-integration/verify","method":"post"}]} />
\ No newline at end of file