Consultas

O tipo de consulta define as operações do GraphQL que recuperam os dados do servidor.

Neste artigo

Sobre consultas

Cada esquema de GraphQL tem um tipo de raiz para consultas e mutações. O tipo de consulta define as operações do GraphQL que recuperam os dados do servidor.

Para obter mais informações, confira "Realizar chamadas com o GraphQL".

Note

Para solicitações do GitHub App feitas com tokens de acesso de usuário, use consultas separadas para problemas e pull requests. Por exemplo, use os filtros is:issue ou is:pull-request e os equivalentes. O uso da conexão search para retornar uma combinação de problemas e solicitações de pull em uma só consulta resultará em um conjunto vazio de nós.

codeOfConduct

Look up a code of conduct by its key.

Argumentos para codeOfConduct

NomeDescrição

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.

Argumentos para enterprise

NomeDescrição

invitationToken (String)

The enterprise invitation token.

slug (String!)

The enterprise URL slug.

license

Look up an open source license by its key.

Tipo: License

Argumentos para license

NomeDescrição

key (String!)

The license's downcased SPDX ID.

licenses

Return a list of known open source licenses.

meta

Return information about the GitHub instance.

node

Fetches an object given its ID.

Tipo: Node

Argumentos para node

NomeDescrição

id (ID!)

ID of the object.

nodes

Lookup nodes by a list of IDs.

Tipo: [Node]!

Argumentos para nodes

NomeDescrição

ids ([ID!]!)

The list of node IDs.

organization

Lookup a organization by login.

Argumentos para organization

NomeDescrição

login (String!)

The organization's login.

organizations

A list of organizations.

Argumentos para organizations

NomeDescrição

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.

Tipo: RateLimit

Argumentos para rateLimit

NomeDescrição

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.).

Tipo: Query!

repository

Lookup a given repository by the owner and repository name.

Argumentos para repository

NomeDescrição

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.

Argumentos para repositoryOwner

NomeDescrição

login (String!)

The username to lookup the owner by.

resource

Lookup resource by a URL.

Argumentos para resource

NomeDescrição

url (URI!)

The URL.

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

Argumentos para search

NomeDescrição

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.

Argumentos para securityAdvisories

NomeDescrição

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.

Argumentos para securityAdvisory

NomeDescrição

ghsaId (String!)

GitHub Security Advisory ID.

securityVulnerabilities

Software Vulnerabilities documented by GitHub Security Advisories.

Argumentos para securityVulnerabilities

NomeDescrição

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.

Tipo: Topic

Argumentos para topic

NomeDescrição

name (String!)

The topic's name.

user

Lookup a user by login.

Tipo: User

Argumentos para user

NomeDescrição

login (String!)

The user's login.

users

A list of users.

Argumentos para users

NomeDescrição

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.

Tipo: User!