Consultas

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

marketplaceListings

Tipo: MarketplaceListingConnection!

Look up Marketplace listings.

Argumentos

Nome Descrição

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

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.

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

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.

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

Tipo: SponsorableItemConnection!

Users and organizations who can be sponsored via GitHub Sponsors.

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.

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.


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.

Argumentos

Nome Descrição

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.


enterpriseAdministratorInvitation

Tipo: EnterpriseAdministratorInvitation

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

Argumentos

Nome Descrição

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

Tipo: EnterpriseAdministratorInvitation

Look up a pending enterprise administrator invitation by invitation token.

Argumentos

Nome Descrição

invitationToken (String!)

The invitation token sent with the invitation email.


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.

Argumentos

Nome Descrição

marketplaceCategories

Tipo: [MarketplaceCategory!]!

Get alphabetically sorted list of Marketplace categories.

Argumentos

Nome Descrição

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

Tipo: MarketplaceCategory

Look up a Marketplace category by its slug.

Argumentos

Nome Descrição

slug (String!)

The URL slug of the category.

useTopicAliases (Boolean)

Also check topic aliases for the category slug.


marketplaceListing

Tipo: MarketplaceListing

Look up a single Marketplace listing.

Argumentos

Nome Descrição

slug (String!)

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


meta

Tipo: GitHubMetadata!

Return information about the GitHub instance.

Argumentos

Nome Descrição

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.

Argumentos

Nome Descrição

repository

Tipo: Repository

Lookup a given repository by the owner and repository name.

Argumentos

Nome Descrição

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.

Argumentos

Nome Descrição

Esse documento ajudou você?Política de Privacidade

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.