Module roctogen::models[][src]

Structs

ActionsBillingUsage
ActionsEnterprisePermissions
ActionsOrganizationPermissions
ActionsPublicKey

The public key used for setting Actions Secrets.

ActionsRepositoryPermissions
ActionsSecret

Set secrets for GitHub Actions.

ActionsbillingusageMinutesUsedBreakdown
Actor

Actor

AlertHtmlUrl

The GitHub URL of the alert resource.

AlertInstancesUrl

The REST API URL for fetching the list of instances for an alert.

AlertUrl

The REST API URL of the alert resource.

AllOfGistOwner
AllOfGistUser
AllOfapplicationGrantUser
AllOfauthorizationInstallation
AllOfauthorizationUser
AllOfbaseGistOwner
AllOfbaseGistUser
AllOfcheckRunApp
AllOfcheckSuiteApp
AllOfcommitAuthor
AllOfcommitCommentUser
AllOfcommitCommitAuthor
AllOfcommitCommitCommitter
AllOfcommitCommitter
AllOfcommitSearchResultItemAuthor
AllOfcommitSearchResultItemCommitter
AllOfcommitsearchresultitemCommitCommitter
AllOfcommunityprofileFilesCodeOfConduct
AllOfcommunityprofileFilesCodeOfConductFile
AllOfcommunityprofileFilesContributing
AllOfcommunityprofileFilesIssueTemplate
AllOfcommunityprofileFilesLicense
AllOfcommunityprofileFilesPullRequestTemplate
AllOfcommunityprofileFilesReadme
AllOfcontributorActivityAuthor
AllOfdeploymentCreator
AllOfdeploymentPerformedViaGithubApp
AllOfdeploymentSimplePerformedViaGithubApp
AllOfdeploymentStatusCreator
AllOfdeploymentStatusPerformedViaGithubApp
AllOffullRepositoryLicense
AllOffullRepositoryOrganization
AllOffullRepositoryTemplateRepository
AllOfgistCommentUser
AllOfgistCommitUser
AllOfinstallationSuspendedBy
AllOfissueAssignee
AllOfissueClosedBy
AllOfissueCommentPerformedViaGithubApp
AllOfissueCommentUser
AllOfissueEventActor
AllOfissueEventAssignee
AllOfissueEventAssigner
AllOfissueEventPerformedViaGithubApp
AllOfissueEventRequestedReviewer
AllOfissueEventReviewRequester
AllOfissueMilestone
AllOfissuePerformedViaGithubApp
AllOfissueSearchResultItemAssignee
AllOfissueSearchResultItemMilestone
AllOfissueSearchResultItemPerformedViaGithubApp
AllOfissueSearchResultItemUser
AllOfissueSimpleAssignee
AllOfissueSimpleMilestone
AllOfissueSimplePerformedViaGithubApp
AllOfissueSimpleUser
AllOfissueUser
AllOflicenseContentLicense
AllOfmigrationOwner
AllOfmilestoneCreator
AllOfminimalRepositoryOwner
AllOfminimalRepositoryTemplateRepository
AllOforgMembershipUser
AllOfpackageOwner
AllOfpackageRepository
AllOfpageBuildPusher
AllOfpersonalAccessTokenUser
AllOfprojectCardCreator
AllOfprojectCreator
AllOfpullRequestAssignee
AllOfpullRequestMergedBy
AllOfpullRequestMilestone
AllOfpullRequestReviewUser
AllOfpullRequestSimpleAssignee
AllOfpullRequestSimpleMilestone
AllOfpullRequestSimpleUser
AllOfpullRequestUser
AllOfpullrequestBaseRepoLicense
AllOfpullrequestsimpleHeadUser
AllOfreactionUser
AllOfreleaseAssetUploader
AllOfrepoSearchResultItemLicense
AllOfrepoSearchResultItemOwner
AllOfrepositoryCollaboratorPermissionUser
AllOfrepositoryInvitationInvitee
AllOfrepositoryInvitationInviter
AllOfrepositoryLicense
AllOfrepositoryOrganization
AllOfrepositoryOwner
AllOfreviewCommentUser
AllOfstargazerUser
AllOfteamDiscussionAuthor
AllOfteamDiscussionCommentAuthor
AllOfteamFullParent
AllOfteamParent
AllOfteamRepositoryLicense
AllOfteamRepositoryOwner
AllOfteamRepositoryTemplateRepository
AllOfworkflowRunHeadCommit
ApiOverview

Api Overview

ApioverviewSshKeyFingerprints
AppPermissions

The permissions granted to the user-to-server access token.

ApplicationGrant

The authorization associated with an OAuth Access.

ApplicationgrantApp
Artifact

An artifact

AuditLogEvent
AuthenticationToken

Authentication Token

Authorization

The authorization for an OAuth app, GitHub App, or a Personal Access Token.

AutoMerge

The status of auto merging a pull request.

BaseGist

Base Gist

BasegistFiles
BasicError

Basic Error

Blob

Blob

BranchProtection

Branch Protection

BranchRestrictionPolicy

Branch Restriction Policy

BranchShort

Branch Short

BranchWithProtection

Branch With Protection

BranchprotectionRequiredLinearHistory
BranchprotectionRequiredSignatures
BranchprotectionRequiredStatusChecks
BranchrestrictionpolicyApps
BranchrestrictionpolicyOwner
BranchrestrictionpolicyPermissions
BranchrestrictionpolicyTeams
BranchshortCommit
BranchwithprotectionLinks
CheckAnnotation

Check Annotation

CheckRun

A check performed on the code of a given code change

CheckSuite

A suite of checks performed on the code of a given code change

CheckSuitePreference

Check suite configuration preferences for a repository.

CheckrunCheckSuite
CheckrunOutput
ChecksuitepreferencePreferences
ChecksuitepreferencePreferencesAutoTriggerChecks
CloneTraffic

Clone Traffic

CodeOfConduct

Code Of Conduct

CodeOfConductSimple

Code of Conduct Simple

CodeScanningAlert
CodeScanningAlertEnvironment

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

CodeScanningAlertInstance
CodeScanningAlertItems
CodeScanningAlertLocation

Describe a region within a file for the alert.

CodeScanningAlertRule
CodeScanningAlertRuleSummary
CodeScanningAnalysis
CodeScanningAnalysisAnalysisKey

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

CodeScanningAnalysisCategory

Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code.

CodeScanningAnalysisCommitSha

The SHA of the commit to which the analysis you are uploading relates.

CodeScanningAnalysisDeletion

Successful deletion of a code scanning analysis

CodeScanningAnalysisEnvironment

Identifies the variable values associated with the environment in which this analysis was performed.

CodeScanningAnalysisSarifFile

A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see "SARIF support for code scanning."

CodeScanningAnalysisSarifId

An identifier for the upload.

CodeScanningAnalysisTool
CodeScanningAnalysisToolGuid

The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data.

CodeScanningAnalysisToolName

The name of the tool used to generate the code scanning analysis.

CodeScanningAnalysisToolVersion

The version of the tool used to generate the code scanning analysis.

CodeScanningAnalysisUrl

The REST API URL of the analysis resource.

CodeScanningRef

The full Git reference, formatted as refs/heads/<branch name>, refs/pull/<number>/merge, or refs/pull/<number>/head.

CodeScanningSarifsReceipt
CodeScanningSarifsStatus
CodeSearchResultItem

Code Search Result Item

CodescanningalertinstanceMessage
Collaborator

Collaborator

CollaboratorPermissions
CombinedBillingUsage
CombinedCommitStatus

Combined Commit Status

Commit

Commit

CommitActivity

Commit Activity

CommitComment

Commit Comment

CommitCommit
CommitCommitTree
CommitComparison

Commit Comparison

CommitFiles
CommitParents
CommitSearchResultItem

Commit Search Result Item

CommitStats
CommitsearchresultitemCommit
CommitsearchresultitemCommitAuthor
CommunityHealthFile
CommunityProfile

Community Profile

CommunityprofileFiles
ContainerMetadata
ContentFile

Content File

ContentReferenceAttachment

Content Reference attachments allow you to provide context around URLs posted in comments

ContentSubmodule

An object describing a symlink

ContentSymlink

An object describing a symlink

ContentTraffic

Content Traffic

ContentTree

Content Tree

ContentdirectoryInner
ContenttreeEntries
ContenttreeLinks
Contributor

Contributor

ContributorActivity

Contributor Activity

ContributoractivityWeeks
CredentialAuthorization

Credential Authorization

DeleteAppsDeleteAuthorization
DeleteAppsDeleteToken
DeleteIssuesRemoveAssignees
DeletePullsRemoveRequestedReviewers
DeleteReposDeleteFile
DeployKey

An SSH key granting access to a single repository.

Deployment

A request for a specific ref(branch,sha,tag) to be deployed

DeploymentBranchPolicy

The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.

DeploymentSimple

A deployment created as the result of an Actions check run from a workflow that references an environment

DeploymentStatus

The status of a deployment.

DiffEntry

Diff Entry

DockerMetadata
Email

Email

EmptyObject

An object without any properties.

Enterprise

An enterprise account

Environment

Details of a deployment environment

EnvironmentApprovals

An entry in the reviews log for environment deployments

EnvironmentapprovalsEnvironments
Event

Event

EventPayload
EventPayloadPages
EventRepo
Feed

Feed

FeedLinks
FileCommit

File Commit

FilecommitCommit
FilecommitCommitAuthor
FilecommitCommitParents
FilecommitCommitTree
FilecommitCommitVerification
FilecommitContent
FilecommitContentLinks
FullRepository

Full Repository

FullrepositoryPermissions
GetActionsListEnvironmentSecretsResponse200
GetActionsListJobsForWorkflowRunResponse200
GetActionsListOrgSecretsResponse200
GetActionsListRepoAccessToSelfHostedRunnerGroupInOrgResponse200
GetActionsListRepoWorkflowsResponse200
GetActionsListSelectedReposForOrgSecretResponse200
GetActionsListSelfHostedRunnerGroupsForOrgResponse200
GetActionsListSelfHostedRunnersForRepoResponse200
GetActionsListSelfHostedRunnersInGroupForOrgResponse200
GetActionsListWorkflowRunArtifactsResponse200
GetActionsListWorkflowRunsResponse200
GetAppsCheckAuthorizationResponse200
GetAppsListInstallationReposForAuthenticatedUserResponse200
GetAppsListInstallationsForAuthenticatedUserResponse200
GetAppsListReposAccessibleToInstallationResponse200
GetChecksListForRefResponse200
GetChecksListSuitesForRefResponse200
GetEnterpriseAdminListOrgAccessToSelfHostedRunnerGroupInEnterpriseResponse200
GetEnterpriseAdminListSelfHostedRunnerGroupsForEnterpriseResponse200
GetEnterpriseAdminListSelfHostedRunnersForEnterpriseResponse200
GetGistsGetCommentResponse403
GetMetaRootResponse200
GetReposGetAllEnvironmentsResponse200
GetSearchCodeResponse200
GetSearchCommitsResponse200
GetSearchIssuesAndPullRequestsResponse200
GetSearchLabelsResponse200
GetSearchReposResponse200
GetSearchTopicsResponse200
GetSearchUsersResponse200
GetSearchUsersResponse503
Gist

Gist

GistComment

A comment made to a gist.

GistCommit

Gist Commit

GistSimple

Gist Simple

GistcommitChangeStatus
GistsFiles
GistsgistIdFiles
GistsimpleFiles
GitCommit

Low-level Git commit operations within a repository

GitRef

Git references within a repository

GitTag

Metadata for a Git tag

GitTree

The hierarchy between files in a Git repository.

GitUser

Metaproperties for Git author/committer information.

GitcommitAuthor

Identifying information for the git-user

GitcommitParents
GitcommitTree
GitcommitVerification
GitignoreTemplate

Gitignore Template

GitrefObject
GittagObject
GittagTagger
GittreeTree
GpgKey

A unique encryption key

GpgkeyEmails
GpgkeySubkeys
GroupMapping

External Groups to be mapped to a team for membership

GroupmappingGroups
Hook

Webhooks for repositories.

HookConfig
HookResponse
Hovercard

Hovercard

HovercardContexts
Import

A repository import from an external source.

ImportProjectChoices
InlineResponse403Block
InlineResponse4032Errors
InlineResponse5031Errors
Installation

Installation

InstallationPermissions
InstallationToken

Authentication token for a GitHub App installed on a user or org.

InstallationtokenPermissions
Integration

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.

IntegrationPermissions

The set of permissions for the GitHub app

InteractionLimitResponse

Interaction limit settings.

Issue

Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.

IssueComment

Comments provide a way for people to collaborate on an issue.

IssueEvent

Issue Event

IssueEventDismissedReview
IssueEventForIssue

Issue Event for Issue

IssueEventLabel

Issue Event Label

IssueEventMilestone

Issue Event Milestone

IssueEventProjectCard

Issue Event Project Card

IssueEventRename

Issue Event Rename

IssueSearchResultItem

Issue Search Result Item

IssueSimple

Issue Simple

IssuesearchresultitemLabels
IssuesimplePullRequest
Job

Information of a job execution in a workflow run

JobSteps
Key

Key

KeySimple

Key Simple

Label

Color-coded labels help you categorize and filter your issues (just like labels in Gmail).

LabelSearchResultItem

Label Search Result Item

Language

Language

License

License

LicenseContent

License Content

LicenseSimple

License Simple

Link

Hypermedia Link

LinkWithType

Hypermedia Link with Type

MarketplaceAccount
MarketplaceListingPlan

Marketplace Listing Plan

MarketplacePurchase

Marketplace Purchase

MarketplacepurchaseMarketplacePendingChange
MarketplacepurchaseMarketplacePurchase
Migration

A migration.

Milestone

A collection of related issues and pull requests.

MinimalRepository

Minimal Repository

MinimalrepositoryLicense
OrgHook

Org Hook

OrgMembership

Org Membership

OrganizationActionsSecret

Secrets for GitHub Actions for an organization.

OrganizationFull

Organization Full

OrganizationInvitation

Organization Invitation

OrganizationSimple

Organization Simple

OrganizationfullPlan
OrghookConfig
OrgmembershipPermissions
OrgsorghooksConfig

Key/value pairs to provide settings for this webhook. These are defined below.

OrgsorghookshookIdConfig

Key/value pairs to provide settings for this webhook. These are defined below.

OrgsorgteamsteamSlugteamsyncgroupmappingsGroups
Package

A software package

PackageVersion

A version of a software package

PackageVersionMetadata
PackagesBillingUsage
Page

The configuration for GitHub Pages for a repository.

PageBuild

Page Build

PageBuildStatus

Page Build Status

PagebuildError
PagesHealthCheck

Pages Health Check Status

PagesHttpsCertificate
PagesSourceHash
PageshealthcheckDomain
ParticipationStats
PatchActionsUpdateSelfHostedRunnerGroupForOrg
PatchAppsResetToken
PatchAppsUpdateWebhookConfigForApp
PatchChecksSetSuitesPreferences
PatchCodeScanningUpdateAlert
PatchEnterpriseAdminUpdateAttributeForEnterpriseGroup
PatchEnterpriseAdminUpdateAttributeForEnterpriseUser
PatchEnterpriseAdminUpdateSelfHostedRunnerGroupForEnterprise
PatchGistsUpdateComment
PatchGitUpdateRef
PatchIssuesUpdate
PatchIssuesUpdateComment
PatchIssuesUpdateLabel
PatchIssuesUpdateMilestone
PatchMigrationsMapCommitAuthor
PatchMigrationsSetLfsPreference
PatchMigrationsUpdateImport
PatchOauthAuthorizationsUpdateAuthorization
PatchOrgsUpdate
PatchOrgsUpdateMembershipForAuthenticatedUser
PatchOrgsUpdateWebhook
PatchOrgsUpdateWebhookConfigForOrg
PatchProjectsUpdate
PatchProjectsUpdateCard
PatchProjectsUpdateColumn
PatchProjectsUpdateResponse403
PatchPullsUpdate
PatchPullsUpdateReviewComment
PatchReposUpdate
PatchReposUpdateCommitComment
PatchReposUpdateInvitation
PatchReposUpdatePullRequestReviewProtection
PatchReposUpdateRelease
PatchReposUpdateReleaseAsset
PatchReposUpdateStatusCheckProtection
PatchReposUpdateWebhook
PatchReposUpdateWebhookConfigForRepo
PatchScimUpdateAttributeForUser
PatchSecretScanningUpdateAlert
PatchTeamsCreateOrUpdateIdpGroupConnectionsInOrg
PatchTeamsCreateOrUpdateIdpGroupConnectionsLegacy
PatchTeamsUpdateDiscussionCommentInOrg
PatchTeamsUpdateDiscussionCommentLegacy
PatchTeamsUpdateDiscussionInOrg
PatchTeamsUpdateDiscussionLegacy
PatchTeamsUpdateInOrg
PatchTeamsUpdateLegacy
PatchUsersSetPrimaryEmailVisibilityForAuthenticated
PatchUsersUpdateAuthenticated
PendingDeployment

Details of a deployment that is waiting for protection rules to pass

PendingdeploymentEnvironment
PendingdeploymentReviewers
PersonalAccessToken

The authorization for a Personal Access Token.

PorterAuthor

Porter Author

PorterLargeFile

Porter Large File

PostActionsCreateSelfHostedRunnerGroupForOrg
PostActionsCreateWorkflowDispatch
PostActionsReviewPendingDeploymentsForRun
PostAppsCheckToken
PostAppsCreateContentAttachment
PostAppsCreateContentAttachmentResponse415
PostAppsCreateFromManifestResponse201
PostAppsCreateInstallationAccessToken
PostAppsScopeToken
PostChecksCreateSuite
PostCodeScanningUploadSarif
PostEnterpriseAdminCreateSelfHostedRunnerGroupForEnterprise
PostEnterpriseAdminProvisionAndInviteEnterpriseGroup
PostEnterpriseAdminProvisionAndInviteEnterpriseUser
PostGistsCreate
PostGistsCreateComment
PostGitCreateBlob
PostGitCreateCommit
PostGitCreateRef
PostGitCreateTag
PostGitCreateTree
PostIssuesAddAssignees
PostIssuesCreate
PostIssuesCreateComment
PostIssuesCreateLabel
PostIssuesCreateMilestone
PostMarkdownRender
PostMigrationsStartForAuthenticatedUser
PostMigrationsStartForOrg
PostOauthAuthorizationsCreateAuthorization
PostOrgsCreateInvitation
PostOrgsCreateWebhook
PostProjectsCreateCardResponse503
PostProjectsCreateColumn
PostProjectsCreateForAuthenticatedUser
PostProjectsCreateForOrg
PostProjectsCreateForRepo
PostProjectsMoveCard
PostProjectsMoveCardResponse403
PostProjectsMoveColumn
PostPullsCreate
PostPullsCreateReplyForReviewComment
PostPullsCreateReview
PostPullsCreateReviewComment
PostPullsSubmitReview
PostReactionsCreateForCommitComment
PostReactionsCreateForIssue
PostReactionsCreateForIssueComment
PostReactionsCreateForPullRequestReviewComment
PostReactionsCreateForRelease
PostReactionsCreateForTeamDiscussionCommentInOrg
PostReactionsCreateForTeamDiscussionCommentLegacy
PostReactionsCreateForTeamDiscussionInOrg
PostReactionsCreateForTeamDiscussionLegacy
PostReposCreateCommitComment
PostReposCreateCommitStatus
PostReposCreateDeployKey
PostReposCreateDeployment
PostReposCreateDeploymentResponse202
PostReposCreateDeploymentStatus
PostReposCreateDispatchEvent
PostReposCreateForAuthenticatedUser
PostReposCreateFork
PostReposCreateInOrg
PostReposCreatePagesSite

The source branch and directory used to publish your Pages site.

PostReposCreateRelease
PostReposCreateUsingTemplate
PostReposCreateWebhook
PostReposMerge
PostReposRenameBranch
PostReposTransfer
PostScimProvisionAndInviteUser
PostTeamsCreate
PostTeamsCreateDiscussionCommentInOrg
PostTeamsCreateDiscussionCommentLegacy
PostTeamsCreateDiscussionInOrg
PostTeamsCreateDiscussionLegacy
PostUsersCreateGpgKeyForAuthenticated
PostUsersCreatePublicSshKeyForAuthenticated
PrivateUser

Private User

PrivateuserPlan
Project

Projects are a way to organize columns and cards of work.

ProjectCard

Project cards represent a scope of work.

ProjectColumn

Project columns contain cards of work.

ProtectedBranch

Branch protections protect branches

ProtectedBranchAdminEnforced

Protected Branch Admin Enforced

ProtectedBranchPullRequestReview

Protected Branch Pull Request Review

ProtectedbranchEnforceAdmins
ProtectedbranchRequiredLinearHistory
ProtectedbranchRequiredPullRequestReviews
ProtectedbranchRequiredPullRequestReviewsDismissalRestrictions
ProtectedbranchpullrequestreviewDismissalRestrictions
PublicUser

Public User

PullRequest

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.

PullRequestMergeResult

Pull Request Merge Result

PullRequestMinimal
PullRequestReview

Pull Request Reviews are reviews on pull requests.

PullRequestReviewComment

Pull Request Review Comments are comments on a portion of the Pull Request’s diff.

PullRequestReviewRequest

Pull Request Review Request

PullRequestSimple

Pull Request Simple

PullrequestBase
PullrequestBaseRepo
PullrequestHead
PullrequestHeadRepo
PullrequestHeadRepoLicense
PullrequestHeadRepoOwner
PullrequestLabels
PullrequestminimalHead
PullrequestminimalHeadRepo
PullrequestreviewLinks
PullrequestreviewLinksHtml
PullrequestreviewcommentLinks
PullrequestreviewcommentLinksHtml
PullrequestreviewcommentLinksPullRequest
PullrequestreviewcommentLinksSelf
PullrequestsimpleHead
PullrequestsimpleLabels
PullrequestsimpleLinks
PutActionsCreateOrUpdateEnvironmentSecret
PutActionsCreateOrUpdateOrgSecret
PutActionsCreateOrUpdateRepoSecret
PutActionsSetAllowedActionsRepository
PutActionsSetGithubActionsPermissionsOrganization
PutActionsSetGithubActionsPermissionsRepository
PutActionsSetRepoAccessToSelfHostedRunnerGroupInOrg
PutActionsSetSelectedReposForOrgSecret
PutActionsSetSelectedRepositoriesEnabledGithubActionsOrganization
PutActionsSetSelfHostedRunnersInGroupForOrg
PutActivityMarkNotificationsAsRead
PutActivityMarkRepoNotificationsAsRead
PutActivitySetRepoSubscription
PutActivitySetThreadSubscription
PutEnterpriseAdminSetGithubActionsPermissionsEnterprise
PutEnterpriseAdminSetInformationForProvisionedEnterpriseGroup
PutEnterpriseAdminSetInformationForProvisionedEnterpriseUser
PutEnterpriseAdminSetOrgAccessToSelfHostedRunnerGroupInEnterprise
PutEnterpriseAdminSetSelectedOrganizationsEnabledGithubActionsEnterprise
PutEnterpriseAdminSetSelfHostedRunnersInGroupForEnterprise
PutInteractionsSetRestrictionsForAuthenticatedUser

Limit interactions to a specific type of user for a specified duration

PutIssuesLock
PutMigrationsStartImport
PutOauthAuthorizationsGetOrCreateAuthorizationForApp
PutOauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprint
PutOrgsSetMembershipForUser
PutProjectsAddCollaborator
PutPullsDismissReview
PutPullsMerge
PutPullsUpdateBranch
PutPullsUpdateBranchResponse202
PutPullsUpdateReview
PutReposAddCollaborator
PutReposCreateOrUpdateEnvironment
PutReposCreateOrUpdateFileContents
PutReposReplaceAllTopics
PutReposUpdateBranchProtection
PutScimSetInformationForProvisionedUser
PutTeamsAddOrUpdateMembershipForUserInOrg
PutTeamsAddOrUpdateMembershipForUserLegacy
PutTeamsAddOrUpdateProjectPermissionsInOrg
PutTeamsAddOrUpdateProjectPermissionsLegacy
PutTeamsAddOrUpdateProjectPermissionsLegacyResponse403
PutTeamsAddOrUpdateRepoPermissionsInOrg
PutTeamsAddOrUpdateRepoPermissionsLegacy
RateLimit
RateLimitOverview

Rate Limit Overview

RatelimitoverviewResources
Reaction

Reactions to conversations provide a way to help people express their feelings more simply and effectively.

ReactionRollup
ReferrerTraffic

Referrer Traffic

Release

A release.

ReleaseAsset

Data related to a release.

RepoSearchResultItem

Repo Search Result Item

Repository

A git repository

RepositoryCollaboratorPermission

Repository Collaborator Permission

RepositoryInvitation

Repository invitations let you manage who you collaborate with.

RepositoryPermissions
RepositorySubscription

Repository invitations let you manage who you collaborate with.

RepositoryTemplateRepository
RepositoryTemplateRepositoryOwner
RepositoryTemplateRepositoryPermissions
ReposownerrepobranchesbranchprotectionRequiredPullRequestReviews

Require at least one approving review on a pull request, before merging. Set to null to disable.

ReposownerrepobranchesbranchprotectionRequiredPullRequestReviewsDismissalRestrictions

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.

ReposownerrepobranchesbranchprotectionRequiredStatusChecks

Require status checks to pass before merging. Set to null to disable.

ReposownerrepobranchesbranchprotectionRestrictions

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.

ReposownerrepocheckrunsActions
ReposownerrepocheckrunsOutput

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.

ReposownerrepocheckrunsOutputAnnotations
ReposownerrepocheckrunsOutputImages
ReposownerrepocheckrunscheckRunIdOutput

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.

ReposownerrepochecksuitespreferencesAutoTriggerChecks
ReposownerrepocontentspathAuthor

The author of the file. Default: The committer or the authenticated user if you omit committer.

ReposownerrepocontentspathAuthor1

object containing information about the author.

ReposownerrepocontentspathCommitter

The person that committed the file. Default: the authenticated user.

ReposownerrepocontentspathCommitter1

object containing information about the committer.

ReposownerrepoenvironmentsenvironmentNameReviewers
ReposownerrepogitcommitsAuthor

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.

ReposownerrepogitcommitsCommitter

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.

ReposownerrepogittagsTagger

An object with information about the individual creating the tag.

ReposownerrepogittreesTree
ReposownerrepohooksConfig

Key/value pairs to provide settings for this webhook. These are defined below.

ReposownerrepohookshookIdConfig

Key/value pairs to provide settings for this webhook. These are defined below.

ReposownerrepoissuesissueNumberlabelsLabels
ReposownerrepopagesSource

The source branch and directory used to publish your Pages site.

ReposownerrepopullspullNumberreviewsComments
ReviewComment

Legacy Review Comment

ReviewcommentLinks
Runner

A self hosted runner

RunnerApplication

Runner Application

RunnerGroupsEnterprise
RunnerGroupsOrg
RunnerLabels
ScimEnterpriseGroup
ScimEnterpriseUser
ScimError

Scim Error

ScimGroupListEnterprise
ScimUser

SCIM /Users provisioning endpoints

ScimUserList

SCIM User List

ScimUserListEnterprise
ScimenterpriseuserEmails
ScimgrouplistenterpriseMembers
ScimgrouplistenterpriseMeta
ScimgrouplistenterpriseResources
ScimuserEmails
ScimuserGroups
ScimuserMeta
ScimuserName
ScimuserOperations
ScimuserlistenterpriseEmails
ScimuserlistenterpriseName
ScimuserlistenterpriseResources
Scimv2enterprisesenterpriseGroupsMembers
Scimv2enterprisesenterpriseGroupsscimGroupIdOperations
Scimv2enterprisesenterpriseUsersEmails
Scimv2enterprisesenterpriseUsersGroups
Scimv2enterprisesenterpriseUsersName
Scimv2organizationsorgUsersEmails
Scimv2organizationsorgUsersName
Scimv2organizationsorgUsersscimUserIdEmails
Scimv2organizationsorgUsersscimUserIdOperations
ScopedInstallation
SearchresulttextmatchesInner
SecretScanningAlert
SelectedActionsUrl

The API URL to use to get or set the actions that are allowed to run, when allowed_actions is set to selected.

ShortBlob

Short Blob

ShortBranch

Short Branch

ShortbranchCommit
SimpleCommit

Simple Commit

SimpleCommitStatus
SimpleUser

Simple User

SimplecommitAuthor
Stargazer

Stargazer

StarredRepository

Starred Repository

Status

The status of a commit.

StatusCheckPolicy

Status Check Policy

Tag

Tag

Team

Groups of organization members that gives permissions on specified repositories.

TeamDiscussion

A team discussion is a persistent record of a free-form conversation within a team.

TeamDiscussionComment

A reply to a discussion within a team.

TeamFull

Groups of organization members that gives permissions on specified repositories.

TeamMembership

Team Membership

TeamProject

A team’s access to a project.

TeamRepository

A team’s access to a repository.

TeamSimple

Groups of organization members that gives permissions on specified repositories.

TeamprojectPermissions
TeamsteamIdteamsyncgroupmappingsGroups
Thread

Thread

ThreadSubject
ThreadSubscription

Thread Subscription

Topic

A topic aggregates entities that are related to a subject.

TopicSearchResultItem

Topic Search Result Item

TopicsearchresultitemRelated
TopicsearchresultitemTopicRelation
Traffic
UserMarketplacePurchase

User Marketplace Purchase

UserSearchResultItem

User Search Result Item

ValidationError

Validation Error

ValidationErrorSimple

Validation Error Simple

ValidationerrorErrors
Verification
ViewTraffic

View Traffic

WebhookConfig

Configuration object of the webhook

WebhookConfigContentType

The media type used to serialize the payloads. Supported values include json and form. The default is form.

WebhookConfigSecret

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

WebhookConfigUrl

The URL to which the payloads will be delivered.

Workflow

A GitHub Actions workflow

WorkflowRun

An invocation of a workflow

WorkflowRunUsage

Workflow Run Usage

WorkflowUsage

Workflow Usage

WorkflowrunusageBillable
WorkflowrunusageBillableUbuntu
WorkflowusageBillable
WorkflowusageBillableUbuntu

Enums

AllowedActions

The permissions policy that controls the actions that are allowed to run. Can be one of: all, local_only, or selected. Enumeration of values. Since this enum’s variants do not hold data, we can easily define them them as #[repr(C)] which helps with FFI.

AuthorAssociation

How the author is associated with the repository. Enumeration of values. Since this enum’s variants do not hold data, we can easily define them them as #[repr(C)] which helps with FFI.

CodeScanningAlertClassification

A classification of the file. For example to identify it as generated. Enumeration of values. Since this enum’s variants do not hold data, we can easily define them them as #[repr(C)] which helps with FFI.

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. Enumeration of values. Since this enum’s variants do not hold data, we can easily define them them as #[repr(C)] which helps with FFI.

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. Enumeration of values. Since this enum’s variants do not hold data, we can easily define them them as #[repr(C)] which helps with FFI.

CodeScanningAlertState

State of a code scanning alert. Enumeration of values. Since this enum’s variants do not hold data, we can easily define them them as #[repr(C)] which helps with FFI.

DeleteReposRemoveAppAccessRestrictions
DeleteReposRemoveStatusCheckContexts
DeleteReposRemoveTeamAccessRestrictions
DeleteReposRemoveUserAccessRestrictions
DeleteUsersDeleteEmailForAuthenticated
DeploymentPayload
DeploymentReviewerType

The type of reviewer. Must be one of: User or Team Enumeration of values. Since this enum’s variants do not hold data, we can easily define them them as #[repr(C)] which helps with FFI.

EnabledOrganizations

The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: all, none, or selected. Enumeration of values. Since this enum’s variants do not hold data, we can easily define them them as #[repr(C)] which helps with FFI.

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. Enumeration of values. Since this enum’s variants do not hold data, we can easily define them them as #[repr(C)] which helps with FFI.

EnvironmentProtectionRulesItems
GetActivityListReposStarredByUserResponse200
GetActivityListStargazersForRepoResponse200
GetInteractionsGetRestrictionsForAuthenticatedUserResponse200
GetUsersGetByUsernameResponse200
InlineResponse20021
InstallationAccount
InteractionExpiry

The duration of the interaction restriction. Can be one of: one_day, three_days, one_week, one_month, six_months. Default: one_day. Enumeration of values. Since this enum’s variants do not hold data, we can easily define them them as #[repr(C)] which helps with FFI.

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. Enumeration of values. Since this enum’s variants do not hold data, we can easily define them them as #[repr(C)] which helps with FFI.

IssueLabelsItems
PatchChecksUpdate
PatchGistsUpdate
PatchIssuesUpdateLabelsItemsEnum
PatchIssuesUpdateMilestoneEnum
PatchIssuesUpdateTitleEnum
PendingdeploymentReviewersReviewer
PostChecksCreate
PostGistsCreatePublicEnum
PostIssuesAddLabels
PostIssuesCreateLabelsItemsEnum
PostIssuesCreateMilestoneEnum
PostIssuesCreateTitleEnum
PostProjectsCreateCard
PostProjectsCreateCardResponse422
PostPullsRequestReviewers
PostReposAddAppAccessRestrictions
PostReposAddStatusCheckContexts
PostReposAddTeamAccessRestrictions
PostReposAddUserAccessRestrictions
PostReposCreateDeploymentPayloadEnum
PostUsersAddEmailForAuthenticated
PutIssuesSetLabels
PutReposSetAppAccessRestrictions
PutReposSetStatusCheckContexts
PutReposSetTeamAccessRestrictions
PutReposSetUserAccessRestrictions
PutReposUpdateInformationAboutPagesSite
PutReposUpdateInformationAboutPagesSiteSourceEnum
ScimuserOperationsValue
Scimv2enterprisesenterpriseGroupsscimGroupIdOperationsValue
Scimv2organizationsorgUsersscimUserIdOperationsValue
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. Enumeration of values. Since this enum’s variants do not hold data, we can easily define them them as #[repr(C)] which helps with FFI.

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. Enumeration of values. Since this enum’s variants do not hold data, we can easily define them them as #[repr(C)] which helps with FFI.

ValidationerrorErrorsValue
WebhookConfigInsecureSsl
WorkflowId

Type Definitions

ActionsEnabled

Whether GitHub Actions is enabled on the repository.

AlertCreatedAt

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

AlertNumber

The security alert number.

CodeFrequencyStat

Code Frequency Stat

CodeScanningAlertDismissedAt

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

CodeScanningAnalysisCreatedAt

The time that the analysis was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

ContentDirectory

A list of directory items

SearchResultTextMatches
WaitTimer

The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).