Skip to main content
설명서에 자주 업데이트를 게시하며 이 페이지의 번역이 계속 진행 중일 수 있습니다. 최신 정보는 영어 설명서를 참조하세요.
All products
GraphQL API

쿼리

이 문서의 내용

쿼리 형식은 서버의 데이터를 검색하는 GraphQL 작업을 정의합니다.

About queries

Every GraphQL schema has a root type for both queries and mutations. The query type defines GraphQL operations that retrieve data from the server.

For more information, see "Forming calls with GraphQL."

Note: For GitHub App requests made with user access tokens, you should use separate queries for issues and pull requests. For example, use the is:issue or is:pull-request filters and their equivalents. Using the search connection to return a combination of issues and pull requests in a single query will result in an empty set of nodes.

codeOfConduct

Look up a code of conduct by its key.

에 대한 인수 codeOfConduct

이름Description

key (String!)

The code of conduct's key.

codesOfConduct

Look up a code of conduct by its key.

enterprise

Look up an enterprise by URL slug.

형식: Enterprise

에 대한 인수 enterprise

이름Description

invitationToken (String)

The enterprise invitation token.

slug (String!)

The enterprise URL slug.

enterpriseAdministratorInvitation

Look up a pending enterprise administrator invitation by invitee, enterprise and role.

에 대한 인수 enterpriseAdministratorInvitation

이름Description

enterpriseSlug (String!)

The slug of the enterprise the user was invited to join.

role (EnterpriseAdministratorRole!)

The role for the business member invitation.

userLogin (String!)

The login of the user invited to join the business.

enterpriseAdministratorInvitationByToken

Look up a pending enterprise administrator invitation by invitation token.

에 대한 인수 enterpriseAdministratorInvitationByToken

이름Description

invitationToken (String!)

The invitation token sent with the invitation email.

license

Look up an open source license by its key.

형식: License

에 대한 인수 license

이름Description

key (String!)

The license's downcased SPDX ID.

licenses

Return a list of known open source licenses.

형식: [License]!

marketplaceCategories

Get alphabetically sorted list of Marketplace categories.

에 대한 인수 marketplaceCategories

이름Description

excludeEmpty (Boolean)

Exclude categories with no listings.

excludeSubcategories (Boolean)

Returns top level categories only, excluding any subcategories.

includeCategories ([String!])

Return only the specified categories.

marketplaceCategory

Look up a Marketplace category by its slug.

에 대한 인수 marketplaceCategory

이름Description

slug (String!)

The URL slug of the category.

useTopicAliases (Boolean)

Also check topic aliases for the category slug.

marketplaceListing

Look up a single Marketplace listing.

에 대한 인수 marketplaceListing

이름Description

slug (String!)

Select the listing that matches this slug. It's the short name of the listing used in its URL.

marketplaceListings

Look up Marketplace listings.

에 대한 인수 marketplaceListings

이름Description

adminId (ID)

Select listings that can be administered by the specified user.

after (String)

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

allStates (Boolean)

Select listings visible to the viewer even if they are not approved. If omitted or false, only approved listings will be returned.

before (String)

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

categorySlug (String)

Select only listings with the given category.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

organizationId (ID)

Select listings for products owned by the specified organization.

primaryCategoryOnly (Boolean)

Select only listings where the primary category matches the given category slug.

The default value is false.

slugs ([String])

Select the listings with these slugs, if they are visible to the viewer.

useTopicAliases (Boolean)

Also check topic aliases for the category slug.

viewerCanAdmin (Boolean)

Select listings to which user has admin access. If omitted, listings visible to the viewer are returned.

withFreeTrialsOnly (Boolean)

Select only listings that offer a free trial.

The default value is false.

meta

Return information about the GitHub instance.

node

Fetches an object given its ID.

형식: Node

에 대한 인수 node

이름Description

id (ID!)

ID of the object.

nodes

Lookup nodes by a list of IDs.

형식: [Node]!

에 대한 인수 nodes

이름Description

ids ([ID!]!)

The list of node IDs.

organization

Lookup a organization by login.

형식: Organization

에 대한 인수 organization

이름Description

login (String!)

The organization's login.

rateLimit

The client's rate limit information.

형식: RateLimit

에 대한 인수 rateLimit

이름Description

dryRun (Boolean)

If true, calculate the cost for the query without evaluating it.

The default value is false.

relay

Workaround for re-exposing the root query object. (Refer to https://github.com/facebook/relay/issues/112 for more information.).

형식: Query!

repository

Lookup a given repository by the owner and repository name.

형식: Repository

에 대한 인수 repository

이름Description

followRenames (Boolean)

Follow repository renames. If disabled, a repository referenced by its old name will return an error.

The default value is true.

name (String!)

The name of the repository.

owner (String!)

The login field of a user or organization.

repositoryOwner

Lookup a repository owner (ie. either a User or an Organization) by login.

에 대한 인수 repositoryOwner

이름Description

login (String!)

The username to lookup the owner by.

resource

Lookup resource by a URL.

에 대한 인수 resource

이름Description

url (URI!)

The URL.

Perform a search across resources, returning a maximum of 1,000 results.

에 대한 인수 search

이름Description

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.

query (String!)

The search string to look for.

type (SearchType!)

The types of search items to search within.

securityAdvisories

GitHub Security Advisories.

에 대한 인수 securityAdvisories

이름Description

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.

classifications ([SecurityAdvisoryClassification!])

A list of classifications to filter advisories by.

first (Int)

Returns the first n elements from the list.

identifier (SecurityAdvisoryIdentifierFilter)

Filter advisories by identifier, e.g. GHSA or CVE.

last (Int)

Returns the last n elements from the list.

orderBy (SecurityAdvisoryOrder)

Ordering options for the returned topics.

publishedSince (DateTime)

Filter advisories to those published since a time in the past.

updatedSince (DateTime)

Filter advisories to those updated since a time in the past.

securityAdvisory

Fetch a Security Advisory by its GHSA ID.

에 대한 인수 securityAdvisory

이름Description

ghsaId (String!)

GitHub Security Advisory ID.

securityVulnerabilities

Software Vulnerabilities documented by GitHub Security Advisories.

에 대한 인수 securityVulnerabilities

이름Description

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.

classifications ([SecurityAdvisoryClassification!])

A list of advisory classifications to filter vulnerabilities by.

ecosystem (SecurityAdvisoryEcosystem)

An ecosystem to filter vulnerabilities by.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (SecurityVulnerabilityOrder)

Ordering options for the returned topics.

package (String)

A package name to filter vulnerabilities by.

severities ([SecurityAdvisorySeverity!])

A list of severities to filter vulnerabilities by.

sponsorables

Users and organizations who can be sponsored via GitHub Sponsors.

에 대한 인수 sponsorables

이름Description

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.

dependencyEcosystem (SecurityAdvisoryEcosystem)

Optional filter for which dependencies should be checked for sponsorable owners. Only sponsorable owners of dependencies in this ecosystem will be included. Used when onlyDependencies = true.

Upcoming Change on 2022-07-01 UTC Description: dependencyEcosystem will be removed. Use the ecosystem argument instead. Reason: The type is switching from SecurityAdvisoryEcosystem to DependencyGraphEcosystem.

ecosystem (DependencyGraphEcosystem)

Optional filter for which dependencies should be checked for sponsorable owners. Only sponsorable owners of dependencies in this ecosystem will be included. Used when onlyDependencies = true.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

onlyDependencies (Boolean)

Whether only sponsorables who own the viewer's dependencies will be returned. Must be authenticated to use. Can check an organization instead for their dependencies owned by sponsorables by passing orgLoginForDependencies.

The default value is false.

orderBy (SponsorableOrder)

Ordering options for users and organizations returned from the connection.

orgLoginForDependencies (String)

Optional organization username for whose dependencies should be checked. Used when onlyDependencies = true. Omit to check your own dependencies. If you are not an administrator of the organization, only dependencies from its public repositories will be considered.

topic

Look up a topic by name.

형식: Topic

에 대한 인수 topic

이름Description

name (String!)

The topic's name.

user

Lookup a user by login.

형식: User

에 대한 인수 user

이름Description

login (String!)

The user's login.

viewer

The currently authenticated user.

형식: User!