[serve] Fix linkcheck + remove deprecated rest api (ray-project#40464)

- Fix linkcheck in performance guide (remove link to microbenchmark instructions that no longer exists) - Remove deprecated v1 rest api
liudunxu · Oct 18, 2023 · 8e86f25 · 8e86f25
1 parent 4d93e37
commit 8e86f25
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 141 deletions.
diff --git a/doc/source/serve/advanced-guides/performance.md b/doc/source/serve/advanced-guides/performance.md
@@ -17,9 +17,6 @@ This section offers some tips and tricks to improve your Ray Serve application's
 
 Ray Serve is built on top of Ray, so its scalability is bounded by Ray’s scalability. Please see Ray’s [scalability envelope](https://github.com/ray-project/ray/blob/master/release/benchmarks/README.md) to learn more about the maximum number of nodes and other limitations.
 
-You can check out our [microbenchmark instructions](https://github.com/ray-project/ray/blob/master/python/ray/serve/benchmarks/README.md)
-to benchmark Ray Serve on your hardware.
-
 ## Debugging performance issues
 
 The performance issue you're most likely to encounter is high latency and/or low throughput for requests.

diff --git a/doc/source/serve/api/index.md b/doc/source/serve/api/index.md
@@ -116,132 +116,7 @@ To opt into the new API, you can either use `handle.options(use_new_handle_api=T
 
 ## Serve REST API
 
-### V1 REST API (Single-application)
-
-#### `PUT "/api/serve/deployments/"`
-
-Declaratively deploys the Serve application. Starts Serve on the Ray cluster if it's not already running. See [single-app config schema](serve-rest-api-config-schema) for the request's JSON schema.
-
-**Example Request**:
-
-```http
-PUT /api/serve/deployments/ HTTP/1.1
-Host: http://localhost:52365/
-Accept: application/json
-Content-Type: application/json
-
-{
-    "import_path": "text_ml:app",
-    "runtime_env": {
-        "working_dir": "https://github.com/ray-project/serve_config_examples/archive/HEAD.zip"
-    },
-    "deployments": [
-        {"name": "Translator", "user_config": {"language": "french"}},
-        {"name": "Summarizer"},
-    ]
-}
-```
-
-**Example Response**
-
-
-```http
-HTTP/1.1 200 OK
-Content-Type: application/json
-```
-
-#### `GET "/api/serve/deployments/"`
-
-Gets the config for the application currently deployed on the Ray cluster. This config represents the current goal state for the Serve application. See [single-app config schema](serve-rest-api-config-schema) for the response's JSON schema.
-
-**Example Request**:
-```http
-GET /api/serve/deployments/ HTTP/1.1
-Host: http://localhost:52365/
-Accept: application/json
-```
-
-**Example Response**:
-
-```http
-HTTP/1.1 200 OK
-Content-Type: application/json
-
-{
-    "import_path": "text_ml:app",
-    "runtime_env": {
-        "working_dir": "https://github.com/ray-project/serve_config_examples/archive/HEAD.zip"
-    },
-    "deployments": [
-        {"name": "Translator", "user_config": {"language": "french"}},
-        {"name": "Summarizer"},
-    ]
-}
-```
-
-
-#### `GET "/api/serve/deployments/status"`
-
-Gets the Serve application's current status, including all the deployment statuses. See [status schema](serve-rest-api-response-schema) for the response's JSON schema.
-
-**Example Request**:
-
-```http
-GET /api/serve/deployments/status HTTP/1.1
-Host: http://localhost:52365/
-Accept: application/json
-```
-
-**Example Response**
-
-```http
-HTTP/1.1 200 OK
-Content-Type: application/json
-
-{
-    "name": "default",
-    "app_status": {
-        "status": "RUNNING",
-        "message": "",
-        "deployment_timestamp": 1694043082.0397763
-    },
-    "deployment_statuses": [
-        {
-            "name": "Translator",
-            "status": "HEALTHY",
-            "message": ""
-        },
-        {
-            "name": "Summarizer",
-            "status": "HEALTHY",
-            "message": ""
-        }
-    ]
-}
-```
-
-#### `DELETE "/api/serve/deployments/"`
-
-Shuts down Serve and the Serve application running on the Ray cluster. Has no effect if Serve is not running on the Ray cluster.
-
-**Example Request**:
-
-```http
-DELETE /api/serve/deployments/ HTTP/1.1
-Host: http://localhost:52365/
-Accept: application/json
-```
-
-**Example Response**
-
-```http
-HTTP/1.1 200 OK
-Content-Type: application/json
-```
-
-### V2 REST API (Multi-application)
-
-#### `PUT "/api/serve/applications/"`
+### `PUT "/api/serve/applications/"`
 
 Declaratively deploys a list of Serve applications. If Serve is already running on the Ray cluster, removes all applications not listed in the new config. If Serve is not running on the Ray cluster, starts Serve. See [multi-app config schema](serve-rest-api-config-schema) for the request's JSON schema.
 
@@ -281,7 +156,7 @@ HTTP/1.1 200 OK
 Content-Type: application/json
 ```
 
-#### `GET "/api/serve/applications/"`
+### `GET "/api/serve/applications/"`
 
 Gets cluster-level info and comprehensive details on all Serve applications deployed on the Ray cluster. See [metadata schema](serve-rest-api-response-schema) for the response's JSON schema.
 
@@ -431,7 +306,7 @@ Content-Type: application/json
 }
 ```
 
-#### `DELETE "/api/serve/applications/"`
+### `DELETE "/api/serve/applications/"`
 
 Shuts down Serve and all applications running on the Ray cluster. Has no effect if Serve is not running on the Ray cluster.
 
@@ -474,16 +349,6 @@ Content-Type: application/json
 (serve-rest-api-response-schema)=
 ## Response Schemas
 
-### V1 REST API
-```{eval-rst}
-.. autosummary::
-   :nosignatures:
-   :toctree: doc/
-
-   schema.ServeStatusSchema
-```
-
-### V2 REST API
 ```{eval-rst}
 .. autosummary::
    :nosignatures: