Remove standalone objects from REST API usage docs#3290
Open
Conversation
Standalone object creation is not a pattern we want to encourage, as objects not assigned to the object tree are immediately unreachable and subject to garbage collection. This mirrors the same change made to the REST SDK usage docs in 3ddb9d6, as a result of the PR comment [1]. Remove the "Creating standalone objects" section and the "Publishing with client-generated IDs" subsection (which showed creating a standalone object). The client-generated IDs section now only shows the atomic batch example that creates and assigns in one operation, with an important note that objects should be assigned to the tree as part of the same batch. [1] #3258 (comment)
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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
2 participants
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.
Standalone object creation is not a pattern we want to encourage, as objects not assigned to the object tree are immediately unreachable and subject to garbage collection. This mirrors the same change made to the REST SDK usage docs in 3ddb9d6, as a result of the PR comment [1].
Remove the "Creating standalone objects" section and the "Publishing with client-generated IDs" subsection (which showed creating a standalone object). The client-generated IDs section now only shows the atomic batch example that creates and assigns in one operation, with an important note that objects should be assigned to the tree as part of the same batch.
[1] #3258 (comment)
Description
Checklist