nodes/generated

Interface GithubNodeParameters

Source


interface GithubNodeParameters {
    additionalFields?:
        | {
            body?: string;
            draft?: boolean;
            name?: string;
            prerelease?: boolean;
            target_commitish?: string;
        }
        | {
            body?: string;
            draft?: boolean;
            name?: string;
            prerelease?: boolean;
            tag_name?: string;
            target_commitish?: string;
        }
        | { commitId?: string };
    additionalParameters?:
        | {
            author: { email?: string; name?: string };
            branch: { branch?: string };
            committer: { email?: string; name?: string };
        }
        | { reference?: string };
    asBinaryProperty?: boolean;
    assignees?: { assignee?: string };
    authentication?:
        | "oAuth2"
        | "accessToken"
        | "githubAppApi";
    base?: string;
    binaryData?: boolean;
    binaryPropertyName?: string;
    body?: string;
    commentId?: number;
    commitMessage?: string;
    commitTitle?: string;
    draft?: boolean;
    editFields?: | {
        base?: string;
        body?: string;
        state?: "open"
        | "closed";
        title?: string;
    }
    | {
        assignees?: { assignee?: string };
        body?: string;
        labels?: { label?: string };
        state?: "open" | "closed";
        state_reason?:
            | "completed"
            | "not_planned"
            | "reopened";
        title?: string;
    };
    email?: string;
    event?: | "comment"
    | "pending"
    | "approve"
    | "requestChanges";
    fileContent?: string;
    filePath?: string;
    getRepositoryIssuesFilters?: {
        assignee?: string;
        creator?: string;
        direction?: "asc"
        | "desc";
        labels?: string;
        mentioned?: string;
        since?: string;
        sort?: "created" | "updated" | "comments";
        state?: "all" | "open" | "closed";
    };
    getRepositoryPullRequestsFilters?: {
        direction?: "asc"
        | "desc";
        sort?:
            | "created"
            | "updated"
            | "popularity"
            | "long-running";
        state?: "all"
        | "open"
        | "closed";
    };
    getUserIssuesFilters?: {
        direction?: "asc"
        | "desc";
        labels?: string;
        mentioned?: string;
        since?: string;
        sort?: "created" | "updated" | "comments";
        state?: "all" | "open" | "closed";
    };
    head?: string;
    inputs?: string;
    issueNumber?: number;
    labels?: { label?: string };
    limit?: number;
    lockReason?:
        | "spam"
        | "resolved"
        | "off-topic"
        | "too heated";
    mergeMethod?: "merge"
    | "squash"
    | "rebase";
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "update"
        | "list"
        | "delete"
        | "edit"
        | "close"
        | "getMembers"
        | "disable"
        | "enable"
        | "getRepositories"
        | "reopen"
        | "createComment"
        | "editComment"
        | "getDiff"
        | "getPatch"
        | "merge"
        | "lock"
        | "getIssues"
        | "getLicense"
        | "getProfile"
        | "getPullRequests"
        | "listPopularPaths"
        | "listReferrers"
        | "getUserIssues"
        | "invite"
        | "dispatch"
        | "dispatchAndWait"
        | "getUsage";
    organization?: string;
    owner?: {
        mode: "list"
        | "url"
        | "name";
        value: string;
    };
    pullRequestNumber?: number;
    ref?: string
    | { mode: "list" | "name"; value: string };
    release_id?: string;
    releaseTag?: string;
    repository?: {
        mode: "list" | "url" | "name";
        value: string;
    };
    resource?: | "organization"
    | "file"
    | "user"
    | "repository"
    | "release"
    | "issue"
    | "pullRequest"
    | "review"
    | "workflow";
    returnAll?: boolean;
    reviewId?: string;
    title?: string;
    workflowId?: {
        mode: "list"
        | "name"
        | "filename";
        value: string;
    };
}

Properties§

§readonly additionalFields?:
    | {
        body?: string;
        draft?: boolean;
        name?: string;
        prerelease?: boolean;
        target_commitish?: string;
    }
    | {
        body?: string;
        draft?: boolean;
        name?: string;
        prerelease?: boolean;
        tag_name?: string;
        target_commitish?: string;
    }
    | { commitId?: string }

Default: {} Type options: {"multipleValueButtonText":"Add Field"}

§readonly additionalParameters?:
    | {
        author: { email?: string; name?: string };
        branch: { branch?: string };
        committer: { email?: string; name?: string };
    }
    | { reference?: string }

Additional fields to add Default: {}

§readonly asBinaryProperty?: boolean

Whether to set the data of the file as binary property instead of returning the raw API response Default: true

§readonly assignees?: { ... }

Default: {"assignee":""} Type options: {"multipleValues":true,"multipleValueButtonText":"Add Assignee"}

§readonly authentication?: "oAuth2" | "accessToken" | "githubAppApi"

Default: "accessToken"

§readonly base?: string

The branch you want to merge into (e.g. master)

§readonly binaryData?: boolean

Whether the data to upload should be taken from binary field

§readonly binaryPropertyName?: string

Default: "data"

§readonly body?: string

The body of the pull request Type options: {"rows":5}

§readonly commentId?: number

The ID of the comment to edit

§readonly commitMessage?: string

Extra detail to append to automatic merge commit Type options: {"rows":4}

§readonly commitTitle?: string

Title for the automatic merge commit

§readonly draft?: boolean

Whether to create the pull request as a draft

§readonly editFields?:
    | {
        base?: string;
        body?: string;
        state?: "open"
        | "closed";
        title?: string;
    }
    | {
        assignees?: { assignee?: string };
        body?: string;
        labels?: { label?: string };
        state?: "open" | "closed";
        state_reason?:
            | "completed"
            | "not_planned"
            | "reopened";
        title?: string;
    }

Default: {}

§readonly email?: string

The email address of the invited user

§readonly event?: "comment" | "pending" | "approve" | "requestChanges"

The review action you want to perform Default: "approve"

§readonly fileContent?: string

The text content of the file

§readonly filePath?: string

The file path of the file. Has to contain the full path.

§readonly getRepositoryIssuesFilters?: { ... }

Default: {} Type options: {"multipleValueButtonText":"Add Filter"}

§readonly getRepositoryPullRequestsFilters?: { ... }

Default: {} Type options: {"multipleValueButtonText":"Add Filter"}

§readonly getUserIssuesFilters?: { ... }

Default: {} Type options: {"multipleValueButtonText":"Add Filter"}

§readonly head?: string

The branch containing your changes. For a cross‑fork PR, use the format owner:branchname (e.g. johndoe:featurebranch).

§readonly inputs?: string

JSON object with input parameters for the workflow Default: "{}"

§readonly issueNumber?: number

The number of the issue on which to create the comment on

§readonly labels?: { ... }

Default: {"label":""} Type options: {"multipleValues":true,"multipleValueButtonText":"Add Label"}

§readonly limit?: number

Max number of results to return Default: 50 Type options: {"minValue":1,"maxValue":100}

§readonly lockReason?: "spam" | "resolved" | "off-topic" | "too heated"

The reason for locking the issue Default: "resolved"

§readonly mergeMethod?: "merge" | "squash" | "rebase"

Default: "merge"

§readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "list"
    | "delete"
    | "edit"
    | "close"
    | "getMembers"
    | "disable"
    | "enable"
    | "getRepositories"
    | "reopen"
    | "createComment"
    | "editComment"
    | "getDiff"
    | "getPatch"
    | "merge"
    | "lock"
    | "getIssues"
    | "getLicense"
    | "getProfile"
    | "getPullRequests"
    | "listPopularPaths"
    | "listReferrers"
    | "getUserIssues"
    | "invite"
    | "dispatch"
    | "dispatchAndWait"
    | "getUsage"

Default: "getRepositories"

§readonly organization?: string

The GitHub organization that the user is being invited to

§readonly owner?: { ... }

Default: {"mode":"list","value":""}

§readonly pullRequestNumber?: number

The number of the pull request

§readonly ref?: string | { mode: "list" | "name"; value: string }

The git reference for the workflow dispatch (branch or tag name) Default: "main"

§readonly release_id?: string
§readonly releaseTag?: string

The tag of the release

§readonly repository?: { ... }

Default: {"mode":"list","value":""}

§readonly resource?:
    | "organization"
    | "file"
    | "user"
    | "repository"
    | "release"
    | "issue"
    | "pullRequest"
    | "review"
    | "workflow"

Default: "issue"

§readonly returnAll?: boolean

Whether to return all results or only up to a given limit

§readonly reviewId?: string

ID of the review

§readonly title?: string

The title of the pull request

§readonly workflowId?: { ... }

The workflow to dispatch Default: {"mode":"list","value":""}