From 2d4e17ad1de47c1cc80dd8d11cd4a6ae92eded4b Mon Sep 17 00:00:00 2001 From: Wolfgang Amann Date: Thu, 21 Mar 2024 21:41:29 +0100 Subject: [PATCH] docs(connectors): add new GitHub connector operations --- .../out-of-the-box-connectors/github.md | 41 +++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/docs/components/connectors/out-of-the-box-connectors/github.md b/docs/components/connectors/out-of-the-box-connectors/github.md index f02677c8266..e71cfc69afb 100644 --- a/docs/components/connectors/out-of-the-box-connectors/github.md +++ b/docs/components/connectors/out-of-the-box-connectors/github.md @@ -215,6 +215,14 @@ The **GitHub Connector** currently supports the following operations. - **Owner:** The account owner of the repository. The name is not case-sensitive. - **Repo:** The name of the repository. The name is not case-sensitive. +#### Get repository content + +- **GitHub API:** [Get repository content](https://docs.github.com/en/rest/repos/contents?apiVersion=2022-11-28#get-repository-content). +- **Owner:** The account owner of the repository. The name is not case-sensitive. +- **Repo:** The name of the repository. The name is not case-sensitive. +- **Path:** The path of the content within the repository. +- **Ref:** The name of the commit/branch/tag. Defaults to the repository’s default branch. + ### Actions #### Create workflow dispatch event @@ -226,6 +234,39 @@ The **GitHub Connector** currently supports the following operations. - **Git reference:** The branch or tag name for the workflow. - **Workflow inputs:** An object containing up to 10 key-value pairs. Inputs are configured in the workflow file. +### References + +#### Create a reference + +- **GitHub API:** [Create a reference](https://docs.github.com/en/rest/git/refs?apiVersion=2022-11-28#create-a-reference) +- **Owner:** The account owner of the repository. The name is not case-sensitive. +- **Repo:** The name of the repository. The name is not case-sensitive +- **Git reference:** The name of the fully qualified reference (ie: `refs/heads/master`). +- **SHA1:** The SHA1 value to create this reference from. + +### Pulls + +#### Create a pull request + +- **GitHub API:** [Create a pull request](https://docs.github.com/en/rest/pulls/pulls?apiVersion=2022-11-28#create-a-pull-request) +- **Owner:** The account owner of the repository. The name is not case-sensitive. +- **Repo:** The name of the repository. The name is not case-sensitive +- **Title:** The title of the new pull request. +- **Head:** The name of the branch where your changes are implemented. +- **Base:** The name of the branch you want the changes pulled into. +- **Body:** The contents of the pull request. +- **Draft:** Indicates whether the pull request is a draft. + +### Collaborators + +#### List repository collaborators + +- **GitHub API:** [List repository collaborators](https://docs.github.com/en/rest/collaborators/collaborators?apiVersion=2022-11-28#list-repository-collaborators) +- **Owner:** The account owner of the repository. The name is not case-sensitive. +- **Repo:** The name of the repository. The name is not case-sensitive +- **Page:** The page number of the results to fetch. +- **Results per page:** The number of results per page. + ## Handle Connector response The **GitHub Connector** is a protocol Connector, meaning it is built on top of the **HTTP REST Connector**, therefore