Module octorust::types [−][src]
Expand description
The data types sent to and returned from the API client.
Structs
The public key used for setting Actions Secrets.
Set secrets for GitHub Actions.
Actor
Added to Project Issue Event
Api Overview
The permissions granted to the user-to-server access token.
The authorization associated with an OAuth Access.
An artifact
Assigned Issue Event
Authentication Token
The authorization for an OAuth app, GitHub App, or a Personal Access Token.
The status of auto merging a pull request.
Base Gist
Basic Error
Blob
Branch Protection
Branch Restriction Policy
Branch Short
Branch With Protection
Check Annotation
A check performed on the code of a given code change
A suite of checks performed on the code of a given code change
Check suite configuration preferences for a repository.
Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.
Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.
JSON payload with extra information about the webhook event that your action or worklow may use.
Clone Traffic
Code Of Conduct
Code of Conduct Simple
Describe a region within a file for the alert.
Successful deletion of a code scanning analysis
Code Search Result Item
Collaborator
Combined Commit Status
Commit Activity
Commit Comment
Commit Comparison
Commit
Commit Search Result Item
Community Profile
Content File
Content Reference attachments allow you to provide context around URLs posted in comments
An object describing a symlink
An object describing a symlink
Content Traffic
Content Tree
Contributor
Contributor Activity
Converted Note to Issue Issue Event
Credential Authorization
Demilestoned Issue Event
An SSH key granting access to a single repository.
A request for a specific ref(branch,sha,tag) to be deployed
The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.
A deployment created as the result of an Actions check run from a workflow that references an environment
The status of a deployment.
Diff Entry
An object without any properties.
An enterprise account
An entry in the reviews log for environment deployments
Details of a deployment environment
Event
Feed
File Commit
Gist
Full Repository
A comment made to a gist.
Gist Commit
Gist History
Gist Simple
Names and content for the files that make up the gist
Names of files to be updated
Low-level Git commit operations within a repository
Identifying information for the git-user
Information about the author of the commit. By default, the author will be the authenticated user and the current date. See the author and committer object below for details.
Information about the person who is making the commit. By default, committer will use the information set in author. See the author and committer object below for details.
An object with information about the individual creating the tag.
Git references within a repository
Metadata for a Git tag
The hierarchy between files in a Git repository.
Metaproperties for Git author/committer information.
Gitignore Template
A unique encryption key
External Groups to be mapped to a team for membership
Webhooks for repositories.
Hovercard
A repository import from an external source.
Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when inputs are omitted.
Installation
Authentication token for a GitHub App installed on a user or org.
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
Limit interactions to a specific type of user for a specified duration
Interaction limit settings.
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
Comments provide a way for people to collaborate on an issue.
Issue Event
Issue Event Label
Issue Event Milestone
Issue Event Project Card
Issue Event Rename
Issue Search Result Item
Issue Simple
Information of a job execution in a workflow run
Key
Key Simple
Color-coded labels help you categorize and filter your issues (just like labels in Gmail).
Label Search Result Item
Labeled Issue Event
Language
License Content
License
License Simple
Hypermedia Link
Hypermedia Link with Type
Locked Issue Event
Marketplace Listing Plan
Marketplace Purchase
A migration.
A collection of related issues and pull requests.
Milestoned Issue Event
Minimal Repository
Moved Column in Project Issue Event
Org Hook
Org Membership
Secrets for GitHub Actions for an organization.
Organization Full
Organization Invitation
Organization Simple
Key/value pairs to provide settings for this webhook. These are defined below.
Key/value pairs to provide settings for this webhook. These are defined below.
A software package
A version of a software package
The configuration for GitHub Pages for a repository.
Page Build
Page Build Status
Pages Health Check Status
Details of a deployment that is waiting for protection rules to pass
The set of permissions for the GitHub app
Porter Author
Porter Large File
Private User
Projects are a way to organize columns and cards of work.
Project cards represent a scope of work.
Project columns contain cards of work.
Branch protections protect branches
Protected Branch Admin Enforced
Protected Branch Pull Request Review
Public User
Pull requests let you tell others about changes you’ve pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.
Pull Request Merge Result
Pull Request Review Request
Pull Request Review Comments are comments on a portion of the Pull Request’s diff.
Pull Request Reviews are reviews on pull requests.
Pull Request Simple
Rate Limit Overview
Reactions to conversations provide a way to help people express their feelings more simply and effectively.
Referrer Traffic
A release.
Data related to a release.
Removed from Project Issue Event
Renamed Issue Event
Repo Search Result Item
The source branch and directory used to publish your Pages site.
The source branch and directory used to publish your Pages site.
The author of the file. Default: The committer or the authenticated user if you omit committer.
The person that committed the file. Default: the authenticated user.
Key/value pairs to provide settings for this webhook. These are defined below.
object containing information about the author.
object containing information about the committer.
Require at least one approving review on a pull request, before merging. Set to null to disable.
Specify which users and teams can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.
Require status checks to pass before merging. Set to null to disable.
Specify which security and analysis features to enable or disable. For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request: {"security_and_analysis": {"advanced_security": {"status": "enabled"}}}. If you have admin permissions for a private repository covered by an Advanced Security license, you can check which security and analysis features are currently enabled by using a GET /repos/{owner}/{repo} request.
Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see “About GitHub Advanced Security.”
Use the status property to enable or disable secret scanning for this repository. For more information, see “About secret scanning.”
Key/value pairs to provide settings for this webhook. These are defined below.
A git repository
Repository Collaborator Permission
Repository invitations let you manage who you collaborate with.
Repository invitations let you manage who you collaborate with.
Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.
Legacy Review Comment
Review Dismissed Issue Event
Review Request Removed Issue Event
Review Requested Issue Event
A self hosted runner
Runner Application
Scim Error
SCIM /Users provisioning endpoints
SCIM User List
Short Blob
Short Branch
Simple Commit
Simple User
Stargazer
Starred Repository
The status of a commit.
Status Check Policy
Tag
Groups of organization members that gives permissions on specified repositories.
A team discussion is a persistent record of a free-form conversation within a team.
A reply to a discussion within a team.
Groups of organization members that gives permissions on specified repositories.
Team Membership
A team’s access to a project.
A team’s access to a repository.
Groups of organization members that gives permissions on specified repositories.
Thread
Thread Subscription
Timeline Assigned Issue Event
Timeline Comment Event
Timeline Commit Commented Event
Timeline Committed Event
Timeline Cross Referenced Event
Timeline Event
Timeline Line Commented Event
Timeline Reviewed Event
Timeline Unassigned Issue Event
A topic aggregates entities that are related to a subject.
Topic Search Result Item
Unassigned Issue Event
Unlabeled Issue Event
User Marketplace Purchase
User Search Result Item
Deletes one or more email addresses from your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.
Validation Error
Validation Error Simple
View Traffic
Configuration object of the webhook
A GitHub Actions workflow
An invocation of a workflow
Workflow Run Usage
Workflow Usage
Enums
The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Can be one of: read or write.
Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. Can be one of: all, selected, or private.
Configures the access that repositories have to the organization secret. Can be one of:
- all - All repositories in an organization can access the secret.
- private - Private repositories in an organization can access the secret.
- selected - Only specific repositories can access the secret.
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.
Whether to approve or reject deployment to the specified environments. Must be one of: approved or rejected
Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. Can be one of: all, selected, or private.
The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. Can be one of: read or write.
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.
The permissions policy that controls the actions that are allowed to run. Can be one of: all, local_only, or selected.
The level of the annotation. Can be one of notice, warning, or failure.
To return the oldest accounts first, set to asc. Can be one of asc or desc. Ignored without the sort parameter.
Filters the project cards that are returned by the card’s state. Can be one of all,archived, or not_archived.
How the author is associated with the repository.
The phase of the lifecycle that the check is currently in.
The level of permission to grant the access token for checks on code. Can be one of: read or write.
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.
The current status. Can be one of queued, in_progress, or completed.
Filters check runs by their completed_at timestamp. Can be one of latest (returning the most recent check runs) or all.
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.
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.
A classification of the file. For example to identify it as generated.
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.
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.
State of a code scanning alert.
The reaction to use
The level of permission to grant the access token for notification of content references and creation content attachments. Can be one of: read or write.
The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. Can be one of: read or write.
Default permission level members have for organization repositories:
* read - can pull, but not push to or administer this repository.
* write - can pull and push, but not administer this repository.
* admin - can pull, push, and administer this repository.
* none - no permissions granted by default.
The type of reviewer. Must be one of: User or Team
The state of the status.
The level of permission to grant the access token for deployments and deployment statuses. Can be one of: read or write.
One of asc (ascending) or desc (descending).
The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: all, none, or selected.
The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: all, none, or selected.
Visibility of a runner group. You can select all organizations or select individual organization. Can be one of: all or selected
Visibility of a runner group. You can select all organizations or select individual organizations. Can be one of: all or selected
Whether deployment to the environment(s) was approved or rejected
The level of permission to grant the access token for managing repository environments. Can be one of: read or write.
Allowed values that can be passed to the exclude param.
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: All issues the authenticated user can see, regardless of participation or creation
The type of the object we’re tagging. Normally this is a commit but it can also be a tree or a blob.
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.
Either blob, tree, or commit.
The event types to include:
The duration of the interaction restriction. Can be one of: one_day, three_days, one_week, one_month, six_months. Default: one_day.
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.
The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. Can be one of: read or write.
One of the following types:
The state of the milestone. Either open or closed.
One of the following types:
Either asc or desc. Ignored without the sort parameter.
The direction of the sort. Either asc or desc.
What to sort results by. Either due_on or completeness.
The state of the milestone. Either open, closed, or all.
What to sort results by. Can be either created, updated, comments.
Indicates the state of the issues to return. Can be either open, closed, or all.
One of the following types:
State of the issue. Either open or closed.
The phase of the lifecycle that the job is currently in.
One of the following types:
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
The level of permission to grant the access token for organization teams and members. Can be one of: read or write.
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.
The merge method to use.
The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. Can be one of: read or write.
One of the following types:
The rendering mode.
The order of audit log events. To list newest events first, specify desc. To list oldest events first, specify asc.
Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.
The state of the member in the organization. The pending state indicates the user has not yet accepted an invitation.
The level of permission to grant the access token to manage access to an organization. Can be one of: read or write.
The level of permission to grant the access token to manage the post-receive hooks for an organization. Can be one of: read or write.
The level of permission to grant the access token for organization packages published to GitHub Packages. Can be one of: read or write.
The baseline permission that all organization members have on this project. Only present if owner is an organization.
The level of permission to grant the access token for viewing an organization’s plan. Can be one of: read.
The level of permission to grant the access token to manage organization projects, columns, and cards. Can be one of: read, write, or admin.
The level of permission to grant the access token to manage organization secrets. Can be one of: read or write.
The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Can be one of: read or write.
The level of permission to grant the access token to view and manage users blocked by the organization. Can be one of: read or write.
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.
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.
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.
Indicates the state of the memberships to return. Can be either active or pending. If not specified, the API returns both active and pending memberships.
Filter the list of outside collaborators. Can be one of:
* 2fa_disabled: Outside collaborators without two-factor authentication enabled.
* all: All outside collaborators.
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.
The state that the membership should be in. Only "active" will be accepted.
One of the following types:
The type of supported package. Can be one of npm, maven, rubygems, nuget, docker, or container. Packages in GitHub’s Gradle registry have the type maven. Docker images pushed to GitHub’s Container registry (ghcr.io) have the type container. You can use the type docker to find images that were pushed to GitHub’s Docker registry (docker.pkg.github.com), even if these have now been migrated to the Container registry.
The level of permission to grant the access token for packages published to GitHub Packages. Can be one of: read or write.
The state of the package, either active or deleted.
The status of the most recent build of the Page.
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.
The repository directory that includes the source files for the Pages site. Allowed paths are / or /docs. Default: /
One of the following types:
Must be one of: day, week.
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.
The level of privacy this team should have
pending files have not yet been processed, while complete means all results in the SARIF have been stored.
The permission to grant the collaborator.
One of the following types:
Indicates the state of the projects to return. Can be either open, closed, or all.
The baseline permission that all organization members have on this project
One of the following types:
State of this Pull Request. Either open or closed.
The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. Can be one of: read or write.
Required with comfort-fade preview. In a split diff view, the side of the diff that the pull request’s changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see “Diff view options” in the GitHub Help documentation.
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.
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.
The direction of the sort. Can be either asc or desc. Default: desc when sort is created or sort is not specified, otherwise asc.
Can be either asc or desc. Ignored without sort parameter.
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).
Either open, closed, or all to filter by state.
Merge method to use. Possible values are merge, squash or rebase. Default is merge.
The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. When you leave this blank, the API returns HTTP 422 (Unrecognizable entity) and sets the review action state to PENDING, which means you will need to re-submit the pull request review using a review action.
The reaction type to add to the commit comment.
The reaction type to add to the issue comment.
The reaction type to add to the issue.
The reaction type to add to the pull request review comment.
The reaction type to add to the release.
The reaction type to add to the team discussion comment.
The reaction type to add to the team discussion.
Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.
Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.
Returns a single reaction type. Omit this parameter to list all reactions to an issue.
Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.
Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
State of the release asset.
One of the following types:
The permission to grant the collaborator. Only valid on organization-owned repositories. Can be one of:
* pull - can pull, but not push to or administer this repository.
* push - can pull and push, but not administer this repository.
* admin - can pull, push and administer this repository.
* maintain - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions.
* triage - Recommended for contributors who need to proactively manage issues and pull requests without write access.
One of the following types:
One of the following types:
One of the following types:
The state of the status. Can be one of error, failure, pending, or success.
One of the following types:
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.
The state of the status. Can be one of error, failure, inactive, in_progress, queued pending, or success. Note: To use the inactive state, you must provide the application/vnd.github.ant-man-preview+json custom media type. To use the in_progress and queued states, you must provide the application/vnd.github.flash-preview+json custom media type. When you set a transient deployment to inactive, the deployment will be shown as destroyed in GitHub.
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.
One of the following types:
Filter collaborators returned by their affiliation. Can be one of:
* outside: All outside collaborators of an organization-owned repository.
* direct: All collaborators with permissions to an organization-owned repository, regardless of organization membership status.
* all: All collaborators the authenticated user can see.
Can be one of asc or desc. Default: asc when using full_name, otherwise desc
The sort order. Can be either newest, oldest, or stargazers.
Can be one of asc or desc. Default: when using full_name: asc, otherwise desc
Can be one of created, updated, pushed, full_name.
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.
Can be one of all, owner, public, private, member. Note: For GitHub AE, can be one of all, owner, internal, private, member. Default: all
Can be one of all, owner, member.
Can be one of all, public, or private. Note: For GitHub AE, can be one of all, internal, or private.
The permissions that the associated user will have on the repository. Valid values are read, write, maintain, triage, and admin.
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. The visibility parameter overrides the private parameter when you use both along with the nebula-preview preview header.
The level of permission to grant the access token to manage the post-receive hooks for a repository. Can be one of: read or write.
The permission associated with the invitation.
The level of permission to grant the access token to manage repository projects, columns, and cards. Can be one of: read, write, or admin.
Describe whether all repositories have been selected or there’s a selection involved
The user’s membership type in the organization.
One of the following types:
One of the following types:
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
Sorts the results of your query by author-date or committer-date. Default: best match
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
Sorts the results of your query by when the label was created or updated. Default: best match
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
Sorts the results of your query by number of followers or repositories, or when the person joined GitHub. Default: best match
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.
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.
The level of permission to grant the access token to view and manage secret scanning alerts. Can be one of: read or write.
Set to open or resolved to only list secret scanning alerts in a specific state.
The level of permission to grant the access token to manage repository secrets. Can be one of: read or write.
The level of permission to grant the access token to view and manage security events like code scanning alerts. Can be one of: read or write.
The security severity of the alert.
The severity of the alert.
The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment
The level of permission to grant the access token to manage just a single file. Can be one of: read or write.
One of created (when the repository was starred) or updated (when it was last pushed to).
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".
The side of the first line of the range for a multi-line comment.
The state of the milestone.
Returns check runs with the specified status. Can be one of queued, in_progress, or completed.
The level of permission to grant the access token for commit statuses. Can be one of: read or write.
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.
The level of permission to grant the access token to manage team discussions and related comments. Can be one of: read or write.
The role of the user in the team.
The state of the user’s membership in the team.
The role that this user should have in the team. Can be one of:
* member - a normal member of the team.
* maintainer - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team’s name and description.
The permission to grant to the team for this project. Can be one of:
* read - team members can read, but not write to or administer this project.
* write - team members can read and write, but not administer this project.
* admin - team members can read, write and administer this project.
Default: the team’s permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you’ll need to set Content-Length to zero when calling out to this endpoint. For more information, see “HTTP verbs.”
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.
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.
The level of privacy this team should have. The options are:
For a non-nested team:
* secret - only visible to organization owners and members of this team.
* closed - visible to all members of this organization.
Default: secret
For a parent or child team:
* closed - visible to all members of this organization.
Default for child team: closed
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.
The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
For a non-nested team:
* secret - only visible to organization owners and members of this team.
* closed - visible to all members of this organization.
For a parent or child team:
* closed - visible to all members of this organization.
The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are:
For a non-nested team:
* secret - only visible to organization owners and members of this team.
* closed - visible to all members of this organization.
For a parent or child team:
* closed - visible to all members of this organization.
One of the following types:
The type of label. Read-only labels are applied automatically when the runner is configured.
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).
One of the following types:
One of the following types:
One of the following types:
Denotes whether an email is publicly visible.
One of the following types:
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 of a secret
The level of permission to grant the access token to retrieve Dependabot alerts. Can be one of: read.
One of the following types:
One of the following types:
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.”
The level of permission to grant the access token to update GitHub Actions workflow files. Can be one of: write.