prefect_github.mutations

This is a module containing: GitHub mutation tasks

add_comment_subject(subject_id, body, github_credentials, return_fields=None) async

Adds a comment to an Issue or Pull Request.

Parameters:

Name	Type	Description	Default
subject_id	str	The Node ID of the subject to modify.	required
body	str	The contents of the comment.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/mutation/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/mutations.py

@task
async def add_comment_subject(  # noqa
    subject_id: str,
    body: str,
    github_credentials: GitHubCredentials,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Adds a comment to an Issue or Pull Request.

    Args:
        subject_id: The Node ID of the subject to modify.
        body: The contents of the comment.
        github_credentials: Credentials to use for authentication with GitHub.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.add_comment(
        **strip_kwargs(
            input=dict(
                subject_id=subject_id,
                body=body,
            )
        )
    ).subject(**strip_kwargs())

    op_stack = (
        "addComment",
        "subject",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["addComment"]["subject"]

add_pull_request_review(pull_request_id, github_credentials, commit_oid=None, body=None, event=None, comments=None, threads=None, return_fields=None) async

Adds a review to a Pull Request.

Parameters:

Name	Type	Description	Default
pull_request_id	str	The Node ID of the pull request to modify.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
commit_oid	Optional[datetime]	The commit OID the review pertains to.	None
body	Optional[str]	The contents of the review body comment.	None
event	PullRequestReviewEvent	The event to perform on the pull request review.	None
comments	Iterable[DraftPullRequestReviewComment]	The review line comments.	None
threads	Iterable[DraftPullRequestReviewThread]	The review line comment threads.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/mutation/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/mutations.py

@task
async def add_pull_request_review(  # noqa
    pull_request_id: str,
    github_credentials: GitHubCredentials,
    commit_oid: Optional[datetime] = None,
    body: Optional[str] = None,
    event: graphql_schema.PullRequestReviewEvent = None,
    comments: Iterable[graphql_schema.DraftPullRequestReviewComment] = None,
    threads: Iterable[graphql_schema.DraftPullRequestReviewThread] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Adds a review to a Pull Request.

    Args:
        pull_request_id: The Node ID of the pull request to modify.
        github_credentials: Credentials to use for authentication with GitHub.
        commit_oid: The commit OID the review pertains to.
        body: The contents of the review body comment.
        event: The event to perform on the pull request review.
        comments: The review line comments.
        threads: The review line comment threads.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.add_pull_request_review(
        **strip_kwargs(
            input=dict(
                pull_request_id=pull_request_id,
                commit_oid=commit_oid,
                body=body,
                event=event,
                comments=comments,
                threads=threads,
            )
        )
    ).pull_request_review(**strip_kwargs())

    op_stack = (
        "addPullRequestReview",
        "pullRequestReview",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["addPullRequestReview"]["pullRequestReview"]

add_reaction(subject_id, content, github_credentials, return_fields=None) async

Adds a reaction to a subject.

Parameters:

Name	Type	Description	Default
subject_id	str	The Node ID of the subject to modify.	required
content	ReactionContent	The name of the emoji to react with.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/mutation/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/mutations.py

@task
async def add_reaction(  # noqa
    subject_id: str,
    content: graphql_schema.ReactionContent,
    github_credentials: GitHubCredentials,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Adds a reaction to a subject.

    Args:
        subject_id: The Node ID of the subject to modify.
        content: The name of the emoji to react with.
        github_credentials: Credentials to use for authentication with GitHub.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.add_reaction(
        **strip_kwargs(
            input=dict(
                subject_id=subject_id,
                content=content,
            )
        )
    ).reaction(**strip_kwargs())

    op_stack = (
        "addReaction",
        "reaction",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["addReaction"]["reaction"]

add_reaction_subject(subject_id, content, github_credentials, return_fields=None) async

Adds a reaction to a subject.

Parameters:

Name	Type	Description	Default
subject_id	str	The Node ID of the subject to modify.	required
content	ReactionContent	The name of the emoji to react with.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/mutation/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/mutations.py

@task
async def add_reaction_subject(  # noqa
    subject_id: str,
    content: graphql_schema.ReactionContent,
    github_credentials: GitHubCredentials,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Adds a reaction to a subject.

    Args:
        subject_id: The Node ID of the subject to modify.
        content: The name of the emoji to react with.
        github_credentials: Credentials to use for authentication with GitHub.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.add_reaction(
        **strip_kwargs(
            input=dict(
                subject_id=subject_id,
                content=content,
            )
        )
    ).subject(**strip_kwargs())

    op_stack = (
        "addReaction",
        "subject",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["addReaction"]["subject"]

add_star_starrable(starrable_id, github_credentials, return_fields=None) async

Adds a star to a Starrable.

Parameters:

Name	Type	Description	Default
starrable_id	str	The Starrable ID to star.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/mutation/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/mutations.py

@task
async def add_star_starrable(  # noqa
    starrable_id: str,
    github_credentials: GitHubCredentials,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Adds a star to a Starrable.

    Args:
        starrable_id: The Starrable ID to star.
        github_credentials: Credentials to use for authentication with GitHub.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.add_star(
        **strip_kwargs(
            input=dict(
                starrable_id=starrable_id,
            )
        )
    ).starrable(**strip_kwargs())

    op_stack = (
        "addStar",
        "starrable",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["addStar"]["starrable"]

close_issue(issue_id, github_credentials, state_reason=None, return_fields=None) async

Close an issue.

Parameters:

Name	Type	Description	Default
issue_id	str	ID of the issue to be closed.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
state_reason	IssueClosedStateReason	The reason the issue is to be closed.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/mutation/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/mutations.py

@task
async def close_issue(  # noqa
    issue_id: str,
    github_credentials: GitHubCredentials,
    state_reason: graphql_schema.IssueClosedStateReason = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Close an issue.

    Args:
        issue_id: ID of the issue to be closed.
        github_credentials: Credentials to use for authentication with GitHub.
        state_reason: The reason the issue is to be closed.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.close_issue(
        **strip_kwargs(
            input=dict(
                issue_id=issue_id,
                state_reason=state_reason,
            )
        )
    ).issue(**strip_kwargs())

    op_stack = (
        "closeIssue",
        "issue",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["closeIssue"]["issue"]

close_pull_request(pull_request_id, github_credentials, return_fields=None) async

Close a pull request.

Parameters:

Name	Type	Description	Default
pull_request_id	str	ID of the pull request to be closed.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/mutation/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/mutations.py

@task
async def close_pull_request(  # noqa
    pull_request_id: str,
    github_credentials: GitHubCredentials,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Close a pull request.

    Args:
        pull_request_id: ID of the pull request to be closed.
        github_credentials: Credentials to use for authentication with GitHub.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.close_pull_request(
        **strip_kwargs(
            input=dict(
                pull_request_id=pull_request_id,
            )
        )
    ).pull_request(**strip_kwargs())

    op_stack = (
        "closePullRequest",
        "pullRequest",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["closePullRequest"]["pullRequest"]

create_issue(repository_id, title, assignee_ids, label_ids, project_ids, github_credentials, body=None, milestone_id=None, issue_template=None, return_fields=None) async

Creates a new issue.

Parameters:

Name	Type	Description	Default
repository_id	str	The Node ID of the repository.	required
title	str	The title for the issue.	required
assignee_ids	Iterable[str]	The Node ID for the user assignee for this issue.	required
label_ids	Iterable[str]	An array of Node IDs of labels for this issue.	required
project_ids	Iterable[str]	An array of Node IDs for projects associated with this issue.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
body	Optional[str]	The body for the issue description.	None
milestone_id	Optional[str]	The Node ID of the milestone for this issue.	None
issue_template	Optional[str]	The name of an issue template in the repository, assigns labels and assignees from the template to the issue.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/mutation/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/mutations.py

@task
async def create_issue(  # noqa
    repository_id: str,
    title: str,
    assignee_ids: Iterable[str],
    label_ids: Iterable[str],
    project_ids: Iterable[str],
    github_credentials: GitHubCredentials,
    body: Optional[str] = None,
    milestone_id: Optional[str] = None,
    issue_template: Optional[str] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Creates a new issue.

    Args:
        repository_id: The Node ID of the repository.
        title: The title for the issue.
        assignee_ids: The Node ID for the user assignee for this issue.
        label_ids: An array of Node IDs of labels for this issue.
        project_ids: An array of Node IDs for projects associated with this
            issue.
        github_credentials: Credentials to use for authentication with GitHub.
        body: The body for the issue description.
        milestone_id: The Node ID of the milestone for this issue.
        issue_template: The name of an issue template in the repository, assigns
            labels and assignees from the template to the issue.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.create_issue(
        **strip_kwargs(
            input=dict(
                repository_id=repository_id,
                title=title,
                assignee_ids=assignee_ids,
                label_ids=label_ids,
                project_ids=project_ids,
                body=body,
                milestone_id=milestone_id,
                issue_template=issue_template,
            )
        )
    ).issue(**strip_kwargs())

    op_stack = (
        "createIssue",
        "issue",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["createIssue"]["issue"]

create_pull_request(repository_id, base_ref_name, head_ref_name, title, github_credentials, body=None, maintainer_can_modify=None, draft=None, return_fields=None) async

Create a new pull request.

Parameters:

Name	Type	Description	Default
repository_id	str	The Node ID of the repository.	required
base_ref_name	str	The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.	required
head_ref_name	str	The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head_ref_name with a user like this: username:branch.	required
title	str	The title of the pull request.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
body	Optional[str]	The contents of the pull request.	None
maintainer_can_modify	Optional[bool]	Indicates whether maintainers can modify the pull request.	None
draft	Optional[bool]	Indicates whether this pull request should be a draft.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/mutation/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/mutations.py

@task
async def create_pull_request(  # noqa
    repository_id: str,
    base_ref_name: str,
    head_ref_name: str,
    title: str,
    github_credentials: GitHubCredentials,
    body: Optional[str] = None,
    maintainer_can_modify: Optional[bool] = None,
    draft: Optional[bool] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Create a new pull request.

    Args:
        repository_id: The Node ID of the repository.
        base_ref_name: The name of the branch you want your changes pulled into.
            This should be an existing branch on the current repository.
            You cannot update the base branch on a pull request to point
            to another repository.
        head_ref_name: The name of the branch where your changes are
            implemented. For cross-repository pull requests in the same
            network, namespace `head_ref_name` with a user like this:
            `username:branch`.
        title: The title of the pull request.
        github_credentials: Credentials to use for authentication with GitHub.
        body: The contents of the pull request.
        maintainer_can_modify: Indicates whether maintainers can modify the pull
            request.
        draft: Indicates whether this pull request should be a draft.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.create_pull_request(
        **strip_kwargs(
            input=dict(
                repository_id=repository_id,
                base_ref_name=base_ref_name,
                head_ref_name=head_ref_name,
                title=title,
                body=body,
                maintainer_can_modify=maintainer_can_modify,
                draft=draft,
            )
        )
    ).pull_request(**strip_kwargs())

    op_stack = (
        "createPullRequest",
        "pullRequest",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["createPullRequest"]["pullRequest"]

remove_reaction(subject_id, content, github_credentials, return_fields=None) async

Removes a reaction from a subject.

Parameters:

Name	Type	Description	Default
subject_id	str	The Node ID of the subject to modify.	required
content	ReactionContent	The name of the emoji reaction to remove.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/mutation/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/mutations.py

@task
async def remove_reaction(  # noqa
    subject_id: str,
    content: graphql_schema.ReactionContent,
    github_credentials: GitHubCredentials,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Removes a reaction from a subject.

    Args:
        subject_id: The Node ID of the subject to modify.
        content: The name of the emoji reaction to remove.
        github_credentials: Credentials to use for authentication with GitHub.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.remove_reaction(
        **strip_kwargs(
            input=dict(
                subject_id=subject_id,
                content=content,
            )
        )
    ).reaction(**strip_kwargs())

    op_stack = (
        "removeReaction",
        "reaction",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["removeReaction"]["reaction"]

remove_reaction_subject(subject_id, content, github_credentials, return_fields=None) async

Removes a reaction from a subject.

Parameters:

Name	Type	Description	Default
subject_id	str	The Node ID of the subject to modify.	required
content	ReactionContent	The name of the emoji reaction to remove.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/mutation/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/mutations.py

@task
async def remove_reaction_subject(  # noqa
    subject_id: str,
    content: graphql_schema.ReactionContent,
    github_credentials: GitHubCredentials,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Removes a reaction from a subject.

    Args:
        subject_id: The Node ID of the subject to modify.
        content: The name of the emoji reaction to remove.
        github_credentials: Credentials to use for authentication with GitHub.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.remove_reaction(
        **strip_kwargs(
            input=dict(
                subject_id=subject_id,
                content=content,
            )
        )
    ).subject(**strip_kwargs())

    op_stack = (
        "removeReaction",
        "subject",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["removeReaction"]["subject"]

remove_star_starrable(starrable_id, github_credentials, return_fields=None) async

Removes a star from a Starrable.

Parameters:

Name	Type	Description	Default
starrable_id	str	The Starrable ID to unstar.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/mutation/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/mutations.py

@task
async def remove_star_starrable(  # noqa
    starrable_id: str,
    github_credentials: GitHubCredentials,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Removes a star from a Starrable.

    Args:
        starrable_id: The Starrable ID to unstar.
        github_credentials: Credentials to use for authentication with GitHub.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.remove_star(
        **strip_kwargs(
            input=dict(
                starrable_id=starrable_id,
            )
        )
    ).starrable(**strip_kwargs())

    op_stack = (
        "removeStar",
        "starrable",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["removeStar"]["starrable"]

request_reviews(pull_request_id, user_ids, team_ids, github_credentials, union=None, return_fields=None) async

Set review requests on a pull request.

Parameters:

Name	Type	Description	Default
pull_request_id	str	The Node ID of the pull request to modify.	required
user_ids	Iterable[str]	The Node IDs of the user to request.	required
team_ids	Iterable[str]	The Node IDs of the team to request.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
union	Optional[bool]	Add users to the set rather than replace.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/mutation/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/mutations.py

@task
async def request_reviews(  # noqa
    pull_request_id: str,
    user_ids: Iterable[str],
    team_ids: Iterable[str],
    github_credentials: GitHubCredentials,
    union: Optional[bool] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Set review requests on a pull request.

    Args:
        pull_request_id: The Node ID of the pull request to modify.
        user_ids: The Node IDs of the user to request.
        team_ids: The Node IDs of the team to request.
        github_credentials: Credentials to use for authentication with GitHub.
        union: Add users to the set rather than replace.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.request_reviews(
        **strip_kwargs(
            input=dict(
                pull_request_id=pull_request_id,
                user_ids=user_ids,
                team_ids=team_ids,
                union=union,
            )
        )
    )

    op_stack = ("requestReviews",)
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["requestReviews"]

request_reviews_pull_request(pull_request_id, user_ids, team_ids, github_credentials, union=None, return_fields=None) async

Set review requests on a pull request.

Parameters:

Name	Type	Description	Default
pull_request_id	str	The Node ID of the pull request to modify.	required
user_ids	Iterable[str]	The Node IDs of the user to request.	required
team_ids	Iterable[str]	The Node IDs of the team to request.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
union	Optional[bool]	Add users to the set rather than replace.	None
return_fields	Optional[Iterable[str]]	Subset the return fields (as snake_case); defaults to fields listed in configs/mutation/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/mutations.py

@task
async def request_reviews_pull_request(  # noqa
    pull_request_id: str,
    user_ids: Iterable[str],
    team_ids: Iterable[str],
    github_credentials: GitHubCredentials,
    union: Optional[bool] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Set review requests on a pull request.

    Args:
        pull_request_id: The Node ID of the pull request to modify.
        user_ids: The Node IDs of the user to request.
        team_ids: The Node IDs of the team to request.
        github_credentials: Credentials to use for authentication with GitHub.
        union: Add users to the set rather than replace.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/mutation/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Mutation)
    op_selection = op.request_reviews(
        **strip_kwargs(
            input=dict(
                pull_request_id=pull_request_id,
                user_ids=user_ids,
                team_ids=team_ids,
                union=union,
            )
        )
    ).pull_request(**strip_kwargs())

    op_stack = (
        "requestReviews",
        "pullRequest",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["requestReviews"]["pullRequest"]