pan3793 commented on code in PR #2624: URL: https://github.com/apache/celeborn/pull/2624#discussion_r1677272777
########## docs/webapi.md: ########## @@ -0,0 +1,98 @@ +--- +license: | + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--- + +## REST API + +Celeborn supports REST API and available for both master and worker. The endpoints are mounted at `host:port`. +For example, +for the master, they would typically be accessible at `http://<master-http-host>:<master-http-port><path>`, and +for the worker, at `http://<worker-http-host>:<worker-http-port><path>`. + +And the swagger UI is available at `http://<http-host>:<http-port>/swagger` (since 0.5.0) both for master and worker. + +The configuration of `<master-http-host>`, `<master-http-port>`, `<worker-http-host>`, `<worker-http--port>` as below: + +| Key | Default | Description | Since | +|---------------------------|---------|---------------------|-------| +| celeborn.master.http.host | 0.0.0.0 | Master's http host. | 0.4.0 | +| celeborn.master.http.port | 9098 | Master's http port. | 0.4.0 | +| celeborn.worker.http.host | 0.0.0.0 | Worker's http host. | 0.4.0 | +| celeborn.worker.http.port | 9096 | Worker's http port. | 0.4.0 | + +### Deprecated REST APIs + +Since 0.6.0, the REST APIs are deprecated and will be removed in the future. Review Comment: ```suggestion Since 0.6.0, the legacy REST APIs are deprecated and will be removed in the future. ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
