Reference documentation for GraphQL schema types in the Gists category.

この記事で

Objects

Gist

Object

A Gist.

Gist 実装

Gist のフィールド

名前説明

comments (GistCommentConnection!)

A list of comments associated with the gist.

comments の引数

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

createdAt (DateTime!)

Identifies the date and time when the object was created.

description (String)

The gist description.

files ([GistFile])

The files in this gist.

files の引数

  • limit (Int)

    The maximum number of files to return.

    The default value is 10.

forks (GistConnection!)

A list of forks associated with the gist.

forks の引数

  • 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 (GistOrder)

    Ordering options for gists returned from the connection.

id (ID!)

The Node ID of the Gist object.

isFork (Boolean!)

Identifies if the gist is a fork.

isPublic (Boolean!)

Whether the gist is public or not.

name (String!)

The gist name.

owner (RepositoryOwner)

The gist owner.

pushedAt (DateTime)

Identifies when the gist was last pushed to.

resourcePath (URI!)

The HTML path to this resource.

stargazerCount (Int!)

Returns a count of how many stargazers there are on this object.

stargazers (StargazerConnection!)

A list of users who have starred this starrable.

stargazers の引数

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

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL for this Gist.

viewerHasStarred (Boolean!)

Returns a boolean indicating whether the viewing user has starred this starrable.

GistComment

Object

Represents a comment on an Gist.

GistComment 実装

GistComment のフィールド

名前説明

author (Actor)

The actor who authored the comment.

authorAssociation (CommentAuthorAssociation!)

Author's association with the gist.

body (String!)

Identifies the comment body.

bodyHTML (HTML!)

The body rendered to HTML.

bodyText (String!)

The body rendered to text.

createdAt (DateTime!)

Identifies the date and time when the object was created.

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

databaseId (Int)

Identifies the primary key from the database.

editor (Actor)

The actor who edited the comment.

gist (Gist!)

The associated gist.

id (ID!)

The Node ID of the GistComment object.

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

lastEditedAt (DateTime)

The moment the editor made the last edit.

minimizedReason (String)

Returns why the comment was minimized. One of abuse, off-topic, outdated, resolved, duplicate, spam, and low-quality. Note that the case and formatting of these values differs from the inputs to the MinimizeComment mutation.

publishedAt (DateTime)

Identifies when the comment was published at.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

userContentEdits (UserContentEditConnection)

A list of edits to this content.

userContentEdits の引数

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

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

viewerCanUnminimize (Boolean!)

Check if the current viewer can unminimize this object.

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

GistCommentConnection

Object

The connection type for GistComment.

GistCommentConnection のフィールド

名前説明

edges ([GistCommentEdge])

A list of edges.

nodes ([GistComment])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

GistCommentEdge

Object

An edge in a connection.

GistCommentEdge のフィールド

名前説明

cursor (String!)

A cursor for use in pagination.

node (GistComment)

The item at the end of the edge.

GistConnection

Object

The connection type for Gist.

GistConnection のフィールド

名前説明

edges ([GistEdge])

A list of edges.

nodes ([Gist])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

GistEdge

Object

An edge in a connection.

GistEdge のフィールド

名前説明

cursor (String!)

A cursor for use in pagination.

node (Gist)

The item at the end of the edge.

GistFile

Object

A file in a gist.

GistFile のフィールド

名前説明

encodedName (String)

The file name encoded to remove characters that are invalid in URL paths.

encoding (String)

The gist file encoding.

extension (String)

The file extension from the file name.

isImage (Boolean!)

Indicates if this file is an image.

isTruncated (Boolean!)

Whether the file's contents were truncated.

language (Language)

The programming language this file is written in.

name (String)

The gist file name.

size (Int)

The gist file size in bytes.

text (String)

UTF8 text data or null if the file is binary.

text の引数

  • truncate (Int)

    Optionally truncate the returned file to this length.

Enums

GistOrderField

Enum

Properties by which gist connections can be ordered.

GistOrderField の値です。

名前説明
CREATED_AT

Order gists by creation time.

PUSHED_AT

Order gists by push time.

UPDATED_AT

Order gists by update time.

GistPrivacy

Enum

The privacy of a Gist.

GistPrivacy の値です。

名前説明
ALL

Gists that are public and secret.

PUBLIC

Public.

SECRET

Secret.

Input objects

GistOrder

Input object

Ordering options for gist connections.

GistOrder の入力フィールド

名前説明

direction (OrderDirection!)

The ordering direction.

field (GistOrderField!)

The field to order repositories by.