diff --git a/docs/decommissioning.md b/docs/decommissioning.md index 6c59e7a99..2802034d8 100644 --- a/docs/decommissioning.md +++ b/docs/decommissioning.md @@ -69,7 +69,7 @@ Administrators perform decommissioning operation in two approaches: curl -X POST -H "Content-Type: application/json" -d '{"eventType":"DecommissionThenIdle","workers":[{"host":"192.168.15.140","rpcPort":"37359","pushPort":"38303","fetchPort":"37569","replicatePort":"37093"},{"host":"192.168.15.141","rpcPort":"37359","pushPort":"38303","fetchPort":"37569","replicatePort":"37093"}]}' http://ip:port/api/v1/workers/events ``` -Details of decommissioning interface can refer to [REST API](../webapi/#rest-api) +Details of decommissioning interface can refer to [REST API](../restapi/#rest-api) ## Decommission Monitoring diff --git a/docs/migration.md b/docs/migration.md index 85f7716d9..29a237c47 100644 --- a/docs/migration.md +++ b/docs/migration.md @@ -22,11 +22,11 @@ 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. + Access the full [RESTful API documentation](./restapi.md) for detailed information. - The mappings of the old RESTful APIs to the new RESTful APIs for Master. diff --git a/docs/monitoring.md b/docs/monitoring.md index e097abdab..bea184fe6 100644 --- a/docs/monitoring.md +++ b/docs/monitoring.md @@ -412,6 +412,6 @@ scrape_configs: ## REST API -In addition to viewing the metrics, Celeborn also supports [REST API](webapi.md). +In addition to viewing the metrics, Celeborn also supports [REST API](restapi.md). This gives developers an easy way to create new visualizations and monitoring tools for Celeborn and also easy for users to get the running status of the service. diff --git a/docs/webapi.md b/docs/restapi.md similarity index 100% rename from docs/webapi.md rename to docs/restapi.md diff --git a/mkdocs.yml b/mkdocs.yml index 8ed79d3b2..8c197ab7f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -67,7 +67,9 @@ nav: - Deployment: - Overview: deploy.md - Kubernetes: deploy_on_k8s.md - - Monitoring: monitoring.md + - Monitoring: + - Overview: monitoring.md + - Rest API: restapi.md - Security: security.md - Quota Management: quota_management.md - Upgrading: upgrading.md