[PLAT-8079] Documenting Body Documents as a "core concept" with updated examples#104
Merged
MadisonEhlers-Vertex merged 2 commits intomainfrom Mar 5, 2026
Merged
[PLAT-8079] Documenting Body Documents as a "core concept" with updated examples#104MadisonEhlers-Vertex merged 2 commits intomainfrom
MadisonEhlers-Vertex merged 2 commits intomainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR documents the bodyDocuments (Body Document) concept in the Vertex Collaboration APIs guide. It introduces a new "Body Document" section under Core Concepts, including JSON examples, and updates all existing curl command examples to replace the deprecated body string field with the withBodyDocument structured object.
Changes:
- Adds a new "Body Document" Core Concepts section with two JSON examples (text-only and with mention)
- Updates all
curlrequest examples (Create Thread, Create Reply, Update Thread, Update Reply) to usewithBodyDocumentinstead of the deprecatedbodyfield - Updates prose descriptions to reference "body document" instead of "body"
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
danschultz
reviewed
Mar 4, 2026
Contributor
danschultz
left a comment
danschultz
left a comment
There was a problem hiding this comment.
LGTM after Copilot suggestions.
|
danschultz
approved these changes
Mar 5, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
These changes include updates from the deprecated
bodytype in favor ofbodyDocuments. I added an additionalBody Documentsection under the Core concepts to document what these are, with a few simple examples.Video of changes:
2026-03-04_11-35-51.mp4
Test Plan
Release Notes
Possible Regressions
Dependencies