Enterprise Server 3.15 в настоящее время доступен в качестве кандидата на выпуск.

Запросы

Тип запроса определяет операции 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.

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!