Draft
Conversation
- Create comprehensive migration guide at openhands/usage/api/migration.mdx - Add migration guide to Cloud API navigation group in docs.json - Document endpoint mapping from V0 to V1 - Include benefits of V1 APIs (reliability, performance, DX) - Document new sandbox management endpoints - Document Agent Server API access and endpoints - Add migration examples with code snippets - List known gaps and workarounds Closes OpenHands/OpenHands#12578 Co-authored-by: openhands <openhands@all-hands.dev>
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.
Summary
This PR adds a comprehensive migration guide to help users transition from OpenHands V0 APIs to V1 APIs, as requested in OpenHands/OpenHands#12578.
Changes
openhands/usage/api/migration.mdx- Complete V0 to V1 migration guidedocs.json- Added migration guide to the Cloud API navigation groupMigration Guide Contents
The guide covers:
Architecture Overview
Benefits of V1 APIs
Endpoint Mapping Tables
Comprehensive tables mapping V0 endpoints to V1 equivalents for:
Migration Examples
Code examples showing V0 vs V1 for:
Agent Server API
Documentation on accessing and using the per-sandbox Agent Server API, including:
Known Gaps
Documented V0 capabilities without direct V1 equivalents and their workarounds.
Navigation
The migration guide is added to the Integrations > Cloud API group, appearing after the V1 API overview:
Related Issues
Closes OpenHands/OpenHands#12578
The content is based on the detailed comments in the issue by @jpshackelford and @enyst.