apache/celeborn
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

[CELEBORN-1477][CIP-9][FOLLOWUP] User guide for /api/v1 migration

Browse Source 
### 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 <fwang12@ebay.com>
Co-authored-by: Wang, Fei <fwang12@ebay.com>
Signed-off-by: SteNicholas <programgeek@163.com>
This commit is contained in:
Fei Wang 2024-07-16 11:55:00 +08:00 committed by SteNicholas
parent 82a3abf10e
commit 9a4f0465fe
1 changed files with 47 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
docs/migration.md
View File

@ -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`.