Skip to main content
Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco.
O GitHub AE está atualmente sob versão limitada. Entre em contato com nossa Equipe de Vendas para saber mais.
GitHub AE
Português do Brasil
 
GraphQL API
GitHub AE
Português do Brasil

 

Consultas

Neste artigo

Sobre as consultas

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

Para obter mais informações, consulte "Sobre consultas".

Observação: Para solicitações de aplicativo GitHub do tipo usuário para servidor você deve usar consultas separadas para problemas e pull requests. Por exemplo, use os filtros is:issue ou is:pull-request e seus equivalentes. Usar a conexão de pesquisa para retornar uma combinação de problemas e pull requests em uma única consulta resultará em um conjunto de nós vazio.

Conexões

organizations

Tipo: OrganizationConnection!

A list of organizations.

Argumentos

Nome Descriçã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.

search

Tipo: SearchResultItemConnection!

Perform a search across resources.

Argumentos

Nome Descriçã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

Tipo: SecurityAdvisoryConnection!

GitHub Security Advisories.

Argumentos

Nome Descriçã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.

securityVulnerabilities

Tipo: SecurityVulnerabilityConnection!

Software Vulnerabilities documented by GitHub Security Advisories.

Argumentos

Nome Descriçã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.

users

Tipo: UserConnection!

A list of users.

Argumentos

Nome Descriçã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.

Campos

codeOfConduct

Tipo: CodeOfConduct

Look up a code of conduct by its key.

Argumentos

Nome Descrição

key (String!)

The code of conduct's key.

codesOfConduct

Tipo: [CodeOfConduct]

Look up a code of conduct by its key.

enterprise

Tipo: Enterprise

Look up an enterprise by URL slug.

Argumentos

Nome Descrição

invitationToken (String)

The enterprise invitation token.

slug (String!)

The enterprise URL slug.

license

Tipo: License

Look up an open source license by its key.

Argumentos

Nome Descrição

key (String!)

The license's downcased SPDX ID.

licenses

Tipo: [License]!

Return a list of known open source licenses.

meta

Tipo: GitHubMetadata!

Return information about the GitHub instance.

node

Tipo: Node

Fetches an object given its ID.

Argumentos

Nome Descrição

id (ID!)

ID of the object.

nodes

Tipo: [Node]!

Lookup nodes by a list of IDs.

Argumentos

Nome Descrição

ids ([ID!]!)

The list of node IDs.

organization

Tipo: Organization

Lookup a organization by login.

Argumentos

Nome Descrição

login (String!)

The organization's login.

rateLimit

Tipo: RateLimit

The client's rate limit information.

Argumentos

Nome Descrição

dryRun (Boolean)

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

The default value is false.

relay

Tipo: Query!

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

repository

Tipo: Repository

Lookup a given repository by the owner and repository name.

Argumentos

Nome Descriçã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

Tipo: RepositoryOwner

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

Argumentos

Nome Descrição

login (String!)

The username to lookup the owner by.

resource

Tipo: UniformResourceLocatable

Lookup resource by a URL.

Argumentos

Nome Descrição

url (URI!)

The URL.

securityAdvisory

Tipo: SecurityAdvisory

Fetch a Security Advisory by its GHSA ID.

Argumentos

Nome Descrição

ghsaId (String!)

GitHub Security Advisory ID.

topic

Tipo: Topic

Look up a topic by name.

Argumentos

Nome Descrição

name (String!)

The topic's name.

user

Tipo: User

Lookup a user by login.

Argumentos

Nome Descrição

login (String!)

The user's login.

viewer

Tipo: User!

The currently authenticated user.