Skip to main content

Module graphql

Module graphql 

Source
Expand description

Exact GraphQL query documents issued by this plugin.

Keeping the production documents here lets the pinned-schema test validate the same bytes that are sent to GitHub, rather than a test-only copy which could drift independently. [STATUS_OPTIONS_UPDATE] is the sole document that may rewrite a board field, and its guarded caller always supplies the complete existing option set with ids.

Constants§

ADD_BLOCKED_BY
Adds GitHub’s native issue blocked-by relationship.
ADD_COMMENT
Adds one comment to an issue, signed as the account the token belongs to.
ADD_SUB_ISSUE
Files one issue under another as a sub-issue, which is what project membership is.
ADD_TO_BOARD
Puts an existing issue on the configured board.
BOARD
Reads the board’s fields and one page of its items.
COMMENT_ISSUE
Which issue one comment is on, read before that comment is edited or removed.
CREATE_ISSUE
Creates one issue in the configured repository.
DELETE_COMMENT
Removes one issue comment. Its payload carries nothing about the comment it removed.
DELETE_ISSUE
Deletes one issue, which takes its board item with it.
DOCUMENTS
Every document above, with what this source is doing when it sends one.
ISSUE
One issue by its own node id, which is what a qualified id names here.
ISSUE_BOARD_ITEMS
One issue’s board memberships alone, walked past the page a read of it carried.
ISSUE_COMMENTS
One task’s comments: a page of its issue’s own comments connection.
ISSUE_DEPENDENCIES
Reads both dependency directions for one issue, with each far end’s own kind — and the issue’s own body, which is where an edge to another source is recorded, so that half of a dependency read needs no second read of the issue or of the board.
REMOVE_BLOCKED_BY
Removes one native issue blocked-by relationship.
REMOVE_SUB_ISSUE
Takes one issue back out of its parent.
REPOSITORY
Resolves the configured repository’s node id, which creating an issue requires.
SEARCH_ISSUES
Every issue of one board, found by a search scoped to that board.
STATUS_OPTIONS_SNAPSHOT
A fresh snapshot of the Status field and every board item’s assignment.
STATUS_OPTIONS_UPDATE
Replaces a single-select field’s options. Only the guarded status-options operation may use this document, because GitHub treats the input as the complete option list.
SUB_ISSUES
One project’s tasks: the sub-issues of the issue that project is.
UPDATE_COMMENT
Replaces the body of one issue comment.
UPDATE_DRAFT
Updates an existing draft’s user-visible fields.
UPDATE_FIELD
Updates a text or single-select value on one project item.
UPDATE_ISSUE
Updates an issue’s visible fields and its open or closed state in one call.