クエリ

クエリの種類によって、サーバーからデータを取得する GraphQL 操作が定義されます。

この記事の内容

クエリについて

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

詳しくは、「GraphQLでの呼び出しの作成」を参照してください。

注: ユーザー アクセス トークンでの GitHub App 要求の場合は、issue と pull request に対して個別のクエリを使う必要があります。 たとえば、is:issue または is:pull-request のフィルターと同等のものを使います。 search 接続を使って issue と pull request の組み合わせを 1 つのクエリで返すと、ノードのセットが空になります。

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.

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]!

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.

organizations

A list of organizations.

organizations の引数

名前説明

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 (OrganizationOrder)

Ordering options for the User's organizations.

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.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

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.

package (String)

A package name to filter vulnerabilities by.

severities ([SecurityAdvisorySeverity!])

A list of severities to filter vulnerabilities by.

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.

users

A list of users.

users の引数

名前説明

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.

viewer

The currently authenticated user.

種類: User!