Update LiveObjects REST API docs for V2 format and improve structure #3119
+882
−1,421
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
The LiveObjects REST API moved from V1 (generic "operation" + "data" fields) to V2 (operation-specific fields: mapSet, counterInc, etc.). Content changes: - Updated the content to match the new V2 API. - Removed the deprecated docs from the open api spec - Added the new V2 api to the open api spec pages. - Added examples of each of the v2 operation types json Structural improvements: - Reorganized the sections into beginner -> advanced flow. - Added or updated header anchors Quality fixes: - Standardized field ordering (objectId/path before operation fields) - Reduced some verbosity, and moved some less relevant data lower in the document.
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 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 |
Contributor
Author
|
Can only be merged (released) after w/c 19th Jan release has completed. |
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.
The LiveObjects REST API moved from V1 (generic "operation" + "data" fields) to V2 (operation-specific fields: mapSet, counterInc, etc.).
Content changes:
Structural improvements:
Quality fixes: