From 9a4f0465feffe7fe8d88bf87aa205820fd2403c2 Mon Sep 17 00:00:00 2001 From: Fei Wang Date: Tue, 16 Jul 2024 11:55:00 +0800 Subject: [PATCH] [CELEBORN-1477][CIP-9][FOLLOWUP] User guide for `/api/v1` migration ### What changes were proposed in this pull request? Provide the user migration guide for /api/v1. ### Why are the changes needed? For migration. ### Does this PR introduce _any_ user-facing change? No. ### How was this patch tested? Verified the api mapping in swagger. Closes #2618 from turboFei/cip_9_migrate. Lead-authored-by: Fei Wang Co-authored-by: Wang, Fei Signed-off-by: SteNicholas --- docs/migration.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) diff --git a/docs/migration.md b/docs/migration.md index a7ce650f1..cdbb91537 100644 --- a/docs/migration.md +++ b/docs/migration.md @@ -21,6 +21,53 @@ license: | # Migration Guide +# Upgrading from 0.5 to 0.6 +- +- Since 0.6.0, Celeborn has introduced a new RESTful API namespace: /api/v1, which uses the application/json media type for requests and responses. + The `celeborn-openapi-client` SDK is also available to help users interact with the new RESTful APIs. + The legacy RESTful APIs have been deprecated and will be removed in future releases. + Access the full [RESTful API documentation](./webapi.md) for detailed information. + + - The mappings of the old RESTful APIs to the new RESTful APIs for Master. + + | Old RESTful API | New RESTful API | Note | + |--------------------------|------------------------------------------|--------------------------------------------------| + | GET /conf | GET /api/v1/conf | | + | GET /listDynamicConfigs | GET /api/v1/conf/dynamic | | + | GET /threadDump | GET /api/v1/conf/thread_dump | | + | GET /applications | GET /api/v1/applications | | + | GET /listTopDiskUsedApps | GET /api/v1/applications/top_disk_usages | | + | GET /hostnames | GET /api/v1/applications/hostnames | | + | GET /shuffle | GET /api/v1/shuffles | | + | GET /masterGroupInfo | GET /api/v1/masters | | + | GET /workerInfo | GET /api/v1/workers | | + | GET /lostWorkers | GET /api/v1/workers | get the lostWorkers field in response | + | GET /excludedWorkers | GET /api/v1/workers | get the excludedWorkers field in response | + | GET /shutdownWorkers | GET /api/v1/workers | get the shutdownWorkers filed in response | + | GET /decommissionWorkers | GET /api/v1/workers | get the decommissioningWorkers filed in response | + | POST /exclude | POST /api/v1/workers/exclude | | + | GET /workerEventInfo | GET /api/v1/workers/events | | + | POST /sendWorkerEvent | POST /api/v1/workers/events | | + + + - The mappings of the old RESTful APIs to the new RESTful APIs for Worker. + + | Old RESTful API | New RESTful API | Note | + |--------------------------------|------------------------------------------|---------------------------------------------| + | GET /conf | GET /api/v1/conf | | + | GET /listDynamicConfigs | GET /api/v1/conf/dynamic | | + | GET /threadDump | GET /api/v1/conf/thread_dump | | + | GET /applications | GET /api/v1/applications | | + | GET /listTopDiskUsedApps | GET /api/v1/applications/top_disk_usages | | + | GET /shuffle | GET /api/v1/shuffles | | + | GET /listPartitionLocationInfo | GET /api/v1/shuffles/partitions | | + | GET /workerInfo | GET /api/v1/workers | | + | GET /isRegistered | GET /api/v1/workers | get the isRegistered field in response | + | GET /isDecommissioning | GET /api/v1/workers | get the isDecommissioning field in response | + | GET /isShutdown | GET /api/v1/workers | get the isShutdown field in response | + | GET /unavailablePeers | GET /api/v1/workers/unavailable_peers | | + | POST /exit | POST /api/v1/workers/exit | | + ## Upgrading from 0.5.0 to 0.5.1 - Since 0.5.1, Celeborn master REST API `/exclude` request uses media type `application/x-www-form-urlencoded` instead of `text/plain`.