Die GitHub Discussions GraphQL API ermöglicht es dir, Diskussionsbeiträge zu erhalten, zu erstellen, zu bearbeiten und zu löschen. Weitere Informationen zu GitHub Discussions findest du unter Informationen zu Diskussionen.
Diese API ist für authentifizierte Benutzer*innen, OAuth apps und GitHub-Apps verfügbar. Zugriffstoken erfordern den repo Bereich für private Repositorys und den public_repo Bereich für öffentliche Repositorys. Weitere Informationen finden Sie unter Bereiche für OAuth-Apps.
Felder
Repository.discussions
Liste die Diskussionen innerhalb eines Repositorys auf. Wenn categoryId angegeben ist, werden nur Ergebnisse innerhalb dieser Kategorie zurückgegeben.
Unterschrift:
discussions(
after: String,
before: String,
first: Int,
last: Int,
categoryId: ID = null,
orderBy: DiscussionOrder = {field: UPDATED_AT, direction: DESC}
) : Discussion
DiscussionOrder
"""
Ways in which discussions can be ordered.
"""
input DiscussionOrder {
"""
The field by which to order discussions.
"""
field: DiscussionOrderField!
"""
The direction in which to order discussions by the specified field.
"""
direction: OrderDirection!
}
"""
Properties by which discussion connections can be ordered.
"""
enum DiscussionOrderField {
"""
Order discussions by creation time.
"""
CREATED_AT
"""
Order discussions by most recent modification time.
"""
UPDATED_AT
}
Repository.discussionCategories
Gib die verfügbaren Diskussionskategorien zurück, die in diesem Repository definiert sind. Jedes Repository kann bis zu 25 Kategorien aufweisen. Weitere Informationen zu Diskussionskategorien findest du unter Informationen zu Diskussionen.
Unterschrift:
discussionCategories(
after: String,
before: String,
first: Int,
last: Int,
) : DiscussionCategoryConnection!
Repository.discussion
Abrufen einer Diskussion. Gibt null zurück, wenn die Diskussion mit der angegebenen ID nicht vorhanden ist.
Unterschrift:
discussion(number: Int!) : Discussion
Repository.pinnedDiscussions
Zurückgeben von Diskussionen, die an dieses Repository angeheftet wurden, sortiert nach Pinposition.
Unterschrift:
pinnedDiscussions(
after: String,
before: String,
first: Int,
last: Int,
) : PinnedDiscussionConnection!
Objekte
Hinweis: Verbindungstypen werden hier nicht erweitert. Jeder im Schema erwähnte Verbindungstyp folgt demselben Muster wie andere Verbindungen in der GraphQL-API. Weitere Informationen finden Sie unter Einführung in GraphQL.
query {
repository(owner: "github", name: "some-repo") {
discussions(first: 10) {
# type: DiscussionConnection
totalCount # Int!
pageInfo {
# type: PageInfo (from the public schema)
startCursor
endCursor
hasNextPage
hasPreviousPage
}
edges {
# type: DiscussionEdge
cursor
node {
# type: Discussion
id
}
}
nodes {
# type: Discussion
id
}
}
}
}
Diskussion (Discussion)
Felder:
"""
A discussion in a repository.
"""
type Discussion implements Comment & Deletable & Lockable & Node & Reactable & RepositoryNode & Subscribable & Updatable {
"""
Reason that the conversation was locked.
"""
activeLockReason: LockReason
"""
The comment chosen as this discussion's answer, if any.
"""
answer: DiscussionComment
"""
The time when a user chose this discussion's answer, if answered.
"""
answerChosenAt: DateTime
"""
The user who chose this discussion's answer, if answered.
"""
answerChosenBy: Actor
"""
The actor who authored the comment.
"""
author: Actor
"""
Author's association with the subject of the comment.
"""
authorAssociation: CommentAuthorAssociation!
"""
The main text of the discussion post.
"""
body: String!
"""
The body rendered to HTML.
"""
bodyHTML: HTML!
"""
The body rendered to text.
"""
bodyText: String!
"""
The category for this discussion.
"""
category: DiscussionCategory!
"""
The replies to the discussion.
"""
comments(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): DiscussionCommentConnection!
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
Check if this comment was created via an email reply.
"""
createdViaEmail: Boolean!
"""
Identifies the primary key from the database.
"""
databaseId: Int
"""
The actor who edited the comment.
"""
editor: Actor
id: ID!
"""
Check if this comment was edited and includes an edit with the creation data
"""
includesCreatedEdit: Boolean!
"""
The moment the editor made the last edit
"""
lastEditedAt: DateTime
"""
`true` if the object is locked
"""
locked: Boolean!
"""
The number identifying this discussion within the repository.
"""
number: Int!
"""
Identifies when the comment was published at.
"""
publishedAt: DateTime
"""
A list of reactions grouped by content left on the subject.
"""
reactionGroups: [ReactionGroup!]
"""
A list of Reactions left on the Issue.
"""
reactions(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Allows filtering Reactions by emoji.
"""
content: ReactionContent
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Allows specifying the order in which reactions are returned.
"""
orderBy: ReactionOrder
): ReactionConnection!
"""
The repository associated with this node.
"""
repository: Repository!
"""
The path for this discussion.
"""
resourcePath: URI!
"""
The title of this discussion.
"""
title: String!
"""
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
"""
The URL for this discussion.
"""
url: URI!
"""
A list of edits to this content.
"""
userContentEdits(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): UserContentEditConnection
"""
Check if the current viewer can delete this object.
"""
viewerCanDelete: Boolean!
"""
Can user react to this subject
"""
viewerCanReact: Boolean!
"""
Check if the viewer is able to change their subscription status for the repository.
"""
viewerCanSubscribe: Boolean!
"""
Check if the current viewer can update this object.
"""
viewerCanUpdate: Boolean!
"""
Did the viewer author this comment.
"""
viewerDidAuthor: Boolean!
"""
Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.
"""
viewerSubscription: SubscriptionState
}
DiscussionComment
Felder
"""
A comment on a discussion.
"""
type DiscussionComment implements Comment & Deletable & Minimizable & Node & Reactable & Updatable & UpdatableComment {
"""
The actor who authored the comment.
"""
author: Actor
"""
Author's association with the subject of the comment.
"""
authorAssociation: CommentAuthorAssociation!
"""
The body as Markdown.
"""
body: String!
"""
The body rendered to HTML.
"""
bodyHTML: HTML!
"""
The body rendered to text.
"""
bodyText: String!
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
Check if this comment was created via an email reply.
"""
createdViaEmail: Boolean!
"""
Identifies the primary key from the database.
"""
databaseId: Int
"""
The time when this replied-to comment was deleted
"""
deletedAt: DateTime
"""
The discussion this comment was created in
"""
discussion: Discussion
"""
The actor who edited the comment.
"""
editor: Actor
id: ID!
"""
Check if this comment was edited and includes an edit with the creation data
"""
includesCreatedEdit: Boolean!
"""
Has this comment been chosen as the answer of its discussion?
"""
isAnswer: Boolean!
"""
Returns whether or not a comment has been minimized.
"""
isMinimized: Boolean!
"""
The moment the editor made the last edit
"""
lastEditedAt: DateTime
"""
Returns why the comment was minimized.
"""
minimizedReason: String
"""
Identifies when the comment was published at.
"""
publishedAt: DateTime
"""
A list of reactions grouped by content left on the subject.
"""
reactionGroups: [ReactionGroup!]
"""
A list of Reactions left on the Issue.
"""
reactions(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Allows filtering Reactions by emoji.
"""
content: ReactionContent
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Allows specifying the order in which reactions are returned.
"""
orderBy: ReactionOrder
): ReactionConnection!
"""
The threaded replies to this comment.
"""
replies(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): DiscussionCommentConnection!
"""
The discussion comment this comment is a reply to
"""
replyTo: DiscussionComment
"""
The path for this discussion comment.
"""
resourcePath: URI!
"""
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
"""
The URL for this discussion comment.
"""
url: URI!
"""
A list of edits to this content.
"""
userContentEdits(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
): UserContentEditConnection
"""
Check if the current viewer can delete this object.
"""
viewerCanDelete: Boolean!
"""
Can the current user mark this comment as an answer?
"""
viewerCanMarkAsAnswer: Boolean!
"""
Check if the current viewer can minimize this object.
"""
viewerCanMinimize: Boolean!
"""
Can user react to this subject
"""
viewerCanReact: Boolean!
"""
Can the current user unmark this comment as an answer?
"""
viewerCanUnmarkAsAnswer: Boolean!
"""
Check if the current viewer can update this object.
"""
viewerCanUpdate: Boolean!
"""
Reasons why the current viewer can not update this comment.
"""
viewerCannotUpdateReasons: [CommentCannotUpdateReason!]!
"""
Did the viewer author this comment.
"""
viewerDidAuthor: Boolean!
}
DiscussionCategory
Felder
"""
A category for discussions in a repository.
"""
type DiscussionCategory implements Node & RepositoryNode {
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
A description of this category.
"""
description: String
"""
An emoji representing this category.
"""
emoji: String!
"""
This category's emoji rendered as HTML.
"""
emojiHTML: HTML!
id: ID!
"""
Whether or not discussions in this category support choosing an answer with the markDiscussionCommentAsAnswer mutation.
"""
isAnswerable: Boolean!
"""
The name of this category.
"""
name: String!
"""
The repository associated with this node.
"""
repository: Repository!
"""
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
}
PinnedDiscussion
Felder:
"""
A Pinned discussion is a discussion pinned to a repository's index page.
"""
type PinnedDiscussion implements Node & RepositoryNode {
"""
Identifies the date and time when the object was created.
"""
createdAt: DateTime!
"""
Identifies the primary key from the database.
"""
databaseId: Int
"""
The discussion that was pinned.
"""
discussion: Discussion!
"""
Color stops of the chosen gradient
"""
gradientStopColors: [String!]!
id: ID!
"""
Background texture pattern
"""
pattern: PinnedDiscussionPattern!
"""
The actor that pinned this discussion.
"""
pinnedBy: Actor!
"""
Preconfigured background gradient option
"""
preconfiguredGradient: PinnedDiscussionGradient
"""
The repository associated with this node.
"""
repository: Repository!
"""
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
}
PinnedDiscussionPattern
Werte
"""
Preconfigured background patterns that may be used to style discussions pinned within a repository.
"""
enum PinnedDiscussionPattern {
"""
An upward-facing chevron pattern
"""
CHEVRON_UP
"""
A hollow dot pattern
"""
DOT
"""
A solid dot pattern
"""
DOT_FILL
"""
A heart pattern
"""
HEART_FILL
"""
A friendly octocat face pattern
"""
OCTOFACE
"""
A plus sign pattern
"""
PLUS
}
PinnedDiscussionGradient
Werte
"""
Preconfigured gradients that may be used to style discussions pinned within a repository.
"""
enum PinnedDiscussionGradient {
"""
A gradient of blue to mint
"""
BLUE_MINT
"""
A gradient of blue to purple
"""
BLUE_PURPLE
"""
A gradient of pink to blue
"""
PINK_BLUE
"""
A gradient of purple to coral
"""
PURPLE_CORAL
"""
A gradient of red to orange
"""
RED_ORANGE
}
Schnittstellen
RepositoryDiscussionAuthor
Implementiert durch die User und Organization Typen. Hinweis: Ein Organization wird nur dann mit Diskussionen verbunden, wenn es aus einem User konvertiert wurde.
Felder
"""
Represents an author of discussions in repositories.
"""
interface RepositoryDiscussionAuthor {
"""
Discussions this user has started.
"""
repositoryDiscussions(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Filter discussions to only those that have been answered or not. Defaults to
including both answered and unanswered discussions.
"""
answered: Boolean = null
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Ordering options for discussions returned from the connection.
"""
orderBy: DiscussionOrder = {field: CREATED_AT, direction: DESC}
"""
Filter discussions to only those in a specific repository.
"""
repositoryId: ID
): DiscussionConnection!
}
RepositoryDiscussionCommentAuthor
Außerdem implementiert durch die User und Organization Typen.
Felder
"""
Represents an author of discussion comments in repositories.
"""
interface RepositoryDiscussionCommentAuthor {
"""
Discussion comments this user has authored.
"""
repositoryDiscussionComments(
"""
Returns the elements in the list that come after the specified cursor.
"""
after: String
"""
Returns the elements in the list that come before the specified cursor.
"""
before: String
"""
Returns the first _n_ elements from the list.
"""
first: Int
"""
Returns the last _n_ elements from the list.
"""
last: Int
"""
Filter discussion comments to only those that were marked as the answer
"""
onlyAnswers: Boolean = false
"""
Filter discussion comments to only those in a specific repository.
"""
repositoryId: ID
): DiscussionCommentConnection!
}
Mutationen
Diese Mutationen folgen demselben Implementierungsmuster wie andere Mutationen in der GraphQL-API. Jede Mutation akzeptiert ein einzelnes Argument eines Input Typs, der nach der Mutation benannt ist, und gibt einen Payload Typ zurück, der die angegebenen Felder enthält.
Dies ist beispielsweise eine grundlegende createDiscussion Mutation, die eine neue Diskussion schafft:
mutation {
# input type: CreateDiscussionInput
createDiscussion(input: {repositoryId: "1234", categoryId: "5678", body: "The body", title: "The title"}) {
# response type: CreateDiscussionPayload
discussion {
id
}
}
}
createDiscussion
Eingabefelder:
body: String!Der Textkörper der neuen Diskussion.title: String!Der Titel der neuen Diskussion.repositoryId: ID!Die ID eines Repositorys, in dem die Diskussion erstellt werden soll.categoryId: ID!Die ID einesDiscussionCategoryinnerhalb dieses Repositorys.clientMutationId: StringEin eindeutiger Bezeichner für den Client, der die Mutation ausführt.
Rückgabetypfelder:
clientMutationId: StringDer eindeutige Bezeichner, der als Eingabe bereitgestellt wird.discussion: DiscussionDie Diskussion, die erstellt wurde.
updateDiscussion
Eingabefelder:
discussionId: ID!Die Knoten-ID der zu aktualisierenden Diskussion.body: StringDer neue Inhalt des Diskussionstexts.title: StringDer neue Diskussionstitel.categoryId: IDDie Knoten-ID einesDiscussionCategoryinnerhalb desselben Repositorys, um diese Diskussion zu ändern.clientMutationId: StringEin eindeutiger Bezeichner für den Client, der die Mutation ausführt.
Rückgabetypfelder:
clientMutationId: StringDer eindeutige Bezeichner, der als Eingabe bereitgestellt wird.discussion: DiscussionDie Diskussion, die geändert wurde.
deleteDiscussion
Eingabefelder:
id: ID!Die Knoten-ID der zu löschenden Diskussion.clientMutationId: StringEin eindeutiger Bezeichner für den Client, der die Mutation ausführt.
Rückgabetypfelder:
clientMutationId: StringDer eindeutige Bezeichner, der als Eingabe bereitgestellt wird.discussion: DiscussionDie Diskussion, die gelöscht wurde.
addDiscussionComment
Eingabefelder:
body: String!Der Inhalt des Kommentars.discussionId: ID!Die Knoten-ID der Diskussion, um zu kommentieren.replyToId: IDDie Knoten-ID des Diskussionskommentars, um darauf zu antworten. Falls nicht vorhanden, ist der erstellte Kommentar ein Kommentar auf oberster Ebene.clientMutationId: StringEin eindeutiger Bezeichner für den Client, der die Mutation ausführt.
Rückgabetypfelder:
clientMutationId: StringDer eindeutige Bezeichner, der als Eingabe bereitgestellt wird.comment: DiscussionCommentDer Diskussionskommentar, der erstellt wurde.
updateDiscussionComment
Eingabefelder:
body: String!Der neue Inhalt des Kommentartexts.commentId: ID!Die Knoten-ID des Diskussionskommentars, der aktualisiert werden soll.clientMutationId: StringEin eindeutiger Bezeichner für den Client, der die Mutation ausführt.
Rückgabetypfelder:
clientMutationId: StringDer eindeutige Bezeichner, der als Eingabe bereitgestellt wird.comment: DiscussionCommentDer Diskussionskommentar, der aktualisiert wurde.
deleteDiscussionComment
Eingabefelder:
id: ID!Die Knoten-ID des zu löschenden Diskussionskommentars.clientMutationId: StringEin eindeutiger Bezeichner für den Client, der die Mutation ausführt.
Rückgabetypfelder:
clientMutationId: StringDer eindeutige Bezeichner, der als Eingabe bereitgestellt wird.comment: DiscussionCommentDer Diskussionskommentar, der gelöscht wurde.
markDiscussionCommentAsAnswer
Eingabefelder:
id: ID!Die Knoten-ID des Diskussionskommentars, der als Antwort markiert werden soll.clientMutationId: StringEin eindeutiger Bezeichner für den Client, der die Mutation ausführt.
Rückgabetypfelder:
clientMutationId: StringDer eindeutige Bezeichner, der als Eingabe bereitgestellt wird.discussion: DiscussionDie Diskussion, die den ausgewählten Kommentar enthält.
unmarkDiscussionCommentAsAnswer
Eingabefelder:
id: ID!Die Knoten-ID des Diskussionskommentars, um als Antwort zu deaktivieren.clientMutationId: StringEin eindeutiger Bezeichner für den Client, der die Mutation ausführt.
Rückgabetypfelder:
clientMutationId: StringDer eindeutige Bezeichner, der als Eingabe bereitgestellt wird.discussion: DiscussionDie Diskussion, die den unmarkierten Kommentar enthält.
Suche
Die Diskussion kann von der obersten Ebene search Feld zurückgegeben werden. Um nach Diskussionen zu suchen, gibst du type als DISCUSSION an. Der SearchResultItemConnection Typ hat ein discussionCount Feld, um die Anzahl der zurückgegebenen Diskussionen zu melden, und der Discussion Typ wird der SearchResultItem Union hinzugefügt. Weitere Informationen findest du unter Abfragen und Durchsuchen von Diskussionen.