我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

此版本的 GitHub Enterprise 将停止服务 2021-02-11. 即使针对重大安全问题,也不会发布补丁。 要获得更好的性能、改进的安全性和新功能,请升级到 GitHub Enterprise 的最新版本。 如需升级方面的帮助,请联系 GitHub Enterprise 支持

接口

本文内容

关于接口

接口可作为供其他对象继承的父对象。

例如,Lockable是一个接口,因为 IssuePullRequest 对象都可以锁定。 接口拥有自己的指定字段列表,这些字段通过实现对象得以共享。

更多信息请参阅“实现。”

Actor

Represents an object which can take actions on GitHub. Typically a User or Bot.

实施者

字段

名称 描述

avatarUrl (URI!)

A URL pointing to the actor's public avatar.

参数

size (Int)

The size of the resulting square image.

login (String!)

The username of the actor.

resourcePath (URI!)

The HTTP path for this actor.

url (URI!)

The HTTP URL for this actor.


Assignable

An object that can have users assigned to it.

实施者

字段

名称 描述

assignees (UserConnection!)

A list of Users assigned to this object.

参数

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.


AuditEntry

An entry in the audit log.

实施者

字段

名称 描述

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

operationType (OperationType)

The corresponding operation type for the action.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


Closable

An object that can be closed.

实施者

字段

名称 描述

closed (Boolean!)

true if the object is closed (definition of closed may depend on type).

closedAt (DateTime)

Identifies the date and time when the object was closed.


Comment

Represents a comment.

实施者

字段

名称 描述

author (Actor)

The actor who authored the comment.

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

body (String!)

The body as Markdown.

bodyHTML (HTML!)

The body rendered to HTML.

bodyText (String!)

The body rendered to text.

createdAt (DateTime!)

Identifies the date and time when the object was created.

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

editor (Actor)

The actor who edited the comment.

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

lastEditedAt (DateTime)

The moment the editor made the last edit.

publishedAt (DateTime)

Identifies when the comment was published at.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

userContentEdits (UserContentEditConnection)

A list of edits to this content.

参数

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

viewerDidAuthor (Boolean!)

Did the viewer author this comment.


Contribution

Represents a contribution a user made on GitHub, such as opening an issue.

实施者

字段

名称 描述

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access.

occurredAt (DateTime!)

When this contribution was made.

resourcePath (URI!)

The HTTP path for this contribution.

url (URI!)

The HTTP URL for this contribution.

user (User!)

The user who made this contribution.


Deletable

Entities that can be deleted.

实施者

字段

名称 描述

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.


EnterpriseAuditEntryData

Metadata for an audit entry containing enterprise account information.


GitObject

Represents a Git object.

实施者

字段

名称 描述

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

commitResourcePath (URI!)

The HTTP path for this Git object.

commitUrl (URI!)

The HTTP URL for this Git object.

oid (GitObjectID!)

The Git object ID.

repository (Repository!)

The Repository the Git object belongs to.


GitSignature

Information about a signature (GPG or S/MIME) on a Commit or Tag.

实施者

字段

名称 描述

email (String!)

Email used to sign this object.

isValid (Boolean!)

True if the signature is valid and verified by GitHub.

payload (String!)

Payload for GPG signing object. Raw ODB object without the signature header.

signature (String!)

ASCII-armored signature header from object.

signer (User)

GitHub user corresponding to the email signing this commit.

state (GitSignatureState!)

The state of this signature. VALID if signature is valid and verified by GitHub, otherwise represents reason why signature is considered invalid.

wasSignedByGitHub (Boolean!)

True if the signature was made with GitHub's signing key.


HovercardContext

An individual line of a hovercard.

实施者

字段

名称 描述

message (String!)

A string describing this context.

octicon (String!)

An octicon to accompany this context.


Labelable

An object that can have labels assigned to it.

实施者

字段

名称 描述

labels (LabelConnection)

A list of labels associated with the object.

参数

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (LabelOrder)

Ordering options for labels returned from the connection.


Lockable

An object that can be locked.

实施者

字段

名称 描述

activeLockReason (LockReason)

Reason that the conversation was locked.

locked (Boolean!)

true if the object is locked.


MemberStatusable

Entities that have members who can set status messages.

实施者

字段

名称 描述

memberStatuses (UserStatusConnection!)

Get the status messages members of this entity have set that are either public or visible only to the organization.

参数

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (UserStatusOrder)

Ordering options for user statuses returned from the connection.


Minimizable

Entities that can be minimized.

预览通知

Minimizable is available under the Minimize comments preview. During the preview period, the API may change without notice.

实施者

字段

名称 描述

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

minimizedReason (String)

Returns why the comment was minimized.

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.


Node

An object with an ID.

实施者

字段

名称 描述

id (ID!)

ID of the object.


OauthApplicationAuditEntryData

Metadata for an audit entry with action oauth_application.*.

实施者

字段

名称 描述

oauthApplicationName (String)

The name of the OAuth Application.

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.


OrganizationAuditEntryData

Metadata for an audit entry with action org.*.

实施者

字段

名称 描述

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.


PackageOwner

Represents an owner of a package.

预览通知

PackageOwner is available under the GitHub packages preview. During the preview period, the API may change without notice.

实施者

字段

名称 描述

packages (PackageConnection!)

A list of packages under the owner.

预览通知

packages is available under the GitHub packages preview. During the preview period, the API may change without notice.

参数

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

names ([String])

Find packages by their names.

orderBy (PackageOrder)

Ordering of the returned packages.

repositoryId (ID)

Find packages in a repository by ID.


ProfileOwner

Represents any entity on GitHub that has a profile page.

实施者

字段

名称 描述

anyPinnableItems (Boolean!)

Determine if this repository owner has any items that can be pinned to their profile.

参数

type (PinnableItemType)

Filter to only a particular kind of pinnable item.

email (String)

The public profile email.

itemShowcase (ProfileItemShowcase!)

Showcases a selection of repositories and gists that the profile owner has either curated or that have been selected automatically based on popularity.

location (String)

The public profile location.

login (String!)

The username used to login.

name (String)

The public profile name.

pinnableItems (PinnableItemConnection!)

A list of repositories and gists this profile owner can pin to their profile.

参数

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

types ([PinnableItemType!])

Filter the types of pinnable items that are returned.

pinnedItems (PinnableItemConnection!)

A list of repositories and gists this profile owner has pinned to their profile.

参数

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

types ([PinnableItemType!])

Filter the types of pinned items that are returned.

pinnedItemsRemaining (Int!)

Returns how many more items this profile owner can pin to their profile.

viewerCanChangePinnedItems (Boolean!)

Can the viewer pin repositories and gists to the profile?.

websiteUrl (URI)

The public profile website URL.


ProjectOwner

Represents an owner of a Project.

实施者

字段

名称 描述

project (Project)

Find project by number.

参数

number (Int!)

The project number to find.

projects (ProjectConnection!)

A list of projects under the owner.

参数

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (ProjectOrder)

Ordering options for projects returned from the connection.

search (String)

Query to search projects by, currently only searching by name.

states ([ProjectState!])

A list of states to filter the projects by.

projectsResourcePath (URI!)

The HTTP path listing owners projects.

projectsUrl (URI!)

The HTTP URL listing owners projects.

viewerCanCreateProjects (Boolean!)

Can the current viewer create new projects on this owner.


Reactable

Represents a subject that can be reacted on.

实施者

字段

名称 描述

databaseId (Int)

Identifies the primary key from the database.

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

参数

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

content (ReactionContent)

Allows filtering Reactions by emoji.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (ReactionOrder)

Allows specifying the order in which reactions are returned.

viewerCanReact (Boolean!)

Can user react to this subject.


RegistryPackageOwner

Represents an owner of a registry package.

实施者

字段

名称 描述

registryPackages (RegistryPackageConnection!)

A list of registry packages under the owner.

废弃通知

registryPackages is deprecated.

Renaming GitHub Packages fields and objects. Use the PackageOwner object instead. Removal on 2020-04-01 UTC.

参数

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

name (String)

Find registry package by name.

names ([String])

Find registry packages by their names.

packageType (RegistryPackageType)

Filter registry package by type.

publicOnly (Boolean)

Filter registry package by whether it is publicly visible.

The default value is false.

registryPackageType (String)

Filter registry package by type (string).

repositoryId (ID)

Find registry packages in a repository.


RegistryPackageSearch

Represents an interface to search packages on an object.

实施者

字段

名称 描述

registryPackagesForQuery (RegistryPackageConnection!)

A list of registry packages for a particular search query.

废弃通知

registryPackagesForQuery is deprecated.

Renaming GitHub Packages fields and objects. Use the PackageSearch object instead. Removal on 2020-04-01 UTC.

参数

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

packageType (RegistryPackageType)

Filter registry package by type.

query (String)

Find registry package by search query.


RepositoryAuditEntryData

Metadata for an audit entry with action repo.*.

实施者

字段

名称 描述

repository (Repository)

The repository associated with the action.

repositoryName (String)

The name of the repository.

repositoryResourcePath (URI)

The HTTP path for the repository.

repositoryUrl (URI)

The HTTP URL for the repository.


RepositoryInfo

A subset of repository info.

实施者

字段

名称 描述

createdAt (DateTime!)

Identifies the date and time when the object was created.

description (String)

The description of the repository.

descriptionHTML (HTML!)

The description of the repository rendered to HTML.

forkCount (Int!)

Returns how many forks there are of this repository in the whole network.

hasAnonymousAccessEnabled (Boolean!)

Indicates if the repository has anonymous Git read access feature enabled.

hasIssuesEnabled (Boolean!)

Indicates if the repository has issues feature enabled.

hasProjectsEnabled (Boolean!)

Indicates if the repository has the Projects feature enabled.

hasWikiEnabled (Boolean!)

Indicates if the repository has wiki feature enabled.

homepageUrl (URI)

The repository's URL.

isArchived (Boolean!)

Indicates if the repository is unmaintained.

isFork (Boolean!)

Identifies if the repository is a fork.

isLocked (Boolean!)

Indicates if the repository has been locked or not.

isMirror (Boolean!)

Identifies if the repository is a mirror.

isPrivate (Boolean!)

Identifies if the repository is private.

isTemplate (Boolean!)

Identifies if the repository is a template that can be used to generate new repositories.

licenseInfo (License)

The license associated with the repository.

lockReason (RepositoryLockReason)

The reason the repository has been locked.

mirrorUrl (URI)

The repository's original mirror URL.

name (String!)

The name of the repository.

nameWithOwner (String!)

The repository's name with owner.

openGraphImageUrl (URI!)

The image used to represent this repository in Open Graph data.

owner (RepositoryOwner!)

The User owner of the repository.

pushedAt (DateTime)

Identifies when the repository was last pushed to.

resourcePath (URI!)

The HTTP path for this repository.

shortDescriptionHTML (HTML!)

A description of the repository, rendered to HTML without any links in it.

参数

limit (Int)

How many characters to return.

The default value is 200.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL for this repository.

usesCustomOpenGraphImage (Boolean!)

Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.


RepositoryNode

Represents a object that belongs to a repository.


RepositoryOwner

Represents an owner of a Repository.

实施者

字段

名称 描述

avatarUrl (URI!)

A URL pointing to the owner's public avatar.

参数

size (Int)

The size of the resulting square image.

login (String!)

The username used to login.

pinnedRepositories (RepositoryConnection!)

A list of repositories this user has pinned to their profile.

废弃通知

pinnedRepositories is deprecated.

pinnedRepositories will be removed Use ProfileOwner.pinnedItems instead. Removal on 2019-10-01 UTC.

参数

affiliations ([RepositoryAffiliation])

Array of viewer's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the current viewer owns.

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

isLocked (Boolean)

If non-null, filters repositories according to whether they have been locked.

last (Int)

Returns the last n elements from the list.

orderBy (RepositoryOrder)

Ordering options for repositories returned from the connection.

ownerAffiliations ([RepositoryAffiliation])

Array of owner's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the organization or user being viewed owns.

privacy (RepositoryPrivacy)

If non-null, filters repositories according to privacy.

repositories (RepositoryConnection!)

A list of repositories that the user owns.

参数

affiliations ([RepositoryAffiliation])

Array of viewer's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the current viewer owns.

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

isFork (Boolean)

If non-null, filters repositories according to whether they are forks of another repository.

isLocked (Boolean)

If non-null, filters repositories according to whether they have been locked.

last (Int)

Returns the last n elements from the list.

orderBy (RepositoryOrder)

Ordering options for repositories returned from the connection.

ownerAffiliations ([RepositoryAffiliation])

Array of owner's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the organization or user being viewed owns.

privacy (RepositoryPrivacy)

If non-null, filters repositories according to privacy.

repository (Repository)

Find Repository.

参数

name (String!)

Name of Repository to find.

resourcePath (URI!)

The HTTP URL for the owner.

url (URI!)

The HTTP URL for the owner.


Starrable

Things that can be starred.

实施者

字段

名称 描述

stargazers (StargazerConnection!)

A list of users who have starred this starrable.

参数

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (StarOrder)

Order for connection.

viewerHasStarred (Boolean!)

Returns a boolean indicating whether the viewing user has starred this starrable.


Subscribable

Entities that can be subscribed to for web and email notifications.

实施者

字段

名称 描述

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.


TeamAuditEntryData

Metadata for an audit entry with action team.*.

实施者

字段

名称 描述

team (Team)

The team associated with the action.

teamName (String)

The name of the team.

teamResourcePath (URI)

The HTTP path for this team.

teamUrl (URI)

The HTTP URL for this team.


TopicAuditEntryData

Metadata for an audit entry with a topic.

实施者

字段

名称 描述

topic (Topic)

The name of the topic added to the repository.

topicName (String)

The name of the topic added to the repository.


UniformResourceLocatable

Represents a type that can be retrieved by a URL.


Updatable

Entities that can be updated.

实施者

字段

名称 描述

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.


UpdatableComment

Comments that can be updated.

实施者

字段

名称 描述

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.


此文档对您有帮助吗?

Privacy policy

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。