| 1 |
# This schema definition is available in the public domain, or under the terms |
| 2 |
# of CC-0, at your choice. |
| 3 |
|
| 4 |
scalar Cursor |
| 5 |
|
| 6 |
"String of the format %Y-%m-%dT%H:%M:%SZ" |
| 7 |
scalar Time |
| 8 |
|
| 9 |
""" |
| 10 |
URL from which some secondary data may be retrieved. You must provide the |
| 11 |
same Authentication header to this address as you did to the GraphQL resolver |
| 12 |
which provided it. The URL is not guaranteed to be consistent for an extended |
| 13 |
length of time; applications should submit a new GraphQL query each time they |
| 14 |
wish to access the data at the provided URL. |
| 15 |
""" |
| 16 |
scalar URL |
| 17 |
|
| 18 |
""" |
| 19 |
A file uploaded alongside the GraphQL request. This API is compatible with the |
| 20 |
multipart request specification for requests that include uploads: |
| 21 |
|
| 22 |
https://github.com/jaydenseric/graphql-multipart-request-spec |
| 23 |
""" |
| 24 |
scalar Upload |
| 25 |
|
| 26 |
"Confirmation token associated with a subscription request" |
| 27 |
scalar ConfirmationToken |
| 28 |
|
| 29 |
"Used to provide a human-friendly description of an access scope" |
| 30 |
directive @scopehelp(details: String!) on ENUM_VALUE |
| 31 |
|
| 32 |
""" |
| 33 |
This is used to decorate fields which are only accessible with a personal |
| 34 |
access token, and are not available to clients using OAuth 2.0 access tokens. |
| 35 |
""" |
| 36 |
directive @private on FIELD_DEFINITION |
| 37 |
|
| 38 |
""" |
| 39 |
This is used to decorate fields which are for internal use, and are not |
| 40 |
available to normal API users. |
| 41 |
""" |
| 42 |
directive @internal on FIELD_DEFINITION |
| 43 |
|
| 44 |
""" |
| 45 |
Used to decorate fields which are for internal use, and are not available to |
| 46 |
normal API users. |
| 47 |
""" |
| 48 |
directive @anoninternal on FIELD_DEFINITION |
| 49 |
|
| 50 |
enum AccessScope { |
| 51 |
ACLS @scopehelp(details: "access control lists") |
| 52 |
EMAILS @scopehelp(details: "emails") |
| 53 |
LISTS @scopehelp(details: "mailing lists") |
| 54 |
PATCHES @scopehelp(details: "patches") |
| 55 |
PROFILE @scopehelp(details: "profile information") |
| 56 |
SUBSCRIPTIONS @scopehelp(details: "tracker & ticket subscriptions") |
| 57 |
} |
| 58 |
|
| 59 |
enum AccessKind { |
| 60 |
RO @scopehelp(details: "read") |
| 61 |
RW @scopehelp(details: "read and write") |
| 62 |
} |
| 63 |
|
| 64 |
""" |
| 65 |
Decorates fields for which access requires a particular OAuth 2.0 scope with |
| 66 |
read or write access. |
| 67 |
""" |
| 68 |
directive @access(scope: AccessScope!, kind: AccessKind!) on FIELD_DEFINITION |
| 69 |
|
| 70 |
# https://semver.org |
| 71 |
type Version { |
| 72 |
major: Int! |
| 73 |
minor: Int! |
| 74 |
patch: Int! |
| 75 |
buildVersion: String! |
| 76 |
buildDate: String! |
| 77 |
|
| 78 |
""" |
| 79 |
If this API version is scheduled for deprecation, this is the date on which |
| 80 |
it will stop working; or null if this API version is not scheduled for |
| 81 |
deprecation. |
| 82 |
""" |
| 83 |
deprecationDate: Time |
| 84 |
} |
| 85 |
|
| 86 |
interface Entity { |
| 87 |
canonicalName: String! |
| 88 |
} |
| 89 |
|
| 90 |
"A registered user" |
| 91 |
type User implements Entity { |
| 92 |
id: Int! |
| 93 |
created: Time! |
| 94 |
updated: Time! |
| 95 |
canonicalName: String! |
| 96 |
username: String! |
| 97 |
email: String! |
| 98 |
url: String |
| 99 |
location: String |
| 100 |
bio: String |
| 101 |
|
| 102 |
list(name: String!): MailingList @access(scope: LISTS, kind: RO) |
| 103 |
lists(cursor: Cursor): MailingListCursor! @access(scope: LISTS, kind: RO) |
| 104 |
emails(cursor: Cursor): EmailCursor! @access(scope: EMAILS, kind: RO) |
| 105 |
threads(cursor: Cursor): ThreadCursor! @access(scope: EMAILS, kind: RO) |
| 106 |
patches(cursor: Cursor): PatchsetCursor! @access(scope: PATCHES, kind: RO) |
| 107 |
} |
| 108 |
|
| 109 |
"A mailbox not associated with a registered user" |
| 110 |
type Mailbox implements Entity { |
| 111 |
canonicalName: String! |
| 112 |
name: String! |
| 113 |
address: String! |
| 114 |
} |
| 115 |
|
| 116 |
enum Visibility { |
| 117 |
PUBLIC |
| 118 |
UNLISTED |
| 119 |
PRIVATE |
| 120 |
} |
| 121 |
|
| 122 |
type MailingList { |
| 123 |
id: Int! |
| 124 |
rid: ID! |
| 125 |
created: Time! |
| 126 |
updated: Time! |
| 127 |
name: String! |
| 128 |
owner: Entity! @access(scope: PROFILE, kind: RO) |
| 129 |
lastActivity: Time |
| 130 |
|
| 131 |
# Markdown |
| 132 |
description: String |
| 133 |
visibility: Visibility! |
| 134 |
|
| 135 |
""" |
| 136 |
List of globs for permitted or rejected mimetypes on this list |
| 137 |
e.g. text/* |
| 138 |
""" |
| 139 |
permitMime: [String!]! |
| 140 |
rejectMime: [String!]! |
| 141 |
|
| 142 |
"List of threads on this list in order of most recently bumped" |
| 143 |
threads(cursor: Cursor): ThreadCursor! @access(scope: EMAILS, kind: RO) |
| 144 |
"List of emails received on this list in reverse chronological order" |
| 145 |
emails(cursor: Cursor): EmailCursor! @access(scope: EMAILS, kind: RO) |
| 146 |
"List of patches received on this list in order of most recently bumped" |
| 147 |
patches(cursor: Cursor): PatchsetCursor! @access(scope: PATCHES, kind: RO) |
| 148 |
|
| 149 |
"Get a specific email archived in this list by its Message-ID" |
| 150 |
message(messageID: String!): Email @access(scope: EMAILS, kind: RO) |
| 151 |
|
| 152 |
"True if an import operation is underway for this list" |
| 153 |
importing: Boolean! |
| 154 |
|
| 155 |
"The access that applies to this user for this list" |
| 156 |
access: ACL! @access(scope: ACLS, kind: RO) |
| 157 |
|
| 158 |
"The user's subscription for this list, if any" |
| 159 |
subscription: MailingListSubscription @access(scope: SUBSCRIPTIONS, kind: RO) |
| 160 |
|
| 161 |
"URLs to application/mbox archives for this mailing list" |
| 162 |
archive: URL! |
| 163 |
last30days: URL! |
| 164 |
|
| 165 |
# |
| 166 |
# The following resolvers are only available to the list owner: |
| 167 |
|
| 168 |
"Access control list entries for this mailing list" |
| 169 |
acl(cursor: Cursor): MailingListACLCursor! @access(scope: ACLS, kind: RO) |
| 170 |
|
| 171 |
defaultACL: GeneralACL! |
| 172 |
|
| 173 |
""" |
| 174 |
Returns a list of mailing list webhook subscriptions. For clients |
| 175 |
authenticated with a personal access token, this returns all webhooks |
| 176 |
configured by all GraphQL clients for your account. For clients |
| 177 |
authenticated with an OAuth 2.0 access token, this returns only webhooks |
| 178 |
registered for your client. |
| 179 |
""" |
| 180 |
webhooks(cursor: Cursor): WebhookSubscriptionCursor! |
| 181 |
|
| 182 |
"Returns details of a mailing list webhook subscription by its ID." |
| 183 |
webhook(id: Int!): WebhookSubscription |
| 184 |
|
| 185 |
""" |
| 186 |
Get the list of subscriptions to this mailing list. |
| 187 |
|
| 188 |
Internal use only. |
| 189 |
""" |
| 190 |
subscriptions: [MailingListSubscription!]! @internal |
| 191 |
|
| 192 |
""" |
| 193 |
Get access permissions for a specific user by their email address. If there |
| 194 |
is a related ACL entry for the given email address or an account linked to |
| 195 |
that address, it will be returned. Otherwise, the default ACL of the mailing |
| 196 |
list will be returned. |
| 197 |
|
| 198 |
Internal use only. |
| 199 |
""" |
| 200 |
userACL(email: String!): GeneralACL! @internal |
| 201 |
} |
| 202 |
|
| 203 |
type OAuthClient { |
| 204 |
uuid: String! |
| 205 |
} |
| 206 |
|
| 207 |
enum WebhookEvent { |
| 208 |
LIST_CREATED |
| 209 |
LIST_UPDATED |
| 210 |
LIST_DELETED |
| 211 |
EMAIL_RECEIVED |
| 212 |
PATCHSET_RECEIVED |
| 213 |
} |
| 214 |
|
| 215 |
interface WebhookSubscription { |
| 216 |
id: Int! |
| 217 |
events: [WebhookEvent!]! |
| 218 |
query: String! |
| 219 |
url: String! |
| 220 |
|
| 221 |
""" |
| 222 |
If this webhook was registered by an authorized OAuth 2.0 client, this |
| 223 |
field is non-null. |
| 224 |
""" |
| 225 |
client: OAuthClient @private |
| 226 |
|
| 227 |
"All deliveries which have been sent to this webhook." |
| 228 |
deliveries(cursor: Cursor): WebhookDeliveryCursor! |
| 229 |
|
| 230 |
"Returns a sample payload for this subscription, for testing purposes" |
| 231 |
sample(event: WebhookEvent!): String! |
| 232 |
} |
| 233 |
|
| 234 |
type UserWebhookSubscription implements WebhookSubscription { |
| 235 |
id: Int! |
| 236 |
events: [WebhookEvent!]! |
| 237 |
query: String! |
| 238 |
url: String! |
| 239 |
client: OAuthClient @private |
| 240 |
deliveries(cursor: Cursor): WebhookDeliveryCursor! |
| 241 |
sample(event: WebhookEvent!): String! |
| 242 |
} |
| 243 |
|
| 244 |
type MailingListWebhookSubscription implements WebhookSubscription { |
| 245 |
id: Int! |
| 246 |
events: [WebhookEvent!]! |
| 247 |
query: String! |
| 248 |
url: String! |
| 249 |
client: OAuthClient @private |
| 250 |
deliveries(cursor: Cursor): WebhookDeliveryCursor! |
| 251 |
sample(event: WebhookEvent!): String! |
| 252 |
|
| 253 |
list: MailingList! |
| 254 |
} |
| 255 |
|
| 256 |
type WebhookDelivery { |
| 257 |
uuid: String! |
| 258 |
date: Time! |
| 259 |
event: WebhookEvent! |
| 260 |
subscription: WebhookSubscription! |
| 261 |
requestBody: String! |
| 262 |
|
| 263 |
""" |
| 264 |
These details are provided only after a response is received from the |
| 265 |
remote server. If a response is sent whose Content-Type is not text/*, or |
| 266 |
cannot be decoded as UTF-8, the response body will be null. It will be |
| 267 |
truncated after 64 KiB. |
| 268 |
""" |
| 269 |
responseBody: String |
| 270 |
responseHeaders: String |
| 271 |
responseStatus: Int |
| 272 |
} |
| 273 |
|
| 274 |
interface WebhookPayload { |
| 275 |
uuid: String! |
| 276 |
event: WebhookEvent! |
| 277 |
date: Time! |
| 278 |
} |
| 279 |
|
| 280 |
type MailingListEvent implements WebhookPayload { |
| 281 |
uuid: String! |
| 282 |
event: WebhookEvent! |
| 283 |
date: Time! |
| 284 |
|
| 285 |
list: MailingList! |
| 286 |
} |
| 287 |
|
| 288 |
type EmailEvent implements WebhookPayload { |
| 289 |
uuid: String! |
| 290 |
event: WebhookEvent! |
| 291 |
date: Time! |
| 292 |
|
| 293 |
email: Email! |
| 294 |
} |
| 295 |
|
| 296 |
type PatchsetEvent implements WebhookPayload { |
| 297 |
uuid: String! |
| 298 |
event: WebhookEvent! |
| 299 |
date: Time! |
| 300 |
|
| 301 |
patchset: Patchset! |
| 302 |
} |
| 303 |
|
| 304 |
interface ACL { |
| 305 |
"Permission to browse or subscribe to emails" |
| 306 |
browse: Boolean! |
| 307 |
"Permission to reply to existing threads" |
| 308 |
reply: Boolean! |
| 309 |
"Permission to start new threads" |
| 310 |
post: Boolean! |
| 311 |
"Permission to moderate the list" |
| 312 |
moderate: Boolean! |
| 313 |
} |
| 314 |
|
| 315 |
""" |
| 316 |
These ACLs are configured for specific entities, and may be used to expand or |
| 317 |
constrain the rights of a participant. |
| 318 |
""" |
| 319 |
type MailingListACL implements ACL { |
| 320 |
id: Int! |
| 321 |
created: Time! |
| 322 |
list: MailingList! @access(scope: LISTS, kind: RO) |
| 323 |
entity: Entity! @access(scope: PROFILE, kind: RO) |
| 324 |
|
| 325 |
browse: Boolean! |
| 326 |
reply: Boolean! |
| 327 |
post: Boolean! |
| 328 |
moderate: Boolean! |
| 329 |
} |
| 330 |
|
| 331 |
""" |
| 332 |
An ACL entry that applies "generally", for example the rights which apply to |
| 333 |
all subscribers to a list. |
| 334 |
""" |
| 335 |
type GeneralACL implements ACL { |
| 336 |
browse: Boolean! |
| 337 |
reply: Boolean! |
| 338 |
post: Boolean! |
| 339 |
moderate: Boolean! |
| 340 |
} |
| 341 |
|
| 342 |
type Thread { |
| 343 |
created: Time! |
| 344 |
updated: Time! |
| 345 |
subject: String! |
| 346 |
replies: Int! |
| 347 |
participants: Int! |
| 348 |
sender: Entity! |
| 349 |
|
| 350 |
root: Email! |
| 351 |
|
| 352 |
list: MailingList! @access(scope: LISTS, kind: RO) |
| 353 |
|
| 354 |
"Replies to this thread, in chronological order" |
| 355 |
descendants(cursor: Cursor): EmailCursor! |
| 356 |
|
| 357 |
"A mailto: URI for replying to the latest message in this thread" |
| 358 |
mailto: String! |
| 359 |
|
| 360 |
"URL to an application/mbox archive of this thread" |
| 361 |
mbox: URL! |
| 362 |
|
| 363 |
""" |
| 364 |
Thread parsed as a tree. |
| 365 |
|
| 366 |
The returned list is never empty. The first item is guaranteed to be the root |
| 367 |
message. The blocks are sorted in topological order. |
| 368 |
""" |
| 369 |
blocks: [ThreadBlock!]! |
| 370 |
} |
| 371 |
|
| 372 |
""" |
| 373 |
A block of text in an email thread. |
| 374 |
|
| 375 |
Blocks are parts of a message's body that aren't quotes of the parent message. |
| 376 |
A block can be a reply to a parent block, in which case the parentStart and |
| 377 |
parentEnd fields indicate which part of the parent message is replied to. A |
| 378 |
block can have replies, each of which will be represented by a block in the |
| 379 |
children field. |
| 380 |
""" |
| 381 |
type ThreadBlock { |
| 382 |
"Unique identifier for this block." |
| 383 |
key: String! |
| 384 |
"The block's plain-text content." |
| 385 |
body: String! |
| 386 |
"Index of the parent block (if any) in Thread.blocks." |
| 387 |
parent: Int |
| 388 |
""" |
| 389 |
Replies to this block. |
| 390 |
|
| 391 |
The list items are indexes into Thread.blocks. |
| 392 |
""" |
| 393 |
children: [Int!]! |
| 394 |
|
| 395 |
"The email this block comes from." |
| 396 |
source: Email! |
| 397 |
"The range of this block in the source email body." |
| 398 |
sourceRange: ByteRange! |
| 399 |
|
| 400 |
""" |
| 401 |
If this block is a reply to a particular chunk of the parent block, this |
| 402 |
field indicates the range of that chunk in the parent's email body. |
| 403 |
""" |
| 404 |
parentRange: ByteRange |
| 405 |
} |
| 406 |
|
| 407 |
""" |
| 408 |
A byte range. |
| 409 |
""" |
| 410 |
type ByteRange { |
| 411 |
"Inclusive start byte offset." |
| 412 |
start: Int! |
| 413 |
"Exclusive end byte offset." |
| 414 |
end: Int! |
| 415 |
} |
| 416 |
|
| 417 |
type Email { |
| 418 |
id: Int! |
| 419 |
|
| 420 |
""" |
| 421 |
The entity which sent this email. Will be a User if it can be associated |
| 422 |
with an account, or a Mailbox otherwise. |
| 423 |
""" |
| 424 |
sender: Entity! |
| 425 |
"Time we received this email (non-forgable)." |
| 426 |
received: Time! |
| 427 |
"Time given by Date header (forgable)." |
| 428 |
date: Time |
| 429 |
"The Subject header." |
| 430 |
subject: String! |
| 431 |
"The Message-ID header, without angle brackets." |
| 432 |
messageID: String! |
| 433 |
"The In-Reply-To header, if present, without angle brackets." |
| 434 |
inReplyTo: String |
| 435 |
|
| 436 |
""" |
| 437 |
Provides the value (or values) of a specific header from this email. Note |
| 438 |
that the returned value is coerced to UTF-8 and may be lossy under certain |
| 439 |
circumstances. |
| 440 |
""" |
| 441 |
header(want: String!): [String!]! |
| 442 |
"Retrieves the value of an address list header, such as To or Cc." |
| 443 |
addressList(want: String!): [Mailbox!]! |
| 444 |
"The decoded text/plain message part of the email, i.e. email body." |
| 445 |
body: String! |
| 446 |
"A URL from which the full raw message may be downloaded." |
| 447 |
rawMessage: URL! |
| 448 |
|
| 449 |
thread: Thread! |
| 450 |
parent: Email |
| 451 |
patch: Patch |
| 452 |
|
| 453 |
patchset: Patchset @access(scope: PATCHES, kind: RO) |
| 454 |
list: MailingList! @access(scope: LISTS, kind: RO) |
| 455 |
} |
| 456 |
|
| 457 |
type Trailer { |
| 458 |
name: String! |
| 459 |
value: String! |
| 460 |
} |
| 461 |
|
| 462 |
""" |
| 463 |
Information parsed from a patch emailed by git send-email. Given the following |
| 464 |
subject line: |
| 465 |
|
| 466 |
[PATCH myproject v2 3/4] Add foo to bar |
| 467 |
|
| 468 |
The following fields are produced: |
| 469 |
|
| 470 |
index: 3 |
| 471 |
count: 4 |
| 472 |
version: 2 |
| 473 |
prefix: "myproject" |
| 474 |
subject: "Add foo to bar" |
| 475 |
""" |
| 476 |
type Patch { |
| 477 |
index: Int |
| 478 |
count: Int |
| 479 |
version: Int |
| 480 |
prefix: String |
| 481 |
subject: String |
| 482 |
|
| 483 |
""" |
| 484 |
git-style commit trailers parsed from the commit message of the patch. |
| 485 |
""" |
| 486 |
trailers: [Trailer!]! |
| 487 |
} |
| 488 |
|
| 489 |
enum PatchsetStatus { |
| 490 |
UNKNOWN |
| 491 |
PROPOSED |
| 492 |
NEEDS_REVISION |
| 493 |
SUPERSEDED |
| 494 |
APPROVED |
| 495 |
REJECTED |
| 496 |
APPLIED |
| 497 |
} |
| 498 |
|
| 499 |
type Patchset { |
| 500 |
id: Int! |
| 501 |
created: Time! |
| 502 |
updated: Time! |
| 503 |
subject: String! |
| 504 |
version: Int! |
| 505 |
prefix: String |
| 506 |
status: PatchsetStatus! |
| 507 |
submitter: Entity! |
| 508 |
|
| 509 |
coverLetter: Email @access(scope: EMAILS, kind: RO) |
| 510 |
thread: Thread! @access(scope: EMAILS, kind: RO) |
| 511 |
supersededBy: Patchset |
| 512 |
list: MailingList! @access(scope: LISTS, kind: RO) |
| 513 |
patches(cursor: Cursor): EmailCursor! @access(scope: EMAILS, kind: RO) |
| 514 |
tools: [PatchsetTool!]! |
| 515 |
|
| 516 |
"URL to an application/mbox archive of only the patches in this thread" |
| 517 |
mbox: URL! |
| 518 |
} |
| 519 |
|
| 520 |
enum ToolIcon { |
| 521 |
PENDING |
| 522 |
WAITING |
| 523 |
SUCCESS |
| 524 |
FAILED |
| 525 |
CANCELLED |
| 526 |
} |
| 527 |
|
| 528 |
""" |
| 529 |
Used to add some kind of indicator for a third-party process associated with |
| 530 |
a patchset, such as a CI service validating the change. |
| 531 |
""" |
| 532 |
type PatchsetTool { |
| 533 |
id: Int! |
| 534 |
created: Time! |
| 535 |
updated: Time! |
| 536 |
icon: ToolIcon! |
| 537 |
details: String! |
| 538 |
patchset: Patchset! |
| 539 |
} |
| 540 |
|
| 541 |
interface ActivitySubscription { |
| 542 |
id: Int! |
| 543 |
created: Time! |
| 544 |
} |
| 545 |
|
| 546 |
type MailingListSubscription implements ActivitySubscription { |
| 547 |
id: Int! |
| 548 |
created: Time! |
| 549 |
list: MailingList! @access(scope: LISTS, kind: RO) |
| 550 |
subscriber: Entity @internal |
| 551 |
} |
| 552 |
|
| 553 |
""" |
| 554 |
A cursor for enumerating ACL entries |
| 555 |
|
| 556 |
If there are additional results available, the cursor object may be passed |
| 557 |
back into the same endpoint to retrieve another page. If the cursor is null, |
| 558 |
there are no remaining results to return. |
| 559 |
""" |
| 560 |
type MailingListACLCursor { |
| 561 |
results: [MailingListACL!]! |
| 562 |
cursor: Cursor |
| 563 |
} |
| 564 |
|
| 565 |
""" |
| 566 |
A cursor for enumerating mailing lists |
| 567 |
|
| 568 |
If there are additional results available, the cursor object may be passed |
| 569 |
back into the same endpoint to retrieve another page. If the cursor is null, |
| 570 |
there are no remaining results to return. |
| 571 |
""" |
| 572 |
type MailingListCursor { |
| 573 |
results: [MailingList!]! |
| 574 |
cursor: Cursor |
| 575 |
} |
| 576 |
|
| 577 |
""" |
| 578 |
A cursor for enumerating threads |
| 579 |
|
| 580 |
If there are additional results available, the cursor object may be passed |
| 581 |
back into the same endpoint to retrieve another page. If the cursor is null, |
| 582 |
there are no remaining results to return. |
| 583 |
""" |
| 584 |
type ThreadCursor { |
| 585 |
results: [Thread!]! |
| 586 |
cursor: Cursor |
| 587 |
} |
| 588 |
|
| 589 |
""" |
| 590 |
A cursor for enumerating emails |
| 591 |
|
| 592 |
If there are additional results available, the cursor object may be passed |
| 593 |
back into the same endpoint to retrieve another page. If the cursor is null, |
| 594 |
there are no remaining results to return. |
| 595 |
""" |
| 596 |
type EmailCursor { |
| 597 |
results: [Email!]! |
| 598 |
cursor: Cursor |
| 599 |
} |
| 600 |
|
| 601 |
""" |
| 602 |
A cursor for enumerating patchsets |
| 603 |
|
| 604 |
If there are additional results available, the cursor object may be passed |
| 605 |
back into the same endpoint to retrieve another page. If the cursor is null, |
| 606 |
there are no remaining results to return. |
| 607 |
""" |
| 608 |
type PatchsetCursor { |
| 609 |
results: [Patchset!]! |
| 610 |
cursor: Cursor |
| 611 |
} |
| 612 |
|
| 613 |
""" |
| 614 |
A cursor for enumerating subscriptions |
| 615 |
|
| 616 |
If there are additional results available, the cursor object may be passed |
| 617 |
back into the same endpoint to retrieve another page. If the cursor is null, |
| 618 |
there are no remaining results to return. |
| 619 |
""" |
| 620 |
type ActivitySubscriptionCursor { |
| 621 |
results: [ActivitySubscription!]! |
| 622 |
cursor: Cursor |
| 623 |
} |
| 624 |
|
| 625 |
""" |
| 626 |
A cursor for enumerating a list of webhook deliveries |
| 627 |
|
| 628 |
If there are additional results available, the cursor object may be passed |
| 629 |
back into the same endpoint to retrieve another page. If the cursor is null, |
| 630 |
there are no remaining results to return. |
| 631 |
""" |
| 632 |
type WebhookDeliveryCursor { |
| 633 |
results: [WebhookDelivery!]! |
| 634 |
cursor: Cursor |
| 635 |
} |
| 636 |
|
| 637 |
""" |
| 638 |
A cursor for enumerating a list of webhook subscriptions |
| 639 |
|
| 640 |
If there are additional results available, the cursor object may be passed |
| 641 |
back into the same endpoint to retrieve another page. If the cursor is null, |
| 642 |
there are no remaining results to return. |
| 643 |
""" |
| 644 |
type WebhookSubscriptionCursor { |
| 645 |
results: [WebhookSubscription!]! |
| 646 |
cursor: Cursor |
| 647 |
} |
| 648 |
|
| 649 |
type Preferences { |
| 650 |
copySelf: Boolean! |
| 651 |
} |
| 652 |
|
| 653 |
type Query { |
| 654 |
"Returns API version information" |
| 655 |
version: Version! |
| 656 |
|
| 657 |
"Returns the authenticated user" |
| 658 |
me: User! @access(scope: PROFILE, kind: RO) |
| 659 |
|
| 660 |
"Looks up a specific user" |
| 661 |
user(username: String!): User @access(scope: PROFILE, kind: RO) |
| 662 |
|
| 663 |
"Looks up a list based on its resource ID." |
| 664 |
list(rid: ID!): MailingList @access(scope: LISTS, kind: RO) |
| 665 |
|
| 666 |
"Looks up a specific email by its ID" |
| 667 |
email(id: Int!): Email @access(scope: EMAILS, kind: RO) |
| 668 |
|
| 669 |
"Looks up a patchset by ID" |
| 670 |
patchset(id: Int!): Patchset @access(scope: EMAILS, kind: RO) |
| 671 |
|
| 672 |
"List of subscriptions of the authenticated user" |
| 673 |
subscriptions(cursor: Cursor): ActivitySubscriptionCursor @access(scope: SUBSCRIPTIONS, kind: RO) |
| 674 |
|
| 675 |
""" |
| 676 |
Returns a list of user webhook subscriptions. For clients |
| 677 |
authenticated with a personal access token, this returns all webhooks |
| 678 |
configured by all GraphQL clients for your account. For clients |
| 679 |
authenticated with an OAuth 2.0 access token, this returns only webhooks |
| 680 |
registered for your client. |
| 681 |
""" |
| 682 |
userWebhooks(cursor: Cursor): WebhookSubscriptionCursor! |
| 683 |
|
| 684 |
"Returns details of a user webhook subscription by its ID." |
| 685 |
userWebhook(id: Int!): WebhookSubscription |
| 686 |
|
| 687 |
""" |
| 688 |
Returns information about the webhook currently being processed. This is |
| 689 |
not valid during normal queries over HTTP, and will return an error if used |
| 690 |
outside of a webhook context. |
| 691 |
""" |
| 692 |
webhook: WebhookPayload! |
| 693 |
|
| 694 |
""" |
| 695 |
Returns the preferences associated with this user account. |
| 696 |
""" |
| 697 |
preferences: Preferences! @access(scope: PROFILE, kind: RO) |
| 698 |
|
| 699 |
""" |
| 700 |
If email corresponds to a registered user, return whether they wish to |
| 701 |
receive their own emails; otherwise return false. |
| 702 |
|
| 703 |
Internal use only. |
| 704 |
""" |
| 705 |
copySelf(email: String!): Boolean! @anoninternal |
| 706 |
} |
| 707 |
|
| 708 |
# You may omit any fields to leave them unchanged. |
| 709 |
# TODO: Allow users to change the name of a mailing list |
| 710 |
input MailingListInput { |
| 711 |
description: String |
| 712 |
visibility: Visibility |
| 713 |
|
| 714 |
""" |
| 715 |
List of globs for permitted or rejected mimetypes on this list |
| 716 |
e.g. text/* |
| 717 |
""" |
| 718 |
permitMime: [String!] |
| 719 |
rejectMime: [String!] |
| 720 |
} |
| 721 |
|
| 722 |
# All fields are required |
| 723 |
input ACLInput { |
| 724 |
browse: Boolean! |
| 725 |
reply: Boolean! |
| 726 |
post: Boolean! |
| 727 |
moderate: Boolean! |
| 728 |
} |
| 729 |
|
| 730 |
input UserWebhookInput { |
| 731 |
url: String! |
| 732 |
events: [WebhookEvent!]! |
| 733 |
query: String! |
| 734 |
} |
| 735 |
|
| 736 |
input MailingListWebhookInput { |
| 737 |
url: String! |
| 738 |
events: [WebhookEvent!]! |
| 739 |
query: String! |
| 740 |
} |
| 741 |
|
| 742 |
input PreferencesInput { |
| 743 |
copySelf: Boolean! |
| 744 |
} |
| 745 |
|
| 746 |
type Mutation { |
| 747 |
"Creates a new mailing list" |
| 748 |
createMailingList( |
| 749 |
name: String!, |
| 750 |
description: String, |
| 751 |
visibility: Visibility!): MailingList! @access(scope: LISTS, kind: RW) |
| 752 |
|
| 753 |
"Updates a mailing list." |
| 754 |
updateMailingList( |
| 755 |
id: Int!, |
| 756 |
input: MailingListInput!): MailingList @access(scope: LISTS, kind: RW) |
| 757 |
|
| 758 |
"Deletes a mailing list" |
| 759 |
deleteMailingList(id: Int!): MailingList @access(scope: LISTS, kind: RW) |
| 760 |
|
| 761 |
"Adds or updates the ACL for a user on a mailing list" |
| 762 |
updateUserACL( |
| 763 |
listID: Int!, |
| 764 |
userID: Int!, |
| 765 |
input: ACLInput!): MailingListACL @access(scope: ACLS, kind: RW) |
| 766 |
|
| 767 |
"Adds or updates the ACL for an email address on a mailing list" |
| 768 |
updateSenderACL( |
| 769 |
listID: Int!, |
| 770 |
address: String!, |
| 771 |
input: ACLInput!): MailingListACL @access(scope: ACLS, kind: RW) |
| 772 |
|
| 773 |
""" |
| 774 |
Updates the default ACL for a mailing list, which applies to users and |
| 775 |
senders for whom a more specific ACL does not exist. |
| 776 |
""" |
| 777 |
updateMailingListACL( |
| 778 |
listID: Int!, |
| 779 |
input: ACLInput!): MailingList @access(scope: ACLS, kind: RW) |
| 780 |
|
| 781 |
""" |
| 782 |
Removes a mailing list ACL. Following this, the default mailing list ACL will |
| 783 |
apply to this user. |
| 784 |
""" |
| 785 |
deleteACL(id: Int!): MailingListACL @access(scope: ACLS, kind: RW) |
| 786 |
|
| 787 |
"Updates the status of a patchset" |
| 788 |
updatePatchset(id: Int!, status: PatchsetStatus!): Patchset @access(scope: PATCHES, kind: RW) |
| 789 |
|
| 790 |
"Create a new patchset tool" |
| 791 |
createTool(patchsetID: Int!, details: String!, icon: ToolIcon!): PatchsetTool @access(scope: PATCHES, kind: RW) |
| 792 |
|
| 793 |
"Updates the status of a patchset tool by its ID" |
| 794 |
updateTool(id: Int!, details: String, icon: ToolIcon): PatchsetTool @access(scope: PATCHES, kind: RW) |
| 795 |
|
| 796 |
"Creates a mailing list subscription" |
| 797 |
mailingListSubscribe(listID: Int!): MailingListSubscription @access(scope: SUBSCRIPTIONS, kind: RW) |
| 798 |
|
| 799 |
"Deletes a mailing list subscription" |
| 800 |
mailingListUnsubscribe(listID: Int!): MailingListSubscription @access(scope: SUBSCRIPTIONS, kind: RW) |
| 801 |
|
| 802 |
"Imports a mail spool (must be in the Mbox format)" |
| 803 |
importMailingListSpool(listID: Int!, spool: Upload!): Boolean! @access(scope: LISTS, kind: RW) |
| 804 |
|
| 805 |
""" |
| 806 |
Creates a new user webhook subscription. When an event from the |
| 807 |
provided list of events occurs, the 'query' parameter (a GraphQL query) |
| 808 |
will be evaluated and the results will be sent to the provided URL as the |
| 809 |
body of an HTTP POST request. The list of events must include at least one |
| 810 |
event, and no duplicates. |
| 811 |
|
| 812 |
This query is evaluated in the webhook context, such that query { webhook } |
| 813 |
may be used to access details of the event which trigged the webhook. The |
| 814 |
query may not make any mutations. |
| 815 |
""" |
| 816 |
createUserWebhook(config: UserWebhookInput!): WebhookSubscription! |
| 817 |
|
| 818 |
""" |
| 819 |
Deletes a user webhook. Any events already queued may still be |
| 820 |
delivered after this request completes. Clients authenticated with a |
| 821 |
personal access token may delete any webhook registered for their account, |
| 822 |
but authorized OAuth 2.0 clients may only delete their own webhooks. |
| 823 |
Manually deleting a webhook configured by a third-party client may cause |
| 824 |
unexpected behavior with the third-party integration. |
| 825 |
""" |
| 826 |
deleteUserWebhook(id: Int!): WebhookSubscription! |
| 827 |
|
| 828 |
"Creates a new mailing list webhook." |
| 829 |
createMailingListWebhook(listId: Int!, config: MailingListWebhookInput!): WebhookSubscription! |
| 830 |
|
| 831 |
"Deletes a mailing list webhook." |
| 832 |
deleteMailingListWebhook(id: Int!): WebhookSubscription! |
| 833 |
|
| 834 |
""" |
| 835 |
Triggers user webhooks for an email. |
| 836 |
|
| 837 |
The result can be null if the user does not have browse access to the |
| 838 |
archived email. In this case, no webhook will be triggered. |
| 839 |
""" |
| 840 |
triggerUserEmailWebhooks(emailId: Int!): Email @internal |
| 841 |
triggerListEmailWebhooks(listId: Int!, emailId: Int!): Email! @internal |
| 842 |
|
| 843 |
""" |
| 844 |
Deletes the authenticated user's account. Internal use only. |
| 845 |
""" |
| 846 |
deleteUser: Int! @internal |
| 847 |
|
| 848 |
""" |
| 849 |
Archives an email (RFC 2045 MIME message) into a mailing list. |
| 850 |
Internal use only. |
| 851 |
""" |
| 852 |
archiveMessage(listID: Int!, message: Upload!): Boolean! @internal |
| 853 |
|
| 854 |
""" |
| 855 |
Request a subscription to a mailing list for a given email address. If the |
| 856 |
email is linked to a registered account, the subscription will be associated |
| 857 |
to the account. Otherwise, it will be associated to the mailbox. If a pending |
| 858 |
subscription request already exists for that list and email pair, the |
| 859 |
existing confirmation token will be returned. |
| 860 |
|
| 861 |
Internal use only. |
| 862 |
""" |
| 863 |
requestSubscription(listID: Int!, email: String!): ConfirmationToken! @internal |
| 864 |
|
| 865 |
""" |
| 866 |
Confirm a subscription request with a token previously obtained with |
| 867 |
requestSubscription(). |
| 868 |
|
| 869 |
Internal use only. |
| 870 |
""" |
| 871 |
confirmSubscription(token: ConfirmationToken!, email: String!): MailingListSubscription! @internal |
| 872 |
|
| 873 |
""" |
| 874 |
Request unsubscription from a mailing list for a given email address. |
| 875 |
|
| 876 |
Internal use only. |
| 877 |
""" |
| 878 |
requestUnsubscription(listID: Int!, email: String!): ConfirmationToken! @internal |
| 879 |
|
| 880 |
""" |
| 881 |
Confirm an unsubscription request with a token previously obtained with |
| 882 |
requestUnsubscription(). |
| 883 |
|
| 884 |
Internal use only. |
| 885 |
""" |
| 886 |
confirmUnsubscription(token: ConfirmationToken!, email: String!): MailingListSubscription! @internal |
| 887 |
|
| 888 |
""" |
| 889 |
Updates the user's preferences. |
| 890 |
""" |
| 891 |
updatePreferences(preferences: PreferencesInput!): Preferences! @access(scope: PROFILE, kind: RW) |
| 892 |
} |