From 7f243a3146b46866a61ef55f2854bf3d4ae85bae Mon Sep 17 00:00:00 2001 From: Ev Date: Wed, 24 Jan 2024 18:16:24 +0100 Subject: [PATCH] docs(connectors): Add Github Create workflow dispatch event section (#3206) * docs: Add Create workflow dispatch event doc * docs: fix whitespace * fix: reflect clarifications from QA process * docs: add GitHub Actions to v8.4 --- .../connectors/out-of-the-box-connectors/github.md | 11 +++++++++++ .../connectors/out-of-the-box-connectors/github.md | 11 +++++++++++ 2 files changed, 22 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 3628f50498c..52c1fab9990 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,17 @@ 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. +### Actions + +#### Create workflow dispatch event + +- **GitHub API:** [Create workflow dispatch event](https://docs.github.com/en/rest/actions/workflows?apiVersion=2022-11-28#create-a-workflow-dispatch-event) +- **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 +- **Workflow ID:** The ID of the workflow. You can also pass the workflow file name as a string. +- **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. + ## Handle Connector response The **GitHub Connector** is a protocol Connector, meaning it is built on top of the **HTTP REST Connector**, therefore diff --git a/versioned_docs/version-8.4/components/connectors/out-of-the-box-connectors/github.md b/versioned_docs/version-8.4/components/connectors/out-of-the-box-connectors/github.md index 3628f50498c..52c1fab9990 100644 --- a/versioned_docs/version-8.4/components/connectors/out-of-the-box-connectors/github.md +++ b/versioned_docs/version-8.4/components/connectors/out-of-the-box-connectors/github.md @@ -215,6 +215,17 @@ 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. +### Actions + +#### Create workflow dispatch event + +- **GitHub API:** [Create workflow dispatch event](https://docs.github.com/en/rest/actions/workflows?apiVersion=2022-11-28#create-a-workflow-dispatch-event) +- **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 +- **Workflow ID:** The ID of the workflow. You can also pass the workflow file name as a string. +- **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. + ## Handle Connector response The **GitHub Connector** is a protocol Connector, meaning it is built on top of the **HTTP REST Connector**, therefore