Enums represent possible sets of values for a field.
The actor’s type.
| Value | Description |
|---|---|
| TEAM | Indicates a team actor. |
| USER | Indicates a user actor. |
Properties by which Audit Log connections can be ordered.
| Value | Description |
|---|---|
| CREATED_AT | Order audit log entries by timestamp |
Represents an annotation’s information level.
| Value | Description |
|---|---|
| FAILURE | An annotation indicating an inescapable error. |
| NOTICE | An annotation indicating some information. |
| WARNING | An annotation indicating an ignorable error. |
The possible states for a check suite or run conclusion.
| Value | Description |
|---|---|
| ACTION_REQUIRED | The check suite or run requires action. |
| CANCELLED | The check suite or run has been cancelled. |
| FAILURE | The check suite or run has failed. |
| NEUTRAL | The check suite or run was neutral. |
| SKIPPED | The check suite or run was skipped. |
| STALE | The check suite or run was marked stale by GitHub. Only GitHub can use this conclusion. |
| STARTUP_FAILURE | The check suite or run has failed at startup. |
| SUCCESS | The check suite or run has succeeded. |
| TIMED_OUT | The check suite or run has timed out. |
The possible types of check runs.
| Value | Description |
|---|---|
| ALL | Every check run available. |
| LATEST | The latest check run. |
The possible states for a check suite or run status.
| Value | Description |
|---|---|
| COMPLETED | The check suite or run has been completed. |
| IN_PROGRESS | The check suite or run is in progress. |
| PENDING | The check suite or run is in pending state. |
| QUEUED | The check suite or run has been queued. |
| REQUESTED | The check suite or run has been requested. |
| WAITING | The check suite or run is in waiting state. |
Collaborators affiliation level with a subject.
| Value | Description |
|---|---|
| ALL | All collaborators the authenticated user can see. |
| DIRECT | All collaborators with permissions to an organization-owned subject, regardless of organization membership status. |
| OUTSIDE | All outside collaborators of an organization-owned subject. |
A comment author association with repository.
| Value | Description |
|---|---|
| COLLABORATOR | Author has been invited to collaborate on the repository. |
| CONTRIBUTOR | Author has previously committed to the repository. |
| FIRST_TIMER | Author has not previously committed to GitHub. |
| FIRST_TIME_CONTRIBUTOR | Author has not previously committed to the repository. |
| MANNEQUIN | Author is a placeholder for an unclaimed user. |
| MEMBER | Author is a member of the organization that owns the repository. |
| NONE | Author has no association with the repository. |
| OWNER | Author is the owner of the repository. |
The possible errors that will prevent a user from updating a comment.
| Value | Description |
|---|---|
| ARCHIVED | Unable to create comment because repository is archived. |
| DENIED | You cannot update this comment |
| INSUFFICIENT_ACCESS | You must be the author or have write access to this repository to update this comment. |
| LOCKED | Unable to create comment because issue is locked. |
| LOGIN_REQUIRED | You must be logged in to update this comment. |
| MAINTENANCE | Repository is under maintenance. |
| VERIFIED_EMAIL_REQUIRED | At least one email address must be verified to update this comment. |
Properties by which commit contribution connections can be ordered.
| Value | Description |
|---|---|
| COMMIT_COUNT | Order commit contributions by how many commits they represent. |
| OCCURRED_AT | Order commit contributions by when they were made. |
Varying levels of contributions from none to many.
| Value | Description |
|---|---|
| FIRST_QUARTILE | Lowest 25% of days of contributions. |
| FOURTH_QUARTILE | Highest 25% of days of contributions. More contributions than the third quartile. |
| NONE | No contributions occurred. |
| SECOND_QUARTILE | Second lowest 25% of days of contributions. More contributions than the first quartile. |
| THIRD_QUARTILE | Second highest 25% of days of contributions. More contributions than second quartile, less than the fourth quartile. |
The possible base permissions for repositories.
| Value | Description |
|---|---|
| ADMIN | Can read, write, and administrate repos by default |
| NONE | No access |
| READ | Can read repos by default |
| WRITE | Can read and write repos by default |
The possible ecosystems of a dependency graph package.
| Value | Description |
|---|---|
| ACTIONS | GitHub Actions |
| COMPOSER | PHP packages hosted at packagist.org |
| GO | Go modules |
| MAVEN | Java artifacts hosted at the Maven central repository |
| NPM | JavaScript packages hosted at npmjs.com |
| NUGET | .NET packages hosted at the NuGet Gallery |
| PIP | Python packages hosted at PyPI.org |
| RUBYGEMS | Ruby gems hosted at RubyGems.org |
Properties by which deployment connections can be ordered.
| Value | Description |
|---|---|
| CREATED_AT | Order collection by creation time |
The possible protection rule types.
| Value | Description |
|---|---|
| REQUIRED_REVIEWERS | Required reviewers |
| WAIT_TIMER | Wait timer |
The possible states for a deployment review.
| Value | Description |
|---|---|
| APPROVED | The deployment was approved. |
| REJECTED | The deployment was rejected. |
The possible states in which a deployment can be.
| Value | Description |
|---|---|
| ABANDONED | The pending deployment was not updated after 30 minutes. |
| ACTIVE | The deployment is currently active. |
| DESTROYED | An inactive transient deployment. |
| ERROR | The deployment experienced an error. |
| FAILURE | The deployment has failed. |
| INACTIVE | The deployment is inactive. |
| IN_PROGRESS | The deployment is in progress. |
| PENDING | The deployment is pending. |
| QUEUED | The deployment has queued |
| WAITING | The deployment is waiting. |
The possible states for a deployment status.
| Value | Description |
|---|---|
| ERROR | The deployment experienced an error. |
| FAILURE | The deployment has failed. |
| INACTIVE | The deployment is inactive. |
| IN_PROGRESS | The deployment is in progress. |
| PENDING | The deployment is pending. |
| QUEUED | The deployment is queued |
| SUCCESS | The deployment was successful. |
| WAITING | The deployment is waiting. |
The possible sides of a diff.
| Value | Description |
|---|---|
| LEFT | The left side of the diff. |
| RIGHT | The right side of the diff. |
Properties by which discussion connections can be ordered.
| Value | Description |
|---|---|
| CREATED_AT | Order discussions by creation time. |
| UPDATED_AT | Order discussions by most recent modification time. |
The possible reasons that a Dependabot alert was dismissed.
| Value | Description |
|---|---|
| FIX_STARTED | A fix has already been started |
| INACCURATE | This alert is inaccurate or incorrect |
| NOT_USED | Vulnerable code is not actually used |
| NO_BANDWIDTH | No bandwidth to fix this |
| TOLERABLE_RISK | Risk is tolerable to this project |
Properties by which enterprise administrator invitation connections can be ordered.
| Value | Description |
|---|---|
| CREATED_AT | Order enterprise administrator member invitations by creation time |
The possible administrator roles in an enterprise account.
| Value | Description |
|---|---|
| BILLING_MANAGER | Represents a billing manager of the enterprise account. |
| OWNER | Represents an owner of the enterprise account. |
The possible values for the enterprise base repository permission setting.
| Value | Description |
|---|---|
| ADMIN | Organization members will be able to clone, pull, push, and add new collaborators to all organization repositories. |
| NONE | Organization members will only be able to clone and pull public repositories. |
| NO_POLICY | Organizations in the enterprise choose base repository permissions for their members. |
| READ | Organization members will be able to clone and pull all organization repositories. |
| WRITE | Organization members will be able to clone, pull, and push all organization repositories. |
The possible values for an enabled/disabled enterprise setting.
| Value | Description |
|---|---|
| DISABLED | The setting is disabled for organizations in the enterprise. |
| ENABLED | The setting is enabled for organizations in the enterprise. |
| NO_POLICY | There is no policy set for organizations in the enterprise. |
The possible values for an enabled/no policy enterprise setting.
| Value | Description |
|---|---|
| ENABLED | The setting is enabled for organizations in the enterprise. |
| NO_POLICY | There is no policy set for organizations in the enterprise. |
Properties by which enterprise member connections can be ordered.
| Value | Description |
|---|---|
| CREATED_AT | Order enterprise members by creation time |
| LOGIN | Order enterprise members by login |
The possible values for the enterprise members can create repositories setting.
| Value | Description |
|---|---|
| ALL | Members will be able to create public and private repositories. |
| DISABLED | Members will not be able to create public or private repositories. |
| NO_POLICY | Organization administrators choose whether to allow members to create repositories. |
| PRIVATE | Members will be able to create only private repositories. |
| PUBLIC | Members will be able to create only public repositories. |
The possible values for the members can make purchases setting.
| Value | Description |
|---|---|
| DISABLED | The setting is disabled for organizations in the enterprise. |
| ENABLED | The setting is enabled for organizations in the enterprise. |
Properties by which Enterprise Server installation connections can be ordered.
| Value | Description |
|---|---|
| CREATED_AT | Order Enterprise Server installations by creation time |
| CUSTOMER_NAME | Order Enterprise Server installations by customer name |
| HOST_NAME | Order Enterprise Server installations by host name |
Properties by which Enterprise Server user account email connections can be ordered.
| Value | Description |
|---|---|
Order emails by email |
Properties by which Enterprise Server user account connections can be ordered.
| Value | Description |
|---|---|
| LOGIN | Order user accounts by login |
| REMOTE_CREATED_AT | Order user accounts by creation time on the Enterprise Server installation |
Properties by which Enterprise Server user accounts upload connections can be ordered.
| Value | Description |
|---|---|
| CREATED_AT | Order user accounts uploads by creation time |
Synchronization state of the Enterprise Server user accounts upload
| Value | Description |
|---|---|
| FAILURE | The synchronization of the upload failed. |
| PENDING | The synchronization of the upload is pending. |
| SUCCESS | The synchronization of the upload succeeded. |
The possible roles for enterprise membership.
| Value | Description |
|---|---|
| MEMBER | The user is a member of the enterprise membership. |
| OWNER | The user is an owner of the enterprise membership. |
The possible GitHub Enterprise deployments where this user can exist.
| Value | Description |
|---|---|
| CLOUD | The user is part of a GitHub Enterprise Cloud deployment. |
| SERVER | The user is part of a GitHub Enterprise Server deployment. |
The possible viewed states of a file .
| Value | Description |
|---|---|
| DISMISSED | The file has new changes since last viewed. |
| UNVIEWED | The file has not been marked as viewed. |
| VIEWED | The file has been marked as viewed. |
The possible funding platforms for repository funding links.
| Value | Description |
|---|---|
| COMMUNITY_BRIDGE | Community Bridge funding platform. |
| CUSTOM | Custom funding platform. |
| GITHUB | GitHub funding platform. |
| ISSUEHUNT | IssueHunt funding platform. |
| KO_FI | Ko-fi funding platform. |
| LFX_CROWDFUNDING | LFX Crowdfunding funding platform. |
| LIBERAPAY | Liberapay funding platform. |
| OPEN_COLLECTIVE | Open Collective funding platform. |
| OTECHIE | Otechie funding platform. |
| PATREON | Patreon funding platform. |
| TIDELIFT | Tidelift funding platform. |
Properties by which gist connections can be ordered.
| Value | Description |
|---|---|
| CREATED_AT | Order gists by creation time |
| PUSHED_AT | Order gists by push time |
| UPDATED_AT | Order gists by update time |
The privacy of a Gist
| Value | Description |
|---|---|
| ALL | Gists that are public and secret |
| PUBLIC | Public |
| SECRET | Secret |
The state of a Git signature.
| Value | Description |
|---|---|
| BAD_CERT | The signing certificate or its chain could not be verified |
| BAD_EMAIL | Invalid email used for signing |
| EXPIRED_KEY | Signing key expired |
| GPGVERIFY_ERROR | Internal error - the GPG verification service misbehaved |
| GPGVERIFY_UNAVAILABLE | Internal error - the GPG verification service is unavailable at the moment |
| INVALID | Invalid signature |
| MALFORMED_SIG | Malformed signature |
| NOT_SIGNING_KEY | The usage flags for the key that signed this don’t allow signing |
| NO_USER | Email used for signing not known to GitHub |
| OCSP_ERROR | Valid signature, though certificate revocation check failed |
| OCSP_PENDING | Valid signature, pending certificate revocation checking |
| OCSP_REVOKED | One or more certificates in chain has been revoked |
| UNKNOWN_KEY | Key used for signing not known to GitHub |
| UNKNOWN_SIG_TYPE | Unknown signature type |
| UNSIGNED | Unsigned |
| UNVERIFIED_EMAIL | Email used for signing unverified on GitHub |
| VALID | Valid signature and verified by GitHub |
The possible states in which authentication can be configured with an identity provider.
| Value | Description |
|---|---|
| CONFIGURED | Authentication with an identity provider is configured but not enforced. |
| ENFORCED | Authentication with an identity provider is configured and enforced. |
| UNCONFIGURED | Authentication with an identity provider is not configured. |
The possible values for the IP allow list enabled setting.
| Value | Description |
|---|---|
| DISABLED | The setting is disabled for the owner. |
| ENABLED | The setting is enabled for the owner. |
Properties by which IP allow list entry connections can be ordered.
| Value | Description |
|---|---|
| ALLOW_LIST_VALUE | Order IP allow list entries by the allow list value. |
| CREATED_AT | Order IP allow list entries by creation time. |
The possible values for the IP allow list configuration for installed GitHub Apps setting.
| Value | Description |
|---|---|
| DISABLED | The setting is disabled for the owner. |
| ENABLED | The setting is enabled for the owner. |
Properties by which issue comment connections can be ordered.
| Value | Description |
|---|---|
| UPDATED_AT | Order issue comments by update time |
Properties by which issue connections can be ordered.
| Value | Description |
|---|---|
| COMMENTS | Order issues by comment count |
| CREATED_AT | Order issues by creation time |
| UPDATED_AT | Order issues by update time |
The possible states of an issue.
| Value | Description |
|---|---|
| CLOSED | An issue that has been closed |
| OPEN | An issue that is still open |
The possible item types found in a timeline.
| Value | Description |
|---|---|
| ADDED_TO_PROJECT_EVENT | Represents a ‘added_to_project’ event on a given issue or pull request. |
| ASSIGNED_EVENT | Represents an ‘assigned’ event on any assignable object. |
| CLOSED_EVENT | Represents a ‘closed’ event on any |
| COMMENT_DELETED_EVENT | Represents a ‘comment_deleted’ event on a given issue or pull request. |
| CONNECTED_EVENT | Represents a ‘connected’ event on a given issue or pull request. |
| CONVERTED_NOTE_TO_ISSUE_EVENT | Represents a ‘converted_note_to_issue’ event on a given issue or pull request. |
| CONVERTED_TO_DISCUSSION_EVENT | Represents a ‘converted_to_discussion’ event on a given issue. |
| CROSS_REFERENCED_EVENT | Represents a mention made by one issue or pull request to another. |
| DEMILESTONED_EVENT | Represents a ‘demilestoned’ event on a given issue or pull request. |
| DISCONNECTED_EVENT | Represents a ‘disconnected’ event on a given issue or pull request. |
| ISSUE_COMMENT | Represents a comment on an Issue. |
| LABELED_EVENT | Represents a ‘labeled’ event on a given issue or pull request. |
| LOCKED_EVENT | Represents a ‘locked’ event on a given issue or pull request. |
| MARKED_AS_DUPLICATE_EVENT | Represents a ‘marked_as_duplicate’ event on a given issue or pull request. |
| MENTIONED_EVENT | Represents a ‘mentioned’ event on a given issue or pull request. |
| MILESTONED_EVENT | Represents a ‘milestoned’ event on a given issue or pull request. |
| MOVED_COLUMNS_IN_PROJECT_EVENT | Represents a ‘moved_columns_in_project’ event on a given issue or pull request. |
| PINNED_EVENT | Represents a ‘pinned’ event on a given issue or pull request. |
| REFERENCED_EVENT | Represents a ‘referenced’ event on a given |
| REMOVED_FROM_PROJECT_EVENT | Represents a ‘removed_from_project’ event on a given issue or pull request. |
| RENAMED_TITLE_EVENT | Represents a ‘renamed’ event on a given issue or pull request |
| REOPENED_EVENT | Represents a ‘reopened’ event on any |
| SUBSCRIBED_EVENT | Represents a ‘subscribed’ event on a given |
| TRANSFERRED_EVENT | Represents a ‘transferred’ event on a given issue or pull request. |
| UNASSIGNED_EVENT | Represents an ‘unassigned’ event on any assignable object. |
| UNLABELED_EVENT | Represents an ‘unlabeled’ event on a given issue or pull request. |
| UNLOCKED_EVENT | Represents an ‘unlocked’ event on a given issue or pull request. |
| UNMARKED_AS_DUPLICATE_EVENT | Represents an ‘unmarked_as_duplicate’ event on a given issue or pull request. |
| UNPINNED_EVENT | Represents an ‘unpinned’ event on a given issue or pull request. |
| UNSUBSCRIBED_EVENT | Represents an ‘unsubscribed’ event on a given |
| USER_BLOCKED_EVENT | Represents a ‘user_blocked’ event on a given user. |
Properties by which label connections can be ordered.
| Value | Description |
|---|---|
| CREATED_AT | Order labels by creation time |
| NAME | Order labels by name |
Properties by which language connections can be ordered.
| Value | Description |
|---|---|
| SIZE | Order languages by the size of all files containing the language |
The possible reasons that an issue or pull request was locked.
| Value | Description |
|---|---|
| OFF_TOPIC | The issue or pull request was locked because the conversation was off-topic. |
| RESOLVED | The issue or pull request was locked because the conversation was resolved. |
| SPAM | The issue or pull request was locked because the conversation was spam. |
| TOO_HEATED | The issue or pull request was locked because the conversation was too heated. |
Detailed status information about a pull request merge.
| Value | Description |
|---|---|
| BEHIND | The head ref is out of date. |
| BLOCKED | The merge is blocked. |
| CLEAN | Mergeable and passing commit status. |
| DIRTY | The merge commit cannot be cleanly created. |
| DRAFT | The merge is blocked due to the pull request being a draft. |
| HAS_HOOKS | Mergeable with passing commit status and pre-receive hooks. |
| UNKNOWN | The state cannot currently be determined. |
| UNSTABLE | Mergeable with non-passing commit status. |
Whether or not a PullRequest can be merged.
| Value | Description |
|---|---|
| CONFLICTING | The pull request cannot be merged due to merge conflicts. |
| MERGEABLE | The pull request can be merged. |
| UNKNOWN | The mergeability of the pull request is still being calculated. |
Represents the different Octoshift migration sources.
| Value | Description |
|---|---|
| AZURE_DEVOPS | An Azure DevOps migration source. |
| BITBUCKET_SERVER | A Bitbucket Server migration source. |
| GITHUB | A GitHub migration source. |
| GITHUB_ARCHIVE | A GitHub Migration API source. |
| GITLAB | A GitLab migration source. |
The Octoshift migration state.
| Value | Description |
|---|---|
| FAILED | The Octoshift migration has failed. |
| IN_PROGRESS | The Octoshift migration is in progress. |
| NOT_STARTED | The Octoshift migration has not started. |
| QUEUED | The Octoshift migration has been queued. |
| SUCCEEDED | The Octoshift migration has succeeded. |
Properties by which milestone connections can be ordered.
| Value | Description |
|---|---|
| CREATED_AT | Order milestones by when they were created. |
| DUE_DATE | Order milestones by when they are due. |
| NUMBER | Order milestones by their number. |
| UPDATED_AT | Order milestones by when they were last updated. |
The possible states of a milestone.
| Value | Description |
|---|---|
| CLOSED | A milestone that has been closed. |
| OPEN | A milestone that is still open. |
The possible values for the notification restriction setting.
| Value | Description |
|---|---|
| DISABLED | The setting is disabled for the owner. |
| ENABLED | The setting is enabled for the owner. |
The OIDC identity provider type
| Value | Description |
|---|---|
| AAD | Azure Active Directory |
The state of an OAuth Application when it was created.
| Value | Description |
|---|---|
| ACTIVE | The OAuth Application was active and allowed to have OAuth Accesses. |
| PENDING_DELETION | The OAuth Application was in the process of being deleted. |
| SUSPENDED | The OAuth Application was suspended from generating OAuth Accesses due to abuse or security concerns. |
The corresponding operation type for the action
| Value | Description |
|---|---|
| ACCESS | An existing resource was accessed |
| AUTHENTICATION | A resource performed an authentication event |
| CREATE | A new resource was created |
| MODIFY | An existing resource was modified |
| REMOVE | An existing resource was removed |
| RESTORE | An existing resource was restored |
| TRANSFER | An existing resource was transferred between multiple resources |
Possible directions in which to order a list of items when provided an orderBy argument.
| Value | Description |
|---|---|
| ASC | Specifies an ascending order for a given |
| DESC | Specifies a descending order for a given |
The permissions available to members on an Organization.
| Value | Description |
|---|---|
| ADMIN | Can read, clone, push, and add collaborators to repositories. |
| READ | Can read and clone repositories. |
The billing plans available for organizations.
| Value | Description |
|---|---|
| BUSINESS | Team Plan |
| BUSINESS_PLUS | Enterprise Cloud Plan |
| FREE | Free Plan |
| TIERED_PER_SEAT | Tiered Per Seat Plan |
| UNLIMITED | Legacy Unlimited Plan |
Properties by which enterprise owners can be ordered.
| Value | Description |
|---|---|
| LOGIN | Order enterprise owners by login. |
The reason a billing manager was removed from an Organization.
| Value | Description |
|---|---|
| SAML_EXTERNAL_IDENTITY_MISSING | SAML external identity missing |
| SAML_SSO_ENFORCEMENT_REQUIRES_EXTERNAL_IDENTITY | SAML SSO enforcement requires an external identity |
| TWO_FACTOR_REQUIREMENT_NON_COMPLIANCE | The organization required 2FA of its billing managers and this user did not have 2FA enabled. |
The type of membership a user has with an Organization.
| Value | Description |
|---|---|
| ADMIN | Organization administrators have full access and can change several settings, including the names of repositories that belong to the Organization and Owners team membership. In addition, organization admins can delete the organization and all of its repositories. |
| BILLING_MANAGER | A billing manager is a user who manages the billing settings for the Organization, such as updating payment information. |
| DIRECT_MEMBER | A direct member is a user that is a member of the Organization. |
| OUTSIDE_COLLABORATOR | An outside collaborator is a person who isn’t explicitly a member of the Organization, but who has Read, Write, or Admin permissions to one or more repositories in the organization. |
| UNAFFILIATED | An unaffiliated collaborator is a person who is not a member of the Organization and does not have access to any repositories in the Organization. |
The reason a member was removed from an Organization.
| Value | Description |
|---|---|
| SAML_EXTERNAL_IDENTITY_MISSING | SAML external identity missing |
| SAML_SSO_ENFORCEMENT_REQUIRES_EXTERNAL_IDENTITY | SAML SSO enforcement requires an external identity |
| TWO_FACTOR_ACCOUNT_RECOVERY | User was removed from organization during account recovery |
| TWO_FACTOR_REQUIREMENT_NON_COMPLIANCE | The organization required 2FA of its billing managers and this user did not have 2FA enabled. |
| USER_ACCOUNT_DELETED | User account has been deleted |
The type of membership a user has with an Organization.
| Value | Description |
|---|---|
| BILLING_MANAGER | A billing manager is a user who manages the billing settings for the Organization, such as updating payment information. |
| OUTSIDE_COLLABORATOR | An outside collaborator is a person who isn’t explicitly a member of the Organization, but who has Read, Write, or Admin permissions to one or more repositories in the organization. |
| UNAFFILIATED | An unaffiliated collaborator is a person who is not a member of the Organization and does not have access to any repositories in the organization. |
The reason an outside collaborator was removed from an Organization.
| Value | Description |
|---|---|
| SAML_EXTERNAL_IDENTITY_MISSING | SAML external identity missing |
| TWO_FACTOR_REQUIREMENT_NON_COMPLIANCE | The organization required 2FA of its billing managers and this user did not have 2FA enabled. |
The default permission a repository can have in an Organization.
| Value | Description |
|---|---|
| ADMIN | Can read, clone, push, and add collaborators to repositories. |
| NONE | No default permission value. |
| READ | Can read and clone repositories. |
| WRITE | Can read, clone and push to repositories. |
The permissions available to members on an Organization.
| Value | Description |
|---|---|
| ADMIN | Can read, clone, push, and add collaborators to repositories. |
| READ | Can read and clone repositories. |
The permissions available for repository creation on an Organization.
| Value | Description |
|---|---|
| ALL | All organization members are restricted from creating any repositories. |
| INTERNAL | All organization members are restricted from creating internal repositories. |
| NONE | All organization members are allowed to create any repositories. |
| PRIVATE | All organization members are restricted from creating private repositories. |
| PRIVATE_INTERNAL | All organization members are restricted from creating private or internal repositories. |
| PUBLIC | All organization members are restricted from creating public repositories. |
| PUBLIC_INTERNAL | All organization members are restricted from creating public or internal repositories. |
| PUBLIC_PRIVATE | All organization members are restricted from creating public or private repositories. |
The possible organization invitation roles.
| Value | Description |
|---|---|
| ADMIN | The user is invited to be an admin of the organization. |
| BILLING_MANAGER | The user is invited to be a billing manager of the organization. |
| DIRECT_MEMBER | The user is invited to be a direct member of the organization. |
| REINSTATE | The user’s previous role will be reinstated. |
The possible organization invitation types.
| Value | Description |
|---|---|
The invitation was to an email address. |
|
| USER | The invitation was to an existing user. |
The possible roles within an organization for its members.
| Value | Description |
|---|---|
| ADMIN | The user is an administrator of the organization. |
| MEMBER | The user is a member of the organization. |
The possible values for the members can create repositories setting on an organization.
| Value | Description |
|---|---|
| ALL | Members will be able to create public and private repositories. |
| DISABLED | Members will not be able to create public or private repositories. |
| INTERNAL | Members will be able to create only internal repositories. |
| PRIVATE | Members will be able to create only private repositories. |
Properties by which organization connections can be ordered.
| Value | Description |
|---|---|
| CREATED_AT | Order organizations by creation time |
| LOGIN | Order organizations by login |
Properties by which package file connections can be ordered.
| Value | Description |
|---|---|
| CREATED_AT | Order package files by creation time |
Properties by which package connections can be ordered.
| Value | Description |
|---|---|
| CREATED_AT | Order packages by creation time |
The possible types of a package.
| Value | Description |
|---|---|
| DEBIAN | A debian package. |
| DOCKER | A docker image. |
| MAVEN | A maven package. |
| NPM | An npm package. |
| NUGET | A nuget package. |
| PYPI | A python package. |
| RUBYGEMS | A rubygems package. |
Properties by which package version connections can be ordered.
| Value | Description |
|---|---|
| CREATED_AT | Order package versions by creation time |
Represents items that can be pinned to a profile page or dashboard.
| Value | Description |
|---|---|
| GIST | A gist. |
| ISSUE | An issue. |
| ORGANIZATION | An organization. |
| PROJECT | A project. |
| PULL_REQUEST | A pull request. |
| REPOSITORY | A repository. |
| TEAM | A team. |
| USER | A user. |
Preconfigured gradients that may be used to style discussions pinned within a repository.
| Value | Description |
|---|---|
| BLUE_MINT | A gradient of blue to mint |
| BLUE_PURPLE | A gradient of blue to purple |
| PINK_BLUE | A gradient of pink to blue |
| PURPLE_CORAL | A gradient of purple to coral |
| RED_ORANGE | A gradient of red to orange |
Preconfigured background patterns that may be used to style discussions pinned within a repository.
| Value | Description |
|---|---|
| CHEVRON_UP | An upward-facing chevron pattern |
| DOT | A hollow dot pattern |
| DOT_FILL | A solid dot pattern |
| HEART_FILL | A heart pattern |
| PLUS | A plus sign pattern |
| ZAP | A lightning bolt pattern |
The possible archived states of a project card.
| Value | Description |
|---|---|
| ARCHIVED | A project card that is archived |
| NOT_ARCHIVED | A project card that is not archived |
Various content states of a ProjectCard
| Value | Description |
|---|---|
| CONTENT_ONLY | The card has content only. |
| NOTE_ONLY | The card has a note only. |
| REDACTED | The card is redacted. |
The semantic purpose of the column - todo, in progress, or done.
| Value | Description |
|---|---|
| DONE | The column contains cards which are complete |
| IN_PROGRESS | The column contains cards which are currently being worked on |
| TODO | The column contains cards still to be worked on |
Properties by which the return project can be ordered.
| Value | Description |
|---|---|
| CREATED_AT | The project’s date and time of creation |
| NUMBER | The project’s number |
| TITLE | The project’s title |
| UPDATED_AT | The project’s date and time of update |
Properties by which project connections can be ordered.
| Value | Description |
|---|---|
| CREATED_AT | Order projects by creation time |
| NAME | Order projects by name |
| UPDATED_AT | Order projects by update time |
State of the project; either ‘open’ or ‘closed’
| Value | Description |
|---|---|
| CLOSED | The project is closed. |
| OPEN | The project is open. |
GitHub-provided templates for Projects
| Value | Description |
|---|---|
| AUTOMATED_KANBAN_V2 | Create a board with v2 triggers to automatically move cards across To do, In progress and Done columns. |
| AUTOMATED_REVIEWS_KANBAN | Create a board with triggers to automatically move cards across columns with review automation. |
| BASIC_KANBAN | Create a board with columns for To do, In progress and Done. |
| BUG_TRIAGE | Create a board to triage and prioritize bugs with To do, priority, and Done columns. |
Represents available types of methods to use when merging a pull request.
| Value | Description |
|---|---|
| MERGE | Add all commits from the head branch to the base branch with a merge commit. |
| REBASE | Add all commits from the head branch onto the base branch individually. |
| SQUASH | Combine all commits from the head branch into a single commit in the base branch. |
Properties by which pull_requests connections can be ordered.
| Value | Description |
|---|---|
| CREATED_AT | Order pull_requests by creation time |
| UPDATED_AT | Order pull_requests by update time |
The possible states of a pull request review comment.
| Value | Description |
|---|---|
| PENDING | A comment that is part of a pending review |
| SUBMITTED | A comment that is part of a submitted review |
The review status of a pull request.
| Value | Description |
|---|---|
| APPROVED | The pull request has received an approving review. |
| CHANGES_REQUESTED | Changes have been requested on the pull request. |
| REVIEW_REQUIRED | A review is required before the pull request can be merged. |
The possible events to perform on a pull request review.
| Value | Description |
|---|---|
| APPROVE | Submit feedback and approve merging these changes. |
| COMMENT | Submit general feedback without explicit approval. |
| DISMISS | Dismiss review so it now longer effects merging. |
| REQUEST_CHANGES | Submit feedback that must be addressed before merging. |
The possible states of a pull request review.
| Value | Description |
|---|---|
| APPROVED | A review allowing the pull request to merge. |
| CHANGES_REQUESTED | A review blocking the pull request from merging. |
| COMMENTED | An informational review. |
| DISMISSED | A review that has been dismissed. |
| PENDING | A review that has not yet been submitted. |
The possible states of a pull request.
| Value | Description |
|---|---|
| CLOSED | A pull request that has been closed without being merged. |
| MERGED | A pull request that has been closed by being merged. |
| OPEN | A pull request that is still open. |
The possible item types found in a timeline.
| Value | Description |
|---|---|
| ADDED_TO_MERGE_QUEUE_EVENT | Represents an ‘added_to_merge_queue’ event on a given pull request. |
| ADDED_TO_PROJECT_EVENT | Represents a ‘added_to_project’ event on a given issue or pull request. |
| ASSIGNED_EVENT | Represents an ‘assigned’ event on any assignable object. |
| AUTOMATIC_BASE_CHANGE_FAILED_EVENT | Represents a ‘automatic_base_change_failed’ event on a given pull request. |
| AUTOMATIC_BASE_CHANGE_SUCCEEDED_EVENT | Represents a ‘automatic_base_change_succeeded’ event on a given pull request. |
| AUTO_MERGE_DISABLED_EVENT | Represents a ‘auto_merge_disabled’ event on a given pull request. |
| AUTO_MERGE_ENABLED_EVENT | Represents a ‘auto_merge_enabled’ event on a given pull request. |
| AUTO_REBASE_ENABLED_EVENT | Represents a ‘auto_rebase_enabled’ event on a given pull request. |
| AUTO_SQUASH_ENABLED_EVENT | Represents a ‘auto_squash_enabled’ event on a given pull request. |
| BASE_REF_CHANGED_EVENT | Represents a ‘base_ref_changed’ event on a given issue or pull request. |
| BASE_REF_DELETED_EVENT | Represents a ‘base_ref_deleted’ event on a given pull request. |
| BASE_REF_FORCE_PUSHED_EVENT | Represents a ‘base_ref_force_pushed’ event on a given pull request. |
| CLOSED_EVENT | Represents a ‘closed’ event on any |
| COMMENT_DELETED_EVENT | Represents a ‘comment_deleted’ event on a given issue or pull request. |
| CONNECTED_EVENT | Represents a ‘connected’ event on a given issue or pull request. |
| CONVERTED_NOTE_TO_ISSUE_EVENT | Represents a ‘converted_note_to_issue’ event on a given issue or pull request. |
| CONVERTED_TO_DISCUSSION_EVENT | Represents a ‘converted_to_discussion’ event on a given issue. |
| CONVERT_TO_DRAFT_EVENT | Represents a ‘convert_to_draft’ event on a given pull request. |
| CROSS_REFERENCED_EVENT | Represents a mention made by one issue or pull request to another. |
| DEMILESTONED_EVENT | Represents a ‘demilestoned’ event on a given issue or pull request. |
| DEPLOYED_EVENT | Represents a ‘deployed’ event on a given pull request. |
| DEPLOYMENT_ENVIRONMENT_CHANGED_EVENT | Represents a ‘deployment_environment_changed’ event on a given pull request. |
| DISCONNECTED_EVENT | Represents a ‘disconnected’ event on a given issue or pull request. |
| HEAD_REF_DELETED_EVENT | Represents a ‘head_ref_deleted’ event on a given pull request. |
| HEAD_REF_FORCE_PUSHED_EVENT | Represents a ‘head_ref_force_pushed’ event on a given pull request. |
| HEAD_REF_RESTORED_EVENT | Represents a ‘head_ref_restored’ event on a given pull request. |
| ISSUE_COMMENT | Represents a comment on an Issue. |
| LABELED_EVENT | Represents a ‘labeled’ event on a given issue or pull request. |
| LOCKED_EVENT | Represents a ‘locked’ event on a given issue or pull request. |
| MARKED_AS_DUPLICATE_EVENT | Represents a ‘marked_as_duplicate’ event on a given issue or pull request. |
| MENTIONED_EVENT | Represents a ‘mentioned’ event on a given issue or pull request. |
| MERGED_EVENT | Represents a ‘merged’ event on a given pull request. |
| MILESTONED_EVENT | Represents a ‘milestoned’ event on a given issue or pull request. |
| MOVED_COLUMNS_IN_PROJECT_EVENT | Represents a ‘moved_columns_in_project’ event on a given issue or pull request. |
| PINNED_EVENT | Represents a ‘pinned’ event on a given issue or pull request. |
| PULL_REQUEST_COMMIT | Represents a Git commit part of a pull request. |
| PULL_REQUEST_COMMIT_COMMENT_THREAD | Represents a commit comment thread part of a pull request. |
| PULL_REQUEST_REVIEW | A review object for a given pull request. |
| PULL_REQUEST_REVIEW_THREAD | A threaded list of comments for a given pull request. |
| PULL_REQUEST_REVISION_MARKER | Represents the latest point in the pull request timeline for which the viewer has seen the pull request’s commits. |
| READY_FOR_REVIEW_EVENT | Represents a ‘ready_for_review’ event on a given pull request. |
| REFERENCED_EVENT | Represents a ‘referenced’ event on a given |
| REMOVED_FROM_MERGE_QUEUE_EVENT | Represents a ‘removed_from_merge_queue’ event on a given pull request. |
| REMOVED_FROM_PROJECT_EVENT | Represents a ‘removed_from_project’ event on a given issue or pull request. |
| RENAMED_TITLE_EVENT | Represents a ‘renamed’ event on a given issue or pull request |
| REOPENED_EVENT | Represents a ‘reopened’ event on any |
| REVIEW_DISMISSED_EVENT | Represents a ‘review_dismissed’ event on a given issue or pull request. |
| REVIEW_REQUESTED_EVENT | Represents an ‘review_requested’ event on a given pull request. |
| REVIEW_REQUEST_REMOVED_EVENT | Represents an ‘review_request_removed’ event on a given pull request. |
| SUBSCRIBED_EVENT | Represents a ‘subscribed’ event on a given |
| TRANSFERRED_EVENT | Represents a ‘transferred’ event on a given issue or pull request. |
| UNASSIGNED_EVENT | Represents an ‘unassigned’ event on any assignable object. |
| UNLABELED_EVENT | Represents an ‘unlabeled’ event on a given issue or pull request. |
| UNLOCKED_EVENT | Represents an ‘unlocked’ event on a given issue or pull request. |
| UNMARKED_AS_DUPLICATE_EVENT | Represents an ‘unmarked_as_duplicate’ event on a given issue or pull request. |
| UNPINNED_EVENT | Represents an ‘unpinned’ event on a given issue or pull request. |
| UNSUBSCRIBED_EVENT | Represents an ‘unsubscribed’ event on a given |
| USER_BLOCKED_EVENT | Represents a ‘user_blocked’ event on a given user. |
The possible target states when updating a pull request.
| Value | Description |
|---|---|
| CLOSED | A pull request that has been closed without being merged. |
| OPEN | A pull request that is still open. |
Emojis that can be attached to Issues, Pull Requests and Comments.
| Value | Description |
|---|---|
| CONFUSED | Represents the |
| EYES | Represents the |
| HEART | Represents the |
| HOORAY | Represents the |
| LAUGH | Represents the |
| ROCKET | Represents the |
| THUMBS_DOWN | Represents the |
| THUMBS_UP | Represents the |
A list of fields that reactions can be ordered by.
| Value | Description |
|---|---|
| CREATED_AT | Allows ordering a list of reactions by when they were created. |
Properties by which ref connections can be ordered.
| Value | Description |
|---|---|
| ALPHABETICAL | Order refs by their alphanumeric name |
| TAG_COMMIT_DATE | Order refs by underlying commit date if the ref prefix is refs/tags/ |
Properties by which release connections can be ordered.
| Value | Description |
|---|---|
| CREATED_AT | Order releases by creation time |
| NAME | Order releases alphabetically by name |
The privacy of a repository
| Value | Description |
|---|---|
| INTERNAL | The repository is visible only to users in the same business. |
| PRIVATE | The repository is visible only to those with explicit access. |
| PUBLIC | The repository is visible to everyone. |
The privacy of a repository
| Value | Description |
|---|---|
| INTERNAL | The repository is visible only to users in the same business. |
| PRIVATE | The repository is visible only to those with explicit access. |
| PUBLIC | The repository is visible to everyone. |
The privacy of a repository
| Value | Description |
|---|---|
| INTERNAL | The repository is visible only to users in the same business. |
| PRIVATE | The repository is visible only to those with explicit access. |
| PUBLIC | The repository is visible to everyone. |
The merge options available for pull requests to this repository.
| Value | Description |
|---|---|
| MERGE | The pull request is added to the base branch in a merge commit. |
| REBASE | Commits from the pull request are added onto the base branch individually without a merge commit. |
| SQUASH | The pull request’s commits are squashed into a single commit before they are merged to the base branch. |
The privacy of a repository
| Value | Description |
|---|---|
| INTERNAL | The repository is visible only to users in the same business. |
| PRIVATE | The repository is visible only to those with explicit access. |
| PUBLIC | The repository is visible to everyone. |
The privacy of a repository
| Value | Description |
|---|---|
| INTERNAL | The repository is visible only to users in the same business. |
| PRIVATE | The repository is visible only to those with explicit access. |
| PUBLIC | The repository is visible to everyone. |
The privacy of a repository
| Value | Description |
|---|---|
| INTERNAL | The repository is visible only to users in the same business. |
| PRIVATE | The repository is visible only to those with explicit access. |
| PUBLIC | The repository is visible to everyone. |
The reasons a piece of content can be reported or minimized.
| Value | Description |
|---|---|
| ABUSE | An abusive or harassing piece of content |
| DUPLICATE | A duplicated piece of content |
| OFF_TOPIC | An irrelevant piece of content |
| OUTDATED | An outdated piece of content |
| RESOLVED | The content has been resolved |
| SPAM | A spammy piece of content |
The affiliation of a user to a repository
| Value | Description |
|---|---|
| COLLABORATOR | Repositories that the user has been added to as a collaborator. |
| ORGANIZATION_MEMBER | Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on. |
| OWNER | Repositories that are owned by the authenticated user. |
The reason a repository is listed as ‘contributed’.
| Value | Description |
|---|---|
| COMMIT | Created a commit |
| ISSUE | Created an issue |
| PULL_REQUEST | Created a pull request |
| PULL_REQUEST_REVIEW | Reviewed a pull request |
| REPOSITORY | Created the repository |
A repository interaction limit.
| Value | Description |
|---|---|
| COLLABORATORS_ONLY | Users that are not collaborators will not be able to interact with the repository. |
| CONTRIBUTORS_ONLY | Users that have not previously committed to a repository’s default branch will be unable to interact with the repository. |
| EXISTING_USERS | Users that have recently created their account will be unable to interact with the repository. |
| NO_LIMIT | No interaction limits are enabled. |
The length for a repository interaction limit to be enabled for.
| Value | Description |
|---|---|
| ONE_DAY | The interaction limit will expire after 1 day. |
| ONE_MONTH | The interaction limit will expire after 1 month. |
| ONE_WEEK | The interaction limit will expire after 1 week. |
| SIX_MONTHS | The interaction limit will expire after 6 months. |
| THREE_DAYS | The interaction limit will expire after 3 days. |
Indicates where an interaction limit is configured.
| Value | Description |
|---|---|
| ORGANIZATION | A limit that is configured at the organization level. |
| REPOSITORY | A limit that is configured at the repository level. |
| USER | A limit that is configured at the user-wide level. |
Properties by which repository invitation connections can be ordered.
| Value | Description |
|---|---|
| CREATED_AT | Order repository invitations by creation time |
| INVITEE_LOGIN | Order repository invitations by invitee login |
The possible reasons a given repository could be in a locked state.
| Value | Description |
|---|---|
| BILLING | The repository is locked due to a billing related reason. |
| MIGRATING | The repository is locked due to a migration. |
| MOVING | The repository is locked due to a move. |
| RENAME | The repository is locked due to a rename. |
Possible directions in which to order a list of repository migrations when provided an orderBy argument.
| Value | Description |
|---|---|
| ASC | Specifies an ascending order for a given |
| DESC | Specifies a descending order for a given |
Properties by which repository migrations can be ordered.
| Value | Description |
|---|---|
| CREATED_AT | Order mannequins why when they were created. |
Properties by which repository connections can be ordered.
| Value | Description |
|---|---|
| CREATED_AT | Order repositories by creation time |
| NAME | Order repositories by name |
| PUSHED_AT | Order repositories by push time |
| STARGAZERS | Order repositories by number of stargazers |
| UPDATED_AT | Order repositories by update time |
The access level to a repository
| Value | Description |
|---|---|
| ADMIN | Can read, clone, and push to this repository. Can also manage issues, pull requests, and repository settings, including adding collaborators |
| MAINTAIN | Can read, clone, and push to this repository. They can also manage issues, pull requests, and some repository settings |
| READ | Can read and clone this repository. Can also open and comment on issues and pull requests |
| TRIAGE | Can read and clone this repository. Can also manage issues and pull requests |
| WRITE | Can read, clone, and push to this repository. Can also manage issues and pull requests |
The privacy of a repository
| Value | Description |
|---|---|
| PRIVATE | Private |
| PUBLIC | Public |
The repository’s visibility level.
| Value | Description |
|---|---|
| INTERNAL | The repository is visible only to users in the same business. |
| PRIVATE | The repository is visible only to those with explicit access. |
| PUBLIC | The repository is visible to everyone. |
The possible states of an alert
| Value | Description |
|---|---|
| DISMISSED | An alert that has been manually closed by a user. |
| FIXED | An alert that has been resolved by a code change. |
| OPEN | An alert that is still open. |
The possible states that can be requested when creating a check run.
| Value | Description |
|---|---|
| COMPLETED | The check suite or run has been completed. |
| IN_PROGRESS | The check suite or run is in progress. |
| PENDING | The check suite or run is in pending state. |
| QUEUED | The check suite or run has been queued. |
| WAITING | The check suite or run is in waiting state. |
Possible roles a user may have in relation to an organization.
| Value | Description |
|---|---|
| DIRECT_MEMBER | A user who is a direct member of the organization. |
| OWNER | A user with full administrative access to the organization. |
| UNAFFILIATED | A user who is unaffiliated with the organization. |
The possible digest algorithms used to sign SAML requests for an identity provider.
| Value | Description |
|---|---|
| SHA1 | SHA1 |
| SHA256 | SHA256 |
| SHA384 | SHA384 |
| SHA512 | SHA512 |
The possible signature algorithms used to sign SAML requests for a Identity Provider.
| Value | Description |
|---|---|
| RSA_SHA1 | RSA-SHA1 |
| RSA_SHA256 | RSA-SHA256 |
| RSA_SHA384 | RSA-SHA384 |
| RSA_SHA512 | RSA-SHA512 |
Properties by which saved reply connections can be ordered.
| Value | Description |
|---|---|
| UPDATED_AT | Order saved reply by when they were updated. |
Represents the individual results of a search.
| Value | Description |
|---|---|
| DISCUSSION | Returns matching discussions in repositories. |
| ISSUE | Returns results matching issues in repositories. |
| REPOSITORY | Returns results matching repositories. |
| USER | Returns results matching users and organizations on GitHub. |
The possible ecosystems of a security vulnerability’s package.
| Value | Description |
|---|---|
| COMPOSER | PHP packages hosted at packagist.org |
| GO | Go modules |
| MAVEN | Java artifacts hosted at the Maven central repository |
| NPM | JavaScript packages hosted at npmjs.com |
| NUGET | .NET packages hosted at the NuGet Gallery |
| PIP | Python packages hosted at PyPI.org |
| RUBYGEMS | Ruby gems hosted at RubyGems.org |
| RUST | Rust crates |
Identifier formats available for advisories.
| Value | Description |
|---|---|
| CVE | Common Vulnerabilities and Exposures Identifier. |
| GHSA | GitHub Security Advisory ID. |
Properties by which security advisory connections can be ordered.
| Value | Description |
|---|---|
| PUBLISHED_AT | Order advisories by publication time |
| UPDATED_AT | Order advisories by update time |
Severity of the vulnerability.
| Value | Description |
|---|---|
| CRITICAL | Critical. |
| HIGH | High. |
| LOW | Low. |
| MODERATE | Moderate. |
Properties by which security vulnerability connections can be ordered.
| Value | Description |
|---|---|
| UPDATED_AT | Order vulnerability by update time |
Properties by which sponsor connections can be ordered.
| Value | Description |
|---|---|
| LOGIN | Order sponsorable entities by login (username). |
| RELEVANCE | Order sponsors by their relevance to the viewer. |
Properties by which sponsorable connections can be ordered.
| Value | Description |
|---|---|
| LOGIN | Order sponsorable entities by login (username). |
The possible actions that GitHub Sponsors activities can represent.
| Value | Description |
|---|---|
| CANCELLED_SPONSORSHIP | The activity was cancelling a sponsorship. |
| NEW_SPONSORSHIP | The activity was starting a sponsorship. |
| PENDING_CHANGE | The activity was scheduling a downgrade or cancellation. |
| REFUND | The activity was funds being refunded to the sponsor or GitHub. |
| SPONSOR_MATCH_DISABLED | The activity was disabling matching for a previously matched sponsorship. |
| TIER_CHANGE | The activity was changing the sponsorship tier, either directly by the sponsor or by a scheduled/pending change. |
Properties by which GitHub Sponsors activity connections can be ordered.
| Value | Description |
|---|---|
| TIMESTAMP | Order activities by when they happened. |
The possible time periods for which Sponsors activities can be requested.
| Value | Description |
|---|---|
| ALL | Don’t restrict the activity to any date range, include all activity. |
| DAY | The previous calendar day. |
| MONTH | The previous thirty days. |
| WEEK | The previous seven days. |
The different kinds of goals a GitHub Sponsors member can have.
| Value | Description |
|---|---|
| MONTHLY_SPONSORSHIP_AMOUNT | The goal is about getting a certain amount in USD from sponsorships each month. |
| TOTAL_SPONSORS_COUNT | The goal is about reaching a certain number of sponsors. |
Properties by which Sponsors tiers connections can be ordered.
| Value | Description |
|---|---|
| CREATED_AT | Order tiers by creation time. |
| MONTHLY_PRICE_IN_CENTS | Order tiers by their monthly price in cents |
Properties by which sponsorship update connections can be ordered.
| Value | Description |
|---|---|
| CREATED_AT | Order sponsorship newsletters by when they were created. |
Properties by which sponsorship connections can be ordered.
| Value | Description |
|---|---|
| CREATED_AT | Order sponsorship by creation time. |
The privacy of a sponsorship
| Value | Description |
|---|---|
| PRIVATE | Private |
| PUBLIC | Public |
Properties by which star connections can be ordered.
| Value | Description |
|---|---|
| STARRED_AT | Allows ordering a list of stars by when they were created. |
The possible commit status states.
| Value | Description |
|---|---|
| ERROR | Status is errored. |
| EXPECTED | Status is expected. |
| FAILURE | Status is failing. |
| PENDING | Status is pending. |
| SUCCESS | Status is successful. |
The possible states of a subscription.
| Value | Description |
|---|---|
| IGNORED | The User is never notified. |
| SUBSCRIBED | The User is notified of all conversations. |
| UNSUBSCRIBED | The User is only notified when participating or @mentioned. |
Properties by which team discussion comment connections can be ordered.
| Value | Description |
|---|---|
| NUMBER | Allows sequential ordering of team discussion comments (which is equivalent to chronological ordering). |
Properties by which team discussion connections can be ordered.
| Value | Description |
|---|---|
| CREATED_AT | Allows chronological ordering of team discussions. |
Properties by which team member connections can be ordered.
| Value | Description |
|---|---|
| CREATED_AT | Order team members by creation time |
| LOGIN | Order team members by login |
The possible team member roles; either ‘maintainer’ or ‘member’.
| Value | Description |
|---|---|
| MAINTAINER | A team maintainer has permission to add and remove team members. |
| MEMBER | A team member has no administrative permissions on the team. |
Defines which types of team members are included in the returned list. Can be one of IMMEDIATE, CHILD_TEAM or ALL.
| Value | Description |
|---|---|
| ALL | Includes immediate and child team members for the team. |
| CHILD_TEAM | Includes only child team members for the team. |
| IMMEDIATE | Includes only immediate members of the team. |
Properties by which team connections can be ordered.
| Value | Description |
|---|---|
| NAME | Allows ordering a list of teams by name. |
The possible team privacy values.
| Value | Description |
|---|---|
| SECRET | A secret team can only be seen by its members. |
| VISIBLE | A visible team can be seen and @mentioned by every member of the organization. |
Properties by which team repository connections can be ordered.
| Value | Description |
|---|---|
| CREATED_AT | Order repositories by creation time |
| NAME | Order repositories by name |
| PERMISSION | Order repositories by permission |
| PUSHED_AT | Order repositories by push time |
| STARGAZERS | Order repositories by number of stargazers |
| UPDATED_AT | Order repositories by update time |
The possible team review assignment algorithms
| Value | Description |
|---|---|
| LOAD_BALANCE | Balance review load across the entire team |
| ROUND_ROBIN | Alternate reviews between each team member |
The role of a user on a team.
| Value | Description |
|---|---|
| ADMIN | User has admin rights on the team. |
| MEMBER | User is a member of the team. |
Reason that the suggested topic is declined.
| Value | Description |
|---|---|
| NOT_RELEVANT | The suggested topic is not relevant to the repository. |
| PERSONAL_PREFERENCE | The viewer does not like the suggested topic. |
| TOO_GENERAL | The suggested topic is too general for the repository. |
| TOO_SPECIFIC | The suggested topic is too specific for the repository (e.g. #ruby-on-rails-version-4-2-1). |
The possible durations that a user can be blocked for.
| Value | Description |
|---|---|
| ONE_DAY | The user was blocked for 1 day |
| ONE_MONTH | The user was blocked for 30 days |
| ONE_WEEK | The user was blocked for 7 days |
| PERMANENT | The user was blocked permanently |
| THREE_DAYS | The user was blocked for 3 days |
Properties by which user status connections can be ordered.
| Value | Description |
|---|---|
| UPDATED_AT | Order user statuses by when they were updated. |
Properties by which verifiable domain connections can be ordered.
| Value | Description |
|---|---|
| CREATED_AT | Order verifiable domains by their creation date. |
| DOMAIN | Order verifiable domains by the domain name. |