Module octorust::types

source ·
Expand description

The data types sent to and returned from the API client.

Structs

Enums

  • ActionsListJobsWorkflowRunFilter
    Filters jobs by their completed_at timestamp. Can be one of:
    * latest: Returns jobs from the most recent execution of the workflow run.
    * all: Returns all jobs for a workflow run, including from old executions of the workflow run.
  • Affiliation
    Filters the collaborators by their affiliation. Can be one of:
    * outside: Outside collaborators of a project that are not a member of the project’s organization.
    * direct: Collaborators with permissions to a project, regardless of organization membership status.
    * all: All collaborators the authenticated user can see.
  • AllowedActions
    The permissions policy that controls the actions that are allowed to run. Can be one of: all, local_only, or selected.
  • AnnotationLevel
    The level of the annotation. Can be one of notice, warning, or failure.
  • ArchivedState
    Filters the project cards that are returned by the card’s state. Can be one of all,archived, or not_archived.
  • AuthorAssociation
    How the author is associated with the repository.
  • ChecksCreateRequestConclusion
    Required if you provide completed_at or a status of completed. The final conclusion of the check. Can be one of action_required, cancelled, failure, neutral, success, skipped, stale, or timed_out. When the conclusion is action_required, additional details should be provided on the site specified by details_url.
    Note: Providing conclusion will automatically set the status parameter to completed. You cannot change a check run conclusion to stale, only GitHub can set this.
  • CodeScanningAlertClassification
    A classification of the file. For example to identify it as generated.
  • CodeScanningAlertDismissedReason
    Required when the state is dismissed. The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.
  • CodeScanningAlertSetState
    Sets the state of the code scanning alert. Can be one of open or dismissed. You must provide dismissed_reason when you set the state to dismissed.
  • CodeScanningAlertState
    State of a code scanning alert.
  • CommitComparisonStatus
  • Conclusion
  • Content
    The reaction to use
  • DeploymentReviewerType
    The type of reviewer. Must be one of: User or Team
  • DeploymentStatusState
    The state of the status.
  • EnabledRepositories
    The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: all, none, or selected.
  • EnterpriseAdminUpdateAttributeGroupRequestOperationsOp
  • EnvironmentApprovalState
    Whether deployment to the environment(s) was approved or rejected
  • Exclude
    Allowed values that can be passed to the exclude param.
  • Filter
    Indicates which sorts of issues to return. Can be one of:
    * assigned: Issues assigned to you
    * created: Issues created by you
    * mentioned: Issues mentioning you
    * subscribed: Issues you’re subscribed to updates for
    * all or repos: All issues the authenticated user can see, regardless of participation or creation
  • GitCreateTagRequestType
    The type of the object we’re tagging. Normally this is a commit but it can also be a tree or a blob.
  • GitCreateTreeRequestMode
    The file mode; one of 100644 for file (blob), 100755 for executable (blob), 040000 for subdirectory (tree), 160000 for submodule (commit), or 120000 for a blob that specifies the path of a symlink.
  • ImportStatus
  • Include
    The event types to include:
  • InteractionExpiry
    The duration of the interaction restriction. Can be one of: one_day, three_days, one_week, one_month, six_months. Default: one_day.
  • InteractionGroup
    The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Can be one of: existing_users, contributors_only, collaborators_only.
  • IssuesAddLabelsRequestOneOf
    All of the following types:
  • IssuesCreateRequestLabelsOneOf
    All of the following types:
  • IssuesListMilestonesSort
    What to sort results by. Either due_on or completeness.
  • IssuesListSort
    What to sort results by. Can be either created, updated, comments.
  • IssuesListState
    Indicates the state of the issues to return. Can be either open, closed, or all.
  • JobStatus
    The phase of the lifecycle that the job is currently in.
  • LabelsOneOf
    All of the following types:
  • LockReason
    The reason for locking the issue or pull request conversation. Lock will fail if you don’t use one of these reasons:
    * off-topic
    * too heated
    * resolved
    * spam
  • MembersAllowedRepositoryCreationType
    Specifies which types of repositories non-admin organization members can create. Can be one of:
    * all - all organization members can create public and private repositories.
    * private - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud.
    * none - only admin members can create repositories.
    Note: This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in members_can_create_repositories. See the parameter deprecation notice in the operation description for details.
  • MergeMethod
    The merge method to use.
  • Mode
    The rendering mode.
  • Op
  • Order
    The order of audit log events. To list newest events first, specify desc. To list oldest events first, specify asc.
  • OrgMembershipState
    The state of the member in the organization. The pending state indicates the user has not yet accepted an invitation.
  • OrganizationPermission
    The baseline permission that all organization members have on this project. Only present if owner is an organization.
  • OrganizationPlan
    The level of permission to grant the access token for viewing an organization’s plan. Can be one of: read.
  • OrgsCreateInvitationRequestRole
    Specify role for new member. Can be one of:
    * admin - Organization owners with full administrative rights to the organization and complete access to all repositories and teams.
    * direct_member - Non-owner organization members with ability to see other members and join teams by invitation.
    * billing_manager - Non-owner organization members with ability to manage the billing settings of your organization.
  • OrgsListMembersFilter
    Filter members returned in the list. Can be one of:
    * 2fa_disabled - Members without two-factor authentication enabled. Available for organization owners.
    * all - All members the authenticated user can see.
  • OrgsListMembersRole
    Filter members returned by their role. Can be one of:
    * all - All members of the organization, regardless of role.
    * admin - Organization owners.
    * member - Non-owner organization members.
  • OrgsSetMembershipUserRequestRole
    The role to give the user in the organization. Can be one of:
    * admin - The user will become an owner of the organization.
    * member - The user will become a non-owner member of the organization.
  • OrgsUpdateMembershipRequestState
    The state that the membership should be in. Only "active" will be accepted.
  • OrgsUpdateResponseOneOf
    All of the following types:
  • PackageType
  • PackageVisibility
  • PackagesGetAllPackageVersionsOwnedByOrgState
    The state of the package, either active or deleted.
  • PageStatus
    The status of the most recent build of the Page.
  • Pages
    The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Can be one of: read or write.
  • PagesHttpsCertificateState
  • Path
    The repository directory that includes the source files for the Pages site. Allowed paths are / or /docs. Default: /
  • PayloadOneOf
    All of the following types:
  • Per
    Must be one of: day, week.
  • Permission
    Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of:
    * pull - team members can pull, but not push to or administer newly-added repositories.
    * push - team members can pull and push, but not administer newly-added repositories.
    * admin - team members can pull, push and administer newly-added repositories.
  • Privacy
    The level of privacy this team should have
  • ProcessingStatus
    pending files have not yet been processed, while complete means all results in the SARIF have been stored.
  • ProjectsCreateCardRequestOneOf
    All of the following types:
  • Public
  • PublicOneOf
    All of the following types:
  • PullsCreateReviewCommentRequestStartSide
    Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see “Commenting on a pull request” in the GitHub Help documentation. See side in this table for additional context.
  • PullsCreateReviewRequestEvent
    The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.
  • PullsListReviewCommentsRepoSort
  • PullsListSort
    What to sort results by. Can be either created, updated, popularity (comment count) or long-running (age, filtering by pulls updated in the last month).
  • ReactionsCreateReleaseRequestContent
    The reaction type to add to the release.
  • ReleaseAssetState
    State of the release asset.
  • ReposAddAppAccessRestrictionsRequestOneOf
    All of the following types:
  • ReposAddStatusCheckContextsRequestOneOf
    All of the following types:
  • ReposAddTeamAccessRestrictionsRequestOneOf
    All of the following types:
  • ReposAddUserAccessRestrictionsRequestOneOf
    All of the following types:
  • ReposCreateCommitStatusRequestState
    The state of the status. Can be one of error, failure, pending, or success.
  • ReposCreateDeploymentStatusRequestEnvironment
    Name for the target deployment environment, which can be changed when setting a deploy status. For example, production, staging, or qa. Note: This parameter requires you to use the application/vnd.github.flash-preview+json custom media type.
  • ReposCreateInOrgRequestVisibility
    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see “Creating an internal repository” in the GitHub Help documentation.
    The visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.
  • ReposGetContentResponseOneOf
    All of the following types:
  • ReposListForksSort
    The sort order. Can be either newest, oldest, or stargazers.
  • ReposListOrgSort
    Can be one of created, updated, pushed, full_name.
  • ReposListOrgType
    Specifies the types of repositories you want returned. Can be one of all, public, private, forks, sources, member, internal. Note: For GitHub AE, can be one of all, private, forks, sources, member, internal. Default: all. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, type can also be internal. However, the internal value is not yet supported when a GitHub App calls this API with an installation access token.
  • ReposListType
    Can be one of all, owner, public, private, member. Note: For GitHub AE, can be one of all, owner, internal, private, member. Default: all
  • ReposListUserType
    Can be one of all, owner, member.
  • ReposListVisibility
    Can be one of all, public, or private. Note: For GitHub AE, can be one of all, internal, or private.
  • RepositoryInvitationPermissions
    The permission associated with the invitation.
  • RepositoryProjects
    The level of permission to grant the access token to manage repository projects, columns, and cards. Can be one of: read, write, or admin.
  • RepositorySelection
    Describe whether all repositories have been selected or there’s a selection involved
  • Role
    The user’s membership type in the organization.
  • ScimUpdateAttributeUserRequestOperationsValueOneOf
    All of the following types:
  • ScimUserOperationsValueOneOf
    All of the following types:
  • SearchCodeSort
    Sorts the results of your query. Can only be indexed, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: best match
  • SearchCommitsSort
    Sorts the results of your query by author-date or committer-date. Default: best match
  • SearchIssuesPullRequestsSort
    Sorts the results of your query by the number of comments, reactions, reactions-+1, reactions--1, reactions-smile, reactions-thinking_face, reactions-heart, reactions-tada, or interactions. You can also sort results by how recently the items were created or updated, Default: best match
  • SearchReposSort
    Sorts the results of your query by number of stars, forks, or help-wanted-issues or how recently the items were updated. Default: best match
  • SearchUsersSort
    Sorts the results of your query by number of followers or repositories, or when the person joined GitHub. Default: best match
  • SecretScanningAlertResolution
    Required when the state is resolved. The reason for resolving the alert. Can be one of false_positive, wont_fix, revoked, or used_in_tests.
  • SecretScanningAlertState
    Sets the state of the secret scanning alert. Can be either open or resolved. You must provide resolution when you set the state to resolved.
  • SecuritySeverityLevel
    The security severity of the alert.
  • Severity
    The severity of the alert.
  • Side
    The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment
  • Sort
    One of created (when the repository was starred) or updated (when it was last pushed to).
  • SourceData
    Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory /docs. Possible values are "gh-pages", "master", and "master /docs".
  • State
    The state of the milestone.
  • Status
  • SubjectType
    Identifies which additional information you’d like to receive about the person’s hovercard. Can be organization, repository, issue, pull_request. Required when using subject_id.
  • TeamMembershipRole
    The role of the user in the team.
  • TeamsAddUpdateRepoPermissionsInOrgRequestPermission
    The permission to grant the team on this repository. Can be one of:
    * pull - team members can pull, but not push to or administer this repository.
    * push - team members can pull and push, but not administer this repository.
    * admin - team members can pull, push and administer this repository.
    * maintain - team members can manage the repository without access to sensitive or destructive actions. Recommended for project managers. Only applies to repositories owned by organizations.
    * triage - team members can proactively manage issues and pull requests without write access. Recommended for contributors who triage a repository. Only applies to repositories owned by organizations.
  • TeamsListMembersInOrgRole
    Filters members returned by their role in the team. Can be one of:
    * member - normal members of the team.
    * maintainer - team maintainers.
    * all - all members of the team.
  • TitleOneOf
    All of the following types:
  • Type
    The type of label. Read-only labels are applied automatically when the runner is configured.
  • UseLfs
    Can be one of opt_in (large files will be stored using Git LFS) or opt_out (large files will be removed during the import).
  • UsersAddEmailAuthenticatedRequestOneOf
    All of the following types:
  • UsersGetByUsernameResponseOneOf
    All of the following types:
  • ValueOneOf
    All of the following types:
  • Vcs
    The originating VCS type. Can be one of subversion, git, mercurial, or tfvc. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.
  • Visibility
    Visibility of a secret
  • WebhookConfigInsecureSslOneOf
    All of the following types:
  • WorkflowRunStatus
    Returns workflow runs with the check run status or conclusion that you specify. For example, a conclusion can be success or a status can be in_progress. Only GitHub can set a status of waiting or requested. For a list of the possible status and conclusion options, see “Create a check run.”
  • WorkflowState
  • Workflows
    The level of permission to grant the access token to update GitHub Actions workflow files. Can be one of: write.