@remit/api-openapi-spec 0.0.20 → 0.0.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/openapi.json +4 -4
  2. package/package.json +1 -1
package/openapi.json CHANGED
@@ -1573,7 +1573,7 @@
1573
1573
  "name": "count",
1574
1574
  "in": "query",
1575
1575
  "required": false,
1576
- "description": "Include a count of matches within the server-capped window.",
1576
+ "description": "Include how many messages the query matches. Counted over the whole mailbox, independent of `limit`.",
1577
1577
  "schema": {
1578
1578
  "type": "boolean"
1579
1579
  }
@@ -1591,7 +1591,7 @@
1591
1591
  "name": "limit",
1592
1592
  "in": "query",
1593
1593
  "required": false,
1594
- "description": "Caller-set recency window, capped server-side at 500. Bounds the read.",
1594
+ "description": "Page size for the rows returned, capped server-side at 500. Bounds the read, not the `count`.",
1595
1595
  "schema": {
1596
1596
  "type": "integer",
1597
1597
  "format": "int32"
@@ -6450,10 +6450,10 @@
6450
6450
  "count": {
6451
6451
  "type": "integer",
6452
6452
  "format": "int32",
6453
- "description": "Number of matches within the server-capped window. Present only when `count=true`."
6453
+ "description": "How many messages the query matches, over the whole mailbox and independent of `limit`. Present only when `count=true`. With `senderTrust` or `dkimMismatch` in the query the count is over the enriched window instead, since those are resolved off the row."
6454
6454
  }
6455
6455
  },
6456
- "description": "Aggregate response for `searchThreads`. Carries the matching rows (`items`), a\npagination `continuationToken`, and an optional `count` of matches within the\nserver-capped window. `items` is omitted when `results=false` (count-only);\n`count` is present only when `count=true`. Thread-specific so the shared\n`ResultList<T>` (7 endpoints) stays untouched."
6456
+ "description": "Aggregate response for `searchThreads`. Carries the matching rows (`items`), a\npagination `continuationToken`, and an optional `count` of every message the\nquery matches. `items` is omitted when `results=false` (count-only); `count` is\npresent only when `count=true`. Thread-specific so the shared `ResultList<T>`\n(7 endpoints) stays untouched."
6457
6457
  },
6458
6458
  "RemitImap.TrustedFlag": {
6459
6459
  "type": "object",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@remit/api-openapi-spec",
3
- "version": "0.0.20",
3
+ "version": "0.0.21",
4
4
  "description": "Remit API OpenAPI 3 document, generated from TypeSpec.",
5
5
  "exports": {
6
6
  ".": "./openapi.json",