ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。

クエリ

ここには以下の内容があります:

クエリについて

すべてのGraphQLスキーマは、クエリとミューテーションの両方についてルート型を持っています。 クエリ型は、サーバーからデータを取り出すGraphQLの操作を定義します。

詳しい情報については「クエリについて」を参照してください。

注釈: For user-to-server GitHub Appリクエストの場合は、Issueとプルリクエストに別々のクエリを使用する必要があります。 たとえば、is:issueまたはis:pull-requestフィルタと、それと同等のフィルタを使用します。 search接続を使用してIssueとプルリクエストの組み合わせを1つのクエリで返すと、ノードのセットが空になります。

コネクション

marketplaceListings

種類: MarketplaceListingConnection!

Look up Marketplace listings.

引数

名前 説明

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.


search

種類: SearchResultItemConnection!

Perform a search across resources.

引数

名前 説明

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

種類: SecurityAdvisoryConnection!

GitHub Security Advisories.

引数

名前 説明

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.

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.


securityVulnerabilities

種類: SecurityVulnerabilityConnection!

Software Vulnerabilities documented by GitHub Security Advisories.

引数

名前 説明

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.

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

種類: SponsorableItemConnection!

Users and organizations who can be sponsored via GitHub Sponsors.

引数

名前 説明

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.

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.


フィールド

codeOfConduct

種類: CodeOfConduct

Look up a code of conduct by its key.

引数

名前 説明

key (String!)

The code of conduct's key.


codesOfConduct

種類: [CodeOfConduct]

Look up a code of conduct by its key.

引数

名前 説明

enterprise

種類: Enterprise

Look up an enterprise by URL slug.

引数

名前 説明

invitationToken (String)

The enterprise invitation token.

slug (String!)

The enterprise URL slug.


enterpriseAdministratorInvitation

種類: EnterpriseAdministratorInvitation

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

引数

名前 説明

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

種類: EnterpriseAdministratorInvitation

Look up a pending enterprise administrator invitation by invitation token.

引数

名前 説明

invitationToken (String!)

The invitation token sent with the invitation email.


license

種類: License

Look up an open source license by its key.

引数

名前 説明

key (String!)

The license's downcased SPDX ID.


licenses

種類: [License]!

Return a list of known open source licenses.

引数

名前 説明

marketplaceCategories

種類: [MarketplaceCategory!]!

Get alphabetically sorted list of Marketplace categories.

引数

名前 説明

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

種類: MarketplaceCategory

Look up a Marketplace category by its slug.

引数

名前 説明

slug (String!)

The URL slug of the category.

useTopicAliases (Boolean)

Also check topic aliases for the category slug.


marketplaceListing

種類: MarketplaceListing

Look up a single Marketplace listing.

引数

名前 説明

slug (String!)

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


meta

種類: GitHubMetadata!

Return information about the GitHub instance.

引数

名前 説明

node

種類: Node

Fetches an object given its ID.

引数

名前 説明

id (ID!)

ID of the object.


nodes

種類: [Node]!

Lookup nodes by a list of IDs.

引数

名前 説明

ids ([ID!]!)

The list of node IDs.


organization

種類: Organization

Lookup a organization by login.

引数

名前 説明

login (String!)

The organization's login.


rateLimit

種類: RateLimit

The client's rate limit information.

引数

名前 説明

dryRun (Boolean)

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

The default value is false.


relay

種類: Query!

Hack to workaround https://github.com/facebook/relay/issues/112 re-exposing the root query object.

引数

名前 説明

repository

種類: Repository

Lookup a given repository by the owner and repository name.

引数

名前 説明

name (String!)

The name of the repository.

owner (String!)

The login field of a user or organization.


repositoryOwner

種類: RepositoryOwner

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

引数

名前 説明

login (String!)

The username to lookup the owner by.


resource

種類: UniformResourceLocatable

Lookup resource by a URL.

引数

名前 説明

url (URI!)

The URL.


securityAdvisory

種類: SecurityAdvisory

Fetch a Security Advisory by its GHSA ID.

引数

名前 説明

ghsaId (String!)

GitHub Security Advisory ID.


sponsorsListing

種類: SponsorsListing

Look up a single Sponsors Listing.

非推奨通知

sponsorsListing is deprecated.

Query.sponsorsListing will be removed. Use Sponsorable.sponsorsListing instead. Removal on 2020-04-01 UTC.

引数

名前 説明

slug (String!)

Select the Sponsors listing which matches this slug.

非推奨通知

sponsorsListing is deprecated.

Query.sponsorsListing will be removed. Use Sponsorable.sponsorsListing instead. Removal on 2020-04-01 UTC.


topic

種類: Topic

Look up a topic by name.

引数

名前 説明

name (String!)

The topic's name.


user

種類: User

Lookup a user by login.

引数

名前 説明

login (String!)

The user's login.


viewer

種類: User!

The currently authenticated user.

引数

名前 説明

Did this doc help you?

Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

OR, learn how to contribute.