The best way to control Claude Code, Codex and more from any computer or phone
| 1 | """ |
| 2 | Marks an element of a GraphQL schema as only available via a preview header |
| 3 | """ |
| 4 | directive @preview( |
| 5 | """ |
| 6 | The identifier of the API preview that toggles this field. |
| 7 | """ |
| 8 | toggledBy: String! |
| 9 | ) on ARGUMENT_DEFINITION | ENUM | ENUM_VALUE | FIELD_DEFINITION | INPUT_FIELD_DEFINITION | INPUT_OBJECT | INTERFACE | OBJECT | SCALAR | UNION |
| 10 | |
| 11 | """ |
| 12 | Defines what type of global IDs are accepted for a mutation argument of type ID. |
| 13 | """ |
| 14 | directive @possibleTypes( |
| 15 | """ |
| 16 | Abstract type of accepted global ID |
| 17 | """ |
| 18 | abstractType: String |
| 19 | |
| 20 | """ |
| 21 | Accepted types of global IDs. |
| 22 | """ |
| 23 | concreteTypes: [String!]! |
| 24 | ) on INPUT_FIELD_DEFINITION |
| 25 | |
| 26 | """ |
| 27 | Assigns a documentation category for docs.github.com, aligned with REST API reference sections. |
| 28 | """ |
| 29 | directive @docsCategory( |
| 30 | """ |
| 31 | The category slug (e.g. "issues", "pulls", "repos"). |
| 32 | """ |
| 33 | name: String! |
| 34 | ) on ENUM | FIELD_DEFINITION | INPUT_OBJECT | INTERFACE | OBJECT | UNION |
| 35 | |
| 36 | """ |
| 37 | Represents an object which can take actions on GitHub. Typically a User or Bot. |
| 38 | """ |
| 39 | interface Actor { |
| 40 | """ |
| 41 | A URL pointing to the actor's public avatar. |
| 42 | """ |
| 43 | avatarUrl(size: Int): URI! |
| 44 | |
| 45 | """ |
| 46 | The username of the actor. |
| 47 | """ |
| 48 | login: String! |
| 49 | } |
| 50 | |
| 51 | """ |
| 52 | Autogenerated input type of AddComment |
| 53 | """ |
| 54 | input AddCommentInput { |
| 55 | """ |
| 56 | The contents of the comment. |
| 57 | """ |
| 58 | body: String! |
| 59 | |
| 60 | """ |
| 61 | A unique identifier for the client performing the mutation. |
| 62 | """ |
| 63 | clientMutationId: String |
| 64 | |
| 65 | """ |
| 66 | The Node ID of the subject to modify. |
| 67 | """ |
| 68 | subjectId: ID! @possibleTypes(concreteTypes: ["Issue", "PullRequest"], abstractType: "IssueOrPullRequest") |
| 69 | } |
| 70 | |
| 71 | """ |
| 72 | Autogenerated return type of AddComment. |
| 73 | """ |
| 74 | type AddCommentPayload { |
| 75 | """ |
| 76 | The edge from the subject's comment connection. |
| 77 | """ |
| 78 | commentEdge: IssueCommentEdge |
| 79 | } |
| 80 | |
| 81 | """ |
| 82 | Represents an 'added_to_merge_queue' event on a given pull request. |
| 83 | """ |
| 84 | type AddedToMergeQueueEvent implements Node { |
| 85 | """ |
| 86 | The Node ID of the AddedToMergeQueueEvent object |
| 87 | """ |
| 88 | id: ID! |
| 89 | } |
| 90 | |
| 91 | """ |
| 92 | Represents a 'added_to_project' event on a given issue or pull request. |
| 93 | """ |
| 94 | type AddedToProjectEvent implements Node { |
| 95 | """ |
| 96 | The Node ID of the AddedToProjectEvent object |
| 97 | """ |
| 98 | id: ID! |
| 99 | } |
| 100 | |
| 101 | """ |
| 102 | A special type of user which takes actions on behalf of GitHub Apps. |
| 103 | """ |
| 104 | type Bot implements Actor & Node { |
| 105 | """ |
| 106 | A URL pointing to the GitHub App's public avatar. |
| 107 | """ |
| 108 | avatarUrl(size: Int): URI! |
| 109 | |
| 110 | """ |
| 111 | The Node ID of the Bot object |
| 112 | """ |
| 113 | id: ID! |
| 114 | |
| 115 | """ |
| 116 | The username of the actor. |
| 117 | """ |
| 118 | login: String! |
| 119 | } |
| 120 | |
| 121 | """ |
| 122 | Represents a 'closed' event on any `Closable`. |
| 123 | """ |
| 124 | type ClosedEvent implements Node { |
| 125 | """ |
| 126 | Object which triggered the creation of this event. |
| 127 | """ |
| 128 | closer: Closer |
| 129 | |
| 130 | """ |
| 131 | Identifies the date and time when the object was created. |
| 132 | """ |
| 133 | createdAt: DateTime! |
| 134 | |
| 135 | """ |
| 136 | The Node ID of the ClosedEvent object |
| 137 | """ |
| 138 | id: ID! |
| 139 | } |
| 140 | |
| 141 | """ |
| 142 | The object which triggered a `ClosedEvent`. |
| 143 | """ |
| 144 | union Closer = Commit | ProjectV2 | PullRequest |
| 145 | |
| 146 | """ |
| 147 | Represents a Git commit. |
| 148 | """ |
| 149 | type Commit implements Node { |
| 150 | """ |
| 151 | The Node ID of the Commit object |
| 152 | """ |
| 153 | id: ID! |
| 154 | |
| 155 | """ |
| 156 | The Git object ID |
| 157 | """ |
| 158 | oid: GitObjectID! |
| 159 | |
| 160 | """ |
| 161 | The datetime when this commit was pushed. |
| 162 | """ |
| 163 | pushedDate: DateTime @deprecated(reason: "`pushedDate` is no longer supported. Removal on 2023-07-01 UTC.") |
| 164 | } |
| 165 | |
| 166 | """ |
| 167 | An ISO-8601 encoded UTC date string. |
| 168 | """ |
| 169 | scalar DateTime |
| 170 | |
| 171 | """ |
| 172 | A Git object ID. |
| 173 | """ |
| 174 | scalar GitObjectID |
| 175 | |
| 176 | """ |
| 177 | An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project. |
| 178 | """ |
| 179 | type Issue implements Node { |
| 180 | """ |
| 181 | Identifies the date and time when the object was created. |
| 182 | """ |
| 183 | createdAt: DateTime! |
| 184 | |
| 185 | """ |
| 186 | The Node ID of the Issue object |
| 187 | """ |
| 188 | id: ID! |
| 189 | |
| 190 | """ |
| 191 | Indicates whether or not this issue is currently pinned to the repository issues list |
| 192 | """ |
| 193 | isPinned: Boolean |
| 194 | |
| 195 | """ |
| 196 | Identifies the issue number. |
| 197 | """ |
| 198 | number: Int! |
| 199 | |
| 200 | """ |
| 201 | Identifies the state of the issue. |
| 202 | """ |
| 203 | state: IssueState! |
| 204 | |
| 205 | """ |
| 206 | Identifies the reason for the issue state. |
| 207 | """ |
| 208 | stateReason: IssueStateReason |
| 209 | |
| 210 | """ |
| 211 | A list of events, comments, commits, etc. associated with the issue. |
| 212 | """ |
| 213 | timelineItems(first: Int, itemTypes: [IssueTimelineItemsItemType!]): IssueTimelineItemsConnection! |
| 214 | |
| 215 | """ |
| 216 | Identifies the issue title. |
| 217 | """ |
| 218 | title: String! |
| 219 | |
| 220 | """ |
| 221 | The HTTP URL for this issue |
| 222 | """ |
| 223 | url: URI! |
| 224 | } |
| 225 | |
| 226 | """ |
| 227 | Represents a comment on an Issue. |
| 228 | """ |
| 229 | type IssueComment implements Node { |
| 230 | """ |
| 231 | The actor who authored the comment. |
| 232 | """ |
| 233 | author: Actor |
| 234 | |
| 235 | """ |
| 236 | The body as Markdown. |
| 237 | """ |
| 238 | body: String! |
| 239 | |
| 240 | """ |
| 241 | Identifies the date and time when the object was created. |
| 242 | """ |
| 243 | createdAt: DateTime! |
| 244 | |
| 245 | """ |
| 246 | The Node ID of the IssueComment object |
| 247 | """ |
| 248 | id: ID! |
| 249 | |
| 250 | """ |
| 251 | The HTTP URL for this issue comment |
| 252 | """ |
| 253 | url: URI! |
| 254 | } |
| 255 | |
| 256 | """ |
| 257 | An edge in a connection. |
| 258 | """ |
| 259 | type IssueCommentEdge { |
| 260 | """ |
| 261 | The item at the end of the edge. |
| 262 | """ |
| 263 | node: IssueComment |
| 264 | } |
| 265 | |
| 266 | """ |
| 267 | The connection type for Issue. |
| 268 | """ |
| 269 | type IssueConnection { |
| 270 | """ |
| 271 | A list of nodes. |
| 272 | """ |
| 273 | nodes: [Issue] |
| 274 | |
| 275 | """ |
| 276 | Information to aid in pagination. |
| 277 | """ |
| 278 | pageInfo: PageInfo! |
| 279 | |
| 280 | """ |
| 281 | Identifies the total count of items in the connection. |
| 282 | """ |
| 283 | totalCount: Int! |
| 284 | } |
| 285 | |
| 286 | """ |
| 287 | A filter for matching an issue field value. Exactly one value argument should be provided. |
| 288 | """ |
| 289 | input IssueFieldValueFilter { |
| 290 | """ |
| 291 | Matches a date issue field value (YYYY-MM-DD). |
| 292 | """ |
| 293 | dateValue: String |
| 294 | |
| 295 | """ |
| 296 | The ID of the issue field to filter by. Exactly one of `fieldId` or `fieldName` must be provided. |
| 297 | """ |
| 298 | fieldId: ID |
| 299 | |
| 300 | """ |
| 301 | The name of the issue field to filter by. Exactly one of `fieldId` or `fieldName` must be provided. |
| 302 | """ |
| 303 | fieldName: String |
| 304 | |
| 305 | """ |
| 306 | Matches issues containing all of the multi-select issue field option IDs. |
| 307 | """ |
| 308 | multiSelectOptionIds: [ID!] |
| 309 | |
| 310 | """ |
| 311 | Matches issues containing all of the multi-select issue field option names. |
| 312 | """ |
| 313 | multiSelectOptionValues: [String!] |
| 314 | |
| 315 | """ |
| 316 | Matches a numeric issue field value. |
| 317 | """ |
| 318 | numberValue: Float |
| 319 | |
| 320 | """ |
| 321 | Matches a single-select issue field option by ID. |
| 322 | """ |
| 323 | singleSelectOptionId: ID |
| 324 | |
| 325 | """ |
| 326 | Matches a single-select issue field option by name. |
| 327 | """ |
| 328 | singleSelectOptionValue: String |
| 329 | |
| 330 | """ |
| 331 | Matches a text issue field value. |
| 332 | """ |
| 333 | textValue: String |
| 334 | } |
| 335 | |
| 336 | """ |
| 337 | Ways in which to filter lists of issues. |
| 338 | """ |
| 339 | input IssueFilters @docsCategory(name: "issues") { |
| 340 | """ |
| 341 | List issues assigned to given name. Pass in `null` for issues with no assigned |
| 342 | user, and `*` for issues assigned to any user. |
| 343 | """ |
| 344 | assignee: String |
| 345 | |
| 346 | """ |
| 347 | List issues created by given name. |
| 348 | """ |
| 349 | createdBy: String |
| 350 | |
| 351 | """ |
| 352 | List issues where each supplied issue field value filter matches. |
| 353 | """ |
| 354 | issueFieldValues: [IssueFieldValueFilter!] |
| 355 | |
| 356 | """ |
| 357 | List issues where the list of label names exist on the issue. |
| 358 | """ |
| 359 | labels: [String!] |
| 360 | |
| 361 | """ |
| 362 | List issues where the given name is mentioned in the issue. |
| 363 | """ |
| 364 | mentioned: String |
| 365 | |
| 366 | """ |
| 367 | List issues by given milestone argument. If an string representation of an |
| 368 | integer is passed, it should refer to a milestone by its database ID. Pass in |
| 369 | `null` for issues with no milestone, and `*` for issues that are assigned to any milestone. |
| 370 | """ |
| 371 | milestone: String |
| 372 | |
| 373 | """ |
| 374 | List issues by given milestone argument. If an string representation of an |
| 375 | integer is passed, it should refer to a milestone by its number field. Pass in |
| 376 | `null` for issues with no milestone, and `*` for issues that are assigned to any milestone. |
| 377 | """ |
| 378 | milestoneNumber: String |
| 379 | |
| 380 | """ |
| 381 | List issues that have been updated at or after the given date. |
| 382 | """ |
| 383 | since: DateTime |
| 384 | |
| 385 | """ |
| 386 | List issues filtered by the list of states given. |
| 387 | """ |
| 388 | states: [IssueState!] |
| 389 | |
| 390 | """ |
| 391 | List issues filtered by the type given, only supported by searches on repositories. |
| 392 | """ |
| 393 | type: String |
| 394 | |
| 395 | """ |
| 396 | List issues subscribed to by viewer. |
| 397 | """ |
| 398 | viewerSubscribed: Boolean = false |
| 399 | } |
| 400 | |
| 401 | """ |
| 402 | Ways in which lists of issues can be ordered upon return. |
| 403 | """ |
| 404 | input IssueOrder @docsCategory(name: "issues") { |
| 405 | """ |
| 406 | The direction in which to order issues by the specified field. |
| 407 | """ |
| 408 | direction: OrderDirection! |
| 409 | |
| 410 | """ |
| 411 | The field in which to order issues by. |
| 412 | """ |
| 413 | field: IssueOrderField! |
| 414 | } |
| 415 | |
| 416 | """ |
| 417 | Properties by which issue connections can be ordered. |
| 418 | """ |
| 419 | enum IssueOrderField @docsCategory(name: "issues") { |
| 420 | """ |
| 421 | Order issues by comment count |
| 422 | """ |
| 423 | COMMENTS |
| 424 | |
| 425 | """ |
| 426 | Order issues by creation time |
| 427 | """ |
| 428 | CREATED_AT |
| 429 | |
| 430 | """ |
| 431 | Order issues by update time |
| 432 | """ |
| 433 | UPDATED_AT |
| 434 | } |
| 435 | |
| 436 | """ |
| 437 | The possible states of an issue. |
| 438 | """ |
| 439 | enum IssueState @docsCategory(name: "issues") { |
| 440 | """ |
| 441 | An issue that has been closed |
| 442 | """ |
| 443 | CLOSED |
| 444 | |
| 445 | """ |
| 446 | An issue that is still open |
| 447 | """ |
| 448 | OPEN |
| 449 | } |
| 450 | |
| 451 | """ |
| 452 | The possible state reasons of an issue. |
| 453 | """ |
| 454 | enum IssueStateReason @docsCategory(name: "issues") { |
| 455 | """ |
| 456 | An issue that has been closed as completed |
| 457 | """ |
| 458 | COMPLETED |
| 459 | |
| 460 | """ |
| 461 | An issue that has been closed as a duplicate. |
| 462 | """ |
| 463 | DUPLICATE |
| 464 | |
| 465 | """ |
| 466 | An issue that has been closed as not planned |
| 467 | """ |
| 468 | NOT_PLANNED |
| 469 | |
| 470 | """ |
| 471 | An issue that has been reopened |
| 472 | """ |
| 473 | REOPENED |
| 474 | } |
| 475 | |
| 476 | """ |
| 477 | An item in an issue timeline |
| 478 | """ |
| 479 | union IssueTimelineItems = AddedToProjectEvent | ClosedEvent | IssueComment | LabeledEvent |
| 480 | |
| 481 | """ |
| 482 | The connection type for IssueTimelineItems. |
| 483 | """ |
| 484 | type IssueTimelineItemsConnection { |
| 485 | """ |
| 486 | A list of nodes. |
| 487 | """ |
| 488 | nodes: [IssueTimelineItems] |
| 489 | } |
| 490 | |
| 491 | """ |
| 492 | The possible item types found in a timeline. |
| 493 | """ |
| 494 | enum IssueTimelineItemsItemType { |
| 495 | """ |
| 496 | Represents a 'closed' event on any `Closable`. |
| 497 | """ |
| 498 | CLOSED_EVENT |
| 499 | |
| 500 | """ |
| 501 | Represents a comment on an Issue. |
| 502 | """ |
| 503 | ISSUE_COMMENT |
| 504 | |
| 505 | """ |
| 506 | Represents a 'labeled' event on a given issue or pull request. |
| 507 | """ |
| 508 | LABELED_EVENT |
| 509 | } |
| 510 | |
| 511 | """ |
| 512 | A label for categorizing Issues, Pull Requests, Milestones, or Discussions with a given Repository. |
| 513 | """ |
| 514 | type Label implements Node { |
| 515 | """ |
| 516 | Identifies the label color. |
| 517 | """ |
| 518 | color: String! |
| 519 | |
| 520 | """ |
| 521 | The Node ID of the Label object |
| 522 | """ |
| 523 | id: ID! |
| 524 | |
| 525 | """ |
| 526 | Identifies the label name. |
| 527 | """ |
| 528 | name: String! |
| 529 | } |
| 530 | |
| 531 | """ |
| 532 | Represents a 'labeled' event on a given issue or pull request. |
| 533 | """ |
| 534 | type LabeledEvent implements Node { |
| 535 | """ |
| 536 | Identifies the date and time when the object was created. |
| 537 | """ |
| 538 | createdAt: DateTime! |
| 539 | |
| 540 | """ |
| 541 | The Node ID of the LabeledEvent object |
| 542 | """ |
| 543 | id: ID! |
| 544 | |
| 545 | """ |
| 546 | Identifies the label associated with the 'labeled' event. |
| 547 | """ |
| 548 | label: Label! |
| 549 | } |
| 550 | |
| 551 | """ |
| 552 | The root query for implementing GraphQL mutations. |
| 553 | """ |
| 554 | type Mutation { |
| 555 | """ |
| 556 | Adds a comment to an Issue or Pull Request. |
| 557 | """ |
| 558 | addComment(input: AddCommentInput!): AddCommentPayload @docsCategory(name: "issues") |
| 559 | } |
| 560 | |
| 561 | """ |
| 562 | An object with an ID. |
| 563 | """ |
| 564 | interface Node { |
| 565 | """ |
| 566 | ID of the object. |
| 567 | """ |
| 568 | id: ID! |
| 569 | } |
| 570 | |
| 571 | """ |
| 572 | Possible directions in which to order a list of items when provided an `orderBy` argument. |
| 573 | """ |
| 574 | enum OrderDirection @docsCategory(name: "meta") { |
| 575 | """ |
| 576 | Specifies an ascending order for a given `orderBy` argument. |
| 577 | """ |
| 578 | ASC |
| 579 | |
| 580 | """ |
| 581 | Specifies a descending order for a given `orderBy` argument. |
| 582 | """ |
| 583 | DESC |
| 584 | } |
| 585 | |
| 586 | """ |
| 587 | Information about pagination in a connection. |
| 588 | """ |
| 589 | type PageInfo { |
| 590 | """ |
| 591 | When paginating forwards, the cursor to continue. |
| 592 | """ |
| 593 | endCursor: String |
| 594 | |
| 595 | """ |
| 596 | When paginating forwards, are there more items? |
| 597 | """ |
| 598 | hasNextPage: Boolean! |
| 599 | } |
| 600 | |
| 601 | """ |
| 602 | New projects that manage issues, pull requests and drafts using tables and boards. |
| 603 | """ |
| 604 | type ProjectV2 implements Node { |
| 605 | """ |
| 606 | The Node ID of the ProjectV2 object |
| 607 | """ |
| 608 | id: ID! |
| 609 | } |
| 610 | |
| 611 | """ |
| 612 | A repository pull request. |
| 613 | """ |
| 614 | type PullRequest implements Node { |
| 615 | """ |
| 616 | The Node ID of the PullRequest object |
| 617 | """ |
| 618 | id: ID! |
| 619 | |
| 620 | """ |
| 621 | Identifies the pull request number. |
| 622 | """ |
| 623 | number: Int! |
| 624 | |
| 625 | """ |
| 626 | Identifies the pull request title. |
| 627 | """ |
| 628 | title: String! |
| 629 | } |
| 630 | |
| 631 | """ |
| 632 | The query root of GitHub's GraphQL interface. |
| 633 | """ |
| 634 | type Query implements Node { |
| 635 | """ |
| 636 | ID of the object. |
| 637 | """ |
| 638 | id: ID! |
| 639 | |
| 640 | """ |
| 641 | Fetches an object given its ID. |
| 642 | """ |
| 643 | node(id: ID!): Node |
| 644 | |
| 645 | """ |
| 646 | Lookup a given repository by the owner and repository name. |
| 647 | """ |
| 648 | repository(name: String!, owner: String!): Repository |
| 649 | } |
| 650 | |
| 651 | """ |
| 652 | A repository contains the content for a project. |
| 653 | """ |
| 654 | type Repository implements Node { |
| 655 | """ |
| 656 | The Node ID of the Repository object |
| 657 | """ |
| 658 | id: ID! |
| 659 | |
| 660 | """ |
| 661 | A list of issues that have been opened in the repository. |
| 662 | """ |
| 663 | issues(filterBy: IssueFilters, first: Int, orderBy: IssueOrder, states: [IssueState!]): IssueConnection! |
| 664 | |
| 665 | """ |
| 666 | The repository's name with owner. |
| 667 | """ |
| 668 | nameWithOwner: String! |
| 669 | } |
| 670 | |
| 671 | """ |
| 672 | An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string. |
| 673 | """ |
| 674 | scalar URI |
| 675 | |
| 676 | """ |
| 677 | A user is an individual's account on GitHub that owns repositories and can make new content. |
| 678 | """ |
| 679 | type User implements Actor & Node { |
| 680 | """ |
| 681 | A URL pointing to the user's public avatar. |
| 682 | """ |
| 683 | avatarUrl(size: Int): URI! |
| 684 | |
| 685 | """ |
| 686 | The Node ID of the User object |
| 687 | """ |
| 688 | id: ID! |
| 689 | |
| 690 | """ |
| 691 | The username used to login. |
| 692 | """ |
| 693 | login: String! |
| 694 | |
| 695 | """ |
| 696 | The user's public profile name. |
| 697 | """ |
| 698 | name: String |
| 699 | } |