Github API - Test Config

Flexydox

TeamDiscussionComment [object]

A comment on a team discussion.

Implements
Comment

Comment [interface]

Represents a comment.

Attributes
author Actor

The actor who authored the comment.

authorAssociation CommentAuthorAssociation

Author's association with the subject of the comment.

body String

The body as Markdown.

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.

editor Actor

The actor who edited the comment.

id ID

The Node ID of the Comment object

includesCreatedEdit Boolean

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

lastEditedAt DateTime

The moment the editor made the last edit

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.

viewerDidAuthor Boolean

Did the viewer author this comment.

API:
Github GraphQL API
Deletable

Deletable [interface]

Entities that can be deleted.

Attributes
viewerCanDelete Boolean

Check if the current viewer can delete this object.

API:
Github GraphQL API
Node

Node [interface]

An object with an ID.

Attributes
id ID

ID of the object.

API:
Github GraphQL API
Reactable

Reactable [interface]

Represents a subject that can be reacted on.

Attributes
databaseId Int

Identifies the primary key from the database.

id ID

The Node ID of the Reactable object

reactionGroups ReactionGroup []

A list of reactions grouped by content left on the subject.

reactions ReactionConnection

A list of Reactions left on the Issue.

viewerCanReact Boolean

Can user react to this subject

API:
Github GraphQL API
UniformResourceLocatable

UniformResourceLocatable [interface]

Represents a type that can be retrieved by a URL.

Attributes
resourcePath URI

The HTML path to this resource.

url URI

The URL to this resource.

API:
Github GraphQL API
Updatable

Updatable [interface]

Entities that can be updated.

Attributes
viewerCanUpdate Boolean

Check if the current viewer can update this object.

API:
Github GraphQL API
UpdatableComment

UpdatableComment [interface]

Comments that can be updated.

Attributes
viewerCannotUpdateReasons CommentCannotUpdateReason []

Reasons why the current viewer can not update this comment.

API:
Github GraphQL API
Attributes
author Actor

Actor [interface]

Represents an object which can take actions on GitHub. Typically a User or Bot.

Attributes
avatarUrl URI

A URL pointing to the actor's public avatar.

login String

The username of the actor.

resourcePath URI

The HTTP path for this actor.

url URI

The HTTP URL for this actor.

API:
Github GraphQL API

The actor who authored the comment.

authorAssociation CommentAuthorAssociation

CommentAuthorAssociation [enum]

A comment author association with repository.

Possible values
COLLABORATOR

Author has been invited to collaborate on the repository.

CONTRIBUTOR

Author has previously committed to the repository.

FIRST_TIMER

Author has not previously committed to GitHub.

FIRST_TIME_CONTRIBUTOR

Author has not previously committed to the repository.

MANNEQUIN

Author is a placeholder for an unclaimed user.

MEMBER

Author is a member of the organization that owns the repository.

NONE

Author has no association with the repository.

OWNER

Author is the owner of the repository.

API:
Github GraphQL API

Author's association with the comment's team.

Deprecated: The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.
body String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The body as Markdown.

bodyHTML HTML

HTML [scalar]

A string containing HTML code.

API:
Github GraphQL API

The body rendered to HTML.

bodyText String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The body rendered to text.

bodyVersion String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The current version of the body content.

Deprecated: The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.
createdAt DateTime

DateTime [scalar]

An ISO-8601 encoded UTC date string.

API:
Github GraphQL API

Identifies the date and time when the object was created.

createdViaEmail Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Check if this comment was created via an email reply.

databaseId Int

Int [scalar]

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

API:
Github GraphQL API

Identifies the primary key from the database.

discussion TeamDiscussion

TeamDiscussion [object]

A team discussion.

Implements
CommentDeletableNodeReactableSubscribableUniformResourceLocatableUpdatableUpdatableComment
Attributes
author Actor

The actor who authored the comment.

authorAssociation CommentAuthorAssociation

Author's association with the discussion's team.

Deprecated: The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.
body String

The body as Markdown.

bodyHTML HTML

The body rendered to HTML.

bodyText String

The body rendered to text.

bodyVersion String

Identifies the discussion body hash.

Deprecated: The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.
comments TeamDiscussionCommentConnection

A list of comments on this discussion.

Deprecated: The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.
commentsResourcePath URI

The HTTP path for discussion comments

Deprecated: The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.
commentsUrl URI

The HTTP URL for discussion comments

Deprecated: The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.
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.

id ID

The Node ID of the TeamDiscussion object

includesCreatedEdit Boolean

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

isPinned Boolean

Whether or not the discussion is pinned.

Deprecated: The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.
isPrivate Boolean

Whether or not the discussion is only visible to team members and organization owners.

Deprecated: The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.
lastEditedAt DateTime

The moment the editor made the last edit

number Int

Identifies the discussion within its team.

Deprecated: The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.
publishedAt DateTime

Identifies when the comment was published at.

reactionGroups ReactionGroup []

A list of reactions grouped by content left on the subject.

reactions ReactionConnection

A list of Reactions left on the Issue.

resourcePath URI

The HTTP path for this discussion

Deprecated: The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.
team Team

The team that defines the context of this discussion.

Deprecated: The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.
title String

The title of the discussion

Deprecated: The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.
updatedAt DateTime

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

url URI

The HTTP URL for this discussion

Deprecated: The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.
userContentEdits UserContentEditConnection

A list of edits to this content.

viewerCanDelete Boolean

Check if the current viewer can delete this object.

viewerCanPin Boolean

Whether or not the current viewer can pin this discussion.

Deprecated: The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.
viewerCanReact Boolean

Can user react to this subject

viewerCanSubscribe Boolean

Check if the viewer is able to change their subscription status for the repository.

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.

viewerSubscription SubscriptionState

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

API:
Github GraphQL API

The discussion this comment is about.

Deprecated: The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.
editor Actor

Actor [interface]

Represents an object which can take actions on GitHub. Typically a User or Bot.

Attributes
avatarUrl URI

A URL pointing to the actor's public avatar.

login String

The username of the actor.

resourcePath URI

The HTTP path for this actor.

url URI

The HTTP URL for this actor.

API:
Github GraphQL API

The actor who edited the comment.

id ID

ID [scalar]

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

API:
Github GraphQL API

The Node ID of the TeamDiscussionComment object

includesCreatedEdit Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

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

lastEditedAt DateTime

DateTime [scalar]

An ISO-8601 encoded UTC date string.

API:
Github GraphQL API

The moment the editor made the last edit

number Int

Int [scalar]

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

API:
Github GraphQL API

Identifies the comment number.

Deprecated: The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.
publishedAt DateTime

DateTime [scalar]

An ISO-8601 encoded UTC date string.

API:
Github GraphQL API

Identifies when the comment was published at.

reactionGroups ReactionGroup []

ReactionGroup [object]

A group of emoji reactions to a particular piece of content.

Attributes
content ReactionContent

Identifies the emoji reaction.

createdAt DateTime

Identifies when the reaction was created.

reactors ReactorConnection

Reactors to the reaction subject with the emotion represented by this reaction group.

subject Reactable

The subject that was reacted to.

users ReactingUserConnection

Users who have reacted to the reaction subject with the emotion represented by this reaction group

Deprecated: Reactors can now be mannequins, bots, and organizations. Use the `reactors` field instead. Removal on 2021-10-01 UTC.
viewerHasReacted Boolean

Whether or not the authenticated user has left a reaction on the subject.

API:
Github GraphQL API

A list of reactions grouped by content left on the subject.

reactions ReactionConnection

ReactionConnection [object]

A list of reactions that have been left on the subject.

Attributes
edges ReactionEdge []

A list of edges.

nodes Reaction []

A list of nodes.

pageInfo PageInfo

Information to aid in pagination.

totalCount Int

Identifies the total count of items in the connection.

viewerHasReacted Boolean

Whether or not the authenticated user has left a reaction on the subject.

API:
Github GraphQL API

A list of Reactions left on the Issue.

resourcePath URI

URI [scalar]

An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.

API:
Github GraphQL API

The HTTP path for this comment

Deprecated: The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.
updatedAt DateTime

DateTime [scalar]

An ISO-8601 encoded UTC date string.

API:
Github GraphQL API

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

url URI

URI [scalar]

An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.

API:
Github GraphQL API

The HTTP URL for this comment

Deprecated: The Team Discussions feature is deprecated in favor of Organization Discussions. Follow the guide at https://github.blog/changelog/2023-02-08-sunset-notice-team-discussions/ to find a suitable replacement. Removal on 2024-07-01 UTC.
userContentEdits UserContentEditConnection

UserContentEditConnection [object]

A list of edits to content.

Attributes
edges UserContentEditEdge []

A list of edges.

nodes UserContentEdit []

A list of nodes.

pageInfo PageInfo

Information to aid in pagination.

totalCount Int

Identifies the total count of items in the connection.

API:
Github GraphQL API

A list of edits to this content.

viewerCanDelete Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Check if the current viewer can delete this object.

viewerCanReact Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Can user react to this subject

viewerCanUpdate Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Check if the current viewer can update this object.

viewerCannotUpdateReasons CommentCannotUpdateReason []

CommentCannotUpdateReason [enum]

The possible errors that will prevent a user from updating a comment.

Possible values
ARCHIVED

Unable to create comment because repository is archived.

DENIED

You cannot update this comment

INSUFFICIENT_ACCESS

You must be the author or have write access to this repository to update this comment.

LOCKED

Unable to create comment because issue is locked.

LOGIN_REQUIRED

You must be logged in to update this comment.

MAINTENANCE

Repository is under maintenance.

VERIFIED_EMAIL_REQUIRED

At least one email address must be verified to update this comment.

API:
Github GraphQL API

Reasons why the current viewer can not update this comment.

viewerDidAuthor Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Did the viewer author this comment.

API:
Github GraphQL API