Queries

Inhalt dieses Artikels

Connections
Fields

About queries

Every GraphQL schema has a root type for both queries and mutations. The query type defines GraphQL operations that retrieve data from the server.

For more information, see "About queries."

Note: For user-to-server GitHub App requests, you should use separate queries for issues and pull requests. For example, use the is:issue or is:pull-request filters and their equivalents. Using the search connection to return a combination of issues and pull requests in a single query will result in an empty set of nodes.

Connections

organizations

Typ: OrganizationConnection!

A list of organizations.

Arguments

Name	Beschreibung
`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

Typ: SearchResultItemConnection!

Perform a search across resources.

Arguments

Name	Beschreibung
`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

Typ: SecurityAdvisoryConnection!

GitHub Security Advisories.

Arguments

Name	Beschreibung
`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.
`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

Typ: SecurityVulnerabilityConnection!

Software Vulnerabilities documented by GitHub Security Advisories.

Arguments

Name	Beschreibung
`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.
`package` (`String`)	A package name to filter vulnerabilities by.
`severities` (`[SecurityAdvisorySeverity!]`)	A list of severities to filter vulnerabilities by.

users

Typ: UserConnection!

A list of users.

Arguments

Name	Beschreibung
`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.

Fields

codeOfConduct

Typ: CodeOfConduct

Look up a code of conduct by its key.

Arguments

Name Beschreibung

key (String!)

The code of conduct's key.

codesOfConduct

Typ: [CodeOfConduct]

Look up a code of conduct by its key.

enterprise

Typ: Enterprise

Look up an enterprise by URL slug.

Arguments

Name Beschreibung

invitationToken (String)

The enterprise invitation token.

slug (String!)

The enterprise URL slug.

license

Typ: License

Look up an open source license by its key.

Arguments

Name Beschreibung

key (String!)

The license's downcased SPDX ID.

licenses

Typ: [License]!

Return a list of known open source licenses.

node

Typ: Node

Fetches an object given its ID.

Arguments

Name Beschreibung

id (ID!)

ID of the object.

nodes

Typ: [Node]!

Lookup nodes by a list of IDs.

Arguments

Name Beschreibung

ids ([ID!]!)

The list of node IDs.

organization

Typ: Organization

Lookup a organization by login.

Arguments

Name Beschreibung

login (String!)

The organization's login.

rateLimit

Typ: RateLimit

The client's rate limit information.

Arguments

Name Beschreibung

dryRun (Boolean)

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

The default value is false.

relay

Typ: Query!

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

repository

Typ: Repository

Lookup a given repository by the owner and repository name.

Arguments

Name Beschreibung

name (String!)

The name of the repository.

owner (String!)

The login field of a user or organization.

repositoryOwner

Typ: RepositoryOwner

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

Arguments

Name Beschreibung

login (String!)

The username to lookup the owner by.

resource

Typ: UniformResourceLocatable

Lookup resource by a URL.

Arguments

Name Beschreibung

url (URI!)

The URL.

securityAdvisory

Typ: SecurityAdvisory

Fetch a Security Advisory by its GHSA ID.

Arguments

Name Beschreibung

ghsaId (String!)

GitHub Security Advisory ID.

topic

Typ: Topic

Look up a topic by name.

Arguments

Name Beschreibung

name (String!)

The topic's name.

user

Typ: User

Lookup a user by login.

Arguments

Name Beschreibung

login (String!)

The user's login.

viewer

Typ: User!

The currently authenticated user.

Queries

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Still need help?