Skip to content

fix: improve document API dry runs, query matching, and reference blok mutations #2498

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
harbournick merged 1 commit into from
Mar 20, 2026
Merged

fix: improve document API dry runs, query matching, and reference blok mutations #2498

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 0 additions & 1 deletion apps/docs/document-api/available-operations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ sidebarTitle: Available Operations
description: All Document API operations and their editor method mappings
---

Document API is in alpha and subject to breaking changes while the contract continues to evolve.
See the full [operation reference](/document-api/reference/index) for detailed input/output schemas.

{/* DOC_API_OPERATIONS_START */}
Expand Down
4 changes: 0 additions & 4 deletions apps/docs/document-api/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ keywords: "document api, programmatic access, query documents, document manipula

Document API gives you a consistent way to read and edit documents without relying on editor internals.

<Info>
Document API is in <strong>alpha</strong> and subject to breaking changes while the contract and adapters continue to evolve. The current API is not yet comprehensive, and more commands and namespaces are being added on an ongoing basis.
</Info>

## Why use Document API

- Build automations without editor-specific code.
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/document-api/reference/_generated-manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -986,5 +986,5 @@
}
],
"marker": "{/* GENERATED FILE: DO NOT EDIT. Regenerate via `pnpm run docapi:sync`. */}",
"sourceHash": "52013243a974232110399da20b569ed98bfa7ab25ab0c09f314168b748ebc7a8"
"sourceHash": "2c5d9a2fb7367b363b9a4612eecc2c80b10f4ed465f33b1fccf2412cb86c63f6"
}
4 changes: 1 addition & 3 deletions apps/docs/document-api/reference/authorities/configure.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: Update the configuration of an existing table-of-authorities block.

{/* GENERATED FILE: DO NOT EDIT. Regenerate via `pnpm run docapi:sync`. */}

> Alpha: Document API is currently alpha and subject to breaking changes.

## Summary

Update the configuration of an existing table-of-authorities block.
Expand All @@ -17,7 +15,7 @@ Update the configuration of an existing table-of-authorities block.
- Mutates document: `yes`
- Idempotency: `idempotent`
- Supports tracked mode: `no`
- Supports dry run: `no`
- Supports dry run: `yes`
- Deterministic target resolution: `yes`

## Expected result
Expand Down
2 changes: 0 additions & 2 deletions apps/docs/document-api/reference/authorities/entries-get.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: Get detailed information about a specific TA authority entry.

{/* GENERATED FILE: DO NOT EDIT. Regenerate via `pnpm run docapi:sync`. */}

> Alpha: Document API is currently alpha and subject to breaking changes.

## Summary

Get detailed information about a specific TA authority entry.
Expand Down
4 changes: 1 addition & 3 deletions apps/docs/document-api/reference/authorities/entries-insert.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: Insert a new TA authority entry field at a target location.

{/* GENERATED FILE: DO NOT EDIT. Regenerate via `pnpm run docapi:sync`. */}

> Alpha: Document API is currently alpha and subject to breaking changes.

## Summary

Insert a new TA authority entry field at a target location.
Expand All @@ -17,7 +15,7 @@ Insert a new TA authority entry field at a target location.
- Mutates document: `yes`
- Idempotency: `non-idempotent`
- Supports tracked mode: `no`
- Supports dry run: `no`
- Supports dry run: `yes`
- Deterministic target resolution: `yes`

## Expected result
Expand Down
2 changes: 0 additions & 2 deletions apps/docs/document-api/reference/authorities/entries-list.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: List all TA (authority entry) fields in the document.

{/* GENERATED FILE: DO NOT EDIT. Regenerate via `pnpm run docapi:sync`. */}

> Alpha: Document API is currently alpha and subject to breaking changes.

## Summary

List all TA (authority entry) fields in the document.
Expand Down
4 changes: 1 addition & 3 deletions apps/docs/document-api/reference/authorities/entries-remove.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: Remove a TA authority entry field from the document.

{/* GENERATED FILE: DO NOT EDIT. Regenerate via `pnpm run docapi:sync`. */}

> Alpha: Document API is currently alpha and subject to breaking changes.

## Summary

Remove a TA authority entry field from the document.
Expand All @@ -17,7 +15,7 @@ Remove a TA authority entry field from the document.
- Mutates document: `yes`
- Idempotency: `non-idempotent`
- Supports tracked mode: `no`
- Supports dry run: `no`
- Supports dry run: `yes`
- Deterministic target resolution: `yes`

## Expected result
Expand Down
4 changes: 1 addition & 3 deletions apps/docs/document-api/reference/authorities/entries-update.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: Update the properties of an existing TA authority entry.

{/* GENERATED FILE: DO NOT EDIT. Regenerate via `pnpm run docapi:sync`. */}

> Alpha: Document API is currently alpha and subject to breaking changes.

## Summary

Update the properties of an existing TA authority entry.
Expand All @@ -17,7 +15,7 @@ Update the properties of an existing TA authority entry.
- Mutates document: `yes`
- Idempotency: `idempotent`
- Supports tracked mode: `no`
- Supports dry run: `no`
- Supports dry run: `yes`
- Deterministic target resolution: `yes`

## Expected result
Expand Down
2 changes: 0 additions & 2 deletions apps/docs/document-api/reference/authorities/get.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: Get detailed information about a specific table-of-authorities bloc

{/* GENERATED FILE: DO NOT EDIT. Regenerate via `pnpm run docapi:sync`. */}

> Alpha: Document API is currently alpha and subject to breaking changes.

## Summary

Get detailed information about a specific table-of-authorities block.
Expand Down
16 changes: 7 additions & 9 deletions apps/docs/document-api/reference/authorities/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: Table of Authorities operation reference from the canonical Documen

{/* GENERATED FILE: DO NOT EDIT. Regenerate via `pnpm run docapi:sync`. */}

> Alpha: Document API is currently alpha and subject to breaking changes.

[Back to full reference](../index)

Table of authorities lifecycle and TA entry operations.
Expand All @@ -16,13 +14,13 @@ Table of authorities lifecycle and TA entry operations.
| --- | --- | --- | --- | --- | --- |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><a href="/document-api/reference/authorities/list"><code>authorities.list</code></a></span> | `authorities.list` | No | `idempotent` | No | No |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><a href="/document-api/reference/authorities/get"><code>authorities.get</code></a></span> | `authorities.get` | No | `idempotent` | No | No |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><a href="/document-api/reference/authorities/insert"><code>authorities.insert</code></a></span> | `authorities.insert` | Yes | `non-idempotent` | No | No |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><a href="/document-api/reference/authorities/configure"><code>authorities.configure</code></a></span> | `authorities.configure` | Yes | `idempotent` | No | No |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><a href="/document-api/reference/authorities/rebuild"><code>authorities.rebuild</code></a></span> | `authorities.rebuild` | Yes | `idempotent` | No | No |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><a href="/document-api/reference/authorities/remove"><code>authorities.remove</code></a></span> | `authorities.remove` | Yes | `non-idempotent` | No | No |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><a href="/document-api/reference/authorities/insert"><code>authorities.insert</code></a></span> | `authorities.insert` | Yes | `non-idempotent` | No | Yes |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><a href="/document-api/reference/authorities/configure"><code>authorities.configure</code></a></span> | `authorities.configure` | Yes | `idempotent` | No | Yes |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><a href="/document-api/reference/authorities/rebuild"><code>authorities.rebuild</code></a></span> | `authorities.rebuild` | Yes | `idempotent` | No | Yes |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><a href="/document-api/reference/authorities/remove"><code>authorities.remove</code></a></span> | `authorities.remove` | Yes | `non-idempotent` | No | Yes |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><a href="/document-api/reference/authorities/entries-list"><code>authorities.entries.list</code></a></span> | `authorities.entries.list` | No | `idempotent` | No | No |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><a href="/document-api/reference/authorities/entries-get"><code>authorities.entries.get</code></a></span> | `authorities.entries.get` | No | `idempotent` | No | No |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><a href="/document-api/reference/authorities/entries-insert"><code>authorities.entries.insert</code></a></span> | `authorities.entries.insert` | Yes | `non-idempotent` | No | No |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><a href="/document-api/reference/authorities/entries-update"><code>authorities.entries.update</code></a></span> | `authorities.entries.update` | Yes | `idempotent` | No | No |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><a href="/document-api/reference/authorities/entries-remove"><code>authorities.entries.remove</code></a></span> | `authorities.entries.remove` | Yes | `non-idempotent` | No | No |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><a href="/document-api/reference/authorities/entries-insert"><code>authorities.entries.insert</code></a></span> | `authorities.entries.insert` | Yes | `non-idempotent` | No | Yes |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><a href="/document-api/reference/authorities/entries-update"><code>authorities.entries.update</code></a></span> | `authorities.entries.update` | Yes | `idempotent` | No | Yes |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><a href="/document-api/reference/authorities/entries-remove"><code>authorities.entries.remove</code></a></span> | `authorities.entries.remove` | Yes | `non-idempotent` | No | Yes |

4 changes: 1 addition & 3 deletions apps/docs/document-api/reference/authorities/insert.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: Insert a new table-of-authorities block at a target location.

{/* GENERATED FILE: DO NOT EDIT. Regenerate via `pnpm run docapi:sync`. */}

> Alpha: Document API is currently alpha and subject to breaking changes.

## Summary

Insert a new table-of-authorities block at a target location.
Expand All @@ -17,7 +15,7 @@ Insert a new table-of-authorities block at a target location.
- Mutates document: `yes`
- Idempotency: `non-idempotent`
- Supports tracked mode: `no`
- Supports dry run: `no`
- Supports dry run: `yes`
- Deterministic target resolution: `yes`

## Expected result
Expand Down
2 changes: 0 additions & 2 deletions apps/docs/document-api/reference/authorities/list.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: List all table-of-authorities blocks in the document.

{/* GENERATED FILE: DO NOT EDIT. Regenerate via `pnpm run docapi:sync`. */}

> Alpha: Document API is currently alpha and subject to breaking changes.

## Summary

List all table-of-authorities blocks in the document.
Expand Down
4 changes: 1 addition & 3 deletions apps/docs/document-api/reference/authorities/rebuild.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: Rebuild a table-of-authorities block from its entries.

{/* GENERATED FILE: DO NOT EDIT. Regenerate via `pnpm run docapi:sync`. */}

> Alpha: Document API is currently alpha and subject to breaking changes.

## Summary

Rebuild a table-of-authorities block from its entries.
Expand All @@ -17,7 +15,7 @@ Rebuild a table-of-authorities block from its entries.
- Mutates document: `yes`
- Idempotency: `idempotent`
- Supports tracked mode: `no`
- Supports dry run: `no`
- Supports dry run: `yes`
- Deterministic target resolution: `yes`

## Expected result
Expand Down
4 changes: 1 addition & 3 deletions apps/docs/document-api/reference/authorities/remove.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: Remove a table-of-authorities block from the document.

{/* GENERATED FILE: DO NOT EDIT. Regenerate via `pnpm run docapi:sync`. */}

> Alpha: Document API is currently alpha and subject to breaking changes.

## Summary

Remove a table-of-authorities block from the document.
Expand All @@ -17,7 +15,7 @@ Remove a table-of-authorities block from the document.
- Mutates document: `yes`
- Idempotency: `non-idempotent`
- Supports tracked mode: `no`
- Supports dry run: `no`
- Supports dry run: `yes`
- Deterministic target resolution: `yes`

## Expected result
Expand Down
2 changes: 0 additions & 2 deletions apps/docs/document-api/reference/blocks/delete-range.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: Delete a contiguous range of top-level blocks between two endpoints

{/* GENERATED FILE: DO NOT EDIT. Regenerate via `pnpm run docapi:sync`. */}

> Alpha: Document API is currently alpha and subject to breaking changes.

## Summary

Delete a contiguous range of top-level blocks between two endpoints (inclusive). Both endpoints must be direct children of the document node. Supports dry-run preview.
Expand Down
2 changes: 0 additions & 2 deletions apps/docs/document-api/reference/blocks/delete.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: Delete an entire block node (paragraph, heading, list item, table,

{/* GENERATED FILE: DO NOT EDIT. Regenerate via `pnpm run docapi:sync`. */}

> Alpha: Document API is currently alpha and subject to breaking changes.

## Summary

Delete an entire block node (paragraph, heading, list item, table, image, or sdt) deterministically.
Expand Down
2 changes: 0 additions & 2 deletions apps/docs/document-api/reference/blocks/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: Blocks operation reference from the canonical Document API contract

{/* GENERATED FILE: DO NOT EDIT. Regenerate via `pnpm run docapi:sync`. */}

> Alpha: Document API is currently alpha and subject to breaking changes.

[Back to full reference](../index)

Block-level structural operations.
Expand Down
2 changes: 0 additions & 2 deletions apps/docs/document-api/reference/blocks/list.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: List top-level blocks in document order with IDs, types, and text p

{/* GENERATED FILE: DO NOT EDIT. Regenerate via `pnpm run docapi:sync`. */}

> Alpha: Document API is currently alpha and subject to breaking changes.

## Summary

List top-level blocks in document order with IDs, types, and text previews. Supports pagination via offset/limit and optional nodeType filtering.
Expand Down
2 changes: 0 additions & 2 deletions apps/docs/document-api/reference/bookmarks/get.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: Get detailed information about a specific bookmark.

{/* GENERATED FILE: DO NOT EDIT. Regenerate via `pnpm run docapi:sync`. */}

> Alpha: Document API is currently alpha and subject to breaking changes.

## Summary

Get detailed information about a specific bookmark.
Expand Down
8 changes: 3 additions & 5 deletions apps/docs/document-api/reference/bookmarks/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: Bookmarks operation reference from the canonical Document API contr

{/* GENERATED FILE: DO NOT EDIT. Regenerate via `pnpm run docapi:sync`. */}

> Alpha: Document API is currently alpha and subject to breaking changes.

[Back to full reference](../index)

Named bookmark inspection, insertion, renaming, and removal.
Expand All @@ -16,7 +14,7 @@ Named bookmark inspection, insertion, renaming, and removal.
| --- | --- | --- | --- | --- | --- |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><a href="/document-api/reference/bookmarks/list"><code>bookmarks.list</code></a></span> | `bookmarks.list` | No | `idempotent` | No | No |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><a href="/document-api/reference/bookmarks/get"><code>bookmarks.get</code></a></span> | `bookmarks.get` | No | `idempotent` | No | No |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><a href="/document-api/reference/bookmarks/insert"><code>bookmarks.insert</code></a></span> | `bookmarks.insert` | Yes | `non-idempotent` | No | No |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><a href="/document-api/reference/bookmarks/rename"><code>bookmarks.rename</code></a></span> | `bookmarks.rename` | Yes | `idempotent` | No | No |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><a href="/document-api/reference/bookmarks/remove"><code>bookmarks.remove</code></a></span> | `bookmarks.remove` | Yes | `non-idempotent` | No | No |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><a href="/document-api/reference/bookmarks/insert"><code>bookmarks.insert</code></a></span> | `bookmarks.insert` | Yes | `non-idempotent` | No | Yes |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><a href="/document-api/reference/bookmarks/rename"><code>bookmarks.rename</code></a></span> | `bookmarks.rename` | Yes | `idempotent` | No | Yes |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><a href="/document-api/reference/bookmarks/remove"><code>bookmarks.remove</code></a></span> | `bookmarks.remove` | Yes | `non-idempotent` | No | Yes |

4 changes: 1 addition & 3 deletions apps/docs/document-api/reference/bookmarks/insert.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: Insert a new named bookmark at a target location.

{/* GENERATED FILE: DO NOT EDIT. Regenerate via `pnpm run docapi:sync`. */}

> Alpha: Document API is currently alpha and subject to breaking changes.

## Summary

Insert a new named bookmark at a target location.
Expand All @@ -17,7 +15,7 @@ Insert a new named bookmark at a target location.
- Mutates document: `yes`
- Idempotency: `non-idempotent`
- Supports tracked mode: `no`
- Supports dry run: `no`
- Supports dry run: `yes`
- Deterministic target resolution: `yes`

## Expected result
Expand Down
2 changes: 0 additions & 2 deletions apps/docs/document-api/reference/bookmarks/list.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: List all bookmarks in the document.

{/* GENERATED FILE: DO NOT EDIT. Regenerate via `pnpm run docapi:sync`. */}

> Alpha: Document API is currently alpha and subject to breaking changes.

## Summary

List all bookmarks in the document.
Expand Down
4 changes: 1 addition & 3 deletions apps/docs/document-api/reference/bookmarks/remove.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: Remove a bookmark from the document.

{/* GENERATED FILE: DO NOT EDIT. Regenerate via `pnpm run docapi:sync`. */}

> Alpha: Document API is currently alpha and subject to breaking changes.

## Summary

Remove a bookmark from the document.
Expand All @@ -17,7 +15,7 @@ Remove a bookmark from the document.
- Mutates document: `yes`
- Idempotency: `non-idempotent`
- Supports tracked mode: `no`
- Supports dry run: `no`
- Supports dry run: `yes`
- Deterministic target resolution: `yes`

## Expected result
Expand Down
4 changes: 1 addition & 3 deletions apps/docs/document-api/reference/bookmarks/rename.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: Rename an existing bookmark.

{/* GENERATED FILE: DO NOT EDIT. Regenerate via `pnpm run docapi:sync`. */}

> Alpha: Document API is currently alpha and subject to breaking changes.

## Summary

Rename an existing bookmark.
Expand All @@ -17,7 +15,7 @@ Rename an existing bookmark.
- Mutates document: `yes`
- Idempotency: `idempotent`
- Supports tracked mode: `no`
- Supports dry run: `no`
- Supports dry run: `yes`
- Deterministic target resolution: `yes`

## Expected result
Expand Down
Loading
Loading