SG-40841 Add information about relative_path field #420
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for the relative_path field in local file links throughout the attachments cookbook. The relative_path field represents the file path relative to the local_storage root directory.
Key changes:
- Added
relative_pathfield definition to the field documentation section - Updated all code examples to include the
relative_pathfield in their output - Improved JSON formatting consistency across examples
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
carlos-villavicencio-adsk
previously approved these changes
Oct 27, 2025
dsauve-adsk
previously approved these changes
Oct 28, 2025
There was a problem hiding this comment.
LGTM,
Good thing that you removed the urls from the loca_storage...
One small detail, half the changed examples has a trailing comma while the other half do not. (Consistency is always best, but I see that it was already this way before, I do not believe that we want to fix all that...)
julien-lang
dismissed stale reviews from dsauve-adsk and carlos-villavicencio-adsk
via
3e5f2dd
eduardoChaucaGallegos
approved these changes
Oct 29, 2025
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.
This pull request updates the documentation in
docs/cookbook/attachments.rstto improve clarity and completeness regarding local file attachment fields. The changes focus on formatting consistency, introducing therelative_pathfield, and updating example code blocks to match the latest data structure.