Skip to main content

Enterprise Server 3.21 est actuellement disponible en tant que version candidate.

Reference documentation for GraphQL schema types in the Meta category.

Queries

codeOfConduct

Query

Look up a code of conduct by its key.

Type: CodeOfConduct

Arguments pour codeOfConduct

NomDescription

key (String!)

The code of conduct's key.

codesOfConduct

Query

Look up a code of conduct by its key.

Type: [CodeOfConduct]

meta

Query

Return information about the GitHub instance.

Type: GitHubMetadata!

node

Query

Fetches an object given its ID.

Type: Node

Arguments pour node

NomDescription

id (ID!)

ID of the object.

nodes

Query

Lookup nodes by a list of IDs.

Type: [Node]!

Arguments pour nodes

NomDescription

ids ([ID!]!)

The list of node IDs.

rateLimit

Query

The client's rate limit information.

Type: RateLimit

Arguments pour rateLimit

NomDescription

dryRun (Boolean)

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

The default value is false.

resource

Query

Lookup resource by a URL.

Type: UniformResourceLocatable

Arguments pour resource

NomDescription

url (URI!)

The URL.

Objects

CodeOfConduct

Object

The Code of Conduct for a repository.

CodeOfConduct Met en œuvre

Champs pour CodeOfConduct

NomDescription

body (String)

The body of the Code of Conduct.

id (ID!)

The Node ID of the CodeOfConduct object.

key (String!)

The key for the Code of Conduct.

name (String!)

The formal name of the Code of Conduct.

resourcePath (URI)

The HTTP path for this Code of Conduct.

url (URI)

The HTTP URL for this Code of Conduct.

GitHubMetadata

Object

Represents information about the GitHub instance.

Champs pour GitHubMetadata

NomDescription

gitHubServicesSha (GitObjectID!)

Returns a String that's a SHA of github-services.

isPasswordAuthenticationVerifiable (Boolean!)

Whether or not users are verified.

RateLimit

Object

Represents the client's rate limit.

Champs pour RateLimit

NomDescription

cost (Int!)

The point cost for the current query counting against the rate limit.

limit (Int!)

The maximum number of points the client is permitted to consume in a 60 minute window.

nodeCount (Int!)

The maximum number of nodes this query may return.

remaining (Int!)

The number of points remaining in the current rate limit window.

resetAt (DateTime!)

The time at which the current rate limit window resets in UTC epoch seconds.

used (Int!)

The number of points used in the current rate limit window.

Interfaces

Node

Interface

An object with an ID.

Node est implémenté par

Champs pour Node

NomDescription

id (ID!)

ID of the object.

UniformResourceLocatable

Interface

Represents a type that can be retrieved by a URL.

UniformResourceLocatable est implémenté par

Champs pour UniformResourceLocatable

NomDescription

resourcePath (URI!)

The HTML path to this resource.

url (URI!)

The URL to this resource.

Enums

OperationType

Enum

The corresponding operation type for the action.

Valeurs pour OperationType.

NomDescription
ACCESS

An existing resource was accessed.

AUTHENTICATION

A resource performed an authentication event.

CREATE

A new resource was created.

MODIFY

An existing resource was modified.

REMOVE

An existing resource was removed.

RESTORE

An existing resource was restored.

TRANSFER

An existing resource was transferred between multiple resources.

OrderDirection

Enum

Possible directions in which to order a list of items when provided an orderBy argument.

Valeurs pour OrderDirection.

NomDescription
ASC

Specifies an ascending order for a given orderBy argument.

DESC

Specifies a descending order for a given orderBy argument.

ReportedContentClassifiers

Enum

The reasons a piece of content can be reported or minimized.

Valeurs pour ReportedContentClassifiers.

NomDescription
DUPLICATE

A duplicated piece of content.

OFF_TOPIC

An irrelevant piece of content.

OUTDATED

An outdated piece of content.

RESOLVED

The content has been resolved.