쿼리

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

이 문서의 내용

쿼리 정보

모든 GraphQL 스키마에는 쿼리 및 변형 모두에 대한 루트 형식이 있습니다. 쿼리 형식은 서버의 데이터를 검색하는 GraphQL 작업을 정의합니다.

자세한 내용은 GraphQL을 사용하여 통화 구성을(를) 참조하세요.

Note

사용자 액세스 토큰으로 만든 GitHub App 요청의 경우, 이슈와 끌어오기 요청에 대해 별도의 쿼리를 사용해야 합니다. 예를 들어, is:issue 또는 is:pull-request 필터 및 그와 동등한 것을 사용하세요. search 연결을 사용하여 단일 쿼리에서 이슈 및 끌어오기 요청의 조합을 반환하면 빈 노드 집합이 생성됩니다.

codeOfConduct

Look up a code of conduct by its key.

codeOfConduct 의 인수

속성설명

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 의 인수

속성설명

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 의 인수

속성설명

enterpriseSlug (String!)

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

role (EnterpriseAdministratorRole!)

The role for the enterprise member invitation.

userLogin (String!)

The login of the user invited to join the enterprise.

enterpriseAdministratorInvitationByToken

Look up a pending enterprise administrator invitation by invitation token.

enterpriseAdministratorInvitationByToken 의 인수

속성설명

invitationToken (String!)

The invitation token sent with the invitation email.

enterpriseMemberInvitation

Look up a pending enterprise unaffiliated member invitation by invitee and enterprise.

enterpriseMemberInvitation 의 인수

속성설명

enterpriseSlug (String!)

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

userLogin (String!)

The login of the user invited to join the enterprise.

enterpriseMemberInvitationByToken

Look up a pending enterprise unaffiliated member invitation by invitation token.

enterpriseMemberInvitationByToken 의 인수

속성설명

invitationToken (String!)

The invitation token sent with the invitation email.

id

ID of the object.

형식: ID!

license

Look up an open source license by its key.

형식: License

license 의 인수

속성설명

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 의 인수

속성설명

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 의 인수

속성설명

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 의 인수

속성설명

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 의 인수

속성설명

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 의 인수

속성설명

id (ID!)

ID of the object.

nodes

Lookup nodes by a list of IDs.

형식: [Node]!

nodes 의 인수

속성설명

ids ([ID!]!)

The list of node IDs.

organization

Lookup a organization by login.

형식: Organization

organization 의 인수

속성설명

login (String!)

The organization's login.

rateLimit

The client's rate limit information.

형식: RateLimit

rateLimit 의 인수

속성설명

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 의 인수

속성설명

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 의 인수

속성설명

login (String!)

The username to lookup the owner by.

resource

Lookup resource by a URL.

resource 의 인수

속성설명

url (URI!)

The URL.

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

search 의 인수

속성설명

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. GitHub search syntax is supported. For more information, see "Searching on GitHub," "Understanding the search syntax," and "Sorting search results.".

type (SearchType!)

The types of search items to search within.

securityAdvisories

GitHub Security Advisories.

securityAdvisories 의 인수

속성설명

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.

epssPercentage (Float)

The EPSS percentage to filter advisories by.

epssPercentile (Float)

The EPSS percentile 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 의 인수

속성설명

ghsaId (String!)

GitHub Security Advisory ID.

securityVulnerabilities

Software Vulnerabilities documented by GitHub Security Advisories.

securityVulnerabilities 의 인수

속성설명

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 의 인수

속성설명

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 의 인수

속성설명

name (String!)

The topic's name.

user

Lookup a user by login.

형식: User

user 의 인수

속성설명

login (String!)

The user's login.

viewer

The currently authenticated user.

형식: User!