Skip to content

V1.0.0#16

Open
m-brtn wants to merge 6 commits into
mainfrom
markdown-ingest
Open

V1.0.0#16
m-brtn wants to merge 6 commits into
mainfrom
markdown-ingest

Conversation

@m-brtn

@m-brtn m-brtn commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

No description provided.

m-brtn and others added 5 commits June 11, 2026 02:57
- post_comment/edit_comment accept markdown (mutually exclusive with content), Comment.content_version
- get_space_members filters bot members; Tree icon added
- deprecate non-markdown document write methods and Task.update_task_description
- adapt tests to Lexical document format; docs updated

Co-authored-by: Cursor <cursoragent@cursor.com>
BREAKING CHANGE: removes the TipTap/JSON document API and DSL from the SDK:
- get_json_document/replace_json_document/append_json_document/replace_document/append_document and their models
- vaiz.helpers.document_structure (all node builders, node types, EmbedType)
- Task.get_task_description now returns Markdown; Task.update_task_description accepts Markdown

Markdown methods (replace/append/get_markdown_document) are the only content interface.
Tests and examples migrated to markdown; docs cleaned up; CHANGELOG includes a migration guide.
Server-side JSON endpoints are untouched, so older SDK versions keep working.

Co-authored-by: Cursor <cursoragent@cursor.com>
Mentions in markdown documents and comments are now converted to live
mention nodes by the backend transformer and survive round-trips.

Co-authored-by: Cursor <cursoragent@cursor.com>
The `get_comments()` method now returns comment content as Markdown, including mentions formatted as `@[label](kind:id)`. Legacy comments with a `content_version` other than `2` are returned as raw HTML. Documentation and tests have been updated to reflect these changes.
Introduced a field validator in the Task model to convert null values for the 'types' field into an empty list, ensuring consistent data handling from the API. This change improves robustness when dealing with tasks that may not have associated types.
@vercel

vercel Bot commented Jun 11, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
vaiz-python-sdk Ready Ready Preview, Comment Jul 8, 2026 12:11pm

Request Review

Changed the homepage URL in the pyproject.toml file from the GitHub repository link to the new documentation site link, ensuring users are directed to the appropriate resource for SDK information.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant