Module graphql 

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_BLOCKED_BYS

Up to WRITE_BATCH native blocked-by relationships a copy adds to the issues it created, in one request.

ADD_COMMENT

Adds one comment to an issue, signed as the account the token belongs to.

ADD_COMMENTS

Adds up to COMMENT_BATCH comments in one request, each as ADD_COMMENT adds one, in order: what task comment add-many sends. GitHub runs each alias on its own and answers one it refused at its own path, beside the others.

ADD_COMMENT_WHOLE

ADD_COMMENT, selecting the whole issue commented on.

ADD_RELATES_TO

Up to RELATION_BATCH relates-to relations added in one request, each relate<n> sent only while $send<n> holds: what a link of a type a source mirrors natively writes beside its metadata.

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.

BOARD_FIELDS

The board’s own id and field definitions, and not one of its items.

BOARD_WITH_COMMENTS

A board page carrying each issue’s first comment page in the same request.

CLEAR_FIELD

Clears one project item’s value of one field, which is what a none priority is.

CLEAR_FIELD_TOKEN

CLEAR_FIELD, selecting the issue behind the board item cleared as UPDATE_ISSUE_TOKEN selects the issue it updates.

CLEAR_FIELD_WHOLE

CLEAR_FIELD, selecting the whole issue behind the board item cleared.

CLOSED_ITEMS

Every closed item of the board, by the board’s own field filter — what task status reconcile reads, and nothing else of the board.

CLOSE_ISSUES

Closes up to MUTATION_BATCH issues a copy created at a closing status, each with its own stateInput and nothing else, once its option is selected.

COMMENT_ISSUE

Which issue one comment is on, read before that comment is edited or removed.

CREATED_BOARD_ITEMS

The board item of each issue a copy created, up to COPY_DETAIL_BATCH at a time, with its Status as the board set it: what createIssue’s projectV2Ids files the issue as, which GitHub adds after answering the create, so its id comes from a read made once every create has been sent.

CREATE_FIELD

Creates one field: a single-select one with its options, or a text one for a projected metadata value. Only the guarded field setup may use this document, and only for a field the board lacks.

CREATE_ISSUE

Creates one issue. Outside a copy it is created on no board, and ADD_TO_BOARD files it; inside one, its input names the board in projectV2Ids and its project in parentIssueId, so this one request files it under both — see GitHubProjectsSource::create_filed_issue.

CREATE_ISSUES

Creates up to MUTATION_BATCH issues in one request, each filed on the board and under its project by the same createIssue — its projectV2Ids and parentIssueId — as CREATE_ISSUE creates one.

CREATION_CONTEXT

What creating an issue needs and has not read yet: the board’s own id and field definitions, as BOARD_FIELDS reads them, and the node id of the repository the issue is created in, as REPOSITORY reads it — in one request.

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.

DELETE_ISSUES

Deletes up to DELETE_BATCH issues in one request, each as DELETE_ISSUE deletes one: what a write that created several issues and was refused part way sends to take them back.

DOCUMENTS

Every document above, with what this source is doing when it sends one.

DOCUMENT_IN_PROJECT

One document by its own node id, as ISSUE reads one, with the project it is filed under and that project’s members beside it: the project issue whole, and a page of its sub-issues, each as SUB_ISSUES carries one but with no page of what blocks it.

DRAFT

One board draft by its own node id, with the board item it sits in.

ISSUE

One issue by its own node id, which is what a qualified id names here — with what a write of it needs and the issue does not carry in board_issue!: the field definitions of the boards it sits on, and the far ends of its blockedBy.

ISSUES_BY_CREATION

One page of a repository’s issues, newest first, each with when it was created and its body: what a retried copy reads to find the issue its earlier attempt created, by the create key in that body’s metadata slot — never through search, whose index lags.

ISSUES_BY_REFERENCE

REFERENCE_BATCH issues at once, each by its repository and number — the one read task status complete makes of a source, and nothing else of the board: no items, no search and no project read.

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_COPY_DETAILS

ISSUE_DETAILS as a copy reads the tasks it carries: each item with the first page of its comments and its blockedBy — the edges a copy reads of every task next, which ISSUE carries and ISSUE_DETAILS does not — COPY_DETAIL_BATCH at a time, so a copy of a changed task costs this read and nothing else.

ISSUE_DEPENDED_ON_BY

What depends on one issue: ISSUE_DEPENDENCIES with its blocking alone. No body: the reverse of a recorded edge is derived from the far end, never written down here.

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.

ISSUE_DEPENDS_ON

What one item depends on: ISSUE_DEPENDENCIES narrowed to blockedBy, so a dependency read asks GitHub for the one direction it answers. The issue’s body rides along because its metadata slot is where an edge to another source is recorded — and a board draft’s body too, with the one board item GitHub links a draft to and, aliased board, this board’s own id, so a draft’s recorded edges are read off this same answer and only when that item is this board’s: no draft read and no board read follow it.

ISSUE_DETAIL

One issue by its own node id, with a page of its comments: what task show and a comment listing read, in one request.

ISSUE_DETAILS

ISSUE_DETAIL for DETAIL_BATCH items at once, each by its own node id, as one fixed-size document of aliased node(id:) fields.

ISSUE_RELATIONS

ISSUE_DETAILS with each issue’s sub-issues in place of its comments: what task relations and a link write read of DETAIL_BATCH tasks at once on a source reading sub-issues as children — each task whole, its parent and the ids of up to $first of its children.

ORIGIN_LOOKUP

Every carrier of one copy origin, by two reads in one request, and nothing else of the board.

ORIGIN_LOOKUPS

The first page of ORIGIN_LOOKUP for up to ORIGIN_BATCH origins a copy is about to look for, and everything creating an item then reads — the board’s own id and field definitions, as CREATION_CONTEXT reads them, and the node id and the numeric id of the repository an issue is created in — in one request.

ORIGIN_LOOKUPS_WITH_MEMBERS

ORIGIN_LOOKUPS, with a page of the members of the project $project beside it, each trimmed to what classifying it reads — its id, its parent, its body and its repository, and no connection under it.

PROJECT_VISIBILITY

Whether the board’s Project is public — half of what decides whether a write here can be read by anybody. Needs the read:project scope.

RELATES_TO_READS

What DETAIL_BATCH issues relate to, one alias each: read after a relation write whose answer never arrived, so each relation is answered from what GitHub holds rather than sent again blindly.

REMOVE_BLOCKED_BY

Removes one native issue blocked-by relationship.

REMOVE_RELATES_TO

ADD_RELATES_TO’s removal: up to RELATION_BATCH relates-to relations removed in one request.

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_BATCH

Up to SEARCH_BATCH board-scoped issue searches in one request, each SEARCH_ISSUES’s connection in an aliased s<n> field with its own query, page size and cursor, and beside them up to SEARCH_BATCH_ORIGINS origin lookups’ board halves — ORIGIN_LOOKUP’s items filtered by the origin field — in aliased o<n> fields, each origin’s issue search in a search slot of its own.

SEARCH_ISSUES

Every issue of one board, found by a search scoped to that board.

SET_PARENTS

Up to RELATION_BATCH parent writes in one request: parent<n> an addSubIssue (a re-parent carrying replaceParent: true) and unparent<n> a removeSubIssue, each sent only while its own send…<n> holds. GitHub runs each alias on its own and answers one it refused — a cycle, a depth or children limit — at its own path, beside the others.

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 field setup — the status-options and fields operations — 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, each with a page of what blocks it.

UPDATE_COMMENT

Replaces the body of one issue comment.

UPDATE_COMMENT_WHOLE

UPDATE_COMMENT, selecting the whole issue the comment is on.

UPDATE_DRAFT

Updates an existing draft’s user-visible fields.

UPDATE_FIELD

Updates a text or single-select value on one project item.

UPDATE_FIELDS

Writes up to six board fields and clears up to three in one ordered mutation: every aliased field is included by its own boolean, as FIELD_WRITE_SLOTS and FIELD_CLEAR_SLOTS name them, writes before clears.

UPDATE_FIELD_TOKEN

UPDATE_FIELD, selecting the issue behind the board item written as UPDATE_ISSUE_TOKEN selects the issue it updates.

UPDATE_FIELD_WHOLE

UPDATE_FIELD, selecting the whole issue behind the board item written.

UPDATE_ISSUE

Updates an issue’s visible fields and its open or closed state in one call.

UPDATE_ISSUES

Updates up to MUTATION_BATCH existing issues a copy rewrites, each with the members its own UPDATE_ISSUE would have sent, in one request.

UPDATE_ISSUE_TOKEN

UPDATE_ISSUE, selecting what a read of the issue updated selects — every part of its change token, and no comment — inline, so its root fields are the plain document’s.

UPDATE_ISSUE_WHOLE

UPDATE_ISSUE, selecting the whole issue updated.

USER_IDS

The node id of one person by their login, as the aliased field u0 answering $login0: what an assignee write names a person by, since assigneeIds takes node ids and a person is named by login.

WRITE_FIELDS_AND_EDGES

A copy’s board field values and its blocked-by edges together, up to WRITE_BATCH of the two kinds between them, in one ordered request: every field value its $sendField<n> sends, then every edge its $sendBlock<n> sends. What a copy sends when one request of its writes holds both kinds; one holding a single kind is WRITE_FIELD_VALUES or ADD_BLOCKED_BYS.

WRITE_FIELD_VALUES

Up to WRITE_BATCH board field values a copy writes on the items it created, each on its own item, in one ordered request.

WRITE_TASKS

Many tasks’ targeted updates, each as UPDATE_FIELDS and UPDATE_ISSUE write one: up to TASK_FIELD_BATCH board field values in field<n>, MUTATION_BATCH field clears in clear<n>, and as many updateIssues in update<n>, each sent only while its own send…<n> holds.

Functions

inventoried

The inventoried document document is an instance of: USER_IDS for any lookup user_ids sized, and document itself otherwise.

sized

The document a request sending document with variables really sends: USER_IDS sized to the logins variables binds, and every other document as it is.

token_twin

The document a targeted update sends in document’s place, when it has one: the twin whose answer spells the change token of the issue written.

user_ids

USER_IDS for people logins — $login0 to $login<people - 1>, each answered at its own alias — and USER_IDS itself for one.

whole_twin

The document sent in document’s place while a write the store’s cache expects runs, when it has one.

with_assignees

document as a source opted in to assignees sends it: [ASSIGNEES] selected wherever it reads an issue or a draft and in every createIssue and updateIssue answer, with the variable it pages by declared — or None when it reads and writes neither, and is sent as written.

without_assignees

document as with_assignees spelled it, back as the document it was written as — or None for a document it did not rewrite.